diff --git a/.github/PULL_REQUEST_TEMPLATE/control_plane_template.md b/.github/PULL_REQUEST_TEMPLATE/control_plane_template.md index 60aba042de93..1bcbe104d811 100644 --- a/.github/PULL_REQUEST_TEMPLATE/control_plane_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/control_plane_template.md @@ -17,6 +17,7 @@ What's the purpose of this PR? Check the specific option that applies. This is * - [ ] New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to [OpenAPI specs PR creation guidance](https://aka.ms/azsdkdocs/createopenapispec)). - [ ] Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.) - [ ] Update existing version to fix OpenAPI spec quality issues in S360. + - [ ] Convert existing [OpenAPI spec to TypeSpec spec](https://aka.ms/typespec/conversion) (do not combine this with implementing changes for a new API version). - [ ] Other, please clarify: - _edit this with your clarification_ @@ -51,7 +52,7 @@ If one or multiple validation error/warning suppression(s) is detected in your P ## Getting help - First, please carefully read through this PR description, from top to bottom. Please fill out the `Purpose of this PR` and `Due diligence checklist`. -- If you don't have permissions to remove or add labels to the PR, request `write access` per [aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories](https://aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories") +- If you don't have permissions to remove or add labels to the PR, request `write access` per [aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories](https://aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories) - To understand what you must do next to merge this PR, see the `Next Steps to Merge` comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state. - For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure and https://aka.ms/ci-fix. diff --git a/.github/PULL_REQUEST_TEMPLATE/data_plane_template.md b/.github/PULL_REQUEST_TEMPLATE/data_plane_template.md index 4fb4266325d3..d4f16039081f 100644 --- a/.github/PULL_REQUEST_TEMPLATE/data_plane_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/data_plane_template.md @@ -76,7 +76,7 @@ The [Azure API Review Board](https://aka.ms/azsdk/onboarding/restapischedule) is ## Getting help - First, please carefully read through this PR description, from top to bottom. -- If you don't have permissions to remove or add labels to the PR, request `write access` per [aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories](https://aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories") +- If you don't have permissions to remove or add labels to the PR, request `write access` per [aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories](https://aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories) - To understand what you must do next to merge this PR, see the `Next Steps to Merge` comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state. - For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure and https://aka.ms/ci-fix. diff --git a/.github/workflows/_reusable-eng-tools-test.yaml b/.github/workflows/_reusable-eng-tools-test.yaml index bf2b2d80b7b6..d568b029d71f 100644 --- a/.github/workflows/_reusable-eng-tools-test.yaml +++ b/.github/workflows/_reusable-eng-tools-test.yaml @@ -8,6 +8,17 @@ on: description: Name of package under eng/tools required: true type: string + sparse-checkout-paths: + description: Paths for sparse checkout + type: string + lint: + description: Run 'npm run lint' if true + required: false + type: boolean + prettier: + description: Run 'npm run prettier' if true + required: false + type: boolean jobs: test: @@ -24,9 +35,15 @@ jobs: runs-on: ${{ matrix.os }} steps: + - if: runner.os == 'Windows' + run: git config --global core.longpaths true + shell: pwsh + - uses: actions/checkout@v4 with: - sparse-checkout: eng + sparse-checkout: | + eng + ${{ inputs.sparse-checkout-paths }} - name: Use Node ${{ matrix.node-version }}.x uses: actions/setup-node@v4 @@ -44,6 +61,16 @@ jobs: shell: pwsh working-directory: ./eng/tools/${{ inputs.package }} + - run: npm run lint + if: inputs.lint == true + shell: pwsh + working-directory: ./eng/tools/${{ inputs.package }} + + - run: npm run prettier + if: inputs.prettier == true + shell: pwsh + working-directory: ./eng/tools/${{ inputs.package }} + - run: npm run test:ci shell: pwsh working-directory: ./eng/tools/${{ inputs.package }} diff --git a/.github/workflows/specs-model-test.yaml b/.github/workflows/specs-model-test.yaml new file mode 100644 index 000000000000..6fcfd221dbd8 --- /dev/null +++ b/.github/workflows/specs-model-test.yaml @@ -0,0 +1,27 @@ +name: Specs Model - Test + +on: + push: + branches: + - main + - typespec-next + pull_request: + paths: + - package-lock.json + - package.json + - tsconfig.json + - .github/workflows/_reusable-eng-tools-test.yaml + - .github/workflows/specs-model-test.yaml + - eng/tools/package.json + - eng/tools/tsconfig.json + - eng/tools/specs-model/** + workflow_dispatch: + +jobs: + specsModel: + name: Specs Model + uses: ./.github/workflows/_reusable-eng-tools-test.yaml + with: + package: specs-model + lint: true + prettier: true diff --git a/.github/workflows/tsp-client-test.yaml b/.github/workflows/tsp-client-test.yaml new file mode 100644 index 000000000000..795aca614f9b --- /dev/null +++ b/.github/workflows/tsp-client-test.yaml @@ -0,0 +1,30 @@ +name: tsp-client - Test + +on: + push: + branches: + - main + pull_request: + branches: + - main + paths: + - package-lock.json + - package.json + - tsconfig.json + - .github/workflows/_reusable-eng-tools-test.yaml + - .github/workflows/tsp-client-test.yaml + - eng/tools/package.json + - eng/tools/tsconfig.json + - eng/tools/tsp-client/** + - specification/keyvault + - specification/sphere + +jobs: + tsp-client: + uses: ./.github/workflows/_reusable-eng-tools-test.yaml + with: + package: tsp-client-tests + sparse-checkout-paths: | + specification/common-types + specification/keyvault + specification/sphere diff --git a/.gitignore b/.gitignore index 410f6505e69c..9e61f4eff330 100644 --- a/.gitignore +++ b/.gitignore @@ -116,6 +116,7 @@ warnings.txt .apitest .assets +# Blanket ignores *.js *.d.ts *.js.map @@ -123,5 +124,10 @@ warnings.txt *.bak # Eng Tools -eng/tools/typespec-validation/dist -!eng/tools/typespec-validation/cmd/*.js +eng/tools/**/dist +!eng/tools/**/cmd/*.js +!eng/tools/**/eslint.config.js + +# No package-lock.json files should be commited except the top-level. +**/package-lock.json +!/package-lock.json diff --git a/arm-compute/quickstart-templates/aliases.json b/arm-compute/quickstart-templates/aliases.json index bb01a79a02ea..711d2bd4862b 100644 --- a/arm-compute/quickstart-templates/aliases.json +++ b/arm-compute/quickstart-templates/aliases.json @@ -101,13 +101,6 @@ "sku": "2012-Datacenter", "version": "latest", "architecture": "x64" - }, - "Win2008R2SP1": { - "publisher": "MicrosoftWindowsServer", - "offer": "WindowsServer", - "sku": "2008-R2-SP1", - "version": "latest", - "architecture": "x64" } } } diff --git a/cSpell.json b/cSpell.json index bcbba8da57cf..064db296adb3 100644 --- a/cSpell.json +++ b/cSpell.json @@ -398,7 +398,13 @@ ] }, { - "filename": "**/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/SystemEvents.json", + "filename": "**/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/GeneratedSystemEvents.json", + "words": [ + "whatsapp" + ] + }, + { + "filename": "**/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/GeneratedSystemEvents.json", "words": [ "whatsapp" ] @@ -442,7 +448,8 @@ { "filename": "**/specification/netapp/**/*.json", "words": [ - "SVMs" + "SVMs", + "kibibytes" ] }, { @@ -1151,6 +1158,15 @@ "mpga" ] }, + { + "filename": "**/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/**/*.json", + "words": [ + "flac", + "FLAC", + "mpga", + "rerank" + ] + }, { "filename": "**/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json", "words": [ @@ -1160,6 +1176,7 @@ { "filename": "**/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/**/*.json", "words": [ + "keyvaultkeyuri", "throughputpool" ] }, @@ -1169,6 +1186,14 @@ "timerange" ] }, + { + "filename": "**/specification/healthdataaiservices/**/*.json", + "words": [ + "deidentification", + "deidentify", + "surrogation" + ] + }, { "filename": "**/specification/search/data-plane/Azure.Search/**/*.json", "words": [ diff --git a/custom-words.txt b/custom-words.txt index 575b10b85ea6..1f21121e61ec 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -593,6 +593,8 @@ corda coreml corent cortana +Correlationid +correlationid cosell cosmosdb costcenter @@ -721,6 +723,7 @@ ddos ddthh deadletter deadlettered +deadlinetype deallocate deallocated deallocates @@ -1613,6 +1616,7 @@ localmachine localmapview localrun localsearch +locationparameter lockdown logalert logalertv1metricmeasurement @@ -2061,6 +2065,7 @@ openstack openxmlformats operationalinsights operationalization +operationids operationresults operationsmanagement operationstatus @@ -4059,4 +4064,4 @@ tpurgent virtualnetworkaddressname VMBM Vmdb -VNIC +VNIC \ No newline at end of file diff --git a/documentation/sdkautomation/GenerateOutputSchema.json b/documentation/sdkautomation/GenerateOutputSchema.json index c0503f4b3375..b14973a2bcb5 100644 --- a/documentation/sdkautomation/GenerateOutputSchema.json +++ b/documentation/sdkautomation/GenerateOutputSchema.json @@ -46,6 +46,19 @@ "type": "string" } }, + "typespecProject": { + // List of related typespec project of this package. + "type": "array", + "items": { + "type": "string" + } + }, + "language": { + "type": "string" + }, + "apiViewArtifact": { + "type": "string" + }, "changelog": { "type": "object", "properties": { @@ -56,6 +69,13 @@ "hasBreakingChange": { // Does the new package has breaking change "type": "boolean" + }, + "breakingChangeItems": { + // The breaking change details quote from the changelog + "type": "array", + "items": { + "type": "string" + } } }, "required": [ diff --git a/eng/.vscode/settings.json b/eng/.vscode/settings.json new file mode 100644 index 000000000000..52fd594fbf59 --- /dev/null +++ b/eng/.vscode/settings.json @@ -0,0 +1,14 @@ +{ + "editor.defaultFormatter": "esbenp.prettier-vscode", + "[javascript]": { + "editor.defaultFormatter": "esbenp.prettier-vscode" + }, + "editor.formatOnPaste": false, + "editor.formatOnType": false, + "editor.formatOnSave": true, + "editor.formatOnSaveMode": "file", // required to format on save + "prettier.requireConfig": true, + "cSpell.words": [ + "tseslint" + ] +} diff --git a/eng/README.md b/eng/README.md new file mode 100644 index 000000000000..cbcbe8dde614 --- /dev/null +++ b/eng/README.md @@ -0,0 +1,48 @@ +# `eng` directory + +The `eng` directory contains source code for automated tooling running on this repository pull requests. + +For context on this directory, see [Design guidelines for spec repos validation tooling] (Microsoft-internal). + +## Code conventions + +Below are code convention we strive to follow in `eng` directory: + +### package.json + +- We align `package.json` dependencies versions across all `package.json` files. +- We align `package.json` dependencies numbers with [microsoft/typespec package.json]. + In few cases we allow more frequent update cadence. +- We avoid doing package overrides. For example, we use `v8` of `eslint` instead of `v9` to avoid an override. + [See this comment for details][eslint override]. +- We order `package.json` keys as follows: `name private type main bin scripts engines dependencies devDependencies`. + +### package-lock.json + +- We maintain only top-level `package-lock.json` file. Running `npm install` from top-level dir removes the need + to ever have other files. +- We ensure the lock file remains clean by ensuring that a PR that adds or modifies any `package.json` dependencies, + makes changes equivalent to following protocol: + - `cd ` + - `git clean -xdf` to remove all untracked files. + - Copy-over [`package-lock.json` from `main`] to local clone. + - `npm install` to reflect the added or modified dependencies. +- In case any dependencies have been removed from any `package.json`, we do `rm package-lock.json` and `npm install`. + This way we ensure the lock file remains free of unused dependencies. +- We do `npm update` only in stand-alone PRs. +- To avoid conflicting changes when updating `package-lock.json`, only use the latest LTS version of Node, and the bundled version of npm (but no newer). You can use `nvm install --lts` (Linux) or `nvm install lts` (Windows). + +## Linting and prettier + +- We make eslint-based linting rules and prettier mandatory in CI for all projects. +- We use strict rulesets as baseline. +- We discuss any desired rule divergences from the strict ruleset + and apply rule modifications to the configs with explanation for our decision. +- We align `prettier` rules with [microsoft/typespec .prettierrc.json]. + +[`package-lock.json` from `main`]: https://github.com/Azure/azure-rest-api-specs/blob/main/package-lock.json +[Design guidelines for spec repos validation tooling]: https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/1153/Design-guidelines-for-spec-repos-validation-tooling +[eslint override]: https://github.com/Azure/azure-rest-api-specs/pull/29820#pullrequestreview-2177045580 +[microsoft/typespec .prettierrc.json]: https://github.com/microsoft/typespec/blob/main/.prettierrc.json +[microsoft/typespec package.json]: https://github.com/microsoft/typespec/blob/main/package.json +[npm/cli #7384]: https://github.com/npm/cli/issues/7384 diff --git a/eng/tools/package.json b/eng/tools/package.json index 1c69ffb902f1..c2b328e705a8 100644 --- a/eng/tools/package.json +++ b/eng/tools/package.json @@ -1,7 +1,9 @@ { "name": "azure-rest-api-specs-eng-tools", "devDependencies": { + "@azure-tools/specs-model": "file:specs-model", "@azure-tools/suppressions": "file:suppressions", + "@azure-tools/tsp-client-tests": "file:tsp-client-tests", "@azure-tools/typespec-requirement": "file:typespec-requirement", "@azure-tools/typespec-validation": "file:typespec-validation" }, diff --git a/eng/tools/specs-model/.prettierignore b/eng/tools/specs-model/.prettierignore new file mode 100644 index 000000000000..fb1653e08b6d --- /dev/null +++ b/eng/tools/specs-model/.prettierignore @@ -0,0 +1,4 @@ +*.json +*.md +*.jsonc +dist diff --git a/eng/tools/specs-model/.prettierrc.mjs b/eng/tools/specs-model/.prettierrc.mjs new file mode 100644 index 000000000000..7bc9d0d1cd4d --- /dev/null +++ b/eng/tools/specs-model/.prettierrc.mjs @@ -0,0 +1,18 @@ +// This config is adapted from https://github.com/microsoft/typespec/blob/main/.prettierrc.json +// See eng/README.md for context. +/** + * @see https://prettier.io/docs/en/configuration.html + * @type {import("prettier").Config} + */ +const config = { + arrowParens: "always", + trailingComma: "es5", + bracketSpacing: true, + endOfLine: "lf", + printWidth: 100, + semi: true, + singleQuote: false, + tabWidth: 2, +}; + +export default config; diff --git a/eng/tools/specs-model/cmd/get-specs-model.js b/eng/tools/specs-model/cmd/get-specs-model.js new file mode 100755 index 000000000000..cf0bb73957bc --- /dev/null +++ b/eng/tools/specs-model/cmd/get-specs-model.js @@ -0,0 +1,5 @@ +#!/usr/bin/env node + +import { main } from "../dist/index.js"; + +await main(); diff --git a/eng/tools/specs-model/eslint.config.js b/eng/tools/specs-model/eslint.config.js new file mode 100644 index 000000000000..03ff25bbdad9 --- /dev/null +++ b/eng/tools/specs-model/eslint.config.js @@ -0,0 +1,98 @@ +// @ts-check + +// The overall contents of this file is based on: +// https://typescript-eslint.io/getting-started#step-2-configuration +// https://typescript-eslint.io/getting-started/typed-linting/#shared-configurations +// Read inline comments for details on other sources. + +import eslint from "@eslint/js"; +import eslintPluginUnicorn from "eslint-plugin-unicorn"; +import tseslint from "typescript-eslint"; + +const config = tseslint.config( + // ======================================== + // ESLint + TS-ESLint configs + // ======================================== + { + // Needed for 'npm run lint' per: + // https://eslint.org/docs/latest/use/configure/migration-guide#--ext + // See also: + // - https://typescript-eslint.io/troubleshooting/typed-linting/#i-get-errors-telling-me-eslint-was-configured-to-run--however-that-tsconfig-does-not--none-of-those-tsconfigs-include-this-file + // - https://eslint.org/docs/latest/use/configure/ignore + ignores: [".prettierrc.cjs", "**/*.d.ts", "**/*.js", "**/*.mjs"], + }, + eslint.configs.recommended, + ...tseslint.configs.strictTypeChecked, + ...tseslint.configs.stylisticTypeChecked, + { + languageOptions: { + parserOptions: { + project: true, + tsconfigRootDir: import.meta.dirname, + }, + }, + }, + { + // Disable type-aware linting on .js files + // Otherwise eslint would complain about types in .js files, including this config file. + // Config snippet taken from https://typescript-eslint.io/packages/typescript-eslint/#advanced-usage + // Note: this is likely redundant with the global ignores of .js files, but keeping here for reference. + files: ["**/*.js"], + ...tseslint.configs.disableTypeChecked, + }, + + // ======================================== + // Secondary configs + // ======================================== + // @ts-expect-error The unicorn configs are not typed correctly, but they do work. + // Snippet taken from https://github.com/sindresorhus/eslint-plugin-unicorn#preset-configs-eslintconfigjs + eslintPluginUnicorn.configs["flat/recommended"], + // Note: in spite of my best efforts, I did not manage to get lodash eslint plugin to work in a clean way. + // https://github.com/wix-incubator/eslint-plugin-lodash + // I did manage to get it to lint, but the ESLint server output was throwing error about + // not being able to locate the config file. + // I suspect this is because the plugin was not migrated to the new flat config format since ESLint v9. + // Maybe this can be worked around with + // https://eslint.org/blog/2024/05/eslint-compatibility-utilities/ + + // ======================================== + // Rulesets overrides + // ======================================== + { + rules: { + // Sometimes we have to help the type checker with "!": + // e.g. when doing `if (arr.length > 0) { const ... = arr[0]! }` + // Note: this originates from [strict] + // https://typescript-eslint.io/rules/no-non-null-assertion + "@typescript-eslint/no-non-null-assertion": "off", + + // We want more flexibility with file names. + // https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/filename-case.md + "unicorn/filename-case": "off", + + // We prefer to have explicitly import at the top of the file, even if the same element is exported again, + // which we do in index.ts files. + // https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/prefer-export-from.md + "unicorn/prefer-export-from": ["error", { ignoreUsedVariables: true }], + + // We allow some abbreviations that we like. + // https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/prevent-abbreviations.md + "unicorn/prevent-abbreviations": [ + "error", + { + allowList: { + args: true, + }, + }, + ], + }, + } +); + +export default config; + +// Debug tool: +// Uncomment to print the config. View it in VS Code / Output / ESLint. Run "ESLint: Restart ESLint Server" command to force output. +// console.log(`ESLint config: ${JSON.stringify(config)}`) + +// [strict]: https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/strict.ts diff --git a/eng/tools/specs-model/package.json b/eng/tools/specs-model/package.json new file mode 100644 index 000000000000..0e681b5b9305 --- /dev/null +++ b/eng/tools/specs-model/package.json @@ -0,0 +1,36 @@ +{ + "name": "@azure-tools/specs-model", + "private": true, + "type": "module", + "main": "dist/src/index.js", + "bin": { + "get-specs-model": "cmd/get-specs-model.js" + }, + "scripts": { + "build": "tsc", + "postinstall": "npm run build", + "test": "vitest", + "test:ci": "vitest run --coverage --reporter=verbose", + "lint": "eslint . -c eslint.config.js --report-unused-disable-directives --max-warnings 0", + "lint:fix": "eslint . -c eslint.config.js --fix", + "prettier": "prettier . --check", + "prettier:debug": "prettier . --check ---log-level debug", + "prettier:write": "prettier . --write" + }, + "engines": { + "node": ">= 18.0.0" + }, + "dependencies": {}, + "devDependencies": { + "@eslint/js": "^9.7.0", + "@tsconfig/strictest": "^2.0.5", + "@types/eslint__js": "^8.42.3", + "@types/node": "^18.19.31", + "@vitest/coverage-v8": "^1.6.0", + "eslint": "^8.57.0", + "eslint-plugin-unicorn": "^54.0.0", + "typescript": "~5.4.5", + "typescript-eslint": "^7.16.0", + "vitest": "^1.6.0" + } +} diff --git a/eng/tools/specs-model/src/getSpecsModel.ts b/eng/tools/specs-model/src/getSpecsModel.ts new file mode 100644 index 000000000000..3377729002b2 --- /dev/null +++ b/eng/tools/specs-model/src/getSpecsModel.ts @@ -0,0 +1,7 @@ +export async function getSpecsModel(path: string): Promise { + // eslint-disable-next-line @typescript-eslint/require-await + await (async () => { + console.log(path); + })(); + return `stub getSpecsModel. path: ${path}`; +} diff --git a/eng/tools/specs-model/src/index.ts b/eng/tools/specs-model/src/index.ts new file mode 100644 index 000000000000..e188045340d5 --- /dev/null +++ b/eng/tools/specs-model/src/index.ts @@ -0,0 +1,32 @@ +import { exit } from "node:process"; +import { getSpecsModel } from "./getSpecsModel.js"; + +function getUsage(): string { + return ( + " Usage: npx get-specs-model \n" + + "Returns: JSON metadata for the input file or directory.\n" + + "\n" + + "The input path:\n" + + "- Must be an absolute or relative path to local clone of the https://github.com/Azure/azure-rest-api-specs or https://github.com/Azure/azure-rest-api-specs-pr repo.\n" + + "- Must point to the /specification directory or one of its descendants.\n" + + "\n" + + "Example: npx get-specs-model $HOME/repos/azure-rest-api-specs/specification\n" + + "Returns: JSON with metadata for the entire 'specification' directory of the local clone of 'azure-rest-api-specs' repo.\n" + ); +} + +export async function main() { + const args: string[] = process.argv.slice(2); + + if (args.length > 0) { + const path: string = args[0]!; + const specsModel: string = await getSpecsModel(path); + console.log(JSON.stringify(specsModel)); + exit(0); + } else { + console.error(getUsage()); + exit(1); + } +} + +export { getSpecsModel }; diff --git a/eng/tools/specs-model/test/getSpecsModel.test.ts b/eng/tools/specs-model/test/getSpecsModel.test.ts new file mode 100644 index 000000000000..a4d8cc32c531 --- /dev/null +++ b/eng/tools/specs-model/test/getSpecsModel.test.ts @@ -0,0 +1,7 @@ +import { expect, test } from "vitest"; +import { getSpecsModel } from "../src/getSpecsModel.js"; + +test("example getSpecsModel test", async () => { + const output = await getSpecsModel("foo_path"); + expect(output).toEqual("stub getSpecsModel. path: foo_path"); +}); diff --git a/eng/tools/specs-model/tsconfig.json b/eng/tools/specs-model/tsconfig.json new file mode 100644 index 000000000000..4a6486ecc5e4 --- /dev/null +++ b/eng/tools/specs-model/tsconfig.json @@ -0,0 +1,21 @@ +{ + "extends": [ + "../tsconfig.json", + // [strictest] + "@tsconfig/strictest/tsconfig.json" + ], + "compilerOptions": { + "outDir": "./dist", + "target": "ES2022", + "lib": ["ES2022"], + + // checkJS is set to true by [strictest] but we need to disable it to avoid this [build failure]. + // We don't need it anyway, as all sources are in .ts except the 3-line cmd entry-point. + // https://www.typescriptlang.org/tsconfig/#checkJs + "checkJs": false + } +} + +// [strictest]: https://www.npmjs.com/package/@tsconfig/strictest from [tsconfig bases] +// [tsconfig bases]: https://github.com/tsconfig/bases#centralized-recommendations-for-tsconfig-bases from https://www.typescriptlang.org/tsconfig#target +// [build failure]: https://stackoverflow.com/questions/42609768/typescript-error-cannot-write-file-because-it-would-overwrite-input-file diff --git a/eng/tools/suppressions/cmd/get-suppressions.js b/eng/tools/suppressions/cmd/get-suppressions.js index 2a7c28a5d607..e2a37e0b5491 100755 --- a/eng/tools/suppressions/cmd/get-suppressions.js +++ b/eng/tools/suppressions/cmd/get-suppressions.js @@ -1,5 +1,5 @@ #!/usr/bin/env node -import { main } from "../dist/src/index.js" +import { main } from "../dist/src/index.js"; await main(); diff --git a/eng/tools/suppressions/package.json b/eng/tools/suppressions/package.json index 774d0580df13..34b271d0fcd5 100644 --- a/eng/tools/suppressions/package.json +++ b/eng/tools/suppressions/package.json @@ -6,6 +6,15 @@ "bin": { "get-suppressions": "cmd/get-suppressions.js" }, + "scripts": { + "build": "tsc", + "postinstall": "npm run build", + "test": "vitest", + "test:ci": "vitest run --coverage --reporter=verbose" + }, + "engines": { + "node": ">= 18.0.0" + }, "dependencies": { "minimatch": "^9.0.4", "yaml": "^2.4.2", @@ -17,14 +26,5 @@ "@vitest/coverage-v8": "^1.6.0", "typescript": "~5.4.5", "vitest": "^1.6.0" - }, - "scripts": { - "build": "tsc", - "postinstall": "npm run build", - "test": "vitest", - "test:ci": "vitest run --coverage --reporter=verbose" - }, - "engines": { - "node": ">= 18.0.0" } } diff --git a/eng/tools/suppressions/src/suppressions.ts b/eng/tools/suppressions/src/suppressions.ts index 51f02e155159..89f62f4008f7 100644 --- a/eng/tools/suppressions/src/suppressions.ts +++ b/eng/tools/suppressions/src/suppressions.ts @@ -37,7 +37,7 @@ const suppressionSchema = z.array( paths: paths, reason: s.reason, } as Suppression; - }), + }) ); /** @@ -74,7 +74,7 @@ export async function getSuppressions(tool: string, path: string): Promise { + return await getSuppressions(tool, join(__dirname, "e2e", path)); +} + +test.concurrent("no suppressions.yaml", async () => { + const suppressions: Suppression[] = await getTestSuppressions("noSuppressionsYaml"); + expect(suppressions).toEqual([]); +}); + +test.concurrent("empty suppressions.yaml", async () => { + const suppressions: Suppression[] = await getTestSuppressions("emptySuppressionsYaml"); + expect(suppressions).toEqual([]); +}); + +test.concurrent("suppress foo.json, get foo.json", async () => { + const suppressions: Suppression[] = await getTestSuppressions( + join("suppressFooJson", "foo.json"), + ); + expect(suppressions).toEqual([ + { + tool: "TestTool", + paths: ["foo.json"], + reason: "test", + }, + ]); +}); + +test.concurrent("suppress foo.json, get bar.json", async () => { + const suppressions: Suppression[] = await getTestSuppressions( + join("suppressFooJson", "bar.json"), + ); + expect(suppressions).toEqual([]); +}); + +test.concurrent("suppress foo.json, get foo.json w/ different tool", async () => { + const suppressions: Suppression[] = await getTestSuppressions( + join("suppressFooJson", "foo.json"), + "TestTool2", + ); + expect(suppressions).toEqual([]); +}); diff --git a/eng/tools/tsp-client-tests/package.json b/eng/tools/tsp-client-tests/package.json new file mode 100644 index 000000000000..3a56644a56c0 --- /dev/null +++ b/eng/tools/tsp-client-tests/package.json @@ -0,0 +1,20 @@ +{ + "name": "@azure-tools/tsp-client-tests", + "private": true, + "type": "module", + "devDependencies": { + "@types/node": "^18.19.31", + "execa": "^9.3.0", + "typescript": "~5.4.5", + "vitest": "^1.6.0" + }, + "scripts": { + "build": "tsc", + "postinstall": "npm run build", + "test": "vitest", + "test:ci": "vitest run --reporter=verbose" + }, + "engines": { + "node": ">= 18.0.0" + } +} diff --git a/eng/tools/tsp-client-tests/test/tsp-client.test.ts b/eng/tools/tsp-client-tests/test/tsp-client.test.ts new file mode 100644 index 000000000000..6cdc45c51e06 --- /dev/null +++ b/eng/tools/tsp-client-tests/test/tsp-client.test.ts @@ -0,0 +1,70 @@ +import { execa } from "execa"; +import { access, constants, mkdir, rm } from "fs/promises"; +import { dirname, join } from "path"; +import { ExpectStatic, test } from "vitest"; + +const repoRoot = join(__dirname, "..", "..", "..", ".."); + +async function tspClient(...args: string[]) { + const allArgs = ["exec", "--no", "--", "tsp-client"].concat(args); + + console.log(`${repoRoot}$ npm ${allArgs.join(" ")}`); + + return await execa("npm", allArgs, { all: true, cwd: repoRoot, reject: false }); +} + +async function convert(expect: ExpectStatic, readme: string) { + const specFolder = dirname(dirname(join(repoRoot, readme))); + const outputFolder = join(specFolder, "Test.TspClientConvert"); + + try { + await mkdir(outputFolder); + } catch { + // Delete and retry + await rm(outputFolder, { recursive: true, force: true }); + await mkdir(outputFolder); + } + + try { + const { stdout, all, exitCode } = await tspClient( + "convert", + "--no-prompt", + "--swagger-readme", + readme, + "-o", + outputFolder, + readme.includes("resource-manager") ? "--arm" : "", + ); + + expect(stdout).toContain("Converting"); + expect(exitCode, all).toBe(0); + + const tspConfigYaml = join(outputFolder, "tspconfig.yaml"); + await access(tspConfigYaml, constants.R_OK); + console.log(`File exists: ${tspConfigYaml}`); + + const mainTsp = join(outputFolder, "main.tsp"); + await access(mainTsp, constants.R_OK); + console.log(`File exists: ${mainTsp}`); + } finally { + await rm(outputFolder, { recursive: true, force: true }); + } + + // Ensure outputFolder is deleted + expect(() => access(outputFolder)).rejects.toThrowError(); +} + +test.concurrent("Usage", async ({ expect }) => { + const { stdout, exitCode } = await tspClient(); + + expect(stdout).toContain("Usage"); + expect(exitCode).not.toBe(0); +}); + +test.concurrent("Convert keyvault/data-plane", async ({ expect }) => { + await convert(expect, "specification/keyvault/data-plane/readme.md"); +}); + +test.concurrent("Convert sphere/resource-manager", async ({ expect }) => { + await convert(expect, "specification/sphere/resource-manager/readme.md"); +}); diff --git a/eng/tools/tsp-client-tests/tsconfig.json b/eng/tools/tsp-client-tests/tsconfig.json new file mode 100644 index 000000000000..ec6d6640928a --- /dev/null +++ b/eng/tools/tsp-client-tests/tsconfig.json @@ -0,0 +1,6 @@ +{ + "extends": "../tsconfig.json", + "compilerOptions": { + "outDir": "./dist", + } +} diff --git a/eng/tools/tsp-client-tests/vite.config.ts b/eng/tools/tsp-client-tests/vite.config.ts new file mode 100644 index 000000000000..56e16cce625c --- /dev/null +++ b/eng/tools/tsp-client-tests/vite.config.ts @@ -0,0 +1,7 @@ +import { defineConfig } from "vite"; + +export default defineConfig({ + test: { + testTimeout: 240000, + }, +}); diff --git a/eng/tools/typespec-requirement/package.json b/eng/tools/typespec-requirement/package.json index e82d0d39da50..6872c5db6c19 100644 --- a/eng/tools/typespec-requirement/package.json +++ b/eng/tools/typespec-requirement/package.json @@ -4,7 +4,6 @@ "type": "module", "devDependencies": { "@types/node": "^18.19.31", - "@vitest/coverage-v8": "^1.6.0", "execa": "^9.3.0", "typescript": "~5.4.5", "vitest": "^1.6.0" @@ -13,7 +12,7 @@ "build": "tsc", "postinstall": "npm run build", "test": "vitest", - "test:ci": "vitest run --coverage --reporter=verbose" + "test:ci": "vitest run --reporter=verbose" }, "engines": { "node": ">= 18.0.0" diff --git a/eng/tools/typespec-validation/src/rules/folder-structure.ts b/eng/tools/typespec-validation/src/rules/folder-structure.ts index f6feb3327407..9e010e12d664 100644 --- a/eng/tools/typespec-validation/src/rules/folder-structure.ts +++ b/eng/tools/typespec-validation/src/rules/folder-structure.ts @@ -1,4 +1,5 @@ import path from "path"; +import { parse as yamlParse } from "yaml"; import { Rule } from "../rule.js"; import { RuleResult } from "../rule-result.js"; import { TsvHost } from "../tsv-host.js"; @@ -10,8 +11,8 @@ export class FolderStructureRule implements Rule { let success = true; let stdOutput = ""; let errorOutput = ""; - let gitRoot = host.normalizePath(await host.gitOperation(folder).revparse("--show-toplevel")); - let relativePath = path.relative(gitRoot, folder).split(path.sep).join("/"); + const gitRoot = host.normalizePath(await host.gitOperation(folder).revparse("--show-toplevel")); + const relativePath = path.relative(gitRoot, folder).split(path.sep).join("/"); stdOutput += `folder: ${folder}\n`; if (!(await host.checkFileExists(folder))) { @@ -32,13 +33,13 @@ export class FolderStructureRule implements Rule { }); // Verify top level folder is lower case and remove empty entries when splitting by slash - let folderStruct = relativePath.split("/").filter(Boolean); + const folderStruct = relativePath.split("/").filter(Boolean); if (folderStruct[1].match(/[A-Z]/g)) { success = false; errorOutput += `Invalid folder name. Folders under specification/ must be lower case.\n`; } - let packageFolder = folderStruct[folderStruct.length - 1]; + const packageFolder = folderStruct[folderStruct.length - 1]; // Verify package folder is at most 3 levels deep if (folderStruct.length > 4) { @@ -61,8 +62,9 @@ export class FolderStructureRule implements Rule { } // Verify tspconfig, main.tsp, examples/ - let mainExists = await host.checkFileExists(path.join(folder, "main.tsp")); - let clientExists = await host.checkFileExists(path.join(folder, "client.tsp")); + const mainExists = await host.checkFileExists(path.join(folder, "main.tsp")); + const clientExists = await host.checkFileExists(path.join(folder, "client.tsp")); + const tspConfigExists = await host.checkFileExists(path.join(folder, "tspconfig.yaml")); if (!mainExists && !clientExists) { errorOutput += `Invalid folder structure: Spec folder must contain main.tsp or client.tsp.`; @@ -74,14 +76,33 @@ export class FolderStructureRule implements Rule { success = false; } - if ( - !packageFolder.includes("Shared") && - !(await host.checkFileExists(path.join(folder, "tspconfig.yaml"))) - ) { + if (!packageFolder.includes("Shared") && !tspConfigExists) { errorOutput += `Invalid folder structure: Spec folder must contain tspconfig.yaml.`; success = false; } + if (tspConfigExists) { + const configText = await host.readTspConfig(folder); + const config = yamlParse(configText); + const rpFolder = + config?.options?.["@azure-tools/typespec-autorest"]?.["azure-resource-provider-folder"]; + stdOutput += `azure-resource-provider-folder: ${JSON.stringify(rpFolder)}\n`; + + if ( + rpFolder?.trim()?.endsWith("resource-manager") && + !packageFolder.endsWith(".Management") + ) { + errorOutput += `Invalid folder structure: TypeSpec for resource-manager specs must be in a folder ending with '.Management'`; + success = false; + } else if ( + !rpFolder?.trim()?.endsWith("resource-manager") && + packageFolder.endsWith(".Management") + ) { + errorOutput += `Invalid folder structure: TypeSpec for data-plane specs or shared code must be in a folder NOT ending with '.Management'`; + success = false; + } + } + return { success: success, stdOutput: stdOutput, diff --git a/eng/tools/typespec-validation/test/folder-structure.test.ts b/eng/tools/typespec-validation/test/folder-structure.test.ts index e1879ead200e..300788ad5f75 100644 --- a/eng/tools/typespec-validation/test/folder-structure.test.ts +++ b/eng/tools/typespec-validation/test/folder-structure.test.ts @@ -205,4 +205,94 @@ describe("folder-structure", function () { assert(result.errorOutput); assert(result.errorOutput.includes("must contain")); }); + + it("should succeed with resource-manager/Management", async function() { + let host = new TsvTestHost(); + host.globby = async () => { + return ["/foo/Foo.Management/tspconfig.yaml"]; + }; + host.normalizePath = () => { + return "/gitroot"; + }; + host.readTspConfig = async (_folder: string) => ` +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "resource-manager" +`; + + const result = await new FolderStructureRule().execute( + host, + "/gitroot/specification/foo/Foo.Management", + ); + + assert(result.success); + }); + + it("should succeed with data-plane/NoManagement", async function() { + let host = new TsvTestHost(); + host.globby = async () => { + return ["/foo/Foo/tspconfig.yaml"]; + }; + host.normalizePath = () => { + return "/gitroot"; + }; + host.readTspConfig = async (_folder: string) => ` +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "data-plane" +`; + + const result = await new FolderStructureRule().execute( + host, + "/gitroot/specification/foo/Foo", + ); + + assert(result.success); + }); + + it("should fail with resource-manager/NoManagement", async function() { + let host = new TsvTestHost(); + host.globby = async () => { + return ["/foo/Foo/tspconfig.yaml"]; + }; + host.normalizePath = () => { + return "/gitroot"; + }; + host.readTspConfig = async (_folder: string) => ` +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "resource-manager" +`; + + const result = await new FolderStructureRule().execute( + host, + "/gitroot/specification/foo/Foo", + ); + + assert(result.errorOutput); + assert(result.errorOutput.includes(".Management")); + }); + + it("should fail with data-plane/Management", async function() { + let host = new TsvTestHost(); + host.globby = async () => { + return ["/foo/Foo.Management/tspconfig.yaml"]; + }; + host.normalizePath = () => { + return "/gitroot"; + }; + host.readTspConfig = async (_folder: string) => ` +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "data-plane" +`; + + const result = await new FolderStructureRule().execute( + host, + "/gitroot/specification/foo/Foo.Management", + ); + + assert(result.errorOutput); + assert(result.errorOutput.includes(".Management")); + }); }); diff --git a/package-lock.json b/package-lock.json index 2ef4d7683924..3239ddbd86f6 100644 --- a/package-lock.json +++ b/package-lock.json @@ -6,20 +6,21 @@ "": { "name": "azure-rest-api-specs", "devDependencies": { - "@azure-tools/typespec-apiview": "0.4.8", - "@azure-tools/typespec-autorest": "0.43.0", - "@azure-tools/typespec-azure-core": "0.43.0", - "@azure-tools/typespec-azure-portal-core": "0.43.0", - "@azure-tools/typespec-azure-resource-manager": "0.43.0", - "@azure-tools/typespec-azure-rulesets": "0.43.0", - "@azure-tools/typespec-client-generator-core": "0.43.0", + "@azure-tools/typespec-apiview": "0.4.9", + "@azure-tools/typespec-autorest": "0.44.0", + "@azure-tools/typespec-azure-core": "0.44.0", + "@azure-tools/typespec-azure-portal-core": "0.44.0", + "@azure-tools/typespec-azure-resource-manager": "0.44.0", + "@azure-tools/typespec-azure-rulesets": "0.44.0", + "@azure-tools/typespec-client-generator-cli": "0.9.3", + "@azure-tools/typespec-client-generator-core": "0.44.0", "@azure/avocado": "^0.8.4", - "@typespec/compiler": "0.57.0", - "@typespec/http": "0.57.0", - "@typespec/openapi": "0.57.0", - "@typespec/openapi3": "0.57.0", - "@typespec/rest": "0.57.0", - "@typespec/versioning": "0.57.0", + "@typespec/compiler": "0.58.1", + "@typespec/http": "0.58.0", + "@typespec/openapi": "0.58.0", + "@typespec/openapi3": "0.58.0", + "@typespec/rest": "0.58.0", + "@typespec/versioning": "0.58.0", "azure-rest-api-specs-eng-tools": "file:eng/tools", "oav": "^3.3.7", "prettier": "~3.2.5", @@ -30,7 +31,9 @@ "name": "azure-rest-api-specs-eng-tools", "dev": true, "devDependencies": { + "@azure-tools/specs-model": "file:specs-model", "@azure-tools/suppressions": "file:suppressions", + "@azure-tools/tsp-client-tests": "file:tsp-client-tests", "@azure-tools/typespec-requirement": "file:typespec-requirement", "@azure-tools/typespec-validation": "file:typespec-validation" } @@ -283,6 +286,29 @@ "url": "https://github.com/sindresorhus/execa?sponsor=1" } }, + "eng/tools/specs-model": { + "name": "@azure-tools/specs-model", + "dev": true, + "hasInstallScript": true, + "bin": { + "get-specs-model": "cmd/get-specs-model.js" + }, + "devDependencies": { + "@eslint/js": "^9.7.0", + "@tsconfig/strictest": "^2.0.5", + "@types/eslint__js": "^8.42.3", + "@types/node": "^18.19.31", + "@vitest/coverage-v8": "^1.6.0", + "eslint": "^8.57.0", + "eslint-plugin-unicorn": "^54.0.0", + "typescript": "~5.4.5", + "typescript-eslint": "^7.16.0", + "vitest": "^1.6.0" + }, + "engines": { + "node": ">= 18.0.0" + } + }, "eng/tools/suppressions": { "name": "@azure-tools/suppressions", "dev": true, @@ -306,13 +332,26 @@ "node": ">= 18.0.0" } }, + "eng/tools/tsp-client-tests": { + "name": "@azure-tools/tsp-client-tests", + "dev": true, + "hasInstallScript": true, + "devDependencies": { + "@types/node": "^18.19.31", + "execa": "^9.3.0", + "typescript": "~5.4.5", + "vitest": "^1.6.0" + }, + "engines": { + "node": ">= 18.0.0" + } + }, "eng/tools/typespec-requirement": { "name": "@azure-tools/typespec-requirement", "dev": true, "hasInstallScript": true, "devDependencies": { "@types/node": "^18.19.31", - "@vitest/coverage-v8": "^1.6.0", "execa": "^9.3.0", "typescript": "~5.4.5", "vitest": "^1.6.0" @@ -419,94 +458,115 @@ "openapi-types": ">=7" } }, - "node_modules/@autorest/schemas": { - "version": "1.3.5", - "resolved": "https://registry.npmjs.org/@autorest/schemas/-/schemas-1.3.5.tgz", - "integrity": "sha512-HUP89Ns/4vDGcMtmFt/fxu+QqKvit/IQ8oBTQjzC6RnJojF+880KoEgTuweTuea2stzRmNyuMiBu4F8AnxdyUA==", - "dev": true - }, - "node_modules/@azure-tools/openapi-tools-common": { - "version": "1.2.2", - "resolved": "https://registry.npmjs.org/@azure-tools/openapi-tools-common/-/openapi-tools-common-1.2.2.tgz", - "integrity": "sha512-r6oBkNsND1sA+ZjHlE1vTf2hUj4RUnbD9KG9uksEKnLVC6oOD5WuJYCO5y4xDzWWuR0x+9gImovQqXAE7ZXYfg==", + "node_modules/@autorest/codemodel": { + "version": "4.20.0", + "resolved": "https://registry.npmjs.org/@autorest/codemodel/-/codemodel-4.20.0.tgz", + "integrity": "sha512-Z2GwVwAGNTcfGUmrWT5LJqZv/WDXKBBpxhZrHu6zco/HrEGrqKQcKx5whlLX/GmAB/KmhcOWYr6aIyWomcoisQ==", "dev": true, "dependencies": { - "@types/async-retry": "^1.4.1", - "@types/commonmark": "^0.27.3", - "@types/node-fetch": "^2.5.7", - "async-retry": "^1.2.3", - "commonmark": "^0.28.1", - "front-matter": "^4.0.2", - "node-fetch": "^2.6.0", - "tslib": "^2.0.0" + "@azure-tools/codegen": "~2.10.0", + "js-yaml": "~4.1.0" + }, + "engines": { + "node": ">=12.0.0" } }, - "node_modules/@azure-tools/openapi-tools-common/node_modules/commonmark": { - "version": "0.28.1", - "resolved": "https://registry.npmjs.org/commonmark/-/commonmark-0.28.1.tgz", - "integrity": "sha512-PklsZ9pgrfFQ5hQH9BRzoWnqI9db2LeR9MhvkNk8iz97kfaTNmhTU+IE8jKDHTEfivZZXoFqzGqzddXdk14EJw==", + "node_modules/@autorest/codemodel/node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "dev": true + }, + "node_modules/@autorest/codemodel/node_modules/js-yaml": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", + "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", "dev": true, "dependencies": { - "entities": "~ 1.1.1", - "mdurl": "~ 1.0.1", - "minimist": "~ 1.2.0", - "string.prototype.repeat": "^0.2.0" + "argparse": "^2.0.1" }, "bin": { - "commonmark": "bin/commonmark" - }, - "engines": { - "node": "*" + "js-yaml": "bin/js-yaml.js" } }, - "node_modules/@azure-tools/openapi-tools-common/node_modules/entities": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/entities/-/entities-1.1.2.tgz", - "integrity": "sha512-f2LZMYl1Fzu7YSBKg+RoROelpOaNrcGmE9AZubeDfrCEia483oW4MI4VyFd5VNHIgQ/7qm1I0wUHK1eJnn2y2w==", + "node_modules/@autorest/csharp": { + "version": "3.0.0-alpha.20231017.8", + "resolved": "https://aka.ms/azsdk/openapi-to-typespec-csharp", + "integrity": "sha512-f3/e8asQVyFmGw6apnPF3bhJXUmsQyLHa3o5hPuoqlKDYkWMwB1R4sayAF4PR0/rTA/RDXaTtheumG0BGUwN6Q==", "dev": true }, - "node_modules/@azure-tools/openapi-tools-common/node_modules/node-fetch": { - "version": "2.7.0", - "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", - "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", + "node_modules/@autorest/extension-base": { + "version": "3.6.0", + "resolved": "https://registry.npmjs.org/@autorest/extension-base/-/extension-base-3.6.0.tgz", + "integrity": "sha512-hE6nmdYu2SA6xlG46lM+/njtz0yNEkhzfkOs7PjrYulnXuBWHo08RdbXHGcecypgNhV2QAQcbV6ar5f1UGX6xQ==", "dev": true, "dependencies": { - "whatwg-url": "^5.0.0" + "@azure-tools/codegen": "~2.10.0", + "js-yaml": "~4.1.0", + "vscode-jsonrpc": "^3.5.0" }, "engines": { - "node": "4.x || >=6.0.0" - }, - "peerDependencies": { - "encoding": "^0.1.0" - }, - "peerDependenciesMeta": { - "encoding": { - "optional": true - } + "node": ">=12.0.0" } }, - "node_modules/@azure-tools/suppressions": { - "resolved": "eng/tools/suppressions", - "link": true + "node_modules/@autorest/extension-base/node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "dev": true }, - "node_modules/@azure-tools/typespec-apiview": { - "version": "0.4.8", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-apiview/-/typespec-apiview-0.4.8.tgz", - "integrity": "sha512-9608+exEW9R4rjfZlGeXkfIoz6Xrg2EZGnF/lVaT/jWR/LdzDr1EoGtxKgo4mUlHK4rhLB3TOO8Gx/WW901+kA==", + "node_modules/@autorest/extension-base/node_modules/js-yaml": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", + "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", "dev": true, - "engines": { - "node": ">=16.0.0" + "dependencies": { + "argparse": "^2.0.1" }, - "peerDependencies": { - "@typespec/compiler": ">=0.52 <1.0", - "@typespec/versioning": ">=0.52 <1.0" + "bin": { + "js-yaml": "bin/js-yaml.js" } }, - "node_modules/@azure-tools/typespec-autorest": { + "node_modules/@autorest/extension-base/node_modules/vscode-jsonrpc": { + "version": "3.6.2", + "resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-3.6.2.tgz", + "integrity": "sha512-T24Jb5V48e4VgYliUXMnZ379ItbrXgOimweKaJshD84z+8q7ZOZjJan0MeDe+Ugb+uqERDVV8SBmemaGMSMugA==", + "dev": true, + "engines": { + "node": ">=4.0.0 || >=6.0.0" + } + }, + "node_modules/@autorest/openapi-to-typespec": { + "version": "0.8.2", + "resolved": "https://registry.npmjs.org/@autorest/openapi-to-typespec/-/openapi-to-typespec-0.8.2.tgz", + "integrity": "sha512-8O3FEtnK2NHk6KdsT0L2AR7ILXffsPrJs3jYVcyeVF3mh73N9Bmk6EssK9a9Jz9tTeDhEjTBguiy2hVv5xVipg==", + "dev": true, + "dependencies": { + "@autorest/codemodel": "~4.20.0", + "@autorest/extension-base": "~3.6.0", + "@azure-tools/codegen": "~2.10.0", + "@azure-tools/typespec-autorest": "^0.43.0", + "@azure-tools/typespec-azure-core": "^0.43.0", + "@azure-tools/typespec-azure-resource-manager": "^0.43.0", + "@typespec/compiler": "^0.57.0", + "@typespec/http": "^0.57.0", + "@typespec/openapi": "^0.57.0", + "@typespec/openapi3": "^0.57.0", + "@typespec/prettier-plugin-typespec": "^0.57.0", + "@typespec/rest": "^0.57.0", + "@typespec/versioning": "^0.57.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.43.0", "resolved": "https://registry.npmjs.org/@azure-tools/typespec-autorest/-/typespec-autorest-0.43.0.tgz", "integrity": "sha512-tZ9uXXOdxu2y01W9n3mzXf+IEY2MQkP/JaQaKlcOx2+dbklHNQWSDU0Vm6Gmm6l//XiF9QiI8653BiuO97czyw==", "dev": true, + "license": "MIT", "engines": { "node": ">=18.0.0" }, @@ -521,11 +581,12 @@ "@typespec/versioning": "~0.57.0" } }, - "node_modules/@azure-tools/typespec-azure-core": { + "node_modules/@autorest/openapi-to-typespec/node_modules/@azure-tools/typespec-azure-core": { "version": "0.43.0", "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-core/-/typespec-azure-core-0.43.0.tgz", "integrity": "sha512-B1r0i3segJ7RuNXxcAMBy8H2t+jTkaf74dkyUWD0HIFPkhETN0uR59nuor+s+LoLU8yI4JypOFSNZt6e1rod8w==", "dev": true, + "license": "MIT", "engines": { "node": ">=18.0.0" }, @@ -535,21 +596,12 @@ "@typespec/rest": "~0.57.0" } }, - "node_modules/@azure-tools/typespec-azure-portal-core": { - "version": "0.43.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-portal-core/-/typespec-azure-portal-core-0.43.0.tgz", - "integrity": "sha512-I/EHlE27zB7arteyg1kNSKua0Uip8qbcLCYYEhdP0NzpEVqcA2mdEnwmc6xjP7/Tg3X0FeGf8Bc+UTSHK5zr/g==", - "dev": true, - "peerDependencies": { - "@azure-tools/typespec-azure-resource-manager": "~0.43.0", - "@typespec/compiler": "~0.57.0" - } - }, - "node_modules/@azure-tools/typespec-azure-resource-manager": { + "node_modules/@autorest/openapi-to-typespec/node_modules/@azure-tools/typespec-azure-resource-manager": { "version": "0.43.0", "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-resource-manager/-/typespec-azure-resource-manager-0.43.0.tgz", "integrity": "sha512-0GQL+/o1u+PAB63FpYz3sy3ZgZvCtk5T4sDAnICnV23v2YWIONDMUfxxd0x40xJbY6PkcwwHDpBLNMqajf2H6A==", "dev": true, + "license": "MIT", "dependencies": { "change-case": "~5.4.4", "pluralize": "^8.0.0" @@ -566,26 +618,13 @@ "@typespec/versioning": "~0.57.0" } }, - "node_modules/@azure-tools/typespec-azure-rulesets": { - "version": "0.43.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-rulesets/-/typespec-azure-rulesets-0.43.0.tgz", - "integrity": "sha512-yh0dNQIM4hRDWATh/tkONP991uMxFDHY8BkC0eWtIpfTjQTuR2PlGhrLgMxHT2Q5cCusfkNWeFvKDYlxKeoFLA==", - "dev": true, - "engines": { - "node": ">=18.0.0" - }, - "peerDependencies": { - "@azure-tools/typespec-azure-core": "~0.43.0", - "@azure-tools/typespec-azure-resource-manager": "~0.43.0", - "@azure-tools/typespec-client-generator-core": "~0.43.0", - "@typespec/compiler": "~0.57.0" - } - }, - "node_modules/@azure-tools/typespec-client-generator-core": { - "version": "0.43.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-core/-/typespec-client-generator-core-0.43.0.tgz", - "integrity": "sha512-rssB/zsg89wstzJC1MWzbd8oPpqbgoftkp9G/NP3BoMb/gCP5uRLggwlSUAgnoU2Lt0jBUKcMlqEiVLTAkY9LA==", + "node_modules/@autorest/openapi-to-typespec/node_modules/@azure-tools/typespec-client-generator-core": { + "version": "0.43.2", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-core/-/typespec-client-generator-core-0.43.2.tgz", + "integrity": "sha512-UAVV30BtTQBiXmBoQ3SyvmiuBDYoqWFIn7G96hjojpwXpE6D5ba0y5LascMuF1b65eAhGnnf974DElJE9DGepQ==", "dev": true, + "license": "MIT", + "peer": true, "dependencies": { "change-case": "~5.4.4", "pluralize": "^8.0.0" @@ -601,253 +640,332 @@ "@typespec/versioning": "~0.57.0" } }, - "node_modules/@azure-tools/typespec-requirement": { - "resolved": "eng/tools/typespec-requirement", - "link": true - }, - "node_modules/@azure-tools/typespec-validation": { - "resolved": "eng/tools/typespec-validation", - "link": true - }, - "node_modules/@azure/abort-controller": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/@azure/abort-controller/-/abort-controller-1.1.0.tgz", - "integrity": "sha512-TrRLIoSQVzfAJX9H1JeFjzAoDGcoK1IYX1UImfceTZpsyYfWr09Ss1aHW1y5TrrR3iq6RZLBwJ3E24uwPhwahw==", + "node_modules/@autorest/openapi-to-typespec/node_modules/@typespec/compiler": { + "version": "0.57.0", + "resolved": "https://registry.npmjs.org/@typespec/compiler/-/compiler-0.57.0.tgz", + "integrity": "sha512-Z5L7J90Ol21IbzU+rBD2wzKy2vJ2Yg2FIzi+yB5rtb7/c4oBea/CgEByMVHBtT7uw45ZXJpHOiepuGSPVXw2EA==", "dev": true, + "license": "MIT", "dependencies": { - "tslib": "^2.2.0" + "@babel/code-frame": "~7.24.2", + "ajv": "~8.13.0", + "change-case": "~5.4.4", + "globby": "~14.0.1", + "mustache": "~4.2.0", + "picocolors": "~1.0.1", + "prettier": "~3.2.5", + "prompts": "~2.4.2", + "semver": "^7.6.2", + "vscode-languageserver": "~9.0.1", + "vscode-languageserver-textdocument": "~1.0.11", + "yaml": "~2.4.2", + "yargs": "~17.7.2" + }, + "bin": { + "tsp": "cmd/tsp.js", + "tsp-server": "cmd/tsp-server.js" }, "engines": { - "node": ">=12.0.0" + "node": ">=18.0.0" } }, - "node_modules/@azure/avocado": { - "version": "0.8.14", - "resolved": "https://registry.npmjs.org/@azure/avocado/-/avocado-0.8.14.tgz", - "integrity": "sha512-9Jor5h3ztfqCfFXuu4ZWYAqAopGn3yRC/G0r9uXqj1yOJSQ1L8rA9r7jME2Syqu6KgTPew7RTbMFE1GIMY/Brw==", + "node_modules/@autorest/openapi-to-typespec/node_modules/@typespec/compiler/node_modules/prettier": { + "version": "3.2.5", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.2.5.tgz", + "integrity": "sha512-3/GWa9aOC0YeD7LUfvOG2NiDyhOWRvt1k+rcKhOuYnMY24iiCphgneUfJDyFXd6rZCAnuLBv6UeAULtrhT/F4A==", "dev": true, - "dependencies": { - "@azure/openapi-markdown": "^0.9.4", - "@azure/swagger-validation-common": "^0.0.5", - "@ts-common/async-iterator": "^0.2.2", - "@ts-common/commonmark-to-markdown": "^2.0.2", - "@ts-common/fs": "^0.2.0", - "@ts-common/iterator": "^1.1.2", - "@ts-common/json": "^0.3.1", - "@ts-common/json-parser": "^0.9.0", - "@ts-common/string-map": "^0.3.0", - "commonmark": "^0.29.0", - "glob": "^7.2.0", - "js-yaml": "^3.13.1", - "jsonpath-plus": "^6.0.1", - "node-fetch": ">=2.6.1", - "node-notifier": ">=8.0.1", - "node-object-hash": "^1.4.2", - "yargs": "^15.3.1" - }, + "license": "MIT", "bin": { - "avocado": "bin/cli.js" + "prettier": "bin/prettier.cjs" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/prettier/prettier?sponsor=1" } }, - "node_modules/@azure/core-auth": { - "version": "1.7.2", - "resolved": "https://registry.npmjs.org/@azure/core-auth/-/core-auth-1.7.2.tgz", - "integrity": "sha512-Igm/S3fDYmnMq1uKS38Ae1/m37B3zigdlZw+kocwEhh5GjyKjPrXKO2J6rzpC1wAxrNil/jX9BJRqBshyjnF3g==", + "node_modules/@autorest/openapi-to-typespec/node_modules/@typespec/http": { + "version": "0.57.0", + "resolved": "https://registry.npmjs.org/@typespec/http/-/http-0.57.0.tgz", + "integrity": "sha512-k3bWOTPNqlRB3/TmrXVBtObmxj2J20l2FnhGXvs+tjdtbXLxCQWmvQz6xlne9nkLAtWVB/pQRUn+oMJfhWta3w==", "dev": true, - "dependencies": { - "@azure/abort-controller": "^2.0.0", - "@azure/core-util": "^1.1.0", - "tslib": "^2.6.2" + "license": "MIT", + "engines": { + "node": ">=18.0.0" }, + "peerDependencies": { + "@typespec/compiler": "~0.57.0" + } + }, + "node_modules/@autorest/openapi-to-typespec/node_modules/@typespec/openapi": { + "version": "0.57.0", + "resolved": "https://registry.npmjs.org/@typespec/openapi/-/openapi-0.57.0.tgz", + "integrity": "sha512-35wK/BqjOXSlhWuGMwoYN3FSgIYFOKtw8ot4ErcgmxAGuKaS2GkUhZvtQJXUn2ByU0Fl4jqslPmTz8SEcz7rbw==", + "dev": true, + "license": "MIT", "engines": { "node": ">=18.0.0" + }, + "peerDependencies": { + "@typespec/compiler": "~0.57.0", + "@typespec/http": "~0.57.0" } }, - "node_modules/@azure/core-auth/node_modules/@azure/abort-controller": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/@azure/abort-controller/-/abort-controller-2.1.2.tgz", - "integrity": "sha512-nBrLsEWm4J2u5LpAPjxADTlq3trDgVZZXHNKabeXZtpq3d3AbN/KGO82R87rdDz5/lYB024rtEf10/q0urNgsA==", + "node_modules/@autorest/openapi-to-typespec/node_modules/@typespec/openapi3": { + "version": "0.57.0", + "resolved": "https://registry.npmjs.org/@typespec/openapi3/-/openapi3-0.57.0.tgz", + "integrity": "sha512-spNLzwCTduPISJBTWhqsMLTjuGC3Tdh/FVI1rTGnRunB7ZXjhRyz031o1bCe2BZeW1w1sacZGfe+ba8sXqgMxA==", "dev": true, + "license": "MIT", "dependencies": { - "tslib": "^2.6.2" + "yaml": "~2.4.2" }, "engines": { "node": ">=18.0.0" + }, + "peerDependencies": { + "@typespec/compiler": "~0.57.0", + "@typespec/http": "~0.57.0", + "@typespec/openapi": "~0.57.0", + "@typespec/versioning": "~0.57.0" } }, - "node_modules/@azure/core-http": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/@azure/core-http/-/core-http-3.0.4.tgz", - "integrity": "sha512-Fok9VVhMdxAFOtqiiAtg74fL0UJkt0z3D+ouUUxcRLzZNBioPRAMJFVxiWoJljYpXsRi4GDQHzQHDc9AiYaIUQ==", + "node_modules/@autorest/openapi-to-typespec/node_modules/@typespec/rest": { + "version": "0.57.0", + "resolved": "https://registry.npmjs.org/@typespec/rest/-/rest-0.57.0.tgz", + "integrity": "sha512-mZj76Kf+cmH38pYA6LT8Zz7QjuR3fdQo5bc8pXhKMwLq9vRqNLz6Z9InbOeo8zY+xP0GfUwEU9kXczmCc8gyRA==", "dev": true, - "dependencies": { - "@azure/abort-controller": "^1.0.0", - "@azure/core-auth": "^1.3.0", - "@azure/core-tracing": "1.0.0-preview.13", - "@azure/core-util": "^1.1.1", - "@azure/logger": "^1.0.0", - "@types/node-fetch": "^2.5.0", - "@types/tunnel": "^0.0.3", - "form-data": "^4.0.0", - "node-fetch": "^2.6.7", - "process": "^0.11.10", - "tslib": "^2.2.0", - "tunnel": "^0.0.6", - "uuid": "^8.3.0", - "xml2js": "^0.5.0" - }, + "license": "MIT", "engines": { - "node": ">=14.0.0" + "node": ">=18.0.0" + }, + "peerDependencies": { + "@typespec/compiler": "~0.57.0", + "@typespec/http": "~0.57.0" } }, - "node_modules/@azure/core-http/node_modules/node-fetch": { - "version": "2.7.0", - "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", - "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", + "node_modules/@autorest/openapi-to-typespec/node_modules/@typespec/versioning": { + "version": "0.57.0", + "resolved": "https://registry.npmjs.org/@typespec/versioning/-/versioning-0.57.0.tgz", + "integrity": "sha512-kk6zCNSwcqqYB9isNNagTy+Zv6wEIRA4NkcZ/X1riTj2zhJwKsIFNXQWm1yxpZn+BY4+1QtuaQHuBLo8HbgR/w==", "dev": true, - "dependencies": { - "whatwg-url": "^5.0.0" - }, + "license": "MIT", "engines": { - "node": "4.x || >=6.0.0" + "node": ">=18.0.0" }, "peerDependencies": { - "encoding": "^0.1.0" + "@typespec/compiler": "~0.57.0" + } + }, + "node_modules/@autorest/openapi-to-typespec/node_modules/ajv": { + "version": "8.13.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.13.0.tgz", + "integrity": "sha512-PRA911Blj99jR5RMeTunVbNXMF6Lp4vZXnk5GQjcnUWUTsrXtekg/pnmFFI2u/I36Y/2bITGS30GZCXei6uNkA==", + "dev": true, + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.3", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2", + "uri-js": "^4.4.1" }, - "peerDependenciesMeta": { - "encoding": { - "optional": true - } + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" } }, - "node_modules/@azure/core-tracing": { - "version": "1.0.0-preview.13", - "resolved": "https://registry.npmjs.org/@azure/core-tracing/-/core-tracing-1.0.0-preview.13.tgz", - "integrity": "sha512-KxDlhXyMlh2Jhj2ykX6vNEU0Vou4nHr025KoSEiz7cS3BNiHNaZcdECk/DmLkEB0as5T7b/TpRcehJ5yV6NeXQ==", + "node_modules/@autorest/openapi-to-typespec/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": { - "@opentelemetry/api": "^1.0.1", - "tslib": "^2.2.0" + "color-convert": "^2.0.1" }, "engines": { - "node": ">=12.0.0" + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" } }, - "node_modules/@azure/core-util": { - "version": "1.7.0", - "resolved": "https://registry.npmjs.org/@azure/core-util/-/core-util-1.7.0.tgz", - "integrity": "sha512-Zq2i3QO6k9DA8vnm29mYM4G8IE9u1mhF1GUabVEqPNX8Lj833gdxQ2NAFxt2BZsfAL+e9cT8SyVN7dFVJ/Hf0g==", + "node_modules/@autorest/openapi-to-typespec/node_modules/cliui": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz", + "integrity": "sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==", "dev": true, + "license": "ISC", "dependencies": { - "@azure/abort-controller": "^2.0.0", - "tslib": "^2.2.0" + "string-width": "^4.2.0", + "strip-ansi": "^6.0.1", + "wrap-ansi": "^7.0.0" }, "engines": { - "node": ">=18.0.0" + "node": ">=12" } }, - "node_modules/@azure/core-util/node_modules/@azure/abort-controller": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/@azure/abort-controller/-/abort-controller-2.1.2.tgz", - "integrity": "sha512-nBrLsEWm4J2u5LpAPjxADTlq3trDgVZZXHNKabeXZtpq3d3AbN/KGO82R87rdDz5/lYB024rtEf10/q0urNgsA==", + "node_modules/@autorest/openapi-to-typespec/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": { - "tslib": "^2.6.2" + "color-name": "~1.1.4" }, "engines": { - "node": ">=18.0.0" + "node": ">=7.0.0" } }, - "node_modules/@azure/logger": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/@azure/logger/-/logger-1.0.4.tgz", - "integrity": "sha512-ustrPY8MryhloQj7OWGe+HrYx+aoiOxzbXTtgblbV3xwCqpzUK36phH3XNHQKj3EPonyFUuDTfR3qFhTEAuZEg==", + "node_modules/@autorest/openapi-to-typespec/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, - "dependencies": { - "tslib": "^2.2.0" + "license": "MIT" + }, + "node_modules/@autorest/openapi-to-typespec/node_modules/prettier": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.1.1.tgz", + "integrity": "sha512-22UbSzg8luF4UuZtzgiUOfcGM8s4tjBv6dJRT7j275NXsy2jb4aJa4NNveul5x4eqlF1wuhuR2RElK71RvmVaw==", + "dev": true, + "bin": { + "prettier": "bin/prettier.cjs" }, "engines": { - "node": ">=14.0.0" + "node": ">=14" + }, + "funding": { + "url": "https://github.com/prettier/prettier?sponsor=1" } }, - "node_modules/@azure/ms-rest-js": { - "version": "2.7.0", - "resolved": "https://registry.npmjs.org/@azure/ms-rest-js/-/ms-rest-js-2.7.0.tgz", - "integrity": "sha512-ngbzWbqF+NmztDOpLBVDxYM+XLcUj7nKhxGbSU9WtIsXfRB//cf2ZbAG5HkOrhU9/wd/ORRB6lM/d69RKVjiyA==", + "node_modules/@autorest/openapi-to-typespec/node_modules/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": { - "@azure/core-auth": "^1.1.4", - "abort-controller": "^3.0.0", - "form-data": "^2.5.0", - "node-fetch": "^2.6.7", - "tslib": "^1.10.0", - "tunnel": "0.0.6", - "uuid": "^8.3.2", - "xml2js": "^0.5.0" + "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/@azure/ms-rest-js/node_modules/form-data": { - "version": "2.5.1", - "resolved": "https://registry.npmjs.org/form-data/-/form-data-2.5.1.tgz", - "integrity": "sha512-m21N3WOmEEURgk6B9GLOE4RuWOFf28Lhh9qGYeNlGq4VDXUlJy2th2slBNU8Gp8EzloYZOibZJ7t5ecIrFSjVA==", + "node_modules/@autorest/openapi-to-typespec/node_modules/y18n": { + "version": "5.0.8", + "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz", + "integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==", + "dev": true, + "license": "ISC", + "engines": { + "node": ">=10" + } + }, + "node_modules/@autorest/openapi-to-typespec/node_modules/yargs": { + "version": "17.7.2", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-17.7.2.tgz", + "integrity": "sha512-7dSzzRQ++CKnNI/krKnYRV7JKKPUXMEh61soaHKg9mrWEhzFWhFnxPxGl+69cD1Ou63C13NUPCnmIcrvqCuM6w==", "dev": true, + "license": "MIT", "dependencies": { - "asynckit": "^0.4.0", - "combined-stream": "^1.0.6", - "mime-types": "^2.1.12" + "cliui": "^8.0.1", + "escalade": "^3.1.1", + "get-caller-file": "^2.0.5", + "require-directory": "^2.1.1", + "string-width": "^4.2.3", + "y18n": "^5.0.5", + "yargs-parser": "^21.1.1" }, "engines": { - "node": ">= 0.12" + "node": ">=12" } }, - "node_modules/@azure/ms-rest-js/node_modules/node-fetch": { - "version": "2.7.0", - "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", - "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", + "node_modules/@autorest/openapi-to-typespec/node_modules/yargs-parser": { + "version": "21.1.1", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz", + "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==", + "dev": true, + "license": "ISC", + "engines": { + "node": ">=12" + } + }, + "node_modules/@autorest/schemas": { + "version": "1.3.5", + "resolved": "https://registry.npmjs.org/@autorest/schemas/-/schemas-1.3.5.tgz", + "integrity": "sha512-HUP89Ns/4vDGcMtmFt/fxu+QqKvit/IQ8oBTQjzC6RnJojF+880KoEgTuweTuea2stzRmNyuMiBu4F8AnxdyUA==", + "dev": true + }, + "node_modules/@azure-tools/async-io": { + "version": "3.0.254", + "resolved": "https://registry.npmjs.org/@azure-tools/async-io/-/async-io-3.0.254.tgz", + "integrity": "sha512-X1C7XdyCuo50ch9FzKtTvmK18FgDxxf1Bbt3cSoknQqeDaRegHSSCO+zByq2YA4NvUzKXeZ1engh29IDxZXgpQ==", "dev": true, "dependencies": { - "whatwg-url": "^5.0.0" + "@azure-tools/tasks": "~3.0.255", + "proper-lockfile": "~2.0.1" }, "engines": { - "node": "4.x || >=6.0.0" - }, - "peerDependencies": { - "encoding": "^0.1.0" + "node": ">=10.12.0" + } + }, + "node_modules/@azure-tools/codegen": { + "version": "2.10.0", + "resolved": "https://registry.npmjs.org/@azure-tools/codegen/-/codegen-2.10.0.tgz", + "integrity": "sha512-gdy0at3BUZAAARgiX9Ye6SNCKhcjLs5FNUewa/KV/dMGcPv7mBvbslt5VO3W8wj0n96ifk970aIFaivjacBxeQ==", + "dev": true, + "dependencies": { + "@azure-tools/async-io": "~3.0.0", + "js-yaml": "~4.1.0", + "semver": "^7.3.5" }, - "peerDependenciesMeta": { - "encoding": { - "optional": true - } + "engines": { + "node": ">=12.0.0" } }, - "node_modules/@azure/ms-rest-js/node_modules/tslib": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", - "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", + "node_modules/@azure-tools/codegen/node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", "dev": true }, - "node_modules/@azure/openapi-markdown": { - "version": "0.9.4", - "resolved": "https://registry.npmjs.org/@azure/openapi-markdown/-/openapi-markdown-0.9.4.tgz", - "integrity": "sha512-QBxabmf+64mQuyWRLsBoLKdvB7PH2U9RsyQMekorl17DOVEkgQxMsQdL/WMlz/V2wMyiI433FlrbdUiiFapfKg==", + "node_modules/@azure-tools/codegen/node_modules/js-yaml": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", + "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", "dev": true, "dependencies": { - "@ts-common/commonmark-to-markdown": "^2.0.2", - "@ts-common/iterator": "^0.3.1", - "@ts-common/string-map": "^0.3.0", - "@ts-common/virtual-fs": "^0.3.0", - "commonmark": "^0.28.1", - "js-yaml": "^3.13.1", - "tslib": "^1.9.3" + "argparse": "^2.0.1" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" } }, - "node_modules/@azure/openapi-markdown/node_modules/@ts-common/iterator": { - "version": "0.3.6", - "resolved": "https://registry.npmjs.org/@ts-common/iterator/-/iterator-0.3.6.tgz", - "integrity": "sha512-nNdcleTj3qLlchH17HI/xqOc6sNgOqJ5DdRR0nOEVdJVZCo5bfqoQTu6+Q9ZwMhuETuR2d86MSlmaL2FVHnPjQ==", - "dev": true + "node_modules/@azure-tools/openapi-tools-common": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/@azure-tools/openapi-tools-common/-/openapi-tools-common-1.2.2.tgz", + "integrity": "sha512-r6oBkNsND1sA+ZjHlE1vTf2hUj4RUnbD9KG9uksEKnLVC6oOD5WuJYCO5y4xDzWWuR0x+9gImovQqXAE7ZXYfg==", + "dev": true, + "dependencies": { + "@types/async-retry": "^1.4.1", + "@types/commonmark": "^0.27.3", + "@types/node-fetch": "^2.5.7", + "async-retry": "^1.2.3", + "commonmark": "^0.28.1", + "front-matter": "^4.0.2", + "node-fetch": "^2.6.0", + "tslib": "^2.0.0" + } }, - "node_modules/@azure/openapi-markdown/node_modules/commonmark": { + "node_modules/@azure-tools/openapi-tools-common/node_modules/commonmark": { "version": "0.28.1", "resolved": "https://registry.npmjs.org/commonmark/-/commonmark-0.28.1.tgz", "integrity": "sha512-PklsZ9pgrfFQ5hQH9BRzoWnqI9db2LeR9MhvkNk8iz97kfaTNmhTU+IE8jKDHTEfivZZXoFqzGqzddXdk14EJw==", @@ -865,906 +983,2580 @@ "node": "*" } }, - "node_modules/@azure/openapi-markdown/node_modules/entities": { + "node_modules/@azure-tools/openapi-tools-common/node_modules/entities": { "version": "1.1.2", "resolved": "https://registry.npmjs.org/entities/-/entities-1.1.2.tgz", "integrity": "sha512-f2LZMYl1Fzu7YSBKg+RoROelpOaNrcGmE9AZubeDfrCEia483oW4MI4VyFd5VNHIgQ/7qm1I0wUHK1eJnn2y2w==", "dev": true }, - "node_modules/@azure/openapi-markdown/node_modules/tslib": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", - "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", - "dev": true - }, - "node_modules/@azure/swagger-validation-common": { - "version": "0.0.5", - "resolved": "https://registry.npmjs.org/@azure/swagger-validation-common/-/swagger-validation-common-0.0.5.tgz", - "integrity": "sha512-oc6OHLdoLlOpO5GjMcOFETEhJi45CI3MVIhvVY/yqyGw9AtaqOYw5HzO3wTuYgYFeGS4v9iqFah0SNLZrpk3Sg==", - "dev": true - }, - "node_modules/@babel/code-frame": { - "version": "7.24.7", - "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.24.7.tgz", - "integrity": "sha512-BcYH1CVJBO9tvyIZ2jVeXgSIMvGZ2FDRvDdOIVQyuklNKSsx+eppDEBq/g47Ayw+RqNFE+URvOShmf+f/qwAlA==", + "node_modules/@azure-tools/openapi-tools-common/node_modules/node-fetch": { + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", + "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", "dev": true, "dependencies": { - "@babel/highlight": "^7.24.7", - "picocolors": "^1.0.0" + "whatwg-url": "^5.0.0" }, "engines": { - "node": ">=6.9.0" + "node": "4.x || >=6.0.0" + }, + "peerDependencies": { + "encoding": "^0.1.0" + }, + "peerDependenciesMeta": { + "encoding": { + "optional": true + } } }, - "node_modules/@babel/helper-string-parser": { - "version": "7.24.7", - "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.24.7.tgz", - "integrity": "sha512-7MbVt6xrwFQbunH2DNQsAP5sTGxfqQtErvBIvIMi6EQnbgUOuVYanvREcmFrOPhoXBrTtjhhP+lW+o5UfK+tDg==", + "node_modules/@azure-tools/specs-model": { + "resolved": "eng/tools/specs-model", + "link": true + }, + "node_modules/@azure-tools/suppressions": { + "resolved": "eng/tools/suppressions", + "link": true + }, + "node_modules/@azure-tools/tasks": { + "version": "3.0.255", + "resolved": "https://registry.npmjs.org/@azure-tools/tasks/-/tasks-3.0.255.tgz", + "integrity": "sha512-GjALNLz7kWMEdRVbaN5g0cJHNAr3XVTbP0611Mv2UzMgGL6FOhNZJK+oPHJKLDR8EEDZNnkwPlyi7B+INXUSQA==", "dev": true, "engines": { - "node": ">=6.9.0" + "node": ">=10.12.0" } }, - "node_modules/@babel/helper-validator-identifier": { - "version": "7.24.7", - "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.24.7.tgz", - "integrity": "sha512-rR+PBcQ1SMQDDyF6X0wxtG8QyLCgUB0eRAGguqRLfkCA87l7yAP7ehq8SNj96OOGTO8OBV70KhuFYcIkHXOg0w==", + "node_modules/@azure-tools/tsp-client-tests": { + "resolved": "eng/tools/tsp-client-tests", + "link": true + }, + "node_modules/@azure-tools/typespec-apiview": { + "version": "0.4.9", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-apiview/-/typespec-apiview-0.4.9.tgz", + "integrity": "sha512-44KT4okSi5/tcCMWZqy9kOu+1I4BcB3Cyh8mu5XakVnAOHWjDPelbMm/4Vi/EpUKHSCTCYCRVno3j3Wz0M6Ppg==", "dev": true, "engines": { - "node": ">=6.9.0" + "node": ">=16.0.0" + }, + "peerDependencies": { + "@typespec/compiler": ">=0.57 <1.0", + "@typespec/versioning": ">=0.57 <1.0" } }, - "node_modules/@babel/highlight": { - "version": "7.24.7", - "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.24.7.tgz", - "integrity": "sha512-EStJpq4OuY8xYfhGVXngigBJRWxftKX9ksiGDnmlY3o7B/V7KIAc9X4oiK87uPJSc/vs5L869bem5fhZa8caZw==", + "node_modules/@azure-tools/typespec-autorest": { + "version": "0.44.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-autorest/-/typespec-autorest-0.44.0.tgz", + "integrity": "sha512-GlIQayA6HfKndq1T2qHBXtL6n8gTiShUEhi30zncoBaIUnwumkXSnx18uCQl0EzFmvAqLYt3kbHqQNzZIdGaeQ==", "dev": true, - "dependencies": { - "@babel/helper-validator-identifier": "^7.24.7", - "chalk": "^2.4.2", - "js-tokens": "^4.0.0", - "picocolors": "^1.0.0" - }, + "license": "MIT", "engines": { - "node": ">=6.9.0" + "node": ">=18.0.0" + }, + "peerDependencies": { + "@azure-tools/typespec-azure-core": "~0.44.0", + "@azure-tools/typespec-azure-resource-manager": "~0.44.0", + "@azure-tools/typespec-client-generator-core": "~0.44.0", + "@typespec/compiler": "~0.58.0", + "@typespec/http": "~0.58.0", + "@typespec/openapi": "~0.58.0", + "@typespec/rest": "~0.58.0", + "@typespec/versioning": "~0.58.0" } }, - "node_modules/@babel/parser": { - "version": "7.24.7", - "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.24.7.tgz", - "integrity": "sha512-9uUYRm6OqQrCqQdG1iCBwBPZgN8ciDBro2nIOFaiRz1/BCxaI7CNvQbDHvsArAC7Tw9Hda/B3U+6ui9u4HWXPw==", + "node_modules/@azure-tools/typespec-azure-core": { + "version": "0.44.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-core/-/typespec-azure-core-0.44.0.tgz", + "integrity": "sha512-d11QK2v5fOZH8YUqf42FsqHEirKCHzeKFq4Uo/51BXCXmJJahsTaFMAG2M0GoJe8tmTHeMijStnVMfzcGNqCAA==", "dev": true, - "bin": { - "parser": "bin/babel-parser.js" - }, + "license": "MIT", "engines": { - "node": ">=6.0.0" + "node": ">=18.0.0" + }, + "peerDependencies": { + "@typespec/compiler": "~0.58.0", + "@typespec/http": "~0.58.0", + "@typespec/rest": "~0.58.0" } }, - "node_modules/@babel/types": { - "version": "7.24.7", - "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.24.7.tgz", - "integrity": "sha512-XEFXSlxiG5td2EJRe8vOmRbaXVgfcBlszKujvVmWIK/UpywWljQCfzAv3RQCGujWQ1RD4YYWEAqDXfuJiy8f5Q==", + "node_modules/@azure-tools/typespec-azure-portal-core": { + "version": "0.44.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-portal-core/-/typespec-azure-portal-core-0.44.0.tgz", + "integrity": "sha512-18Cy8RFhfDP5wy4J/noXZibXCxdBHEETOpk0q1xKe3qXgEKoE/MPKZgdEi5syLGP9HvMOEQ9Sy6iDYbhYdKQ1w==", "dev": true, + "license": "MIT", + "peerDependencies": { + "@azure-tools/typespec-azure-resource-manager": "~0.44.0", + "@typespec/compiler": "~0.58.0" + } + }, + "node_modules/@azure-tools/typespec-azure-resource-manager": { + "version": "0.44.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-resource-manager/-/typespec-azure-resource-manager-0.44.0.tgz", + "integrity": "sha512-m4dG41at6En1swbxlvCDl1v4Mvrfp17acDnRxEcd4SdKP2R9eVS2mBy1tSuFtMcJlOnoBZ5CxQgk+Osg/Q9nmA==", + "dev": true, + "license": "MIT", "dependencies": { - "@babel/helper-string-parser": "^7.24.7", - "@babel/helper-validator-identifier": "^7.24.7", - "to-fast-properties": "^2.0.0" + "change-case": "~5.4.4", + "pluralize": "^8.0.0" }, "engines": { - "node": ">=6.9.0" + "node": ">=18.0.0" + }, + "peerDependencies": { + "@azure-tools/typespec-azure-core": "~0.44.0", + "@typespec/compiler": "~0.58.0", + "@typespec/http": "~0.58.0", + "@typespec/openapi": "~0.58.0", + "@typespec/rest": "~0.58.0", + "@typespec/versioning": "~0.58.0" } }, - "node_modules/@bcoe/v8-coverage": { - "version": "0.2.3", - "resolved": "https://registry.npmjs.org/@bcoe/v8-coverage/-/v8-coverage-0.2.3.tgz", - "integrity": "sha512-0hYQ8SB4Db5zvZB4axdMHGwEaQjkZzFjQiN9LVYvIFB2nSUHW9tYpxWriPrWDASIxiaXax83REcLxuSdnGPZtw==", - "dev": true - }, - "node_modules/@colors/colors": { - "version": "1.5.0", - "resolved": "https://registry.npmjs.org/@colors/colors/-/colors-1.5.0.tgz", - "integrity": "sha512-ooWCrlZP11i8GImSjTHYHLkvFDP48nS4+204nGb1RiX/WXYHmJA2III9/e2DWVabCESdW7hBAEzHRqUn9OUVvQ==", + "node_modules/@azure-tools/typespec-azure-rulesets": { + "version": "0.44.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-rulesets/-/typespec-azure-rulesets-0.44.0.tgz", + "integrity": "sha512-ZFiT+rtLIq3uP4uSr85i7w+3r02BEqERePaCtTyjexo2IBz0lwQ5Nn/5ujfuDDSy+3daoC2bQy8hw/BGWg9/Ng==", "dev": true, - "optional": true, + "license": "MIT", "engines": { - "node": ">=0.1.90" + "node": ">=18.0.0" + }, + "peerDependencies": { + "@azure-tools/typespec-azure-core": "~0.44.0", + "@azure-tools/typespec-azure-resource-manager": "~0.44.0", + "@azure-tools/typespec-client-generator-core": "~0.44.0", + "@typespec/compiler": "~0.58.0" } }, - "node_modules/@dabh/diagnostics": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/@dabh/diagnostics/-/diagnostics-2.0.3.tgz", - "integrity": "sha512-hrlQOIi7hAfzsMqlGSFyVucrx38O+j6wiGOf//H2ecvIEqYN4ADBSS2iLMh5UFyDunCNniUIPk/q3riFv45xRA==", + "node_modules/@azure-tools/typespec-client-generator-cli": { + "version": "0.9.3", + "resolved": "https://artprodcus3.artifacts.visualstudio.com/A0fb41ef4-5012-48a9-bf39-4ee3de03ee35/29ec6040-b234-4e31-b139-33dc4287b756/_apis/artifact/cGlwZWxpbmVhcnRpZmFjdDovL2F6dXJlLXNkay9wcm9qZWN0SWQvMjllYzYwNDAtYjIzNC00ZTMxLWIxMzktMzNkYzQyODdiNzU2L2J1aWxkSWQvMzk2Mzc2Ni9hcnRpZmFjdE5hbWUvZHJvcA2/content?format=file&subPath=%2Fazure-tools-typespec-client-generator-cli-0.9.3.tgz", "dev": true, "dependencies": { - "colorspace": "1.1.x", - "enabled": "2.0.x", - "kuler": "^2.0.0" + "@autorest/csharp": "https://aka.ms/azsdk/openapi-to-typespec-csharp", + "@autorest/openapi-to-typespec": "0.8.2", + "@azure/core-rest-pipeline": "^1.12.0", + "autorest": "^3.7.1", + "chalk": "^5.3.0", + "dotenv": "^16.4.5", + "prompt-sync": "^4.2.0", + "simple-git": "^3.20.0", + "yaml": "^2.3.1" + }, + "bin": { + "tsp-client": "cmd/tsp-client.js" + }, + "engines": { + "node": ">=18.0.0" + }, + "peerDependencies": { + "@typespec/compiler": ">=0.48.1 <1.0.0" } }, - "node_modules/@esbuild/aix-ppc64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.21.5.tgz", - "integrity": "sha512-1SDgH6ZSPTlggy1yI6+Dbkiz8xzpHJEVAlF/AM1tHPLsf5STom9rwtjE4hKAF20FfXXNTFqEYXyJNWh1GiZedQ==", - "cpu": [ - "ppc64" - ], + "node_modules/@azure-tools/typespec-client-generator-cli/node_modules/chalk": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.3.0.tgz", + "integrity": "sha512-dLitG79d+GV1Nb/VYcCDFivJeK1hiukt9QjRNVOsUtTy1rR1YJsmpGGTZ3qJos+uw7WmWF4wUwBd9jxjocFC2w==", "dev": true, - "optional": true, - "os": [ - "aix" - ], "engines": { - "node": ">=12" + "node": "^12.17.0 || ^14.13 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" } }, - "node_modules/@esbuild/android-arm": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.21.5.tgz", - "integrity": "sha512-vCPvzSjpPHEi1siZdlvAlsPxXl7WbOVUBBAowWug4rJHb68Ox8KualB+1ocNvT5fjv6wpkX6o/iEpbDrf68zcg==", - "cpu": [ - "arm" - ], + "node_modules/@azure-tools/typespec-client-generator-core": { + "version": "0.44.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-core/-/typespec-client-generator-core-0.44.0.tgz", + "integrity": "sha512-ng2QsUVmnMFm/ZjwXHhR5oba94Taep32b4cBr/PtXnAlDyqX+pPeg1cvBJv6WoDkSYIxtNpj2Qz1XBit986/xw==", "dev": true, - "optional": true, - "os": [ - "android" - ], + "license": "MIT", + "dependencies": { + "change-case": "~5.4.4", + "pluralize": "^8.0.0" + }, "engines": { - "node": ">=12" + "node": ">=18.0.0" + }, + "peerDependencies": { + "@azure-tools/typespec-azure-core": "~0.44.0", + "@typespec/compiler": "~0.58.0", + "@typespec/http": "~0.58.0", + "@typespec/rest": "~0.58.0", + "@typespec/versioning": "~0.58.0" } }, - "node_modules/@esbuild/android-arm64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.21.5.tgz", - "integrity": "sha512-c0uX9VAUBQ7dTDCjq+wdyGLowMdtR/GoC2U5IYk/7D1H1JYC0qseD7+11iMP2mRLN9RcCMRcjC4YMclCzGwS/A==", - "cpu": [ - "arm64" - ], + "node_modules/@azure-tools/typespec-requirement": { + "resolved": "eng/tools/typespec-requirement", + "link": true + }, + "node_modules/@azure-tools/typespec-validation": { + "resolved": "eng/tools/typespec-validation", + "link": true + }, + "node_modules/@azure/abort-controller": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@azure/abort-controller/-/abort-controller-1.1.0.tgz", + "integrity": "sha512-TrRLIoSQVzfAJX9H1JeFjzAoDGcoK1IYX1UImfceTZpsyYfWr09Ss1aHW1y5TrrR3iq6RZLBwJ3E24uwPhwahw==", "dev": true, - "optional": true, - "os": [ - "android" - ], + "dependencies": { + "tslib": "^2.2.0" + }, "engines": { - "node": ">=12" + "node": ">=12.0.0" } }, - "node_modules/@esbuild/android-x64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.21.5.tgz", - "integrity": "sha512-D7aPRUUNHRBwHxzxRvp856rjUHRFW1SdQATKXH2hqA0kAZb1hKmi02OpYRacl0TxIGz/ZmXWlbZgjwWYaCakTA==", - "cpu": [ - "x64" - ], + "node_modules/@azure/avocado": { + "version": "0.8.14", + "resolved": "https://registry.npmjs.org/@azure/avocado/-/avocado-0.8.14.tgz", + "integrity": "sha512-9Jor5h3ztfqCfFXuu4ZWYAqAopGn3yRC/G0r9uXqj1yOJSQ1L8rA9r7jME2Syqu6KgTPew7RTbMFE1GIMY/Brw==", "dev": true, - "optional": true, - "os": [ - "android" - ], - "engines": { - "node": ">=12" + "dependencies": { + "@azure/openapi-markdown": "^0.9.4", + "@azure/swagger-validation-common": "^0.0.5", + "@ts-common/async-iterator": "^0.2.2", + "@ts-common/commonmark-to-markdown": "^2.0.2", + "@ts-common/fs": "^0.2.0", + "@ts-common/iterator": "^1.1.2", + "@ts-common/json": "^0.3.1", + "@ts-common/json-parser": "^0.9.0", + "@ts-common/string-map": "^0.3.0", + "commonmark": "^0.29.0", + "glob": "^7.2.0", + "js-yaml": "^3.13.1", + "jsonpath-plus": "^6.0.1", + "node-fetch": ">=2.6.1", + "node-notifier": ">=8.0.1", + "node-object-hash": "^1.4.2", + "yargs": "^15.3.1" + }, + "bin": { + "avocado": "bin/cli.js" } }, - "node_modules/@esbuild/darwin-arm64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.21.5.tgz", - "integrity": "sha512-DwqXqZyuk5AiWWf3UfLiRDJ5EDd49zg6O9wclZ7kUMv2WRFr4HKjXp/5t8JZ11QbQfUS6/cRCKGwYhtNAY88kQ==", - "cpu": [ - "arm64" - ], + "node_modules/@azure/core-auth": { + "version": "1.7.2", + "resolved": "https://registry.npmjs.org/@azure/core-auth/-/core-auth-1.7.2.tgz", + "integrity": "sha512-Igm/S3fDYmnMq1uKS38Ae1/m37B3zigdlZw+kocwEhh5GjyKjPrXKO2J6rzpC1wAxrNil/jX9BJRqBshyjnF3g==", "dev": true, - "optional": true, - "os": [ - "darwin" - ], + "dependencies": { + "@azure/abort-controller": "^2.0.0", + "@azure/core-util": "^1.1.0", + "tslib": "^2.6.2" + }, "engines": { - "node": ">=12" + "node": ">=18.0.0" } }, - "node_modules/@esbuild/darwin-x64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.21.5.tgz", - "integrity": "sha512-se/JjF8NlmKVG4kNIuyWMV/22ZaerB+qaSi5MdrXtd6R08kvs2qCN4C09miupktDitvh8jRFflwGFBQcxZRjbw==", - "cpu": [ - "x64" - ], - "dev": true, - "optional": true, - "os": [ - "darwin" - ], + "node_modules/@azure/core-auth/node_modules/@azure/abort-controller": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/@azure/abort-controller/-/abort-controller-2.1.2.tgz", + "integrity": "sha512-nBrLsEWm4J2u5LpAPjxADTlq3trDgVZZXHNKabeXZtpq3d3AbN/KGO82R87rdDz5/lYB024rtEf10/q0urNgsA==", + "dev": true, + "dependencies": { + "tslib": "^2.6.2" + }, "engines": { - "node": ">=12" + "node": ">=18.0.0" } }, - "node_modules/@esbuild/freebsd-arm64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.21.5.tgz", - "integrity": "sha512-5JcRxxRDUJLX8JXp/wcBCy3pENnCgBR9bN6JsY4OmhfUtIHe3ZW0mawA7+RDAcMLrMIZaf03NlQiX9DGyB8h4g==", - "cpu": [ - "arm64" - ], + "node_modules/@azure/core-http": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@azure/core-http/-/core-http-3.0.4.tgz", + "integrity": "sha512-Fok9VVhMdxAFOtqiiAtg74fL0UJkt0z3D+ouUUxcRLzZNBioPRAMJFVxiWoJljYpXsRi4GDQHzQHDc9AiYaIUQ==", "dev": true, - "optional": true, - "os": [ - "freebsd" - ], + "dependencies": { + "@azure/abort-controller": "^1.0.0", + "@azure/core-auth": "^1.3.0", + "@azure/core-tracing": "1.0.0-preview.13", + "@azure/core-util": "^1.1.1", + "@azure/logger": "^1.0.0", + "@types/node-fetch": "^2.5.0", + "@types/tunnel": "^0.0.3", + "form-data": "^4.0.0", + "node-fetch": "^2.6.7", + "process": "^0.11.10", + "tslib": "^2.2.0", + "tunnel": "^0.0.6", + "uuid": "^8.3.0", + "xml2js": "^0.5.0" + }, "engines": { - "node": ">=12" + "node": ">=14.0.0" } }, - "node_modules/@esbuild/freebsd-x64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.21.5.tgz", - "integrity": "sha512-J95kNBj1zkbMXtHVH29bBriQygMXqoVQOQYA+ISs0/2l3T9/kj42ow2mpqerRBxDJnmkUDCaQT/dfNXWX/ZZCQ==", - "cpu": [ - "x64" - ], + "node_modules/@azure/core-http/node_modules/node-fetch": { + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", + "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", "dev": true, - "optional": true, - "os": [ - "freebsd" - ], + "dependencies": { + "whatwg-url": "^5.0.0" + }, "engines": { - "node": ">=12" + "node": "4.x || >=6.0.0" + }, + "peerDependencies": { + "encoding": "^0.1.0" + }, + "peerDependenciesMeta": { + "encoding": { + "optional": true + } } }, - "node_modules/@esbuild/linux-arm": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.21.5.tgz", - "integrity": "sha512-bPb5AHZtbeNGjCKVZ9UGqGwo8EUu4cLq68E95A53KlxAPRmUyYv2D6F0uUI65XisGOL1hBP5mTronbgo+0bFcA==", - "cpu": [ - "arm" - ], + "node_modules/@azure/core-rest-pipeline": { + "version": "1.16.2", + "resolved": "https://registry.npmjs.org/@azure/core-rest-pipeline/-/core-rest-pipeline-1.16.2.tgz", + "integrity": "sha512-Hnhm/PG9/SQ07JJyLDv3l9Qr8V3xgAe1hFoBYzt6LaalMxfL/ZqFaZf/bz5VN3pMcleCPwl8ivlS2Fjxq/iC8Q==", "dev": true, - "optional": true, - "os": [ - "linux" - ], + "dependencies": { + "@azure/abort-controller": "^2.0.0", + "@azure/core-auth": "^1.4.0", + "@azure/core-tracing": "^1.0.1", + "@azure/core-util": "^1.9.0", + "@azure/logger": "^1.0.0", + "http-proxy-agent": "^7.0.0", + "https-proxy-agent": "^7.0.0", + "tslib": "^2.6.2" + }, "engines": { - "node": ">=12" + "node": ">=18.0.0" } }, - "node_modules/@esbuild/linux-arm64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.21.5.tgz", - "integrity": "sha512-ibKvmyYzKsBeX8d8I7MH/TMfWDXBF3db4qM6sy+7re0YXya+K1cem3on9XgdT2EQGMu4hQyZhan7TeQ8XkGp4Q==", - "cpu": [ - "arm64" - ], + "node_modules/@azure/core-rest-pipeline/node_modules/@azure/abort-controller": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/@azure/abort-controller/-/abort-controller-2.1.2.tgz", + "integrity": "sha512-nBrLsEWm4J2u5LpAPjxADTlq3trDgVZZXHNKabeXZtpq3d3AbN/KGO82R87rdDz5/lYB024rtEf10/q0urNgsA==", "dev": true, - "optional": true, - "os": [ - "linux" - ], + "dependencies": { + "tslib": "^2.6.2" + }, "engines": { - "node": ">=12" + "node": ">=18.0.0" } }, - "node_modules/@esbuild/linux-ia32": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.21.5.tgz", - "integrity": "sha512-YvjXDqLRqPDl2dvRODYmmhz4rPeVKYvppfGYKSNGdyZkA01046pLWyRKKI3ax8fbJoK5QbxblURkwK/MWY18Tg==", - "cpu": [ - "ia32" - ], + "node_modules/@azure/core-rest-pipeline/node_modules/@azure/core-tracing": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/@azure/core-tracing/-/core-tracing-1.1.2.tgz", + "integrity": "sha512-dawW9ifvWAWmUm9/h+/UQ2jrdvjCJ7VJEuCJ6XVNudzcOwm53BFZH4Q845vjfgoUAM8ZxokvVNxNxAITc502YA==", "dev": true, - "optional": true, - "os": [ - "linux" - ], + "dependencies": { + "tslib": "^2.6.2" + }, "engines": { - "node": ">=12" + "node": ">=18.0.0" } }, - "node_modules/@esbuild/linux-loong64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.21.5.tgz", - "integrity": "sha512-uHf1BmMG8qEvzdrzAqg2SIG/02+4/DHB6a9Kbya0XDvwDEKCoC8ZRWI5JJvNdUjtciBGFQ5PuBlpEOXQj+JQSg==", - "cpu": [ - "loong64" - ], + "node_modules/@azure/core-rest-pipeline/node_modules/@azure/core-util": { + "version": "1.9.1", + "resolved": "https://registry.npmjs.org/@azure/core-util/-/core-util-1.9.1.tgz", + "integrity": "sha512-OLsq0etbHO1MA7j6FouXFghuHrAFGk+5C1imcpQ2e+0oZhYF07WLA+NW2Vqs70R7d+zOAWiWM3tbE1sXcDN66g==", "dev": true, - "optional": true, - "os": [ - "linux" - ], + "dependencies": { + "@azure/abort-controller": "^2.0.0", + "tslib": "^2.6.2" + }, "engines": { - "node": ">=12" + "node": ">=18.0.0" } }, - "node_modules/@esbuild/linux-mips64el": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.21.5.tgz", - "integrity": "sha512-IajOmO+KJK23bj52dFSNCMsz1QP1DqM6cwLUv3W1QwyxkyIWecfafnI555fvSGqEKwjMXVLokcV5ygHW5b3Jbg==", - "cpu": [ - "mips64el" - ], + "node_modules/@azure/core-tracing": { + "version": "1.0.0-preview.13", + "resolved": "https://registry.npmjs.org/@azure/core-tracing/-/core-tracing-1.0.0-preview.13.tgz", + "integrity": "sha512-KxDlhXyMlh2Jhj2ykX6vNEU0Vou4nHr025KoSEiz7cS3BNiHNaZcdECk/DmLkEB0as5T7b/TpRcehJ5yV6NeXQ==", "dev": true, - "optional": true, - "os": [ - "linux" - ], + "dependencies": { + "@opentelemetry/api": "^1.0.1", + "tslib": "^2.2.0" + }, "engines": { - "node": ">=12" + "node": ">=12.0.0" } }, - "node_modules/@esbuild/linux-ppc64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.21.5.tgz", - "integrity": "sha512-1hHV/Z4OEfMwpLO8rp7CvlhBDnjsC3CttJXIhBi+5Aj5r+MBvy4egg7wCbe//hSsT+RvDAG7s81tAvpL2XAE4w==", - "cpu": [ - "ppc64" - ], + "node_modules/@azure/core-util": { + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/@azure/core-util/-/core-util-1.7.0.tgz", + "integrity": "sha512-Zq2i3QO6k9DA8vnm29mYM4G8IE9u1mhF1GUabVEqPNX8Lj833gdxQ2NAFxt2BZsfAL+e9cT8SyVN7dFVJ/Hf0g==", "dev": true, - "optional": true, - "os": [ - "linux" - ], + "dependencies": { + "@azure/abort-controller": "^2.0.0", + "tslib": "^2.2.0" + }, "engines": { - "node": ">=12" + "node": ">=18.0.0" } }, - "node_modules/@esbuild/linux-riscv64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.21.5.tgz", - "integrity": "sha512-2HdXDMd9GMgTGrPWnJzP2ALSokE/0O5HhTUvWIbD3YdjME8JwvSCnNGBnTThKGEB91OZhzrJ4qIIxk/SBmyDDA==", - "cpu": [ - "riscv64" - ], + "node_modules/@azure/core-util/node_modules/@azure/abort-controller": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/@azure/abort-controller/-/abort-controller-2.1.2.tgz", + "integrity": "sha512-nBrLsEWm4J2u5LpAPjxADTlq3trDgVZZXHNKabeXZtpq3d3AbN/KGO82R87rdDz5/lYB024rtEf10/q0urNgsA==", "dev": true, - "optional": true, - "os": [ - "linux" - ], + "dependencies": { + "tslib": "^2.6.2" + }, "engines": { - "node": ">=12" + "node": ">=18.0.0" } }, - "node_modules/@esbuild/linux-s390x": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.21.5.tgz", - "integrity": "sha512-zus5sxzqBJD3eXxwvjN1yQkRepANgxE9lgOW2qLnmr8ikMTphkjgXu1HR01K4FJg8h1kEEDAqDcZQtbrRnB41A==", - "cpu": [ - "s390x" - ], + "node_modules/@azure/logger": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@azure/logger/-/logger-1.0.4.tgz", + "integrity": "sha512-ustrPY8MryhloQj7OWGe+HrYx+aoiOxzbXTtgblbV3xwCqpzUK36phH3XNHQKj3EPonyFUuDTfR3qFhTEAuZEg==", "dev": true, - "optional": true, - "os": [ - "linux" - ], + "dependencies": { + "tslib": "^2.2.0" + }, "engines": { - "node": ">=12" + "node": ">=14.0.0" } }, - "node_modules/@esbuild/linux-x64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.21.5.tgz", - "integrity": "sha512-1rYdTpyv03iycF1+BhzrzQJCdOuAOtaqHTWJZCWvijKD2N5Xu0TtVC8/+1faWqcP9iBCWOmjmhoH94dH82BxPQ==", - "cpu": [ - "x64" - ], + "node_modules/@azure/ms-rest-js": { + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/@azure/ms-rest-js/-/ms-rest-js-2.7.0.tgz", + "integrity": "sha512-ngbzWbqF+NmztDOpLBVDxYM+XLcUj7nKhxGbSU9WtIsXfRB//cf2ZbAG5HkOrhU9/wd/ORRB6lM/d69RKVjiyA==", "dev": true, - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=12" + "dependencies": { + "@azure/core-auth": "^1.1.4", + "abort-controller": "^3.0.0", + "form-data": "^2.5.0", + "node-fetch": "^2.6.7", + "tslib": "^1.10.0", + "tunnel": "0.0.6", + "uuid": "^8.3.2", + "xml2js": "^0.5.0" } }, - "node_modules/@esbuild/netbsd-x64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.21.5.tgz", - "integrity": "sha512-Woi2MXzXjMULccIwMnLciyZH4nCIMpWQAs049KEeMvOcNADVxo0UBIQPfSmxB3CWKedngg7sWZdLvLczpe0tLg==", - "cpu": [ - "x64" - ], + "node_modules/@azure/ms-rest-js/node_modules/form-data": { + "version": "2.5.1", + "resolved": "https://registry.npmjs.org/form-data/-/form-data-2.5.1.tgz", + "integrity": "sha512-m21N3WOmEEURgk6B9GLOE4RuWOFf28Lhh9qGYeNlGq4VDXUlJy2th2slBNU8Gp8EzloYZOibZJ7t5ecIrFSjVA==", + "dev": true, + "dependencies": { + "asynckit": "^0.4.0", + "combined-stream": "^1.0.6", + "mime-types": "^2.1.12" + }, + "engines": { + "node": ">= 0.12" + } + }, + "node_modules/@azure/ms-rest-js/node_modules/node-fetch": { + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", + "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", + "dev": true, + "dependencies": { + "whatwg-url": "^5.0.0" + }, + "engines": { + "node": "4.x || >=6.0.0" + }, + "peerDependencies": { + "encoding": "^0.1.0" + }, + "peerDependenciesMeta": { + "encoding": { + "optional": true + } + } + }, + "node_modules/@azure/ms-rest-js/node_modules/tslib": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", + "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", + "dev": true + }, + "node_modules/@azure/openapi-markdown": { + "version": "0.9.4", + "resolved": "https://registry.npmjs.org/@azure/openapi-markdown/-/openapi-markdown-0.9.4.tgz", + "integrity": "sha512-QBxabmf+64mQuyWRLsBoLKdvB7PH2U9RsyQMekorl17DOVEkgQxMsQdL/WMlz/V2wMyiI433FlrbdUiiFapfKg==", + "dev": true, + "dependencies": { + "@ts-common/commonmark-to-markdown": "^2.0.2", + "@ts-common/iterator": "^0.3.1", + "@ts-common/string-map": "^0.3.0", + "@ts-common/virtual-fs": "^0.3.0", + "commonmark": "^0.28.1", + "js-yaml": "^3.13.1", + "tslib": "^1.9.3" + } + }, + "node_modules/@azure/openapi-markdown/node_modules/@ts-common/iterator": { + "version": "0.3.6", + "resolved": "https://registry.npmjs.org/@ts-common/iterator/-/iterator-0.3.6.tgz", + "integrity": "sha512-nNdcleTj3qLlchH17HI/xqOc6sNgOqJ5DdRR0nOEVdJVZCo5bfqoQTu6+Q9ZwMhuETuR2d86MSlmaL2FVHnPjQ==", + "dev": true + }, + "node_modules/@azure/openapi-markdown/node_modules/commonmark": { + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/commonmark/-/commonmark-0.28.1.tgz", + "integrity": "sha512-PklsZ9pgrfFQ5hQH9BRzoWnqI9db2LeR9MhvkNk8iz97kfaTNmhTU+IE8jKDHTEfivZZXoFqzGqzddXdk14EJw==", + "dev": true, + "dependencies": { + "entities": "~ 1.1.1", + "mdurl": "~ 1.0.1", + "minimist": "~ 1.2.0", + "string.prototype.repeat": "^0.2.0" + }, + "bin": { + "commonmark": "bin/commonmark" + }, + "engines": { + "node": "*" + } + }, + "node_modules/@azure/openapi-markdown/node_modules/entities": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/entities/-/entities-1.1.2.tgz", + "integrity": "sha512-f2LZMYl1Fzu7YSBKg+RoROelpOaNrcGmE9AZubeDfrCEia483oW4MI4VyFd5VNHIgQ/7qm1I0wUHK1eJnn2y2w==", + "dev": true + }, + "node_modules/@azure/openapi-markdown/node_modules/tslib": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", + "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", + "dev": true + }, + "node_modules/@azure/swagger-validation-common": { + "version": "0.0.5", + "resolved": "https://registry.npmjs.org/@azure/swagger-validation-common/-/swagger-validation-common-0.0.5.tgz", + "integrity": "sha512-oc6OHLdoLlOpO5GjMcOFETEhJi45CI3MVIhvVY/yqyGw9AtaqOYw5HzO3wTuYgYFeGS4v9iqFah0SNLZrpk3Sg==", + "dev": true + }, + "node_modules/@babel/code-frame": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.24.7.tgz", + "integrity": "sha512-BcYH1CVJBO9tvyIZ2jVeXgSIMvGZ2FDRvDdOIVQyuklNKSsx+eppDEBq/g47Ayw+RqNFE+URvOShmf+f/qwAlA==", + "dev": true, + "dependencies": { + "@babel/highlight": "^7.24.7", + "picocolors": "^1.0.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-string-parser": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.24.7.tgz", + "integrity": "sha512-7MbVt6xrwFQbunH2DNQsAP5sTGxfqQtErvBIvIMi6EQnbgUOuVYanvREcmFrOPhoXBrTtjhhP+lW+o5UfK+tDg==", + "dev": true, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-validator-identifier": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.24.7.tgz", + "integrity": "sha512-rR+PBcQ1SMQDDyF6X0wxtG8QyLCgUB0eRAGguqRLfkCA87l7yAP7ehq8SNj96OOGTO8OBV70KhuFYcIkHXOg0w==", + "dev": true, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/highlight": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.24.7.tgz", + "integrity": "sha512-EStJpq4OuY8xYfhGVXngigBJRWxftKX9ksiGDnmlY3o7B/V7KIAc9X4oiK87uPJSc/vs5L869bem5fhZa8caZw==", + "dev": true, + "dependencies": { + "@babel/helper-validator-identifier": "^7.24.7", + "chalk": "^2.4.2", + "js-tokens": "^4.0.0", + "picocolors": "^1.0.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/parser": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.24.7.tgz", + "integrity": "sha512-9uUYRm6OqQrCqQdG1iCBwBPZgN8ciDBro2nIOFaiRz1/BCxaI7CNvQbDHvsArAC7Tw9Hda/B3U+6ui9u4HWXPw==", + "dev": true, + "bin": { + "parser": "bin/babel-parser.js" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@babel/runtime": { + "version": "7.24.8", + "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.24.8.tgz", + "integrity": "sha512-5F7SDGs1T72ZczbRwbGO9lQi0NLjQxzl6i4lJxLxfW9U5UluCSyEJeniWvnhl3/euNiqQVbo8zruhsDfid0esA==", + "dev": true, + "license": "MIT", + "dependencies": { + "regenerator-runtime": "^0.14.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/types": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.24.7.tgz", + "integrity": "sha512-XEFXSlxiG5td2EJRe8vOmRbaXVgfcBlszKujvVmWIK/UpywWljQCfzAv3RQCGujWQ1RD4YYWEAqDXfuJiy8f5Q==", + "dev": true, + "dependencies": { + "@babel/helper-string-parser": "^7.24.7", + "@babel/helper-validator-identifier": "^7.24.7", + "to-fast-properties": "^2.0.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@bcoe/v8-coverage": { + "version": "0.2.3", + "resolved": "https://registry.npmjs.org/@bcoe/v8-coverage/-/v8-coverage-0.2.3.tgz", + "integrity": "sha512-0hYQ8SB4Db5zvZB4axdMHGwEaQjkZzFjQiN9LVYvIFB2nSUHW9tYpxWriPrWDASIxiaXax83REcLxuSdnGPZtw==", + "dev": true + }, + "node_modules/@colors/colors": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/@colors/colors/-/colors-1.5.0.tgz", + "integrity": "sha512-ooWCrlZP11i8GImSjTHYHLkvFDP48nS4+204nGb1RiX/WXYHmJA2III9/e2DWVabCESdW7hBAEzHRqUn9OUVvQ==", "dev": true, "optional": true, - "os": [ - "netbsd" - ], "engines": { - "node": ">=12" + "node": ">=0.1.90" } }, - "node_modules/@esbuild/openbsd-x64": { + "node_modules/@dabh/diagnostics": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/@dabh/diagnostics/-/diagnostics-2.0.3.tgz", + "integrity": "sha512-hrlQOIi7hAfzsMqlGSFyVucrx38O+j6wiGOf//H2ecvIEqYN4ADBSS2iLMh5UFyDunCNniUIPk/q3riFv45xRA==", + "dev": true, + "dependencies": { + "colorspace": "1.1.x", + "enabled": "2.0.x", + "kuler": "^2.0.0" + } + }, + "node_modules/@esbuild/aix-ppc64": { "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.21.5.tgz", - "integrity": "sha512-HLNNw99xsvx12lFBUwoT8EVCsSvRNDVxNpjZ7bPn947b8gJPzeHWyNVhFsaerc0n3TsbOINvRP2byTZ5LKezow==", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.21.5.tgz", + "integrity": "sha512-1SDgH6ZSPTlggy1yI6+Dbkiz8xzpHJEVAlF/AM1tHPLsf5STom9rwtjE4hKAF20FfXXNTFqEYXyJNWh1GiZedQ==", "cpu": [ - "x64" + "ppc64" ], "dev": true, "optional": true, "os": [ - "openbsd" + "aix" ], "engines": { "node": ">=12" } }, - "node_modules/@esbuild/sunos-x64": { + "node_modules/@esbuild/android-arm": { "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.21.5.tgz", - "integrity": "sha512-6+gjmFpfy0BHU5Tpptkuh8+uw3mnrvgs+dSPQXQOv3ekbordwnzTVEb4qnIvQcYXq6gzkyTnoZ9dZG+D4garKg==", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.21.5.tgz", + "integrity": "sha512-vCPvzSjpPHEi1siZdlvAlsPxXl7WbOVUBBAowWug4rJHb68Ox8KualB+1ocNvT5fjv6wpkX6o/iEpbDrf68zcg==", "cpu": [ - "x64" + "arm" ], "dev": true, "optional": true, "os": [ - "sunos" + "android" ], "engines": { "node": ">=12" } }, - "node_modules/@esbuild/win32-arm64": { + "node_modules/@esbuild/android-arm64": { "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.21.5.tgz", - "integrity": "sha512-Z0gOTd75VvXqyq7nsl93zwahcTROgqvuAcYDUr+vOv8uHhNSKROyU961kgtCD1e95IqPKSQKH7tBTslnS3tA8A==", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.21.5.tgz", + "integrity": "sha512-c0uX9VAUBQ7dTDCjq+wdyGLowMdtR/GoC2U5IYk/7D1H1JYC0qseD7+11iMP2mRLN9RcCMRcjC4YMclCzGwS/A==", "cpu": [ "arm64" ], "dev": true, "optional": true, "os": [ - "win32" + "android" ], "engines": { "node": ">=12" } }, - "node_modules/@esbuild/win32-ia32": { + "node_modules/@esbuild/android-x64": { "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.21.5.tgz", - "integrity": "sha512-SWXFF1CL2RVNMaVs+BBClwtfZSvDgtL//G/smwAc5oVK/UPu2Gu9tIaRgFmYFFKrmg3SyAjSrElf0TiJ1v8fYA==", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.21.5.tgz", + "integrity": "sha512-D7aPRUUNHRBwHxzxRvp856rjUHRFW1SdQATKXH2hqA0kAZb1hKmi02OpYRacl0TxIGz/ZmXWlbZgjwWYaCakTA==", "cpu": [ - "ia32" + "x64" ], "dev": true, "optional": true, "os": [ - "win32" + "android" ], "engines": { "node": ">=12" } }, - "node_modules/@esbuild/win32-x64": { + "node_modules/@esbuild/darwin-arm64": { "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.21.5.tgz", - "integrity": "sha512-tQd/1efJuzPC6rCFwEvLtci/xNFcTZknmXs98FYDfGE4wP9ClFV98nyKrzJKVPMhdDnjzLhdUyMX4PsQAPjwIw==", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.21.5.tgz", + "integrity": "sha512-DwqXqZyuk5AiWWf3UfLiRDJ5EDd49zg6O9wclZ7kUMv2WRFr4HKjXp/5t8JZ11QbQfUS6/cRCKGwYhtNAY88kQ==", "cpu": [ - "x64" + "arm64" ], "dev": true, "optional": true, "os": [ - "win32" + "darwin" ], "engines": { "node": ">=12" } }, - "node_modules/@faker-js/faker": { - "version": "5.5.3", - "resolved": "https://registry.npmjs.org/@faker-js/faker/-/faker-5.5.3.tgz", - "integrity": "sha512-R11tGE6yIFwqpaIqcfkcg7AICXzFg14+5h5v0TfF/9+RMDL6jhzCy/pxHVOfbALGdtVYdt6JdR21tuxEgl34dw==", - "dev": true - }, - "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==", + "node_modules/@esbuild/darwin-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.21.5.tgz", + "integrity": "sha512-se/JjF8NlmKVG4kNIuyWMV/22ZaerB+qaSi5MdrXtd6R08kvs2qCN4C09miupktDitvh8jRFflwGFBQcxZRjbw==", + "cpu": [ + "x64" + ], "dev": true, + "optional": true, + "os": [ + "darwin" + ], "engines": { - "node": ">=8" + "node": ">=12" } }, - "node_modules/@jest/schemas": { - "version": "29.6.3", - "resolved": "https://registry.npmjs.org/@jest/schemas/-/schemas-29.6.3.tgz", - "integrity": "sha512-mo5j5X+jIZmJQveBKeS/clAueipV7KgiX1vMgCxam1RNYiqE1w62n0/tJJnHtjW8ZHcQco5gY85jA3mi0L+nSA==", + "node_modules/@esbuild/freebsd-arm64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.21.5.tgz", + "integrity": "sha512-5JcRxxRDUJLX8JXp/wcBCy3pENnCgBR9bN6JsY4OmhfUtIHe3ZW0mawA7+RDAcMLrMIZaf03NlQiX9DGyB8h4g==", + "cpu": [ + "arm64" + ], "dev": true, - "dependencies": { - "@sinclair/typebox": "^0.27.8" - }, + "optional": true, + "os": [ + "freebsd" + ], "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + "node": ">=12" } }, - "node_modules/@jridgewell/gen-mapping": { - "version": "0.3.5", - "resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.5.tgz", - "integrity": "sha512-IzL8ZoEDIBRWEzlCcRhOaCupYyN5gdIK+Q6fbFdPDg6HqX6jpkItn7DFIpW9LQzXG6Df9sA7+OKnq0qlz/GaQg==", + "node_modules/@esbuild/freebsd-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.21.5.tgz", + "integrity": "sha512-J95kNBj1zkbMXtHVH29bBriQygMXqoVQOQYA+ISs0/2l3T9/kj42ow2mpqerRBxDJnmkUDCaQT/dfNXWX/ZZCQ==", + "cpu": [ + "x64" + ], "dev": true, - "dependencies": { - "@jridgewell/set-array": "^1.2.1", - "@jridgewell/sourcemap-codec": "^1.4.10", - "@jridgewell/trace-mapping": "^0.3.24" - }, + "optional": true, + "os": [ + "freebsd" + ], "engines": { - "node": ">=6.0.0" + "node": ">=12" } }, - "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==", + "node_modules/@esbuild/linux-arm": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.21.5.tgz", + "integrity": "sha512-bPb5AHZtbeNGjCKVZ9UGqGwo8EUu4cLq68E95A53KlxAPRmUyYv2D6F0uUI65XisGOL1hBP5mTronbgo+0bFcA==", + "cpu": [ + "arm" + ], "dev": true, + "optional": true, + "os": [ + "linux" + ], "engines": { - "node": ">=6.0.0" + "node": ">=12" } }, - "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==", + "node_modules/@esbuild/linux-arm64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.21.5.tgz", + "integrity": "sha512-ibKvmyYzKsBeX8d8I7MH/TMfWDXBF3db4qM6sy+7re0YXya+K1cem3on9XgdT2EQGMu4hQyZhan7TeQ8XkGp4Q==", + "cpu": [ + "arm64" + ], "dev": true, + "optional": true, + "os": [ + "linux" + ], "engines": { - "node": ">=6.0.0" + "node": ">=12" } }, - "node_modules/@jridgewell/sourcemap-codec": { - "version": "1.4.15", - "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.4.15.tgz", - "integrity": "sha512-eF2rxCRulEKXHTRiDrDy6erMYWqNw4LPdQ8UQA4huuxaQsVeRPFl2oM8oDGxMFhJUWZf9McpLtJasDDZb/Bpeg==", - "dev": true - }, - "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==", + "node_modules/@esbuild/linux-ia32": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.21.5.tgz", + "integrity": "sha512-YvjXDqLRqPDl2dvRODYmmhz4rPeVKYvppfGYKSNGdyZkA01046pLWyRKKI3ax8fbJoK5QbxblURkwK/MWY18Tg==", + "cpu": [ + "ia32" + ], "dev": true, - "dependencies": { - "@jridgewell/resolve-uri": "^3.1.0", - "@jridgewell/sourcemap-codec": "^1.4.14" + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" } }, - "node_modules/@jsdevtools/ono": { - "version": "7.1.3", - "resolved": "https://registry.npmjs.org/@jsdevtools/ono/-/ono-7.1.3.tgz", - "integrity": "sha512-4JQNk+3mVzK3xh2rqd6RB4J46qUR19azEHBneZyTZM+c456qOrbbM/5xcR8huNCCcbVt7+UmizG6GuUvPvKUYg==", - "dev": true - }, - "node_modules/@kwsites/file-exists": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/@kwsites/file-exists/-/file-exists-1.1.1.tgz", - "integrity": "sha512-m9/5YGR18lIwxSFDwfE3oA7bWuq9kdau6ugN4H2rJeyhFQZcG9AgSHkQtSD15a8WvTgfz9aikZMrKPHvbpqFiw==", + "node_modules/@esbuild/linux-loong64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.21.5.tgz", + "integrity": "sha512-uHf1BmMG8qEvzdrzAqg2SIG/02+4/DHB6a9Kbya0XDvwDEKCoC8ZRWI5JJvNdUjtciBGFQ5PuBlpEOXQj+JQSg==", + "cpu": [ + "loong64" + ], "dev": true, - "dependencies": { - "debug": "^4.1.1" + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" } }, - "node_modules/@kwsites/promise-deferred": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/@kwsites/promise-deferred/-/promise-deferred-1.1.1.tgz", - "integrity": "sha512-GaHYm+c0O9MjZRu0ongGBRbinu8gVAMd2UZjji6jVmqKtZluZnptXGWhz1E8j8D2HJ3f/yMxKAUC0b+57wncIw==", - "dev": true - }, - "node_modules/@nodelib/fs.scandir": { - "version": "2.1.5", - "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", - "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", + "node_modules/@esbuild/linux-mips64el": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.21.5.tgz", + "integrity": "sha512-IajOmO+KJK23bj52dFSNCMsz1QP1DqM6cwLUv3W1QwyxkyIWecfafnI555fvSGqEKwjMXVLokcV5ygHW5b3Jbg==", + "cpu": [ + "mips64el" + ], "dev": true, - "dependencies": { - "@nodelib/fs.stat": "2.0.5", - "run-parallel": "^1.1.9" - }, + "optional": true, + "os": [ + "linux" + ], "engines": { - "node": ">= 8" + "node": ">=12" } }, - "node_modules/@nodelib/fs.stat": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", - "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", + "node_modules/@esbuild/linux-ppc64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.21.5.tgz", + "integrity": "sha512-1hHV/Z4OEfMwpLO8rp7CvlhBDnjsC3CttJXIhBi+5Aj5r+MBvy4egg7wCbe//hSsT+RvDAG7s81tAvpL2XAE4w==", + "cpu": [ + "ppc64" + ], "dev": true, + "optional": true, + "os": [ + "linux" + ], "engines": { - "node": ">= 8" + "node": ">=12" } }, - "node_modules/@nodelib/fs.walk": { - "version": "1.2.8", - "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", - "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", + "node_modules/@esbuild/linux-riscv64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.21.5.tgz", + "integrity": "sha512-2HdXDMd9GMgTGrPWnJzP2ALSokE/0O5HhTUvWIbD3YdjME8JwvSCnNGBnTThKGEB91OZhzrJ4qIIxk/SBmyDDA==", + "cpu": [ + "riscv64" + ], "dev": true, - "dependencies": { - "@nodelib/fs.scandir": "2.1.5", - "fastq": "^1.6.0" - }, + "optional": true, + "os": [ + "linux" + ], "engines": { - "node": ">= 8" + "node": ">=12" } }, - "node_modules/@opentelemetry/api": { - "version": "1.9.0", - "resolved": "https://registry.npmjs.org/@opentelemetry/api/-/api-1.9.0.tgz", - "integrity": "sha512-3giAOQvZiH5F9bMlMiv8+GSPMeqg0dbaeo58/0SlA9sxSqZhnUtxzX9/2FzyhS9sWQf5S0GJE0AKBrFqjpeYcg==", + "node_modules/@esbuild/linux-s390x": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.21.5.tgz", + "integrity": "sha512-zus5sxzqBJD3eXxwvjN1yQkRepANgxE9lgOW2qLnmr8ikMTphkjgXu1HR01K4FJg8h1kEEDAqDcZQtbrRnB41A==", + "cpu": [ + "s390x" + ], "dev": true, + "optional": true, + "os": [ + "linux" + ], "engines": { - "node": ">=8.0.0" + "node": ">=12" } }, - "node_modules/@postman/form-data": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/@postman/form-data/-/form-data-3.1.1.tgz", - "integrity": "sha512-vjh8Q2a8S6UCm/KKs31XFJqEEgmbjBmpPNVV2eVav6905wyFAwaUOBGA1NPBI4ERH9MMZc6w0umFgM6WbEPMdg==", + "node_modules/@esbuild/linux-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.21.5.tgz", + "integrity": "sha512-1rYdTpyv03iycF1+BhzrzQJCdOuAOtaqHTWJZCWvijKD2N5Xu0TtVC8/+1faWqcP9iBCWOmjmhoH94dH82BxPQ==", + "cpu": [ + "x64" + ], "dev": true, - "dependencies": { - "asynckit": "^0.4.0", - "combined-stream": "^1.0.8", - "mime-types": "^2.1.12" - }, + "optional": true, + "os": [ + "linux" + ], "engines": { - "node": ">= 6" + "node": ">=12" } }, - "node_modules/@postman/tough-cookie": { - "version": "4.1.3-postman.1", - "resolved": "https://registry.npmjs.org/@postman/tough-cookie/-/tough-cookie-4.1.3-postman.1.tgz", - "integrity": "sha512-txpgUqZOnWYnUHZpHjkfb0IwVH4qJmyq77pPnJLlfhMtdCLMFTEeQHlzQiK906aaNCe4NEB5fGJHo9uzGbFMeA==", - "dev": true, - "dependencies": { - "psl": "^1.1.33", - "punycode": "^2.1.1", - "universalify": "^0.2.0", - "url-parse": "^1.5.3" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/@postman/tough-cookie/node_modules/universalify": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.2.0.tgz", - "integrity": "sha512-CJ1QgKmNg3CwvAv/kOFmtnEN05f0D/cn9QntgNOQlQF9dgvVTHj3t+8JPdjqawCHk7V/KA+fbUqzZ9XWhcqPUg==", - "dev": true, - "engines": { - "node": ">= 4.0.0" - } - }, - "node_modules/@postman/tunnel-agent": { - "version": "0.6.3", - "resolved": "https://registry.npmjs.org/@postman/tunnel-agent/-/tunnel-agent-0.6.3.tgz", - "integrity": "sha512-k57fzmAZ2PJGxfOA4SGR05ejorHbVAa/84Hxh/2nAztjNXc4ZjOm9NUIk6/Z6LCrBvJZqjRZbN8e/nROVUPVdg==", - "dev": true, - "dependencies": { - "safe-buffer": "^5.0.1" - }, - "engines": { - "node": "*" - } - }, - "node_modules/@rollup/rollup-android-arm-eabi": { - "version": "4.18.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.18.0.tgz", - "integrity": "sha512-Tya6xypR10giZV1XzxmH5wr25VcZSncG0pZIjfePT0OVBvqNEurzValetGNarVrGiq66EBVAFn15iYX4w6FKgQ==", - "cpu": [ - "arm" - ], - "dev": true, - "optional": true, - "os": [ - "android" - ] - }, - "node_modules/@rollup/rollup-android-arm64": { - "version": "4.18.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.18.0.tgz", - "integrity": "sha512-avCea0RAP03lTsDhEyfy+hpfr85KfyTctMADqHVhLAF3MlIkq83CP8UfAHUssgXTYd+6er6PaAhx/QGv4L1EiA==", + "node_modules/@esbuild/netbsd-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.21.5.tgz", + "integrity": "sha512-Woi2MXzXjMULccIwMnLciyZH4nCIMpWQAs049KEeMvOcNADVxo0UBIQPfSmxB3CWKedngg7sWZdLvLczpe0tLg==", "cpu": [ - "arm64" + "x64" ], "dev": true, "optional": true, "os": [ - "android" - ] - }, - "node_modules/@rollup/rollup-darwin-arm64": { - "version": "4.18.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.18.0.tgz", - "integrity": "sha512-IWfdwU7KDSm07Ty0PuA/W2JYoZ4iTj3TUQjkVsO/6U+4I1jN5lcR71ZEvRh52sDOERdnNhhHU57UITXz5jC1/w==", - "cpu": [ - "arm64" + "netbsd" ], - "dev": true, - "optional": true, - "os": [ - "darwin" - ] + "engines": { + "node": ">=12" + } }, - "node_modules/@rollup/rollup-darwin-x64": { - "version": "4.18.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.18.0.tgz", - "integrity": "sha512-n2LMsUz7Ynu7DoQrSQkBf8iNrjOGyPLrdSg802vk6XT3FtsgX6JbE8IHRvposskFm9SNxzkLYGSq9QdpLYpRNA==", + "node_modules/@esbuild/openbsd-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.21.5.tgz", + "integrity": "sha512-HLNNw99xsvx12lFBUwoT8EVCsSvRNDVxNpjZ7bPn947b8gJPzeHWyNVhFsaerc0n3TsbOINvRP2byTZ5LKezow==", "cpu": [ "x64" ], "dev": true, "optional": true, "os": [ - "darwin" - ] - }, - "node_modules/@rollup/rollup-linux-arm-gnueabihf": { - "version": "4.18.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.18.0.tgz", - "integrity": "sha512-C/zbRYRXFjWvz9Z4haRxcTdnkPt1BtCkz+7RtBSuNmKzMzp3ZxdM28Mpccn6pt28/UWUCTXa+b0Mx1k3g6NOMA==", - "cpu": [ - "arm" + "openbsd" ], - "dev": true, - "optional": true, - "os": [ - "linux" - ] + "engines": { + "node": ">=12" + } }, - "node_modules/@rollup/rollup-linux-arm-musleabihf": { - "version": "4.18.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.18.0.tgz", - "integrity": "sha512-l3m9ewPgjQSXrUMHg93vt0hYCGnrMOcUpTz6FLtbwljo2HluS4zTXFy2571YQbisTnfTKPZ01u/ukJdQTLGh9A==", + "node_modules/@esbuild/sunos-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.21.5.tgz", + "integrity": "sha512-6+gjmFpfy0BHU5Tpptkuh8+uw3mnrvgs+dSPQXQOv3ekbordwnzTVEb4qnIvQcYXq6gzkyTnoZ9dZG+D4garKg==", "cpu": [ - "arm" + "x64" ], "dev": true, "optional": true, "os": [ - "linux" - ] - }, - "node_modules/@rollup/rollup-linux-arm64-gnu": { - "version": "4.18.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.18.0.tgz", - "integrity": "sha512-rJ5D47d8WD7J+7STKdCUAgmQk49xuFrRi9pZkWoRD1UeSMakbcepWXPF8ycChBoAqs1pb2wzvbY6Q33WmN2ftw==", - "cpu": [ - "arm64" + "sunos" ], - "dev": true, - "optional": true, - "os": [ - "linux" - ] + "engines": { + "node": ">=12" + } }, - "node_modules/@rollup/rollup-linux-arm64-musl": { - "version": "4.18.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.18.0.tgz", - "integrity": "sha512-be6Yx37b24ZwxQ+wOQXXLZqpq4jTckJhtGlWGZs68TgdKXJgw54lUUoFYrg6Zs/kjzAQwEwYbp8JxZVzZLRepQ==", + "node_modules/@esbuild/win32-arm64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.21.5.tgz", + "integrity": "sha512-Z0gOTd75VvXqyq7nsl93zwahcTROgqvuAcYDUr+vOv8uHhNSKROyU961kgtCD1e95IqPKSQKH7tBTslnS3tA8A==", "cpu": [ "arm64" ], "dev": true, "optional": true, "os": [ - "linux" - ] - }, - "node_modules/@rollup/rollup-linux-powerpc64le-gnu": { - "version": "4.18.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-powerpc64le-gnu/-/rollup-linux-powerpc64le-gnu-4.18.0.tgz", - "integrity": "sha512-hNVMQK+qrA9Todu9+wqrXOHxFiD5YmdEi3paj6vP02Kx1hjd2LLYR2eaN7DsEshg09+9uzWi2W18MJDlG0cxJA==", - "cpu": [ - "ppc64" + "win32" ], - "dev": true, - "optional": true, - "os": [ - "linux" - ] + "engines": { + "node": ">=12" + } }, - "node_modules/@rollup/rollup-linux-riscv64-gnu": { - "version": "4.18.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.18.0.tgz", - "integrity": "sha512-ROCM7i+m1NfdrsmvwSzoxp9HFtmKGHEqu5NNDiZWQtXLA8S5HBCkVvKAxJ8U+CVctHwV2Gb5VUaK7UAkzhDjlg==", + "node_modules/@esbuild/win32-ia32": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.21.5.tgz", + "integrity": "sha512-SWXFF1CL2RVNMaVs+BBClwtfZSvDgtL//G/smwAc5oVK/UPu2Gu9tIaRgFmYFFKrmg3SyAjSrElf0TiJ1v8fYA==", "cpu": [ - "riscv64" + "ia32" ], "dev": true, "optional": true, "os": [ - "linux" - ] - }, - "node_modules/@rollup/rollup-linux-s390x-gnu": { - "version": "4.18.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.18.0.tgz", - "integrity": "sha512-0UyyRHyDN42QL+NbqevXIIUnKA47A+45WyasO+y2bGJ1mhQrfrtXUpTxCOrfxCR4esV3/RLYyucGVPiUsO8xjg==", - "cpu": [ - "s390x" + "win32" ], - "dev": true, - "optional": true, - "os": [ - "linux" - ] + "engines": { + "node": ">=12" + } }, - "node_modules/@rollup/rollup-linux-x64-gnu": { - "version": "4.18.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.18.0.tgz", - "integrity": "sha512-xuglR2rBVHA5UsI8h8UbX4VJ470PtGCf5Vpswh7p2ukaqBGFTnsfzxUBetoWBWymHMxbIG0Cmx7Y9qDZzr648w==", + "node_modules/@esbuild/win32-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.21.5.tgz", + "integrity": "sha512-tQd/1efJuzPC6rCFwEvLtci/xNFcTZknmXs98FYDfGE4wP9ClFV98nyKrzJKVPMhdDnjzLhdUyMX4PsQAPjwIw==", "cpu": [ "x64" ], "dev": true, "optional": true, "os": [ - "linux" - ] - }, - "node_modules/@rollup/rollup-linux-x64-musl": { - "version": "4.18.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.18.0.tgz", - "integrity": "sha512-LKaqQL9osY/ir2geuLVvRRs+utWUNilzdE90TpyoX0eNqPzWjRm14oMEE+YLve4k/NAqCdPkGYDaDF5Sw+xBfg==", - "cpu": [ - "x64" + "win32" ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@eslint-community/eslint-utils": { + "version": "4.4.0", + "resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.4.0.tgz", + "integrity": "sha512-1/sA4dwrzBAyeUoQ6oxahHKmrZvsnLCg4RfxW3ZFGGmQkSNQPFNLV9CUEFQP1x9EYXHTo5p6xdhZM1Ne9p/AfA==", "dev": true, - "optional": true, - "os": [ - "linux" - ] + "dependencies": { + "eslint-visitor-keys": "^3.3.0" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "peerDependencies": { + "eslint": "^6.0.0 || ^7.0.0 || >=8.0.0" + } }, - "node_modules/@rollup/rollup-win32-arm64-msvc": { - "version": "4.18.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.18.0.tgz", - "integrity": "sha512-7J6TkZQFGo9qBKH0pk2cEVSRhJbL6MtfWxth7Y5YmZs57Pi+4x6c2dStAUvaQkHQLnEQv1jzBUW43GvZW8OFqA==", - "cpu": [ - "arm64" - ], + "node_modules/@eslint-community/regexpp": { + "version": "4.11.0", + "resolved": "https://registry.npmjs.org/@eslint-community/regexpp/-/regexpp-4.11.0.tgz", + "integrity": "sha512-G/M/tIiMrTAxEWRfLfQJMmGNX28IxBg4PBz8XqQhqUHLFI6TL2htpIB1iQCj144V5ee/JaKyT9/WZ0MGZWfA7A==", "dev": true, - "optional": true, - "os": [ - "win32" - ] + "engines": { + "node": "^12.0.0 || ^14.0.0 || >=16.0.0" + } }, - "node_modules/@rollup/rollup-win32-ia32-msvc": { - "version": "4.18.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.18.0.tgz", - "integrity": "sha512-Txjh+IxBPbkUB9+SXZMpv+b/vnTEtFyfWZgJ6iyCmt2tdx0OF5WhFowLmnh8ENGNpfUlUZkdI//4IEmhwPieNg==", - "cpu": [ - "ia32" - ], + "node_modules/@eslint/eslintrc": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-2.1.4.tgz", + "integrity": "sha512-269Z39MS6wVJtsoUl10L60WdkhJVdPG24Q4eZTH3nnF6lpvSShEK3wQjDX9JRWAUPvPh7COouPpU9IrqaZFvtQ==", "dev": true, - "optional": true, - "os": [ - "win32" - ] + "dependencies": { + "ajv": "^6.12.4", + "debug": "^4.3.2", + "espree": "^9.6.0", + "globals": "^13.19.0", + "ignore": "^5.2.0", + "import-fresh": "^3.2.1", + "js-yaml": "^4.1.0", + "minimatch": "^3.1.2", + "strip-json-comments": "^3.1.1" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + } }, - "node_modules/@rollup/rollup-win32-x64-msvc": { - "version": "4.18.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.18.0.tgz", - "integrity": "sha512-UOo5FdvOL0+eIVTgS4tIdbW+TtnBLWg1YBCcU2KWM7nuNwRz9bksDX1bekJJCpu25N1DVWaCwnT39dVQxzqS8g==", - "cpu": [ - "x64" - ], + "node_modules/@eslint/eslintrc/node_modules/ajv": { + "version": "6.12.6", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", + "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "dev": true, + "dependencies": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/@eslint/eslintrc/node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "dev": true + }, + "node_modules/@eslint/eslintrc/node_modules/js-yaml": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", + "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", + "dev": true, + "dependencies": { + "argparse": "^2.0.1" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/@eslint/eslintrc/node_modules/json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", + "dev": true + }, + "node_modules/@eslint/js": { + "version": "9.7.0", + "resolved": "https://registry.npmjs.org/@eslint/js/-/js-9.7.0.tgz", + "integrity": "sha512-ChuWDQenef8OSFnvuxv0TCVxEwmu3+hPNKvM9B34qpM0rDRbjL8t5QkQeHHeAfsKQjuH9wS82WeCi1J/owatng==", + "dev": true, + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + } + }, + "node_modules/@faker-js/faker": { + "version": "5.5.3", + "resolved": "https://registry.npmjs.org/@faker-js/faker/-/faker-5.5.3.tgz", + "integrity": "sha512-R11tGE6yIFwqpaIqcfkcg7AICXzFg14+5h5v0TfF/9+RMDL6jhzCy/pxHVOfbALGdtVYdt6JdR21tuxEgl34dw==", + "dev": true + }, + "node_modules/@humanwhocodes/config-array": { + "version": "0.11.14", + "resolved": "https://registry.npmjs.org/@humanwhocodes/config-array/-/config-array-0.11.14.tgz", + "integrity": "sha512-3T8LkOmg45BV5FICb15QQMsyUSWrQ8AygVfC7ZG32zOalnqrilm018ZVCw0eapXux8FtA33q8PSRSstjee3jSg==", + "deprecated": "Use @eslint/config-array instead", + "dev": true, + "dependencies": { + "@humanwhocodes/object-schema": "^2.0.2", + "debug": "^4.3.1", + "minimatch": "^3.0.5" + }, + "engines": { + "node": ">=10.10.0" + } + }, + "node_modules/@humanwhocodes/module-importer": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/@humanwhocodes/module-importer/-/module-importer-1.0.1.tgz", + "integrity": "sha512-bxveV4V8v5Yb4ncFTT3rPSgZBOpCkjfK0y4oVVVJwIuDVBRMDXrPyXRL988i5ap9m9bnyEEjWfm5WkBmtffLfA==", + "dev": true, + "engines": { + "node": ">=12.22" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/nzakas" + } + }, + "node_modules/@humanwhocodes/momoa": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/@humanwhocodes/momoa/-/momoa-2.0.4.tgz", + "integrity": "sha512-RE815I4arJFtt+FVeU1Tgp9/Xvecacji8w/V6XtXsWWH/wz/eNkNbhb+ny/+PlVZjV0rxQpRSQKNKE3lcktHEA==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": ">=10.10.0" + } + }, + "node_modules/@humanwhocodes/object-schema": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/@humanwhocodes/object-schema/-/object-schema-2.0.3.tgz", + "integrity": "sha512-93zYdMES/c1D69yZiKDBj0V24vqNzB/koF26KPaagAfd3P/4gUlh3Dys5ogAK+Exi9QyzlD8x/08Zt7wIKcDcA==", + "deprecated": "Use @eslint/object-schema instead", + "dev": true + }, + "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, + "engines": { + "node": ">=8" + } + }, + "node_modules/@jest/schemas": { + "version": "29.6.3", + "resolved": "https://registry.npmjs.org/@jest/schemas/-/schemas-29.6.3.tgz", + "integrity": "sha512-mo5j5X+jIZmJQveBKeS/clAueipV7KgiX1vMgCxam1RNYiqE1w62n0/tJJnHtjW8ZHcQco5gY85jA3mi0L+nSA==", + "dev": true, + "dependencies": { + "@sinclair/typebox": "^0.27.8" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/@jridgewell/gen-mapping": { + "version": "0.3.5", + "resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.5.tgz", + "integrity": "sha512-IzL8ZoEDIBRWEzlCcRhOaCupYyN5gdIK+Q6fbFdPDg6HqX6jpkItn7DFIpW9LQzXG6Df9sA7+OKnq0qlz/GaQg==", + "dev": true, + "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, + "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, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@jridgewell/sourcemap-codec": { + "version": "1.4.15", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.4.15.tgz", + "integrity": "sha512-eF2rxCRulEKXHTRiDrDy6erMYWqNw4LPdQ8UQA4huuxaQsVeRPFl2oM8oDGxMFhJUWZf9McpLtJasDDZb/Bpeg==", + "dev": true + }, + "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, + "dependencies": { + "@jridgewell/resolve-uri": "^3.1.0", + "@jridgewell/sourcemap-codec": "^1.4.14" + } + }, + "node_modules/@jsdevtools/ono": { + "version": "7.1.3", + "resolved": "https://registry.npmjs.org/@jsdevtools/ono/-/ono-7.1.3.tgz", + "integrity": "sha512-4JQNk+3mVzK3xh2rqd6RB4J46qUR19azEHBneZyTZM+c456qOrbbM/5xcR8huNCCcbVt7+UmizG6GuUvPvKUYg==", + "dev": true + }, + "node_modules/@kwsites/file-exists": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/@kwsites/file-exists/-/file-exists-1.1.1.tgz", + "integrity": "sha512-m9/5YGR18lIwxSFDwfE3oA7bWuq9kdau6ugN4H2rJeyhFQZcG9AgSHkQtSD15a8WvTgfz9aikZMrKPHvbpqFiw==", + "dev": true, + "dependencies": { + "debug": "^4.1.1" + } + }, + "node_modules/@kwsites/promise-deferred": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/@kwsites/promise-deferred/-/promise-deferred-1.1.1.tgz", + "integrity": "sha512-GaHYm+c0O9MjZRu0ongGBRbinu8gVAMd2UZjji6jVmqKtZluZnptXGWhz1E8j8D2HJ3f/yMxKAUC0b+57wncIw==", + "dev": true + }, + "node_modules/@nodelib/fs.scandir": { + "version": "2.1.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", + "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", + "dev": true, + "dependencies": { + "@nodelib/fs.stat": "2.0.5", + "run-parallel": "^1.1.9" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.stat": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", + "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", + "dev": true, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.walk": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", + "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", + "dev": true, + "dependencies": { + "@nodelib/fs.scandir": "2.1.5", + "fastq": "^1.6.0" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@opentelemetry/api": { + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/@opentelemetry/api/-/api-1.9.0.tgz", + "integrity": "sha512-3giAOQvZiH5F9bMlMiv8+GSPMeqg0dbaeo58/0SlA9sxSqZhnUtxzX9/2FzyhS9sWQf5S0GJE0AKBrFqjpeYcg==", + "dev": true, + "engines": { + "node": ">=8.0.0" + } + }, + "node_modules/@postman/form-data": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/@postman/form-data/-/form-data-3.1.1.tgz", + "integrity": "sha512-vjh8Q2a8S6UCm/KKs31XFJqEEgmbjBmpPNVV2eVav6905wyFAwaUOBGA1NPBI4ERH9MMZc6w0umFgM6WbEPMdg==", + "dev": true, + "dependencies": { + "asynckit": "^0.4.0", + "combined-stream": "^1.0.8", + "mime-types": "^2.1.12" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/@postman/tough-cookie": { + "version": "4.1.3-postman.1", + "resolved": "https://registry.npmjs.org/@postman/tough-cookie/-/tough-cookie-4.1.3-postman.1.tgz", + "integrity": "sha512-txpgUqZOnWYnUHZpHjkfb0IwVH4qJmyq77pPnJLlfhMtdCLMFTEeQHlzQiK906aaNCe4NEB5fGJHo9uzGbFMeA==", + "dev": true, + "dependencies": { + "psl": "^1.1.33", + "punycode": "^2.1.1", + "universalify": "^0.2.0", + "url-parse": "^1.5.3" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/@postman/tough-cookie/node_modules/universalify": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.2.0.tgz", + "integrity": "sha512-CJ1QgKmNg3CwvAv/kOFmtnEN05f0D/cn9QntgNOQlQF9dgvVTHj3t+8JPdjqawCHk7V/KA+fbUqzZ9XWhcqPUg==", + "dev": true, + "engines": { + "node": ">= 4.0.0" + } + }, + "node_modules/@postman/tunnel-agent": { + "version": "0.6.3", + "resolved": "https://registry.npmjs.org/@postman/tunnel-agent/-/tunnel-agent-0.6.3.tgz", + "integrity": "sha512-k57fzmAZ2PJGxfOA4SGR05ejorHbVAa/84Hxh/2nAztjNXc4ZjOm9NUIk6/Z6LCrBvJZqjRZbN8e/nROVUPVdg==", + "dev": true, + "dependencies": { + "safe-buffer": "^5.0.1" + }, + "engines": { + "node": "*" + } + }, + "node_modules/@readme/better-ajv-errors": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/@readme/better-ajv-errors/-/better-ajv-errors-1.6.0.tgz", + "integrity": "sha512-9gO9rld84Jgu13kcbKRU+WHseNhaVt76wYMeRDGsUGYxwJtI3RmEJ9LY9dZCYQGI8eUZLuxb5qDja0nqklpFjQ==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "@babel/code-frame": "^7.16.0", + "@babel/runtime": "^7.21.0", + "@humanwhocodes/momoa": "^2.0.3", + "chalk": "^4.1.2", + "json-to-ast": "^2.0.3", + "jsonpointer": "^5.0.0", + "leven": "^3.1.0" + }, + "engines": { + "node": ">=14" + }, + "peerDependencies": { + "ajv": "4.11.8 - 8" + } + }, + "node_modules/@readme/better-ajv-errors/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/@readme/better-ajv-errors/node_modules/chalk": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/@readme/better-ajv-errors/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/@readme/better-ajv-errors/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/@readme/better-ajv-errors/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/@readme/better-ajv-errors/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/@readme/json-schema-ref-parser": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/@readme/json-schema-ref-parser/-/json-schema-ref-parser-1.2.0.tgz", + "integrity": "sha512-Bt3QVovFSua4QmHa65EHUmh2xS0XJ3rgTEUPH998f4OW4VVJke3BuS16f+kM0ZLOGdvIrzrPRqwihuv5BAjtrA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jsdevtools/ono": "^7.1.3", + "@types/json-schema": "^7.0.6", + "call-me-maybe": "^1.0.1", + "js-yaml": "^4.1.0" + } + }, + "node_modules/@readme/json-schema-ref-parser/node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "dev": true, + "license": "Python-2.0" + }, + "node_modules/@readme/json-schema-ref-parser/node_modules/js-yaml": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", + "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", + "dev": true, + "license": "MIT", + "dependencies": { + "argparse": "^2.0.1" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/@readme/openapi-parser": { + "version": "2.6.0", + "resolved": "https://registry.npmjs.org/@readme/openapi-parser/-/openapi-parser-2.6.0.tgz", + "integrity": "sha512-pyFJXezWj9WI1O+gdp95CoxfY+i+Uq3kKk4zXIFuRAZi9YnHpHOpjumWWr67wkmRTw19Hskh9spyY0Iyikf3fA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@apidevtools/swagger-methods": "^3.0.2", + "@jsdevtools/ono": "^7.1.3", + "@readme/better-ajv-errors": "^1.6.0", + "@readme/json-schema-ref-parser": "^1.2.0", + "@readme/openapi-schemas": "^3.1.0", + "ajv": "^8.12.0", + "ajv-draft-04": "^1.0.0", + "call-me-maybe": "^1.0.1" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "openapi-types": ">=7" + } + }, + "node_modules/@readme/openapi-schemas": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@readme/openapi-schemas/-/openapi-schemas-3.1.0.tgz", + "integrity": "sha512-9FC/6ho8uFa8fV50+FPy/ngWN53jaUu4GRXlAjcxIRrzhltJnpKkBG2Tp0IDraFJeWrOpk84RJ9EMEEYzaI1Bw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=18" + } + }, + "node_modules/@rollup/rollup-android-arm-eabi": { + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.18.0.tgz", + "integrity": "sha512-Tya6xypR10giZV1XzxmH5wr25VcZSncG0pZIjfePT0OVBvqNEurzValetGNarVrGiq66EBVAFn15iYX4w6FKgQ==", + "cpu": [ + "arm" + ], + "dev": true, + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-android-arm64": { + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.18.0.tgz", + "integrity": "sha512-avCea0RAP03lTsDhEyfy+hpfr85KfyTctMADqHVhLAF3MlIkq83CP8UfAHUssgXTYd+6er6PaAhx/QGv4L1EiA==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-darwin-arm64": { + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.18.0.tgz", + "integrity": "sha512-IWfdwU7KDSm07Ty0PuA/W2JYoZ4iTj3TUQjkVsO/6U+4I1jN5lcR71ZEvRh52sDOERdnNhhHU57UITXz5jC1/w==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-darwin-x64": { + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.18.0.tgz", + "integrity": "sha512-n2LMsUz7Ynu7DoQrSQkBf8iNrjOGyPLrdSg802vk6XT3FtsgX6JbE8IHRvposskFm9SNxzkLYGSq9QdpLYpRNA==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-linux-arm-gnueabihf": { + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.18.0.tgz", + "integrity": "sha512-C/zbRYRXFjWvz9Z4haRxcTdnkPt1BtCkz+7RtBSuNmKzMzp3ZxdM28Mpccn6pt28/UWUCTXa+b0Mx1k3g6NOMA==", + "cpu": [ + "arm" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm-musleabihf": { + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.18.0.tgz", + "integrity": "sha512-l3m9ewPgjQSXrUMHg93vt0hYCGnrMOcUpTz6FLtbwljo2HluS4zTXFy2571YQbisTnfTKPZ01u/ukJdQTLGh9A==", + "cpu": [ + "arm" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-gnu": { + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.18.0.tgz", + "integrity": "sha512-rJ5D47d8WD7J+7STKdCUAgmQk49xuFrRi9pZkWoRD1UeSMakbcepWXPF8ycChBoAqs1pb2wzvbY6Q33WmN2ftw==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-musl": { + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.18.0.tgz", + "integrity": "sha512-be6Yx37b24ZwxQ+wOQXXLZqpq4jTckJhtGlWGZs68TgdKXJgw54lUUoFYrg6Zs/kjzAQwEwYbp8JxZVzZLRepQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-powerpc64le-gnu": { + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-powerpc64le-gnu/-/rollup-linux-powerpc64le-gnu-4.18.0.tgz", + "integrity": "sha512-hNVMQK+qrA9Todu9+wqrXOHxFiD5YmdEi3paj6vP02Kx1hjd2LLYR2eaN7DsEshg09+9uzWi2W18MJDlG0cxJA==", + "cpu": [ + "ppc64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-gnu": { + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.18.0.tgz", + "integrity": "sha512-ROCM7i+m1NfdrsmvwSzoxp9HFtmKGHEqu5NNDiZWQtXLA8S5HBCkVvKAxJ8U+CVctHwV2Gb5VUaK7UAkzhDjlg==", + "cpu": [ + "riscv64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-s390x-gnu": { + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.18.0.tgz", + "integrity": "sha512-0UyyRHyDN42QL+NbqevXIIUnKA47A+45WyasO+y2bGJ1mhQrfrtXUpTxCOrfxCR4esV3/RLYyucGVPiUsO8xjg==", + "cpu": [ + "s390x" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-gnu": { + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.18.0.tgz", + "integrity": "sha512-xuglR2rBVHA5UsI8h8UbX4VJ470PtGCf5Vpswh7p2ukaqBGFTnsfzxUBetoWBWymHMxbIG0Cmx7Y9qDZzr648w==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-musl": { + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.18.0.tgz", + "integrity": "sha512-LKaqQL9osY/ir2geuLVvRRs+utWUNilzdE90TpyoX0eNqPzWjRm14oMEE+YLve4k/NAqCdPkGYDaDF5Sw+xBfg==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-win32-arm64-msvc": { + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.18.0.tgz", + "integrity": "sha512-7J6TkZQFGo9qBKH0pk2cEVSRhJbL6MtfWxth7Y5YmZs57Pi+4x6c2dStAUvaQkHQLnEQv1jzBUW43GvZW8OFqA==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-ia32-msvc": { + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.18.0.tgz", + "integrity": "sha512-Txjh+IxBPbkUB9+SXZMpv+b/vnTEtFyfWZgJ6iyCmt2tdx0OF5WhFowLmnh8ENGNpfUlUZkdI//4IEmhwPieNg==", + "cpu": [ + "ia32" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-x64-msvc": { + "version": "4.18.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.18.0.tgz", + "integrity": "sha512-UOo5FdvOL0+eIVTgS4tIdbW+TtnBLWg1YBCcU2KWM7nuNwRz9bksDX1bekJJCpu25N1DVWaCwnT39dVQxzqS8g==", + "cpu": [ + "x64" + ], "dev": true, "optional": true, "os": [ "win32" ] }, - "node_modules/@sec-ant/readable-stream": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/@sec-ant/readable-stream/-/readable-stream-0.4.1.tgz", - "integrity": "sha512-831qok9r2t8AlxLko40y2ebgSDhenenCatLVeW/uBtnHPyhHOvG0C7TvfgecV+wHzIm5KUICgzmVpWS+IMEAeg==", + "node_modules/@sec-ant/readable-stream": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/@sec-ant/readable-stream/-/readable-stream-0.4.1.tgz", + "integrity": "sha512-831qok9r2t8AlxLko40y2ebgSDhenenCatLVeW/uBtnHPyhHOvG0C7TvfgecV+wHzIm5KUICgzmVpWS+IMEAeg==", + "dev": true + }, + "node_modules/@sinclair/typebox": { + "version": "0.27.8", + "resolved": "https://registry.npmjs.org/@sinclair/typebox/-/typebox-0.27.8.tgz", + "integrity": "sha512-+Fj43pSMwJs4KRrH/938Uf+uAELIgVBmQzg/q1YG10djyfA3TnrU8N8XzqCh/okZdszqBQTZf96idMfE5lnwTA==", + "dev": true + }, + "node_modules/@sindresorhus/merge-streams": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/@sindresorhus/merge-streams/-/merge-streams-2.3.0.tgz", + "integrity": "sha512-LtoMMhxAlorcGhmFYI+LhPgbPZCkgP6ra1YL604EeF6U98pLlQ3iWIGMdWSC+vWmPBWBNgmDBAhnAobLROJmwg==", + "dev": true, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/@ts-common/add-position": { + "version": "0.0.2", + "resolved": "https://registry.npmjs.org/@ts-common/add-position/-/add-position-0.0.2.tgz", + "integrity": "sha512-ENfIN5410jyxqXbQZXmj1ifFPjnhXOuJdQjglDXhLR8vyD74PTUz277BN9Voua2DKeOjlAnyBK7ml1ciMsBqhw==", + "dev": true, + "dependencies": { + "@ts-common/iterator": "^0.3.5" + } + }, + "node_modules/@ts-common/add-position/node_modules/@ts-common/iterator": { + "version": "0.3.6", + "resolved": "https://registry.npmjs.org/@ts-common/iterator/-/iterator-0.3.6.tgz", + "integrity": "sha512-nNdcleTj3qLlchH17HI/xqOc6sNgOqJ5DdRR0nOEVdJVZCo5bfqoQTu6+Q9ZwMhuETuR2d86MSlmaL2FVHnPjQ==", + "dev": true + }, + "node_modules/@ts-common/async-iterator": { + "version": "0.2.3", + "resolved": "https://registry.npmjs.org/@ts-common/async-iterator/-/async-iterator-0.2.3.tgz", + "integrity": "sha512-szLdrutwQxBCIECaO2RTFcUPFj+9QVk4xKAj+APgeeLoEs67tNjXFgvfU0kOfF04qTHlPNPqcutSqxMHqzG3qA==", + "dev": true, + "dependencies": { + "@ts-common/iterator": "^0.3.6", + "tslib": "^1.10.0" + } + }, + "node_modules/@ts-common/async-iterator/node_modules/@ts-common/iterator": { + "version": "0.3.6", + "resolved": "https://registry.npmjs.org/@ts-common/iterator/-/iterator-0.3.6.tgz", + "integrity": "sha512-nNdcleTj3qLlchH17HI/xqOc6sNgOqJ5DdRR0nOEVdJVZCo5bfqoQTu6+Q9ZwMhuETuR2d86MSlmaL2FVHnPjQ==", + "dev": true + }, + "node_modules/@ts-common/async-iterator/node_modules/tslib": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", + "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", + "dev": true + }, + "node_modules/@ts-common/commonmark-to-markdown": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/@ts-common/commonmark-to-markdown/-/commonmark-to-markdown-2.0.2.tgz", + "integrity": "sha512-gLUxc7phOvWiDavHDshU3JGxKsepSCYAuXpMVxU0j6MDah2EbV3y0UA4x1wHkWmlf7bVuDLcnsiYQttqEX1zQw==", + "dev": true, + "dependencies": { + "@ts-common/iterator": "^1.1.1", + "@types/commonmark": "^0.27.3", + "commonmark": "^0.28.1", + "front-matter": "^4.0.2" + } + }, + "node_modules/@ts-common/commonmark-to-markdown/node_modules/commonmark": { + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/commonmark/-/commonmark-0.28.1.tgz", + "integrity": "sha512-PklsZ9pgrfFQ5hQH9BRzoWnqI9db2LeR9MhvkNk8iz97kfaTNmhTU+IE8jKDHTEfivZZXoFqzGqzddXdk14EJw==", + "dev": true, + "dependencies": { + "entities": "~ 1.1.1", + "mdurl": "~ 1.0.1", + "minimist": "~ 1.2.0", + "string.prototype.repeat": "^0.2.0" + }, + "bin": { + "commonmark": "bin/commonmark" + }, + "engines": { + "node": "*" + } + }, + "node_modules/@ts-common/commonmark-to-markdown/node_modules/entities": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/entities/-/entities-1.1.2.tgz", + "integrity": "sha512-f2LZMYl1Fzu7YSBKg+RoROelpOaNrcGmE9AZubeDfrCEia483oW4MI4VyFd5VNHIgQ/7qm1I0wUHK1eJnn2y2w==", + "dev": true + }, + "node_modules/@ts-common/fs": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/@ts-common/fs/-/fs-0.2.0.tgz", + "integrity": "sha512-ul1v4ZatcHuAzrwr/hGjSbk37pnfnLYDWC1yMEynQlnV8ndAcIVNYwQPPOYtLADPKTi3y74g5Q4BF3xPurDHLA==", + "dev": true, + "dependencies": { + "@ts-common/async-iterator": "^0.2.0", + "@types/node": "^10.12.18", + "tslib": "^1.9.3" + } + }, + "node_modules/@ts-common/fs/node_modules/tslib": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", + "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", + "dev": true + }, + "node_modules/@ts-common/iterator": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/@ts-common/iterator/-/iterator-1.1.2.tgz", + "integrity": "sha512-edwrL2/efx3uphxuSEI7fCHJENFmTg+gR7TY8ruTRxNWIWc240YSg+v4T3qVAtgG8npwRC4QtQDu72hi8mrR5A==", + "dev": true, + "peerDependencies": { + "tslib": "^2.3.1" + } + }, + "node_modules/@ts-common/json": { + "version": "0.3.1", + "resolved": "https://registry.npmjs.org/@ts-common/json/-/json-0.3.1.tgz", + "integrity": "sha512-vaplNdZPdeWr4p+hLJGdn08UMTSgYQrlRtxrAS0fAWyMlmFalBm/XRhHnohgiflRaj2jxl7ZxihjNlC/LZ/1YQ==", + "dev": true, + "dependencies": { + "@ts-common/iterator": "^0.3.1", + "@ts-common/string-map": "^0.3.0" + } + }, + "node_modules/@ts-common/json-parser": { + "version": "0.9.0", + "resolved": "https://registry.npmjs.org/@ts-common/json-parser/-/json-parser-0.9.0.tgz", + "integrity": "sha512-how0z/Ak7Bay+feIYfJFVV8UMw8Ky2Czoo5XwN7QigCOlN4HyW6wSNup4zrZ7t6NUB0002tW/+IOKCH2lAVJOg==", + "dev": true, + "dependencies": { + "@ts-common/add-position": "0.0.2", + "@ts-common/iterator": "^0.3.5", + "@ts-common/json": "^0.3.1", + "@ts-common/source-map": "^0.5.0", + "@ts-common/string-map": "^0.3.0", + "tslib": "^1.9.3" + } + }, + "node_modules/@ts-common/json-parser/node_modules/@ts-common/iterator": { + "version": "0.3.6", + "resolved": "https://registry.npmjs.org/@ts-common/iterator/-/iterator-0.3.6.tgz", + "integrity": "sha512-nNdcleTj3qLlchH17HI/xqOc6sNgOqJ5DdRR0nOEVdJVZCo5bfqoQTu6+Q9ZwMhuETuR2d86MSlmaL2FVHnPjQ==", + "dev": true + }, + "node_modules/@ts-common/json-parser/node_modules/tslib": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", + "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", + "dev": true + }, + "node_modules/@ts-common/json/node_modules/@ts-common/iterator": { + "version": "0.3.6", + "resolved": "https://registry.npmjs.org/@ts-common/iterator/-/iterator-0.3.6.tgz", + "integrity": "sha512-nNdcleTj3qLlchH17HI/xqOc6sNgOqJ5DdRR0nOEVdJVZCo5bfqoQTu6+Q9ZwMhuETuR2d86MSlmaL2FVHnPjQ==", + "dev": true + }, + "node_modules/@ts-common/property-set": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/@ts-common/property-set/-/property-set-0.1.0.tgz", + "integrity": "sha512-Mw/CPiksQI/Tvp8/bmne6ZYmOcgHuMOrflairbzdpfgMz7lrINFu8PyDQw6yTnIASeZR4yW0xljb66gCE4Jj0w==", + "dev": true + }, + "node_modules/@ts-common/source-map": { + "version": "0.5.0", + "resolved": "https://registry.npmjs.org/@ts-common/source-map/-/source-map-0.5.0.tgz", + "integrity": "sha512-aKFWvuN5uALt+hUtkPA4gHjtloDy2qHW1FB1r758KCTI0h0lP3dNJGcfwg7NnmD0qKQiZAY/J73/NYrbuTfT3A==", + "dev": true, + "dependencies": { + "@ts-common/iterator": "^0.3.0", + "@ts-common/json": "^0.3.0", + "@ts-common/property-set": "^0.1.0", + "@ts-common/string-map": "^0.3.0" + } + }, + "node_modules/@ts-common/source-map/node_modules/@ts-common/iterator": { + "version": "0.3.6", + "resolved": "https://registry.npmjs.org/@ts-common/iterator/-/iterator-0.3.6.tgz", + "integrity": "sha512-nNdcleTj3qLlchH17HI/xqOc6sNgOqJ5DdRR0nOEVdJVZCo5bfqoQTu6+Q9ZwMhuETuR2d86MSlmaL2FVHnPjQ==", + "dev": true + }, + "node_modules/@ts-common/string-map": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/@ts-common/string-map/-/string-map-0.3.0.tgz", + "integrity": "sha512-tikHtQPV/R48VAnlolyl1FIHciror68LXyruelvYf+lRE6ysjIGB2iNyw7wN6aDcUs2wN/CD6fF8Ye7lVIWNTQ==", + "dev": true, + "dependencies": { + "@ts-common/iterator": "^0.3.0" + } + }, + "node_modules/@ts-common/string-map/node_modules/@ts-common/iterator": { + "version": "0.3.6", + "resolved": "https://registry.npmjs.org/@ts-common/iterator/-/iterator-0.3.6.tgz", + "integrity": "sha512-nNdcleTj3qLlchH17HI/xqOc6sNgOqJ5DdRR0nOEVdJVZCo5bfqoQTu6+Q9ZwMhuETuR2d86MSlmaL2FVHnPjQ==", + "dev": true + }, + "node_modules/@ts-common/virtual-fs": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/@ts-common/virtual-fs/-/virtual-fs-0.3.0.tgz", + "integrity": "sha512-ryoXw52FTLhiexoNBA/hcAlW8gxPhrKEuZODgpCiF0wswNJdg/j+rCb9k1VppJdeIJ30b0Wg+2vPsrOrdnYTIw==", + "dev": true, + "dependencies": { + "@ts-common/fs": "^0.2.0", + "@ts-common/iterator": "^0.3.0", + "@types/async-retry": "^1.4.1", + "@types/node-fetch": "^2.5.5", + "async-retry": "^1.3.1", + "node-fetch": "^2.6.0" + } + }, + "node_modules/@ts-common/virtual-fs/node_modules/@ts-common/iterator": { + "version": "0.3.6", + "resolved": "https://registry.npmjs.org/@ts-common/iterator/-/iterator-0.3.6.tgz", + "integrity": "sha512-nNdcleTj3qLlchH17HI/xqOc6sNgOqJ5DdRR0nOEVdJVZCo5bfqoQTu6+Q9ZwMhuETuR2d86MSlmaL2FVHnPjQ==", + "dev": true + }, + "node_modules/@ts-common/virtual-fs/node_modules/node-fetch": { + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", + "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", + "dev": true, + "dependencies": { + "whatwg-url": "^5.0.0" + }, + "engines": { + "node": "4.x || >=6.0.0" + }, + "peerDependencies": { + "encoding": "^0.1.0" + }, + "peerDependenciesMeta": { + "encoding": { + "optional": true + } + } + }, + "node_modules/@tsconfig/strictest": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@tsconfig/strictest/-/strictest-2.0.5.tgz", + "integrity": "sha512-ec4tjL2Rr0pkZ5hww65c+EEPYwxOi4Ryv+0MtjeaSQRJyq322Q27eOQiFbuNgw2hpL4hB1/W/HBGk3VKS43osg==", + "dev": true + }, + "node_modules/@types/async-retry": { + "version": "1.4.8", + "resolved": "https://registry.npmjs.org/@types/async-retry/-/async-retry-1.4.8.tgz", + "integrity": "sha512-Qup/B5PWLe86yI5I3av6ePGaeQrIHNKCwbsQotD6aHQ6YkHsMUxVZkZsmx/Ry3VZQ6uysHwTjQ7666+k6UjVJA==", + "dev": true, + "dependencies": { + "@types/retry": "*" + } + }, + "node_modules/@types/commonmark": { + "version": "0.27.9", + "resolved": "https://registry.npmjs.org/@types/commonmark/-/commonmark-0.27.9.tgz", + "integrity": "sha512-d3+57WgyPCcIc6oshmcPkmP4+JqRRot9eeZLsBsutWtIxwWivpoyc2wEcolOp8MyO3ZWN846mMdoR02kdHSMCw==", + "dev": true + }, + "node_modules/@types/eslint": { + "version": "8.56.10", + "resolved": "https://registry.npmjs.org/@types/eslint/-/eslint-8.56.10.tgz", + "integrity": "sha512-Shavhk87gCtY2fhXDctcfS3e6FdxWkCx1iUZ9eEUbh7rTqlZT0/IzOkCOVt0fCjcFuZ9FPYfuezTBImfHCDBGQ==", + "dev": true, + "dependencies": { + "@types/estree": "*", + "@types/json-schema": "*" + } + }, + "node_modules/@types/eslint__js": { + "version": "8.42.3", + "resolved": "https://registry.npmjs.org/@types/eslint__js/-/eslint__js-8.42.3.tgz", + "integrity": "sha512-alfG737uhmPdnvkrLdZLcEKJ/B8s9Y4hrZ+YAdzUeoArBlSUERA2E87ROfOaS4jd/C45fzOoZzidLc1IPwLqOw==", + "dev": true, + "dependencies": { + "@types/eslint": "*" + } + }, + "node_modules/@types/estree": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.5.tgz", + "integrity": "sha512-/kYRxGDLWzHOB7q+wtSUQlFrtcdUccpfy+X+9iMBpHK8QLLhx2wIPYuS5DYtR9Wa/YlZAbIovy7qVdB1Aq6Lyw==", + "dev": true + }, + "node_modules/@types/json-schema": { + "version": "7.0.15", + "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", + "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==", + "dev": true + }, + "node_modules/@types/node": { + "version": "10.17.60", + "resolved": "https://registry.npmjs.org/@types/node/-/node-10.17.60.tgz", + "integrity": "sha512-F0KIgDJfy2nA3zMLmWGKxcH2ZVEtCZXHHdOQs2gSaQ27+lNeEfGxzkIw90aXswATX7AZ33tahPbzy6KAfUreVw==", + "dev": true + }, + "node_modules/@types/node-fetch": { + "version": "2.6.11", + "resolved": "https://registry.npmjs.org/@types/node-fetch/-/node-fetch-2.6.11.tgz", + "integrity": "sha512-24xFj9R5+rfQJLRyM56qh+wnVSYhyXC2tkoBndtY0U+vubqNsYXGjufB2nn8Q6gt0LrARwL6UBtMCSVCwl4B1g==", + "dev": true, + "dependencies": { + "@types/node": "*", + "form-data": "^4.0.0" + } + }, + "node_modules/@types/normalize-package-data": { + "version": "2.4.4", + "resolved": "https://registry.npmjs.org/@types/normalize-package-data/-/normalize-package-data-2.4.4.tgz", + "integrity": "sha512-37i+OaWTh9qeK4LSHPsyRC7NahnGotNuZvjLSgcPzblpHB3rrCJxAOgI5gCdKm7coonsaX1Of0ILiTcnZjbfxA==", + "dev": true + }, + "node_modules/@types/retry": { + "version": "0.12.5", + "resolved": "https://registry.npmjs.org/@types/retry/-/retry-0.12.5.tgz", + "integrity": "sha512-3xSjTp3v03X/lSQLkczaN9UIEwJMoMCA1+Nb5HfbJEQWogdeQIyVtTvxPXDQjZ5zws8rFQfVfRdz03ARihPJgw==", + "dev": true + }, + "node_modules/@types/triple-beam": { + "version": "1.3.5", + "resolved": "https://registry.npmjs.org/@types/triple-beam/-/triple-beam-1.3.5.tgz", + "integrity": "sha512-6WaYesThRMCl19iryMYP7/x2OVgCtbIVflDGFpWnb9irXI3UjYE4AzmYuiUKY1AJstGijoY+MgUszMgRxIYTYw==", + "dev": true + }, + "node_modules/@types/tunnel": { + "version": "0.0.3", + "resolved": "https://registry.npmjs.org/@types/tunnel/-/tunnel-0.0.3.tgz", + "integrity": "sha512-sOUTGn6h1SfQ+gbgqC364jLFBw2lnFqkgF3q0WovEHRLMrVD1sd5aufqi/aJObLekJO+Aq5z646U4Oxy6shXMA==", + "dev": true, + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@typescript-eslint/eslint-plugin": { + "version": "7.16.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-7.16.1.tgz", + "integrity": "sha512-SxdPak/5bO0EnGktV05+Hq8oatjAYVY3Zh2bye9pGZy6+jwyR3LG3YKkV4YatlsgqXP28BTeVm9pqwJM96vf2A==", + "dev": true, + "dependencies": { + "@eslint-community/regexpp": "^4.10.0", + "@typescript-eslint/scope-manager": "7.16.1", + "@typescript-eslint/type-utils": "7.16.1", + "@typescript-eslint/utils": "7.16.1", + "@typescript-eslint/visitor-keys": "7.16.1", + "graphemer": "^1.4.0", + "ignore": "^5.3.1", + "natural-compare": "^1.4.0", + "ts-api-utils": "^1.3.0" + }, + "engines": { + "node": "^18.18.0 || >=20.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "@typescript-eslint/parser": "^7.0.0", + "eslint": "^8.56.0" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/parser": { + "version": "7.16.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-7.16.1.tgz", + "integrity": "sha512-u+1Qx86jfGQ5i4JjK33/FnawZRpsLxRnKzGE6EABZ40KxVT/vWsiZFEBBHjFOljmmV3MBYOHEKi0Jm9hbAOClA==", + "dev": true, + "dependencies": { + "@typescript-eslint/scope-manager": "7.16.1", + "@typescript-eslint/types": "7.16.1", + "@typescript-eslint/typescript-estree": "7.16.1", + "@typescript-eslint/visitor-keys": "7.16.1", + "debug": "^4.3.4" + }, + "engines": { + "node": "^18.18.0 || >=20.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "eslint": "^8.56.0" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/scope-manager": { + "version": "7.16.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-7.16.1.tgz", + "integrity": "sha512-nYpyv6ALte18gbMz323RM+vpFpTjfNdyakbf3nsLvF43uF9KeNC289SUEW3QLZ1xPtyINJ1dIsZOuWuSRIWygw==", + "dev": true, + "dependencies": { + "@typescript-eslint/types": "7.16.1", + "@typescript-eslint/visitor-keys": "7.16.1" + }, + "engines": { + "node": "^18.18.0 || >=20.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + } + }, + "node_modules/@typescript-eslint/type-utils": { + "version": "7.16.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-7.16.1.tgz", + "integrity": "sha512-rbu/H2MWXN4SkjIIyWcmYBjlp55VT+1G3duFOIukTNFxr9PI35pLc2ydwAfejCEitCv4uztA07q0QWanOHC7dA==", + "dev": true, + "dependencies": { + "@typescript-eslint/typescript-estree": "7.16.1", + "@typescript-eslint/utils": "7.16.1", + "debug": "^4.3.4", + "ts-api-utils": "^1.3.0" + }, + "engines": { + "node": "^18.18.0 || >=20.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "eslint": "^8.56.0" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/types": { + "version": "7.16.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-7.16.1.tgz", + "integrity": "sha512-AQn9XqCzUXd4bAVEsAXM/Izk11Wx2u4H3BAfQVhSfzfDOm/wAON9nP7J5rpkCxts7E5TELmN845xTUCQrD1xIQ==", + "dev": true, + "engines": { + "node": "^18.18.0 || >=20.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + } + }, + "node_modules/@typescript-eslint/typescript-estree": { + "version": "7.16.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-7.16.1.tgz", + "integrity": "sha512-0vFPk8tMjj6apaAZ1HlwM8w7jbghC8jc1aRNJG5vN8Ym5miyhTQGMqU++kuBFDNKe9NcPeZ6x0zfSzV8xC1UlQ==", + "dev": true, + "dependencies": { + "@typescript-eslint/types": "7.16.1", + "@typescript-eslint/visitor-keys": "7.16.1", + "debug": "^4.3.4", + "globby": "^11.1.0", + "is-glob": "^4.0.3", + "minimatch": "^9.0.4", + "semver": "^7.6.0", + "ts-api-utils": "^1.3.0" + }, + "engines": { + "node": "^18.18.0 || >=20.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/typescript-estree/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, + "dependencies": { + "balanced-match": "^1.0.0" + } + }, + "node_modules/@typescript-eslint/typescript-estree/node_modules/globby": { + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/globby/-/globby-11.1.0.tgz", + "integrity": "sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g==", + "dev": true, + "dependencies": { + "array-union": "^2.1.0", + "dir-glob": "^3.0.1", + "fast-glob": "^3.2.9", + "ignore": "^5.2.0", + "merge2": "^1.4.1", + "slash": "^3.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/@typescript-eslint/typescript-estree/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, + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=16 || 14 >=14.17" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/@typescript-eslint/typescript-estree/node_modules/slash": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", + "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/@typescript-eslint/utils": { + "version": "7.16.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-7.16.1.tgz", + "integrity": "sha512-WrFM8nzCowV0he0RlkotGDujx78xudsxnGMBHI88l5J8wEhED6yBwaSLP99ygfrzAjsQvcYQ94quDwI0d7E1fA==", + "dev": true, + "dependencies": { + "@eslint-community/eslint-utils": "^4.4.0", + "@typescript-eslint/scope-manager": "7.16.1", + "@typescript-eslint/types": "7.16.1", + "@typescript-eslint/typescript-estree": "7.16.1" + }, + "engines": { + "node": "^18.18.0 || >=20.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "eslint": "^8.56.0" + } + }, + "node_modules/@typescript-eslint/visitor-keys": { + "version": "7.16.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-7.16.1.tgz", + "integrity": "sha512-Qlzzx4sE4u3FsHTPQAAQFJFNOuqtuY0LFrZHwQ8IHK705XxBiWOFkfKRWu6niB7hwfgnwIpO4jTC75ozW1PHWg==", + "dev": true, + "dependencies": { + "@typescript-eslint/types": "7.16.1", + "eslint-visitor-keys": "^3.4.3" + }, + "engines": { + "node": "^18.18.0 || >=20.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + } + }, + "node_modules/@typespec/compiler": { + "version": "0.58.1", + "resolved": "https://registry.npmjs.org/@typespec/compiler/-/compiler-0.58.1.tgz", + "integrity": "sha512-bVxxM35r40OtuL4+/9W/g1EevlnWnW6i151nsZAFOJj1xWHoE2G9zkx5/Feic8OlzArjhGGLJOLH3Ez1Wrw35A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/code-frame": "~7.24.7", + "ajv": "~8.16.0", + "change-case": "~5.4.4", + "globby": "~14.0.2", + "mustache": "~4.2.0", + "picocolors": "~1.0.1", + "prettier": "~3.3.2", + "prompts": "~2.4.2", + "semver": "^7.6.2", + "temporal-polyfill": "^0.2.5", + "vscode-languageserver": "~9.0.1", + "vscode-languageserver-textdocument": "~1.0.11", + "yaml": "~2.4.5", + "yargs": "~17.7.2" + }, + "bin": { + "tsp": "cmd/tsp.js", + "tsp-server": "cmd/tsp-server.js" + }, + "engines": { + "node": ">=18.0.0" + } + }, + "node_modules/@typespec/compiler/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, + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/@typespec/compiler/node_modules/cliui": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz", + "integrity": "sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==", + "dev": true, + "dependencies": { + "string-width": "^4.2.0", + "strip-ansi": "^6.0.1", + "wrap-ansi": "^7.0.0" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/@typespec/compiler/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, + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/@typespec/compiler/node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", "dev": true }, - "node_modules/@sinclair/typebox": { - "version": "0.27.8", - "resolved": "https://registry.npmjs.org/@sinclair/typebox/-/typebox-0.27.8.tgz", - "integrity": "sha512-+Fj43pSMwJs4KRrH/938Uf+uAELIgVBmQzg/q1YG10djyfA3TnrU8N8XzqCh/okZdszqBQTZf96idMfE5lnwTA==", + "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/@typespec/compiler/node_modules/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, + "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/@typespec/compiler/node_modules/y18n": { + "version": "5.0.8", + "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz", + "integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==", + "dev": true, + "engines": { + "node": ">=10" + } + }, + "node_modules/@typespec/compiler/node_modules/yargs": { + "version": "17.7.2", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-17.7.2.tgz", + "integrity": "sha512-7dSzzRQ++CKnNI/krKnYRV7JKKPUXMEh61soaHKg9mrWEhzFWhFnxPxGl+69cD1Ou63C13NUPCnmIcrvqCuM6w==", + "dev": true, + "dependencies": { + "cliui": "^8.0.1", + "escalade": "^3.1.1", + "get-caller-file": "^2.0.5", + "require-directory": "^2.1.1", + "string-width": "^4.2.3", + "y18n": "^5.0.5", + "yargs-parser": "^21.1.1" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/@typespec/compiler/node_modules/yargs-parser": { + "version": "21.1.1", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz", + "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==", + "dev": true, + "engines": { + "node": ">=12" + } + }, + "node_modules/@typespec/http": { + "version": "0.58.0", + "resolved": "https://registry.npmjs.org/@typespec/http/-/http-0.58.0.tgz", + "integrity": "sha512-jQpkugg9AZVrNDMkDIgZRpIoRkkU2b0LtKWqMGg33MItYj9/DYSgDtY7xb7oCBppRtFFZ/h138HyhYl3zQxZRg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=18.0.0" + }, + "peerDependencies": { + "@typespec/compiler": "~0.58.0" + } + }, + "node_modules/@typespec/openapi": { + "version": "0.58.0", + "resolved": "https://registry.npmjs.org/@typespec/openapi/-/openapi-0.58.0.tgz", + "integrity": "sha512-gu6nXfmpfZrfq8Etpgl1dpMfsXii7EzQyhZgsPhIy7ZwV5bDmFk1/oyhTqIpWrnr4pD3r151T2BQjzJefjf15A==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=18.0.0" + }, + "peerDependencies": { + "@typespec/compiler": "~0.58.0", + "@typespec/http": "~0.58.0" + } + }, + "node_modules/@typespec/openapi3": { + "version": "0.58.0", + "resolved": "https://registry.npmjs.org/@typespec/openapi3/-/openapi3-0.58.0.tgz", + "integrity": "sha512-G9t9CWT9cN6ip39dLZaE6JdEDxGsFyOUxA2s6a087rweoTH85XzsFiQL7uiUD8vHhXyEo6tF6sy3LMZVN0BsoQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@readme/openapi-parser": "~2.6.0", + "yaml": "~2.4.5" + }, + "bin": { + "tsp-openapi3": "cmd/tsp-openapi3.js" + }, + "engines": { + "node": ">=18.0.0" + }, + "peerDependencies": { + "@typespec/compiler": "~0.58.0", + "@typespec/http": "~0.58.0", + "@typespec/openapi": "~0.58.0", + "@typespec/versioning": "~0.58.0" + } + }, + "node_modules/@typespec/prettier-plugin-typespec": { + "version": "0.57.0", + "resolved": "https://registry.npmjs.org/@typespec/prettier-plugin-typespec/-/prettier-plugin-typespec-0.57.0.tgz", + "integrity": "sha512-nWrgv/yPGYfE4FL6ON3BpYZnvCdZYvE6yrgcr/ifqZnMBJfCLl4sk+tk3JoVysj6kTTWaFME7GQ/X/guMvbjUA==", + "dev": true, + "dependencies": { + "prettier": "~3.2.5" + } + }, + "node_modules/@typespec/rest": { + "version": "0.58.0", + "resolved": "https://registry.npmjs.org/@typespec/rest/-/rest-0.58.0.tgz", + "integrity": "sha512-QBxkED0/KQKG22pwzis0n7BY+uLMSZZPSoVe/ESBFika9n5/yyeQ0l58xbFFwwfxAxe4xwuZ5PNwTdEXZbzr5g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=18.0.0" + }, + "peerDependencies": { + "@typespec/compiler": "~0.58.0", + "@typespec/http": "~0.58.0" + } + }, + "node_modules/@typespec/versioning": { + "version": "0.58.0", + "resolved": "https://registry.npmjs.org/@typespec/versioning/-/versioning-0.58.0.tgz", + "integrity": "sha512-brnQQ3wKWh4AbgqmnVLj+8zyOaDk9VPWg4QBecdQxzz7PrSrlAzIzRfeIyr67+hwi/0SvkTAB6GNH7YYTypKGA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=18.0.0" + }, + "peerDependencies": { + "@typespec/compiler": "~0.58.0" + } + }, + "node_modules/@ungap/structured-clone": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/@ungap/structured-clone/-/structured-clone-1.2.0.tgz", + "integrity": "sha512-zuVdFrMJiuCDQUMCzQaD6KL28MjnqqN8XnAqiEq9PNm/hCPTSGfrXCOfwj1ow4LFb/tNymJPwsNbVePc1xFqrQ==", "dev": true }, - "node_modules/@sindresorhus/merge-streams": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/@sindresorhus/merge-streams/-/merge-streams-2.3.0.tgz", - "integrity": "sha512-LtoMMhxAlorcGhmFYI+LhPgbPZCkgP6ra1YL604EeF6U98pLlQ3iWIGMdWSC+vWmPBWBNgmDBAhnAobLROJmwg==", + "node_modules/@vitest/expect": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-1.6.0.tgz", + "integrity": "sha512-ixEvFVQjycy/oNgHjqsL6AZCDduC+tflRluaHIzKIsdbzkLn2U/iBnVeJwB6HsIjQBdfMR8Z0tRxKUsvFJEeWQ==", "dev": true, + "dependencies": { + "@vitest/spy": "1.6.0", + "@vitest/utils": "1.6.0", + "chai": "^4.3.10" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/runner": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-1.6.0.tgz", + "integrity": "sha512-P4xgwPjwesuBiHisAVz/LSSZtDjOTPYZVmNAnpHHSR6ONrf8eCJOFRvUwdHn30F5M1fxhqtl7QZQUk2dprIXAg==", + "dev": true, + "dependencies": { + "@vitest/utils": "1.6.0", + "p-limit": "^5.0.0", + "pathe": "^1.1.1" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/runner/node_modules/p-limit": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-5.0.0.tgz", + "integrity": "sha512-/Eaoq+QyLSiXQ4lyYV23f14mZRQcXnxfHrN0vCai+ak9G0pp9iEQukIIZq5NccEvwRB8PUnZT0KsOoDCINS1qQ==", + "dev": true, + "dependencies": { + "yocto-queue": "^1.0.0" + }, "engines": { "node": ">=18" }, @@ -1772,1261 +3564,1457 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/@ts-common/add-position": { - "version": "0.0.2", - "resolved": "https://registry.npmjs.org/@ts-common/add-position/-/add-position-0.0.2.tgz", - "integrity": "sha512-ENfIN5410jyxqXbQZXmj1ifFPjnhXOuJdQjglDXhLR8vyD74PTUz277BN9Voua2DKeOjlAnyBK7ml1ciMsBqhw==", + "node_modules/@vitest/snapshot": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-1.6.0.tgz", + "integrity": "sha512-+Hx43f8Chus+DCmygqqfetcAZrDJwvTj0ymqjQq4CvmpKFSTVteEOBzCusu1x2tt4OJcvBflyHUE0DZSLgEMtQ==", "dev": true, "dependencies": { - "@ts-common/iterator": "^0.3.5" + "magic-string": "^0.30.5", + "pathe": "^1.1.1", + "pretty-format": "^29.7.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" } }, - "node_modules/@ts-common/add-position/node_modules/@ts-common/iterator": { - "version": "0.3.6", - "resolved": "https://registry.npmjs.org/@ts-common/iterator/-/iterator-0.3.6.tgz", - "integrity": "sha512-nNdcleTj3qLlchH17HI/xqOc6sNgOqJ5DdRR0nOEVdJVZCo5bfqoQTu6+Q9ZwMhuETuR2d86MSlmaL2FVHnPjQ==", - "dev": true + "node_modules/@vitest/spy": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-1.6.0.tgz", + "integrity": "sha512-leUTap6B/cqi/bQkXUu6bQV5TZPx7pmMBKBQiI0rJA8c3pB56ZsaTbREnF7CJfmvAS4V2cXIBAh/3rVwrrCYgw==", + "dev": true, + "dependencies": { + "tinyspy": "^2.2.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } }, - "node_modules/@ts-common/async-iterator": { - "version": "0.2.3", - "resolved": "https://registry.npmjs.org/@ts-common/async-iterator/-/async-iterator-0.2.3.tgz", - "integrity": "sha512-szLdrutwQxBCIECaO2RTFcUPFj+9QVk4xKAj+APgeeLoEs67tNjXFgvfU0kOfF04qTHlPNPqcutSqxMHqzG3qA==", + "node_modules/@vitest/utils": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-1.6.0.tgz", + "integrity": "sha512-21cPiuGMoMZwiOHa2i4LXkMkMkCGzA+MVFV70jRwHo95dL4x/ts5GZhML1QWuy7yfp3WzK3lRvZi3JnXTYqrBw==", + "dev": true, + "dependencies": { + "diff-sequences": "^29.6.3", + "estree-walker": "^3.0.3", + "loupe": "^2.3.7", + "pretty-format": "^29.7.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/abort-controller": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/abort-controller/-/abort-controller-3.0.0.tgz", + "integrity": "sha512-h8lQ8tacZYnR3vNQTgibj+tODHI5/+l06Au2Pcriv/Gmet0eaj4TwWH41sO9wnHDiQsEj19q0drzdWdeAHtweg==", + "dev": true, + "dependencies": { + "event-target-shim": "^5.0.0" + }, + "engines": { + "node": ">=6.5" + } + }, + "node_modules/acorn": { + "version": "8.12.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.12.0.tgz", + "integrity": "sha512-RTvkC4w+KNXrM39/lWCUaG0IbRkWdCv7W/IOW9oU6SawyxulvkQy5HQPVTKxEjczcUvapcrw3cFx/60VN/NRNw==", "dev": true, - "dependencies": { - "@ts-common/iterator": "^0.3.6", - "tslib": "^1.10.0" + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" } }, - "node_modules/@ts-common/async-iterator/node_modules/@ts-common/iterator": { - "version": "0.3.6", - "resolved": "https://registry.npmjs.org/@ts-common/iterator/-/iterator-0.3.6.tgz", - "integrity": "sha512-nNdcleTj3qLlchH17HI/xqOc6sNgOqJ5DdRR0nOEVdJVZCo5bfqoQTu6+Q9ZwMhuETuR2d86MSlmaL2FVHnPjQ==", - "dev": true - }, - "node_modules/@ts-common/async-iterator/node_modules/tslib": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", - "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", - "dev": true + "node_modules/acorn-jsx": { + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.2.tgz", + "integrity": "sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==", + "dev": true, + "peerDependencies": { + "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" + } }, - "node_modules/@ts-common/commonmark-to-markdown": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/@ts-common/commonmark-to-markdown/-/commonmark-to-markdown-2.0.2.tgz", - "integrity": "sha512-gLUxc7phOvWiDavHDshU3JGxKsepSCYAuXpMVxU0j6MDah2EbV3y0UA4x1wHkWmlf7bVuDLcnsiYQttqEX1zQw==", + "node_modules/acorn-walk": { + "version": "8.3.3", + "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.3.3.tgz", + "integrity": "sha512-MxXdReSRhGO7VlFe1bRG/oI7/mdLV9B9JJT0N8vZOhF7gFRR5l3M8W9G8JxmKV+JC5mGqJ0QvqfSOLsCPa4nUw==", "dev": true, "dependencies": { - "@ts-common/iterator": "^1.1.1", - "@types/commonmark": "^0.27.3", - "commonmark": "^0.28.1", - "front-matter": "^4.0.2" + "acorn": "^8.11.0" + }, + "engines": { + "node": ">=0.4.0" } }, - "node_modules/@ts-common/commonmark-to-markdown/node_modules/commonmark": { - "version": "0.28.1", - "resolved": "https://registry.npmjs.org/commonmark/-/commonmark-0.28.1.tgz", - "integrity": "sha512-PklsZ9pgrfFQ5hQH9BRzoWnqI9db2LeR9MhvkNk8iz97kfaTNmhTU+IE8jKDHTEfivZZXoFqzGqzddXdk14EJw==", + "node_modules/agent-base": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-7.1.1.tgz", + "integrity": "sha512-H0TSyFNDMomMNJQBn8wFV5YC/2eJ+VXECwOadZJT554xP6cODZHPX3H9QMQECxvrgiSOP1pHjy1sMWQVYJOUOA==", "dev": true, "dependencies": { - "entities": "~ 1.1.1", - "mdurl": "~ 1.0.1", - "minimist": "~ 1.2.0", - "string.prototype.repeat": "^0.2.0" - }, - "bin": { - "commonmark": "bin/commonmark" + "debug": "^4.3.4" }, "engines": { - "node": "*" + "node": ">= 14" } }, - "node_modules/@ts-common/commonmark-to-markdown/node_modules/entities": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/entities/-/entities-1.1.2.tgz", - "integrity": "sha512-f2LZMYl1Fzu7YSBKg+RoROelpOaNrcGmE9AZubeDfrCEia483oW4MI4VyFd5VNHIgQ/7qm1I0wUHK1eJnn2y2w==", - "dev": true - }, - "node_modules/@ts-common/fs": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/@ts-common/fs/-/fs-0.2.0.tgz", - "integrity": "sha512-ul1v4ZatcHuAzrwr/hGjSbk37pnfnLYDWC1yMEynQlnV8ndAcIVNYwQPPOYtLADPKTi3y74g5Q4BF3xPurDHLA==", + "node_modules/ajv": { + "version": "8.16.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.16.0.tgz", + "integrity": "sha512-F0twR8U1ZU67JIEtekUcLkXkoO5mMMmgGD8sK/xUFzJ805jxHQl92hImFAqqXMyMYjSPOyUPAwHYhB72g5sTXw==", "dev": true, + "license": "MIT", "dependencies": { - "@ts-common/async-iterator": "^0.2.0", - "@types/node": "^10.12.18", - "tslib": "^1.9.3" + "fast-deep-equal": "^3.1.3", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2", + "uri-js": "^4.4.1" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" } }, - "node_modules/@ts-common/fs/node_modules/tslib": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", - "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", - "dev": true - }, - "node_modules/@ts-common/iterator": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/@ts-common/iterator/-/iterator-1.1.2.tgz", - "integrity": "sha512-edwrL2/efx3uphxuSEI7fCHJENFmTg+gR7TY8ruTRxNWIWc240YSg+v4T3qVAtgG8npwRC4QtQDu72hi8mrR5A==", + "node_modules/ajv-draft-04": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/ajv-draft-04/-/ajv-draft-04-1.0.0.tgz", + "integrity": "sha512-mv00Te6nmYbRp5DCwclxtt7yV/joXJPGS7nM+97GdxvuttCOfgI3K4U25zboyeX0O+myI8ERluxQe5wljMmVIw==", "dev": true, + "license": "MIT", "peerDependencies": { - "tslib": "^2.3.1" + "ajv": "^8.5.0" + }, + "peerDependenciesMeta": { + "ajv": { + "optional": true + } } }, - "node_modules/@ts-common/json": { - "version": "0.3.1", - "resolved": "https://registry.npmjs.org/@ts-common/json/-/json-0.3.1.tgz", - "integrity": "sha512-vaplNdZPdeWr4p+hLJGdn08UMTSgYQrlRtxrAS0fAWyMlmFalBm/XRhHnohgiflRaj2jxl7ZxihjNlC/LZ/1YQ==", + "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, - "dependencies": { - "@ts-common/iterator": "^0.3.1", - "@ts-common/string-map": "^0.3.0" + "engines": { + "node": ">=8" } }, - "node_modules/@ts-common/json-parser": { - "version": "0.9.0", - "resolved": "https://registry.npmjs.org/@ts-common/json-parser/-/json-parser-0.9.0.tgz", - "integrity": "sha512-how0z/Ak7Bay+feIYfJFVV8UMw8Ky2Czoo5XwN7QigCOlN4HyW6wSNup4zrZ7t6NUB0002tW/+IOKCH2lAVJOg==", + "node_modules/ansi-styles": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", + "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", "dev": true, "dependencies": { - "@ts-common/add-position": "0.0.2", - "@ts-common/iterator": "^0.3.5", - "@ts-common/json": "^0.3.1", - "@ts-common/source-map": "^0.5.0", - "@ts-common/string-map": "^0.3.0", - "tslib": "^1.9.3" + "color-convert": "^1.9.0" + }, + "engines": { + "node": ">=4" } }, - "node_modules/@ts-common/json-parser/node_modules/@ts-common/iterator": { - "version": "0.3.6", - "resolved": "https://registry.npmjs.org/@ts-common/iterator/-/iterator-0.3.6.tgz", - "integrity": "sha512-nNdcleTj3qLlchH17HI/xqOc6sNgOqJ5DdRR0nOEVdJVZCo5bfqoQTu6+Q9ZwMhuETuR2d86MSlmaL2FVHnPjQ==", - "dev": true - }, - "node_modules/@ts-common/json-parser/node_modules/tslib": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", - "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", - "dev": true - }, - "node_modules/@ts-common/json/node_modules/@ts-common/iterator": { - "version": "0.3.6", - "resolved": "https://registry.npmjs.org/@ts-common/iterator/-/iterator-0.3.6.tgz", - "integrity": "sha512-nNdcleTj3qLlchH17HI/xqOc6sNgOqJ5DdRR0nOEVdJVZCo5bfqoQTu6+Q9ZwMhuETuR2d86MSlmaL2FVHnPjQ==", - "dev": true + "node_modules/argparse": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", + "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", + "dev": true, + "dependencies": { + "sprintf-js": "~1.0.2" + } }, - "node_modules/@ts-common/property-set": { - "version": "0.1.0", - "resolved": "https://registry.npmjs.org/@ts-common/property-set/-/property-set-0.1.0.tgz", - "integrity": "sha512-Mw/CPiksQI/Tvp8/bmne6ZYmOcgHuMOrflairbzdpfgMz7lrINFu8PyDQw6yTnIASeZR4yW0xljb66gCE4Jj0w==", - "dev": true + "node_modules/array-union": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz", + "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==", + "dev": true, + "engines": { + "node": ">=8" + } }, - "node_modules/@ts-common/source-map": { - "version": "0.5.0", - "resolved": "https://registry.npmjs.org/@ts-common/source-map/-/source-map-0.5.0.tgz", - "integrity": "sha512-aKFWvuN5uALt+hUtkPA4gHjtloDy2qHW1FB1r758KCTI0h0lP3dNJGcfwg7NnmD0qKQiZAY/J73/NYrbuTfT3A==", + "node_modules/asn1": { + "version": "0.2.6", + "resolved": "https://registry.npmjs.org/asn1/-/asn1-0.2.6.tgz", + "integrity": "sha512-ix/FxPn0MDjeyJ7i/yoHGFt/EX6LyNbxSEhPPXODPL+KB0VPk86UYfL0lMdy+KCnv+fmvIzySwaK5COwqVbWTQ==", "dev": true, "dependencies": { - "@ts-common/iterator": "^0.3.0", - "@ts-common/json": "^0.3.0", - "@ts-common/property-set": "^0.1.0", - "@ts-common/string-map": "^0.3.0" + "safer-buffer": "~2.1.0" } }, - "node_modules/@ts-common/source-map/node_modules/@ts-common/iterator": { - "version": "0.3.6", - "resolved": "https://registry.npmjs.org/@ts-common/iterator/-/iterator-0.3.6.tgz", - "integrity": "sha512-nNdcleTj3qLlchH17HI/xqOc6sNgOqJ5DdRR0nOEVdJVZCo5bfqoQTu6+Q9ZwMhuETuR2d86MSlmaL2FVHnPjQ==", - "dev": true + "node_modules/assert-plus": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/assert-plus/-/assert-plus-1.0.0.tgz", + "integrity": "sha512-NfJ4UzBCcQGLDlQq7nHxH+tv3kyZ0hHQqF5BO6J7tNJeP5do1llPr8dZ8zHonfhAu0PHAdMkSo+8o0wxg9lZWw==", + "dev": true, + "engines": { + "node": ">=0.8" + } }, - "node_modules/@ts-common/string-map": { - "version": "0.3.0", - "resolved": "https://registry.npmjs.org/@ts-common/string-map/-/string-map-0.3.0.tgz", - "integrity": "sha512-tikHtQPV/R48VAnlolyl1FIHciror68LXyruelvYf+lRE6ysjIGB2iNyw7wN6aDcUs2wN/CD6fF8Ye7lVIWNTQ==", + "node_modules/assertion-error": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/assertion-error/-/assertion-error-1.1.0.tgz", + "integrity": "sha512-jgsaNduz+ndvGyFt3uSuWqvy4lCnIJiovtouQN5JZHOKCS2QuhEdbcQHFhVksz2N2U9hXJo8odG7ETyWlEeuDw==", "dev": true, - "dependencies": { - "@ts-common/iterator": "^0.3.0" + "engines": { + "node": "*" } }, - "node_modules/@ts-common/string-map/node_modules/@ts-common/iterator": { - "version": "0.3.6", - "resolved": "https://registry.npmjs.org/@ts-common/iterator/-/iterator-0.3.6.tgz", - "integrity": "sha512-nNdcleTj3qLlchH17HI/xqOc6sNgOqJ5DdRR0nOEVdJVZCo5bfqoQTu6+Q9ZwMhuETuR2d86MSlmaL2FVHnPjQ==", + "node_modules/async": { + "version": "3.2.5", + "resolved": "https://registry.npmjs.org/async/-/async-3.2.5.tgz", + "integrity": "sha512-baNZyqaaLhyLVKm/DlvdW051MSgO6b8eVfIezl9E5PqWxFgzLm/wQntEW4zOytVburDEr0JlALEpdOFwvErLsg==", "dev": true }, - "node_modules/@ts-common/virtual-fs": { - "version": "0.3.0", - "resolved": "https://registry.npmjs.org/@ts-common/virtual-fs/-/virtual-fs-0.3.0.tgz", - "integrity": "sha512-ryoXw52FTLhiexoNBA/hcAlW8gxPhrKEuZODgpCiF0wswNJdg/j+rCb9k1VppJdeIJ30b0Wg+2vPsrOrdnYTIw==", + "node_modules/async-retry": { + "version": "1.3.3", + "resolved": "https://registry.npmjs.org/async-retry/-/async-retry-1.3.3.tgz", + "integrity": "sha512-wfr/jstw9xNi/0teMHrRW7dsz3Lt5ARhYNZ2ewpadnhaIp5mbALhOAP+EAdsC7t4Z6wqsDVv9+W6gm1Dk9mEyw==", "dev": true, "dependencies": { - "@ts-common/fs": "^0.2.0", - "@ts-common/iterator": "^0.3.0", - "@types/async-retry": "^1.4.1", - "@types/node-fetch": "^2.5.5", - "async-retry": "^1.3.1", - "node-fetch": "^2.6.0" + "retry": "0.13.1" } }, - "node_modules/@ts-common/virtual-fs/node_modules/@ts-common/iterator": { - "version": "0.3.6", - "resolved": "https://registry.npmjs.org/@ts-common/iterator/-/iterator-0.3.6.tgz", - "integrity": "sha512-nNdcleTj3qLlchH17HI/xqOc6sNgOqJ5DdRR0nOEVdJVZCo5bfqoQTu6+Q9ZwMhuETuR2d86MSlmaL2FVHnPjQ==", + "node_modules/asynckit": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", + "integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==", "dev": true }, - "node_modules/@ts-common/virtual-fs/node_modules/node-fetch": { - "version": "2.7.0", - "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", - "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", + "node_modules/autorest": { + "version": "3.7.1", + "resolved": "https://registry.npmjs.org/autorest/-/autorest-3.7.1.tgz", + "integrity": "sha512-6q17NtosQZPqBkIOUnaOPedf3PDIBF7Ha1iEGRhTqZF6TG2Q/1E3ID/D+ePIIzZDKvW01p/2pENq/oiBWH9IGQ==", "dev": true, - "dependencies": { - "whatwg-url": "^5.0.0" + "hasInstallScript": true, + "bin": { + "autorest": "entrypoints/app.js" }, "engines": { - "node": "4.x || >=6.0.0" - }, - "peerDependencies": { - "encoding": "^0.1.0" - }, - "peerDependenciesMeta": { - "encoding": { - "optional": true - } + "node": ">=12.0.0" } }, - "node_modules/@types/async-retry": { - "version": "1.4.8", - "resolved": "https://registry.npmjs.org/@types/async-retry/-/async-retry-1.4.8.tgz", - "integrity": "sha512-Qup/B5PWLe86yI5I3av6ePGaeQrIHNKCwbsQotD6aHQ6YkHsMUxVZkZsmx/Ry3VZQ6uysHwTjQ7666+k6UjVJA==", + "node_modules/aws-sign2": { + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/aws-sign2/-/aws-sign2-0.7.0.tgz", + "integrity": "sha512-08kcGqnYf/YmjoRhfxyu+CLxBjUtHLXLXX/vUfx9l2LYzG3c1m61nrpyFUZI6zeS+Li/wWMMidD9KgrqtGq3mA==", "dev": true, - "dependencies": { - "@types/retry": "*" + "engines": { + "node": "*" } }, - "node_modules/@types/commonmark": { - "version": "0.27.9", - "resolved": "https://registry.npmjs.org/@types/commonmark/-/commonmark-0.27.9.tgz", - "integrity": "sha512-d3+57WgyPCcIc6oshmcPkmP4+JqRRot9eeZLsBsutWtIxwWivpoyc2wEcolOp8MyO3ZWN846mMdoR02kdHSMCw==", + "node_modules/aws4": { + "version": "1.13.0", + "resolved": "https://registry.npmjs.org/aws4/-/aws4-1.13.0.tgz", + "integrity": "sha512-3AungXC4I8kKsS9PuS4JH2nc+0bVY/mjgrephHTIi8fpEeGsTHBUJeosp0Wc1myYMElmD0B3Oc4XL/HVJ4PV2g==", "dev": true }, - "node_modules/@types/estree": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.5.tgz", - "integrity": "sha512-/kYRxGDLWzHOB7q+wtSUQlFrtcdUccpfy+X+9iMBpHK8QLLhx2wIPYuS5DYtR9Wa/YlZAbIovy7qVdB1Aq6Lyw==", - "dev": true + "node_modules/azure-rest-api-specs-eng-tools": { + "resolved": "eng/tools", + "link": true }, - "node_modules/@types/json-schema": { - "version": "7.0.15", - "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", - "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==", + "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 }, - "node_modules/@types/node": { - "version": "10.17.60", - "resolved": "https://registry.npmjs.org/@types/node/-/node-10.17.60.tgz", - "integrity": "sha512-F0KIgDJfy2nA3zMLmWGKxcH2ZVEtCZXHHdOQs2gSaQ27+lNeEfGxzkIw90aXswATX7AZ33tahPbzy6KAfUreVw==", - "dev": true + "node_modules/base64-js": { + "version": "1.5.1", + "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz", + "integrity": "sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ] }, - "node_modules/@types/node-fetch": { - "version": "2.6.11", - "resolved": "https://registry.npmjs.org/@types/node-fetch/-/node-fetch-2.6.11.tgz", - "integrity": "sha512-24xFj9R5+rfQJLRyM56qh+wnVSYhyXC2tkoBndtY0U+vubqNsYXGjufB2nn8Q6gt0LrARwL6UBtMCSVCwl4B1g==", + "node_modules/bcrypt-pbkdf": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/bcrypt-pbkdf/-/bcrypt-pbkdf-1.0.2.tgz", + "integrity": "sha512-qeFIXtP4MSoi6NLqO12WfqARWWuCKi2Rn/9hJLEmtB5yTNr9DqFWkJRCf2qShWzPeAMRnOgCrq0sg/KLv5ES9w==", "dev": true, "dependencies": { - "@types/node": "*", - "form-data": "^4.0.0" + "tweetnacl": "^0.14.3" } }, - "node_modules/@types/retry": { - "version": "0.12.5", - "resolved": "https://registry.npmjs.org/@types/retry/-/retry-0.12.5.tgz", - "integrity": "sha512-3xSjTp3v03X/lSQLkczaN9UIEwJMoMCA1+Nb5HfbJEQWogdeQIyVtTvxPXDQjZ5zws8rFQfVfRdz03ARihPJgw==", + "node_modules/bluebird": { + "version": "2.11.0", + "resolved": "https://registry.npmjs.org/bluebird/-/bluebird-2.11.0.tgz", + "integrity": "sha512-UfFSr22dmHPQqPP9XWHRhq+gWnHCYguQGkXQlbyPtW5qTnhFWA8/iXg765tH0cAjy7l/zPJ1aBTO0g5XgA7kvQ==", "dev": true }, - "node_modules/@types/triple-beam": { - "version": "1.3.5", - "resolved": "https://registry.npmjs.org/@types/triple-beam/-/triple-beam-1.3.5.tgz", - "integrity": "sha512-6WaYesThRMCl19iryMYP7/x2OVgCtbIVflDGFpWnb9irXI3UjYE4AzmYuiUKY1AJstGijoY+MgUszMgRxIYTYw==", - "dev": true + "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, + "dependencies": { + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" + } }, - "node_modules/@types/tunnel": { - "version": "0.0.3", - "resolved": "https://registry.npmjs.org/@types/tunnel/-/tunnel-0.0.3.tgz", - "integrity": "sha512-sOUTGn6h1SfQ+gbgqC364jLFBw2lnFqkgF3q0WovEHRLMrVD1sd5aufqi/aJObLekJO+Aq5z646U4Oxy6shXMA==", + "node_modules/braces": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", + "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", "dev": true, "dependencies": { - "@types/node": "*" + "fill-range": "^7.1.1" + }, + "engines": { + "node": ">=8" } }, - "node_modules/@typespec/compiler": { - "version": "0.57.0", - "resolved": "https://registry.npmjs.org/@typespec/compiler/-/compiler-0.57.0.tgz", - "integrity": "sha512-Z5L7J90Ol21IbzU+rBD2wzKy2vJ2Yg2FIzi+yB5rtb7/c4oBea/CgEByMVHBtT7uw45ZXJpHOiepuGSPVXw2EA==", + "node_modules/brotli": { + "version": "1.3.3", + "resolved": "https://registry.npmjs.org/brotli/-/brotli-1.3.3.tgz", + "integrity": "sha512-oTKjJdShmDuGW94SyyaoQvAjf30dZaHnjJ8uAF+u2/vGJkJbJPJAT1gDiOJP5v1Zb6f9KEyW/1HpuaWIXtGHPg==", "dev": true, "dependencies": { - "@babel/code-frame": "~7.24.2", - "ajv": "~8.13.0", - "change-case": "~5.4.4", - "globby": "~14.0.1", - "mustache": "~4.2.0", - "picocolors": "~1.0.1", - "prettier": "~3.2.5", - "prompts": "~2.4.2", - "semver": "^7.6.2", - "vscode-languageserver": "~9.0.1", - "vscode-languageserver-textdocument": "~1.0.11", - "yaml": "~2.4.2", - "yargs": "~17.7.2" + "base64-js": "^1.1.2" + } + }, + "node_modules/browserslist": { + "version": "4.23.2", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.23.2.tgz", + "integrity": "sha512-qkqSyistMYdxAcw+CzbZwlBy8AGmS/eEWs+sEV5TnLRGDOL+C5M2EnH6tlZyg0YoAxGJAFKh61En9BR941GnHA==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/browserslist" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "dependencies": { + "caniuse-lite": "^1.0.30001640", + "electron-to-chromium": "^1.4.820", + "node-releases": "^2.0.14", + "update-browserslist-db": "^1.1.0" }, "bin": { - "tsp": "cmd/tsp.js", - "tsp-server": "cmd/tsp-server.js" + "browserslist": "cli.js" }, "engines": { - "node": ">=18.0.0" + "node": "^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || >=13.7" } }, - "node_modules/@typespec/compiler/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==", + "node_modules/builtin-modules": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/builtin-modules/-/builtin-modules-3.3.0.tgz", + "integrity": "sha512-zhaCDicdLuWN5UbN5IMnFqNMhNfo919sH85y2/ea+5Yg9TsTkeZxpL+JLbp6cgYFS4sRLp3YV4S6yDuqVWHYOw==", "dev": true, - "dependencies": { - "color-convert": "^2.0.1" - }, "engines": { - "node": ">=8" + "node": ">=6" }, "funding": { - "url": "https://github.com/chalk/ansi-styles?sponsor=1" + "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/@typespec/compiler/node_modules/cliui": { - "version": "8.0.1", - "resolved": "https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz", - "integrity": "sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==", + "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, + "engines": { + "node": ">=8" + } + }, + "node_modules/call-me-maybe": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/call-me-maybe/-/call-me-maybe-1.0.2.tgz", + "integrity": "sha512-HpX65o1Hnr9HH25ojC1YGs7HCQLq0GCOibSaWER0eNpgJ/Z1MZv2mTc7+xh6WOPxbRVcmgbv4hGU+uSQ/2xFZQ==", + "dev": true + }, + "node_modules/callsites": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", + "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/camelcase": { + "version": "5.3.1", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-5.3.1.tgz", + "integrity": "sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/caniuse-lite": { + "version": "1.0.30001642", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001642.tgz", + "integrity": "sha512-3XQ0DoRgLijXJErLSl+bLnJ+Et4KqV1PY6JJBGAFlsNsz31zeAIncyeZfLCabHK/jtSh+671RM9YMldxjUPZtA==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/caniuse-lite" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ] + }, + "node_modules/caseless": { + "version": "0.12.0", + "resolved": "https://registry.npmjs.org/caseless/-/caseless-0.12.0.tgz", + "integrity": "sha512-4tYFyifaFfGacoiObjJegolkwSU4xQNGbVgUiNYVUxbQ2x2lUsFvY4hVgVzGiIe6WLOPqycWXA40l+PWsxthUw==", + "dev": true + }, + "node_modules/chai": { + "version": "4.4.1", + "resolved": "https://registry.npmjs.org/chai/-/chai-4.4.1.tgz", + "integrity": "sha512-13sOfMv2+DWduEU+/xbun3LScLoqN17nBeTLUsmDfKdoiC1fr0n9PU4guu4AhRcOVFk/sW8LyZWHuhWtQZiF+g==", "dev": true, "dependencies": { - "string-width": "^4.2.0", - "strip-ansi": "^6.0.1", - "wrap-ansi": "^7.0.0" + "assertion-error": "^1.1.0", + "check-error": "^1.0.3", + "deep-eql": "^4.1.3", + "get-func-name": "^2.0.2", + "loupe": "^2.3.6", + "pathval": "^1.1.1", + "type-detect": "^4.0.8" }, "engines": { - "node": ">=12" + "node": ">=4" } }, - "node_modules/@typespec/compiler/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==", + "node_modules/chalk": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", + "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", "dev": true, "dependencies": { - "color-name": "~1.1.4" + "ansi-styles": "^3.2.1", + "escape-string-regexp": "^1.0.5", + "supports-color": "^5.3.0" }, "engines": { - "node": ">=7.0.0" + "node": ">=4" } }, - "node_modules/@typespec/compiler/node_modules/color-name": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", - "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "node_modules/change-case": { + "version": "5.4.4", + "resolved": "https://registry.npmjs.org/change-case/-/change-case-5.4.4.tgz", + "integrity": "sha512-HRQyTk2/YPEkt9TnUPbOpr64Uw3KOicFWPVBb+xiHvd6eBx/qPr9xqfBFDT8P2vWsvvz4jbEkfDe71W3VyNu2w==", "dev": true }, - "node_modules/@typespec/compiler/node_modules/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==", + "node_modules/change-case-all": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/change-case-all/-/change-case-all-2.1.0.tgz", + "integrity": "sha512-v6b0WWWkZUMHVuYk82l+WROgkUm4qEN2w5hKRNWtEOYwWqUGoi8C6xH0l1RLF1EoWqDFK6MFclmN3od6ws3/uw==", "dev": true, "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" + "change-case": "^5.2.0", + "sponge-case": "^2.0.2", + "swap-case": "^3.0.2", + "title-case": "^3.0.3" } }, - "node_modules/@typespec/compiler/node_modules/y18n": { - "version": "5.0.8", - "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz", - "integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==", + "node_modules/chardet": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/chardet/-/chardet-2.0.0.tgz", + "integrity": "sha512-xVgPpulCooDjY6zH4m9YW3jbkaBe3FKIAvF5sj5t7aBNsVl2ljIE+xwJ4iNgiDZHFQvNIpjdKdVOQvvk5ZfxbQ==", + "dev": true + }, + "node_modules/charset": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/charset/-/charset-1.0.1.tgz", + "integrity": "sha512-6dVyOOYjpfFcL1Y4qChrAoQLRHvj2ziyhcm0QJlhOcAhykL/k1kTUPbeo+87MNRTRdk2OIIsIXbuF3x2wi5EXg==", "dev": true, "engines": { - "node": ">=10" + "node": ">=4.0.0" } }, - "node_modules/@typespec/compiler/node_modules/yargs": { - "version": "17.7.2", - "resolved": "https://registry.npmjs.org/yargs/-/yargs-17.7.2.tgz", - "integrity": "sha512-7dSzzRQ++CKnNI/krKnYRV7JKKPUXMEh61soaHKg9mrWEhzFWhFnxPxGl+69cD1Ou63C13NUPCnmIcrvqCuM6w==", + "node_modules/check-error": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/check-error/-/check-error-1.0.3.tgz", + "integrity": "sha512-iKEoDYaRmd1mxM90a2OEfWhjsjPpYPuQ+lMYsoxB126+t8fw7ySEO48nmDg5COTjxDI65/Y2OWpeEHk3ZOe8zg==", "dev": true, "dependencies": { - "cliui": "^8.0.1", - "escalade": "^3.1.1", - "get-caller-file": "^2.0.5", - "require-directory": "^2.1.1", - "string-width": "^4.2.3", - "y18n": "^5.0.5", - "yargs-parser": "^21.1.1" + "get-func-name": "^2.0.2" }, "engines": { - "node": ">=12" + "node": "*" } }, - "node_modules/@typespec/compiler/node_modules/yargs-parser": { - "version": "21.1.1", - "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz", - "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==", + "node_modules/ci-info": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-4.0.0.tgz", + "integrity": "sha512-TdHqgGf9odd8SXNuxtUBVx8Nv+qZOejE6qyqiy5NtbYYQOeFa6zmHkxlPzmaLxWWHsU6nJmB7AETdVPi+2NBUg==", "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/sibiraj-s" + } + ], "engines": { - "node": ">=12" + "node": ">=8" } }, - "node_modules/@typespec/http": { - "version": "0.57.0", - "resolved": "https://registry.npmjs.org/@typespec/http/-/http-0.57.0.tgz", - "integrity": "sha512-k3bWOTPNqlRB3/TmrXVBtObmxj2J20l2FnhGXvs+tjdtbXLxCQWmvQz6xlne9nkLAtWVB/pQRUn+oMJfhWta3w==", + "node_modules/clean-regexp": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/clean-regexp/-/clean-regexp-1.0.0.tgz", + "integrity": "sha512-GfisEZEJvzKrmGWkvfhgzcz/BllN1USeqD2V6tg14OAOgaCD2Z/PUEuxnAZ/nPvmaHRG7a8y77p1T/IRQ4D1Hw==", "dev": true, - "engines": { - "node": ">=18.0.0" + "dependencies": { + "escape-string-regexp": "^1.0.5" }, - "peerDependencies": { - "@typespec/compiler": "~0.57.0" + "engines": { + "node": ">=4" } }, - "node_modules/@typespec/openapi": { - "version": "0.57.0", - "resolved": "https://registry.npmjs.org/@typespec/openapi/-/openapi-0.57.0.tgz", - "integrity": "sha512-35wK/BqjOXSlhWuGMwoYN3FSgIYFOKtw8ot4ErcgmxAGuKaS2GkUhZvtQJXUn2ByU0Fl4jqslPmTz8SEcz7rbw==", + "node_modules/cli-progress": { + "version": "3.12.0", + "resolved": "https://registry.npmjs.org/cli-progress/-/cli-progress-3.12.0.tgz", + "integrity": "sha512-tRkV3HJ1ASwm19THiiLIXLO7Im7wlTuKnvkYaTkyoAPefqjNg7W7DHKUlGRxy9vxDvbyCYQkQozvptuMkGCg8A==", "dev": true, - "engines": { - "node": ">=18.0.0" + "dependencies": { + "string-width": "^4.2.3" }, - "peerDependencies": { - "@typespec/compiler": "~0.57.0", - "@typespec/http": "~0.57.0" + "engines": { + "node": ">=4" } }, - "node_modules/@typespec/openapi3": { - "version": "0.57.0", - "resolved": "https://registry.npmjs.org/@typespec/openapi3/-/openapi3-0.57.0.tgz", - "integrity": "sha512-spNLzwCTduPISJBTWhqsMLTjuGC3Tdh/FVI1rTGnRunB7ZXjhRyz031o1bCe2BZeW1w1sacZGfe+ba8sXqgMxA==", + "node_modules/cli-table3": { + "version": "0.6.5", + "resolved": "https://registry.npmjs.org/cli-table3/-/cli-table3-0.6.5.tgz", + "integrity": "sha512-+W/5efTR7y5HRD7gACw9yQjqMVvEMLBHmboM/kPWam+H+Hmyrgjh6YncVKK122YZkXrLudzTuAukUw9FnMf7IQ==", "dev": true, "dependencies": { - "yaml": "~2.4.2" + "string-width": "^4.2.0" }, "engines": { - "node": ">=18.0.0" + "node": "10.* || >= 12.*" }, - "peerDependencies": { - "@typespec/compiler": "~0.57.0", - "@typespec/http": "~0.57.0", - "@typespec/openapi": "~0.57.0", - "@typespec/versioning": "~0.57.0" + "optionalDependencies": { + "@colors/colors": "1.5.0" } }, - "node_modules/@typespec/rest": { - "version": "0.57.0", - "resolved": "https://registry.npmjs.org/@typespec/rest/-/rest-0.57.0.tgz", - "integrity": "sha512-mZj76Kf+cmH38pYA6LT8Zz7QjuR3fdQo5bc8pXhKMwLq9vRqNLz6Z9InbOeo8zY+xP0GfUwEU9kXczmCc8gyRA==", + "node_modules/cliui": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/cliui/-/cliui-6.0.0.tgz", + "integrity": "sha512-t6wbgtoCXvAzst7QgXxJYqPt0usEfbgQdftEPbLL/cvv6HPE5VgvqCuAIDR0NgU52ds6rFwqrgakNLrHEjCbrQ==", "dev": true, - "engines": { - "node": ">=18.0.0" - }, - "peerDependencies": { - "@typespec/compiler": "~0.57.0", - "@typespec/http": "~0.57.0" + "dependencies": { + "string-width": "^4.2.0", + "strip-ansi": "^6.0.0", + "wrap-ansi": "^6.2.0" } }, - "node_modules/@typespec/versioning": { - "version": "0.57.0", - "resolved": "https://registry.npmjs.org/@typespec/versioning/-/versioning-0.57.0.tgz", - "integrity": "sha512-kk6zCNSwcqqYB9isNNagTy+Zv6wEIRA4NkcZ/X1riTj2zhJwKsIFNXQWm1yxpZn+BY4+1QtuaQHuBLo8HbgR/w==", + "node_modules/code-error-fragment": { + "version": "0.0.230", + "resolved": "https://registry.npmjs.org/code-error-fragment/-/code-error-fragment-0.0.230.tgz", + "integrity": "sha512-cadkfKp6932H8UkhzE/gcUqhRMNf8jHzkAN7+5Myabswaghu4xABTgPHDCjW+dBAJxj/SpkTYokpzDqY4pCzQw==", "dev": true, + "license": "MIT", "engines": { - "node": ">=18.0.0" - }, - "peerDependencies": { - "@typespec/compiler": "~0.57.0" + "node": ">= 4" } }, - "node_modules/@vitest/expect": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-1.6.0.tgz", - "integrity": "sha512-ixEvFVQjycy/oNgHjqsL6AZCDduC+tflRluaHIzKIsdbzkLn2U/iBnVeJwB6HsIjQBdfMR8Z0tRxKUsvFJEeWQ==", + "node_modules/color": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/color/-/color-3.2.1.tgz", + "integrity": "sha512-aBl7dZI9ENN6fUGC7mWpMTPNHmWUSNan9tuWN6ahh5ZLNk9baLJOnSMlrQkHcrfFgz2/RigjUVAjdx36VcemKA==", "dev": true, "dependencies": { - "@vitest/spy": "1.6.0", - "@vitest/utils": "1.6.0", - "chai": "^4.3.10" - }, - "funding": { - "url": "https://opencollective.com/vitest" + "color-convert": "^1.9.3", + "color-string": "^1.6.0" } }, - "node_modules/@vitest/runner": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-1.6.0.tgz", - "integrity": "sha512-P4xgwPjwesuBiHisAVz/LSSZtDjOTPYZVmNAnpHHSR6ONrf8eCJOFRvUwdHn30F5M1fxhqtl7QZQUk2dprIXAg==", + "node_modules/color-convert": { + "version": "1.9.3", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", + "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", "dev": true, "dependencies": { - "@vitest/utils": "1.6.0", - "p-limit": "^5.0.0", - "pathe": "^1.1.1" - }, - "funding": { - "url": "https://opencollective.com/vitest" + "color-name": "1.1.3" } }, - "node_modules/@vitest/runner/node_modules/p-limit": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-5.0.0.tgz", - "integrity": "sha512-/Eaoq+QyLSiXQ4lyYV23f14mZRQcXnxfHrN0vCai+ak9G0pp9iEQukIIZq5NccEvwRB8PUnZT0KsOoDCINS1qQ==", + "node_modules/color-name": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", + "integrity": "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw==", + "dev": true + }, + "node_modules/color-string": { + "version": "1.9.1", + "resolved": "https://registry.npmjs.org/color-string/-/color-string-1.9.1.tgz", + "integrity": "sha512-shrVawQFojnZv6xM40anx4CkoDP+fZsw/ZerEMsW/pyzsRbElpsL/DBVW7q3ExxwusdNXI3lXpuhEZkzs8p5Eg==", "dev": true, "dependencies": { - "yocto-queue": "^1.0.0" - }, + "color-name": "^1.0.0", + "simple-swizzle": "^0.2.2" + } + }, + "node_modules/colors": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.4.0.tgz", + "integrity": "sha512-a+UqTh4kgZg/SlGvfbzDHpgRu7AAQOmmqRHJnxhRZICKFUT91brVhNNt58CMWU9PsBbv3PDCZUHbVxuDiH2mtA==", + "dev": true, "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" + "node": ">=0.1.90" } }, - "node_modules/@vitest/snapshot": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-1.6.0.tgz", - "integrity": "sha512-+Hx43f8Chus+DCmygqqfetcAZrDJwvTj0ymqjQq4CvmpKFSTVteEOBzCusu1x2tt4OJcvBflyHUE0DZSLgEMtQ==", + "node_modules/colorspace": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/colorspace/-/colorspace-1.1.4.tgz", + "integrity": "sha512-BgvKJiuVu1igBUF2kEjRCZXol6wiiGbY5ipL/oVPwm0BL9sIpMIzM8IK7vwuxIIzOXMV3Ey5w+vxhm0rR/TN8w==", "dev": true, "dependencies": { - "magic-string": "^0.30.5", - "pathe": "^1.1.1", - "pretty-format": "^29.7.0" - }, - "funding": { - "url": "https://opencollective.com/vitest" + "color": "^3.1.3", + "text-hex": "1.0.x" } }, - "node_modules/@vitest/spy": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-1.6.0.tgz", - "integrity": "sha512-leUTap6B/cqi/bQkXUu6bQV5TZPx7pmMBKBQiI0rJA8c3pB56ZsaTbREnF7CJfmvAS4V2cXIBAh/3rVwrrCYgw==", + "node_modules/combined-stream": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", + "integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==", "dev": true, "dependencies": { - "tinyspy": "^2.2.0" + "delayed-stream": "~1.0.0" }, - "funding": { - "url": "https://opencollective.com/vitest" + "engines": { + "node": ">= 0.8" } }, - "node_modules/@vitest/utils": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-1.6.0.tgz", - "integrity": "sha512-21cPiuGMoMZwiOHa2i4LXkMkMkCGzA+MVFV70jRwHo95dL4x/ts5GZhML1QWuy7yfp3WzK3lRvZi3JnXTYqrBw==", + "node_modules/commander": { + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-11.1.0.tgz", + "integrity": "sha512-yPVavfyCcRhmorC7rWlkHn15b4wDVgVmBA7kV4QVBsF7kv/9TKJAbAXVTxvTnwP8HHKjRCJDClKbciiYS7p0DQ==", "dev": true, - "dependencies": { - "diff-sequences": "^29.6.3", - "estree-walker": "^3.0.3", - "loupe": "^2.3.7", - "pretty-format": "^29.7.0" - }, - "funding": { - "url": "https://opencollective.com/vitest" + "engines": { + "node": ">=16" } }, - "node_modules/abort-controller": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/abort-controller/-/abort-controller-3.0.0.tgz", - "integrity": "sha512-h8lQ8tacZYnR3vNQTgibj+tODHI5/+l06Au2Pcriv/Gmet0eaj4TwWH41sO9wnHDiQsEj19q0drzdWdeAHtweg==", + "node_modules/commonmark": { + "version": "0.29.3", + "resolved": "https://registry.npmjs.org/commonmark/-/commonmark-0.29.3.tgz", + "integrity": "sha512-fvt/NdOFKaL2gyhltSy6BC4LxbbxbnPxBMl923ittqO/JBM0wQHaoYZliE4tp26cRxX/ZZtRsJlZzQrVdUkXAA==", "dev": true, "dependencies": { - "event-target-shim": "^5.0.0" + "entities": "~2.0", + "mdurl": "~1.0.1", + "minimist": ">=1.2.2", + "string.prototype.repeat": "^0.2.0" + }, + "bin": { + "commonmark": "bin/commonmark" }, "engines": { - "node": ">=6.5" + "node": "*" } }, - "node_modules/acorn": { - "version": "8.12.0", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.12.0.tgz", - "integrity": "sha512-RTvkC4w+KNXrM39/lWCUaG0IbRkWdCv7W/IOW9oU6SawyxulvkQy5HQPVTKxEjczcUvapcrw3cFx/60VN/NRNw==", + "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 + }, + "node_modules/confbox": { + "version": "0.1.7", + "resolved": "https://registry.npmjs.org/confbox/-/confbox-0.1.7.tgz", + "integrity": "sha512-uJcB/FKZtBMCJpK8MQji6bJHgu1tixKPxRLeGkNzBoOZzpnZUJm0jm2/sBDWcuBx1dYgxV4JU+g5hmNxCyAmdA==", + "dev": true + }, + "node_modules/core-js-compat": { + "version": "3.37.1", + "resolved": "https://registry.npmjs.org/core-js-compat/-/core-js-compat-3.37.1.tgz", + "integrity": "sha512-9TNiImhKvQqSUkOvk/mMRZzOANTiEVC7WaBNhHcKM7x+/5E1l5NvsysR19zuDQScE8k+kfQXWRN3AtS/eOSHpg==", "dev": true, - "bin": { - "acorn": "bin/acorn" + "dependencies": { + "browserslist": "^4.23.0" }, - "engines": { - "node": ">=0.4.0" + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/core-js" } }, - "node_modules/acorn-walk": { - "version": "8.3.3", - "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.3.3.tgz", - "integrity": "sha512-MxXdReSRhGO7VlFe1bRG/oI7/mdLV9B9JJT0N8vZOhF7gFRR5l3M8W9G8JxmKV+JC5mGqJ0QvqfSOLsCPa4nUw==", + "node_modules/core-util-is": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz", + "integrity": "sha512-3lqz5YjWTYnW6dlDa5TLaTCcShfar1e40rmcJVwCBJC6mWlFuj0eCHIElmG1g5kyuJ/GD+8Wn4FFCcz4gJPfaQ==", + "dev": true + }, + "node_modules/cross-spawn": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", + "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", "dev": true, "dependencies": { - "acorn": "^8.11.0" + "path-key": "^3.1.0", + "shebang-command": "^2.0.0", + "which": "^2.0.1" }, "engines": { - "node": ">=0.4.0" + "node": ">= 8" } }, - "node_modules/ajv": { - "version": "8.13.0", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.13.0.tgz", - "integrity": "sha512-PRA911Blj99jR5RMeTunVbNXMF6Lp4vZXnk5GQjcnUWUTsrXtekg/pnmFFI2u/I36Y/2bITGS30GZCXei6uNkA==", + "node_modules/csv-parse": { + "version": "4.16.3", + "resolved": "https://registry.npmjs.org/csv-parse/-/csv-parse-4.16.3.tgz", + "integrity": "sha512-cO1I/zmz4w2dcKHVvpCr7JVRu8/FymG5OEpmvsZYlccYolPBLoVGKUHgNoc4ZGkFeFlWGEDmMyBM+TTqRdW/wg==", + "dev": true + }, + "node_modules/dashdash": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/dashdash/-/dashdash-1.14.1.tgz", + "integrity": "sha512-jRFi8UDGo6j+odZiEpjazZaWqEal3w/basFjQHQEwVtZJGDpxbH1MeYluwCS8Xq5wmLJooDlMgvVarmWfGM44g==", "dev": true, "dependencies": { - "fast-deep-equal": "^3.1.3", - "json-schema-traverse": "^1.0.0", - "require-from-string": "^2.0.2", - "uri-js": "^4.4.1" + "assert-plus": "^1.0.0" }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/epoberezkin" + "engines": { + "node": ">=0.10" } }, - "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==", + "node_modules/data-uri-to-buffer": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/data-uri-to-buffer/-/data-uri-to-buffer-4.0.1.tgz", + "integrity": "sha512-0R9ikRb668HB7QDxT1vkpuUBtqc53YyAwMwGeUFKRojY/NWKvdZ+9UYtRfGmhqNbRkTSVpMbmyhXipFFv2cb/A==", "dev": true, "engines": { - "node": ">=8" + "node": ">= 12" } }, - "node_modules/ansi-styles": { - "version": "3.2.1", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", - "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", + "node_modules/date-format": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/date-format/-/date-format-4.0.3.tgz", + "integrity": "sha512-7P3FyqDcfeznLZp2b+OMitV9Sz2lUnsT87WaTat9nVwqsBkTzPG3lPLNwW3en6F4pHUiWzr6vb8CLhjdK9bcxQ==", "dev": true, - "dependencies": { - "color-convert": "^1.9.0" - }, "engines": { - "node": ">=4" + "node": ">=4.0" } }, - "node_modules/argparse": { - "version": "1.0.10", - "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", - "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", + "node_modules/debug": { + "version": "4.3.5", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.5.tgz", + "integrity": "sha512-pt0bNEmneDIvdL1Xsd9oDQ/wrQRkXDT4AUWlNZNPKvW5x/jyO9VFXkJUP07vQ2upmw5PlaITaPKc31jK13V+jg==", "dev": true, "dependencies": { - "sprintf-js": "~1.0.2" + "ms": "2.1.2" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } } }, - "node_modules/asn1": { - "version": "0.2.6", - "resolved": "https://registry.npmjs.org/asn1/-/asn1-0.2.6.tgz", - "integrity": "sha512-ix/FxPn0MDjeyJ7i/yoHGFt/EX6LyNbxSEhPPXODPL+KB0VPk86UYfL0lMdy+KCnv+fmvIzySwaK5COwqVbWTQ==", - "dev": true, - "dependencies": { - "safer-buffer": "~2.1.0" - } + "node_modules/debug/node_modules/ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "dev": true }, - "node_modules/assert-plus": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/assert-plus/-/assert-plus-1.0.0.tgz", - "integrity": "sha512-NfJ4UzBCcQGLDlQq7nHxH+tv3kyZ0hHQqF5BO6J7tNJeP5do1llPr8dZ8zHonfhAu0PHAdMkSo+8o0wxg9lZWw==", + "node_modules/decamelize": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/decamelize/-/decamelize-1.2.0.tgz", + "integrity": "sha512-z2S+W9X73hAUUki+N+9Za2lBlun89zigOyGrsax+KUQ6wKW4ZoWpEYBkGhQjwAjjDCkWxhY0VKEhk8wzY7F5cA==", "dev": true, "engines": { - "node": ">=0.8" + "node": ">=0.10.0" } }, - "node_modules/assertion-error": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/assertion-error/-/assertion-error-1.1.0.tgz", - "integrity": "sha512-jgsaNduz+ndvGyFt3uSuWqvy4lCnIJiovtouQN5JZHOKCS2QuhEdbcQHFhVksz2N2U9hXJo8odG7ETyWlEeuDw==", + "node_modules/deep-eql": { + "version": "4.1.4", + "resolved": "https://registry.npmjs.org/deep-eql/-/deep-eql-4.1.4.tgz", + "integrity": "sha512-SUwdGfqdKOwxCPeVYjwSyRpJ7Z+fhpwIAtmCUdZIWZ/YP5R9WAsyuSgpLVDi9bjWoN2LXHNss/dk3urXtdQxGg==", "dev": true, + "dependencies": { + "type-detect": "^4.0.0" + }, "engines": { - "node": "*" + "node": ">=6" } }, - "node_modules/async": { - "version": "3.2.5", - "resolved": "https://registry.npmjs.org/async/-/async-3.2.5.tgz", - "integrity": "sha512-baNZyqaaLhyLVKm/DlvdW051MSgO6b8eVfIezl9E5PqWxFgzLm/wQntEW4zOytVburDEr0JlALEpdOFwvErLsg==", + "node_modules/deep-is": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz", + "integrity": "sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ==", "dev": true }, - "node_modules/async-retry": { - "version": "1.3.3", - "resolved": "https://registry.npmjs.org/async-retry/-/async-retry-1.3.3.tgz", - "integrity": "sha512-wfr/jstw9xNi/0teMHrRW7dsz3Lt5ARhYNZ2ewpadnhaIp5mbALhOAP+EAdsC7t4Z6wqsDVv9+W6gm1Dk9mEyw==", + "node_modules/deepdash": { + "version": "5.3.9", + "resolved": "https://registry.npmjs.org/deepdash/-/deepdash-5.3.9.tgz", + "integrity": "sha512-GRzJ0q9PDj2T+J2fX+b+TlUa2NlZ11l6vJ8LHNKVGeZ8CfxCuJaCychTq07iDRTvlfO8435jlvVS1QXBrW9kMg==", "dev": true, "dependencies": { - "retry": "0.13.1" + "lodash": "^4.17.21", + "lodash-es": "^4.17.21" } }, - "node_modules/asynckit": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", - "integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==", - "dev": true - }, - "node_modules/aws-sign2": { - "version": "0.7.0", - "resolved": "https://registry.npmjs.org/aws-sign2/-/aws-sign2-0.7.0.tgz", - "integrity": "sha512-08kcGqnYf/YmjoRhfxyu+CLxBjUtHLXLXX/vUfx9l2LYzG3c1m61nrpyFUZI6zeS+Li/wWMMidD9KgrqtGq3mA==", + "node_modules/delayed-stream": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", + "integrity": "sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ==", "dev": true, "engines": { - "node": "*" + "node": ">=0.4.0" } }, - "node_modules/aws4": { - "version": "1.13.0", - "resolved": "https://registry.npmjs.org/aws4/-/aws4-1.13.0.tgz", - "integrity": "sha512-3AungXC4I8kKsS9PuS4JH2nc+0bVY/mjgrephHTIi8fpEeGsTHBUJeosp0Wc1myYMElmD0B3Oc4XL/HVJ4PV2g==", - "dev": true - }, - "node_modules/azure-rest-api-specs-eng-tools": { - "resolved": "eng/tools", - "link": true - }, - "node_modules/balanced-match": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", - "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", - "dev": true - }, - "node_modules/base64-js": { - "version": "1.5.1", - "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz", - "integrity": "sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ] - }, - "node_modules/bcrypt-pbkdf": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/bcrypt-pbkdf/-/bcrypt-pbkdf-1.0.2.tgz", - "integrity": "sha512-qeFIXtP4MSoi6NLqO12WfqARWWuCKi2Rn/9hJLEmtB5yTNr9DqFWkJRCf2qShWzPeAMRnOgCrq0sg/KLv5ES9w==", + "node_modules/des.js": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/des.js/-/des.js-1.1.0.tgz", + "integrity": "sha512-r17GxjhUCjSRy8aiJpr8/UadFIzMzJGexI3Nmz4ADi9LYSFx4gTBp80+NaX/YsXWWLhpZ7v/v/ubEc/bCNfKwg==", "dev": true, "dependencies": { - "tweetnacl": "^0.14.3" + "inherits": "^2.0.1", + "minimalistic-assert": "^1.0.0" } }, - "node_modules/bluebird": { - "version": "2.11.0", - "resolved": "https://registry.npmjs.org/bluebird/-/bluebird-2.11.0.tgz", - "integrity": "sha512-UfFSr22dmHPQqPP9XWHRhq+gWnHCYguQGkXQlbyPtW5qTnhFWA8/iXg765tH0cAjy7l/zPJ1aBTO0g5XgA7kvQ==", - "dev": true - }, - "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==", + "node_modules/diff-sequences": { + "version": "29.6.3", + "resolved": "https://registry.npmjs.org/diff-sequences/-/diff-sequences-29.6.3.tgz", + "integrity": "sha512-EjePK1srD3P08o2j4f0ExnylqRs5B9tJjcp9t1krH2qRi8CCdsYfwe9JgSLurFBWwq4uOlipzfk5fHNvwFKr8Q==", "dev": true, - "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, - "node_modules/braces": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", - "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", + "node_modules/difflib": { + "version": "0.2.4", + "resolved": "https://registry.npmjs.org/difflib/-/difflib-0.2.4.tgz", + "integrity": "sha512-9YVwmMb0wQHQNr5J9m6BSj6fk4pfGITGQOOs+D9Fl+INODWFOfvhIU1hNv6GgR1RBoC/9NJcwu77zShxV0kT7w==", "dev": true, "dependencies": { - "fill-range": "^7.1.1" + "heap": ">= 0.2.0" }, "engines": { - "node": ">=8" + "node": "*" } }, - "node_modules/brotli": { - "version": "1.3.3", - "resolved": "https://registry.npmjs.org/brotli/-/brotli-1.3.3.tgz", - "integrity": "sha512-oTKjJdShmDuGW94SyyaoQvAjf30dZaHnjJ8uAF+u2/vGJkJbJPJAT1gDiOJP5v1Zb6f9KEyW/1HpuaWIXtGHPg==", + "node_modules/dir-glob": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz", + "integrity": "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==", "dev": true, "dependencies": { - "base64-js": "^1.1.2" - } - }, - "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, + "path-type": "^4.0.0" + }, "engines": { "node": ">=8" } }, - "node_modules/call-me-maybe": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/call-me-maybe/-/call-me-maybe-1.0.2.tgz", - "integrity": "sha512-HpX65o1Hnr9HH25ojC1YGs7HCQLq0GCOibSaWER0eNpgJ/Z1MZv2mTc7+xh6WOPxbRVcmgbv4hGU+uSQ/2xFZQ==", - "dev": true - }, - "node_modules/camelcase": { - "version": "5.3.1", - "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-5.3.1.tgz", - "integrity": "sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg==", + "node_modules/dir-glob/node_modules/path-type": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz", + "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==", "dev": true, "engines": { - "node": ">=6" + "node": ">=8" } }, - "node_modules/caseless": { - "version": "0.12.0", - "resolved": "https://registry.npmjs.org/caseless/-/caseless-0.12.0.tgz", - "integrity": "sha512-4tYFyifaFfGacoiObjJegolkwSU4xQNGbVgUiNYVUxbQ2x2lUsFvY4hVgVzGiIe6WLOPqycWXA40l+PWsxthUw==", - "dev": true - }, - "node_modules/chai": { - "version": "4.4.1", - "resolved": "https://registry.npmjs.org/chai/-/chai-4.4.1.tgz", - "integrity": "sha512-13sOfMv2+DWduEU+/xbun3LScLoqN17nBeTLUsmDfKdoiC1fr0n9PU4guu4AhRcOVFk/sW8LyZWHuhWtQZiF+g==", + "node_modules/doctrine": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz", + "integrity": "sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w==", "dev": true, "dependencies": { - "assertion-error": "^1.1.0", - "check-error": "^1.0.3", - "deep-eql": "^4.1.3", - "get-func-name": "^2.0.2", - "loupe": "^2.3.6", - "pathval": "^1.1.1", - "type-detect": "^4.0.8" + "esutils": "^2.0.2" }, "engines": { - "node": ">=4" + "node": ">=6.0.0" } }, - "node_modules/chalk": { - "version": "2.4.2", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", - "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", + "node_modules/dotenv": { + "version": "16.4.5", + "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-16.4.5.tgz", + "integrity": "sha512-ZmdL2rui+eB2YwhsWzjInR8LldtZHGDoQ1ugH85ppHKwpUHL7j7rN0Ti9NCnGiQbhaZ11FpR+7ao1dNsmduNUg==", "dev": true, - "dependencies": { - "ansi-styles": "^3.2.1", - "escape-string-regexp": "^1.0.5", - "supports-color": "^5.3.0" - }, "engines": { - "node": ">=4" + "node": ">=12" + }, + "funding": { + "url": "https://dotenvx.com" } }, - "node_modules/change-case": { - "version": "5.4.4", - "resolved": "https://registry.npmjs.org/change-case/-/change-case-5.4.4.tgz", - "integrity": "sha512-HRQyTk2/YPEkt9TnUPbOpr64Uw3KOicFWPVBb+xiHvd6eBx/qPr9xqfBFDT8P2vWsvvz4jbEkfDe71W3VyNu2w==", + "node_modules/ecc-jsbn": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/ecc-jsbn/-/ecc-jsbn-0.1.2.tgz", + "integrity": "sha512-eh9O+hwRHNbG4BLTjEl3nw044CkGm5X6LoaCf7LPp7UU8Qrt47JYNi6nPX8xjW97TKGKm1ouctg0QSpZe9qrnw==", + "dev": true, + "dependencies": { + "jsbn": "~0.1.0", + "safer-buffer": "^2.1.0" + } + }, + "node_modules/electron-to-chromium": { + "version": "1.4.828", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.4.828.tgz", + "integrity": "sha512-QOIJiWpQJDHAVO4P58pwb133Cwee0nbvy/MV1CwzZVGpkH1RX33N3vsaWRCpR6bF63AAq366neZrRTu7Qlsbbw==", "dev": true }, - "node_modules/chardet": { + "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 + }, + "node_modules/enabled": { "version": "2.0.0", - "resolved": "https://registry.npmjs.org/chardet/-/chardet-2.0.0.tgz", - "integrity": "sha512-xVgPpulCooDjY6zH4m9YW3jbkaBe3FKIAvF5sj5t7aBNsVl2ljIE+xwJ4iNgiDZHFQvNIpjdKdVOQvvk5ZfxbQ==", + "resolved": "https://registry.npmjs.org/enabled/-/enabled-2.0.0.tgz", + "integrity": "sha512-AKrN98kuwOzMIdAizXGI86UFBoo26CL21UM763y1h/GMSJ4/OHU9k2YlsmBpyScFo/wbLzWQJBMCW4+IO3/+OQ==", "dev": true }, - "node_modules/charset": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/charset/-/charset-1.0.1.tgz", - "integrity": "sha512-6dVyOOYjpfFcL1Y4qChrAoQLRHvj2ziyhcm0QJlhOcAhykL/k1kTUPbeo+87MNRTRdk2OIIsIXbuF3x2wi5EXg==", + "node_modules/entities": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/entities/-/entities-2.0.3.tgz", + "integrity": "sha512-MyoZ0jgnLvB2X3Lg5HqpFmn1kybDiIfEQmKzTb5apr51Rb+T3KdmMiqa70T+bhGnyv7bQ6WMj2QMHpGMmlrUYQ==", + "dev": true + }, + "node_modules/error-ex": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz", + "integrity": "sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==", "dev": true, - "engines": { - "node": ">=4.0.0" + "dependencies": { + "is-arrayish": "^0.2.1" } }, - "node_modules/check-error": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/check-error/-/check-error-1.0.3.tgz", - "integrity": "sha512-iKEoDYaRmd1mxM90a2OEfWhjsjPpYPuQ+lMYsoxB126+t8fw7ySEO48nmDg5COTjxDI65/Y2OWpeEHk3ZOe8zg==", + "node_modules/error-ex/node_modules/is-arrayish": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz", + "integrity": "sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg==", + "dev": true + }, + "node_modules/esbuild": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.21.5.tgz", + "integrity": "sha512-mg3OPMV4hXywwpoDxu3Qda5xCKQi+vCTZq8S9J/EpkhB2HzKXq4SNFZE3+NK93JYxc8VMSep+lOUSC/RVKaBqw==", "dev": true, - "dependencies": { - "get-func-name": "^2.0.2" + "hasInstallScript": true, + "bin": { + "esbuild": "bin/esbuild" }, "engines": { - "node": "*" + "node": ">=12" + }, + "optionalDependencies": { + "@esbuild/aix-ppc64": "0.21.5", + "@esbuild/android-arm": "0.21.5", + "@esbuild/android-arm64": "0.21.5", + "@esbuild/android-x64": "0.21.5", + "@esbuild/darwin-arm64": "0.21.5", + "@esbuild/darwin-x64": "0.21.5", + "@esbuild/freebsd-arm64": "0.21.5", + "@esbuild/freebsd-x64": "0.21.5", + "@esbuild/linux-arm": "0.21.5", + "@esbuild/linux-arm64": "0.21.5", + "@esbuild/linux-ia32": "0.21.5", + "@esbuild/linux-loong64": "0.21.5", + "@esbuild/linux-mips64el": "0.21.5", + "@esbuild/linux-ppc64": "0.21.5", + "@esbuild/linux-riscv64": "0.21.5", + "@esbuild/linux-s390x": "0.21.5", + "@esbuild/linux-x64": "0.21.5", + "@esbuild/netbsd-x64": "0.21.5", + "@esbuild/openbsd-x64": "0.21.5", + "@esbuild/sunos-x64": "0.21.5", + "@esbuild/win32-arm64": "0.21.5", + "@esbuild/win32-ia32": "0.21.5", + "@esbuild/win32-x64": "0.21.5" } }, - "node_modules/cli-progress": { - "version": "3.12.0", - "resolved": "https://registry.npmjs.org/cli-progress/-/cli-progress-3.12.0.tgz", - "integrity": "sha512-tRkV3HJ1ASwm19THiiLIXLO7Im7wlTuKnvkYaTkyoAPefqjNg7W7DHKUlGRxy9vxDvbyCYQkQozvptuMkGCg8A==", + "node_modules/escalade": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.1.2.tgz", + "integrity": "sha512-ErCHMCae19vR8vQGe50xIsVomy19rg6gFu3+r3jkEO46suLMWBksvVyoGgQV+jOfl84ZSOSlmv6Gxa89PmTGmA==", "dev": true, - "dependencies": { - "string-width": "^4.2.3" - }, "engines": { - "node": ">=4" + "node": ">=6" } }, - "node_modules/cli-table3": { - "version": "0.6.5", - "resolved": "https://registry.npmjs.org/cli-table3/-/cli-table3-0.6.5.tgz", - "integrity": "sha512-+W/5efTR7y5HRD7gACw9yQjqMVvEMLBHmboM/kPWam+H+Hmyrgjh6YncVKK122YZkXrLudzTuAukUw9FnMf7IQ==", + "node_modules/escape-string-regexp": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", + "integrity": "sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==", "dev": true, - "dependencies": { - "string-width": "^4.2.0" + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/eslint": { + "version": "8.57.0", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.57.0.tgz", + "integrity": "sha512-dZ6+mexnaTIbSBZWgou51U6OmzIhYM2VcNdtiTtI7qPNZm35Akpr0f6vtw3w1Kmn5PYo+tZVfh13WrhpS6oLqQ==", + "dev": true, + "dependencies": { + "@eslint-community/eslint-utils": "^4.2.0", + "@eslint-community/regexpp": "^4.6.1", + "@eslint/eslintrc": "^2.1.4", + "@eslint/js": "8.57.0", + "@humanwhocodes/config-array": "^0.11.14", + "@humanwhocodes/module-importer": "^1.0.1", + "@nodelib/fs.walk": "^1.2.8", + "@ungap/structured-clone": "^1.2.0", + "ajv": "^6.12.4", + "chalk": "^4.0.0", + "cross-spawn": "^7.0.2", + "debug": "^4.3.2", + "doctrine": "^3.0.0", + "escape-string-regexp": "^4.0.0", + "eslint-scope": "^7.2.2", + "eslint-visitor-keys": "^3.4.3", + "espree": "^9.6.1", + "esquery": "^1.4.2", + "esutils": "^2.0.2", + "fast-deep-equal": "^3.1.3", + "file-entry-cache": "^6.0.1", + "find-up": "^5.0.0", + "glob-parent": "^6.0.2", + "globals": "^13.19.0", + "graphemer": "^1.4.0", + "ignore": "^5.2.0", + "imurmurhash": "^0.1.4", + "is-glob": "^4.0.0", + "is-path-inside": "^3.0.3", + "js-yaml": "^4.1.0", + "json-stable-stringify-without-jsonify": "^1.0.1", + "levn": "^0.4.1", + "lodash.merge": "^4.6.2", + "minimatch": "^3.1.2", + "natural-compare": "^1.4.0", + "optionator": "^0.9.3", + "strip-ansi": "^6.0.1", + "text-table": "^0.2.0" + }, + "bin": { + "eslint": "bin/eslint.js" }, "engines": { - "node": "10.* || >= 12.*" + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" }, - "optionalDependencies": { - "@colors/colors": "1.5.0" + "funding": { + "url": "https://opencollective.com/eslint" } }, - "node_modules/cliui": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/cliui/-/cliui-6.0.0.tgz", - "integrity": "sha512-t6wbgtoCXvAzst7QgXxJYqPt0usEfbgQdftEPbLL/cvv6HPE5VgvqCuAIDR0NgU52ds6rFwqrgakNLrHEjCbrQ==", + "node_modules/eslint-plugin-unicorn": { + "version": "54.0.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-unicorn/-/eslint-plugin-unicorn-54.0.0.tgz", + "integrity": "sha512-XxYLRiYtAWiAjPv6z4JREby1TAE2byBC7wlh0V4vWDCpccOSU1KovWV//jqPXF6bq3WKxqX9rdjoRQ1EhdmNdQ==", "dev": true, "dependencies": { - "string-width": "^4.2.0", - "strip-ansi": "^6.0.0", - "wrap-ansi": "^6.2.0" + "@babel/helper-validator-identifier": "^7.24.5", + "@eslint-community/eslint-utils": "^4.4.0", + "@eslint/eslintrc": "^3.0.2", + "ci-info": "^4.0.0", + "clean-regexp": "^1.0.0", + "core-js-compat": "^3.37.0", + "esquery": "^1.5.0", + "indent-string": "^4.0.0", + "is-builtin-module": "^3.2.1", + "jsesc": "^3.0.2", + "pluralize": "^8.0.0", + "read-pkg-up": "^7.0.1", + "regexp-tree": "^0.1.27", + "regjsparser": "^0.10.0", + "semver": "^7.6.1", + "strip-indent": "^3.0.0" + }, + "engines": { + "node": ">=18.18" + }, + "funding": { + "url": "https://github.com/sindresorhus/eslint-plugin-unicorn?sponsor=1" + }, + "peerDependencies": { + "eslint": ">=8.56.0" } }, - "node_modules/color": { - "version": "3.2.1", - "resolved": "https://registry.npmjs.org/color/-/color-3.2.1.tgz", - "integrity": "sha512-aBl7dZI9ENN6fUGC7mWpMTPNHmWUSNan9tuWN6ahh5ZLNk9baLJOnSMlrQkHcrfFgz2/RigjUVAjdx36VcemKA==", + "node_modules/eslint-plugin-unicorn/node_modules/@eslint/eslintrc": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-3.1.0.tgz", + "integrity": "sha512-4Bfj15dVJdoy3RfZmmo86RK1Fwzn6SstsvK9JS+BaVKqC6QQQQyXekNaC+g+LKNgkQ+2VhGAzm6hO40AhMR3zQ==", "dev": true, "dependencies": { - "color-convert": "^1.9.3", - "color-string": "^1.6.0" + "ajv": "^6.12.4", + "debug": "^4.3.2", + "espree": "^10.0.1", + "globals": "^14.0.0", + "ignore": "^5.2.0", + "import-fresh": "^3.2.1", + "js-yaml": "^4.1.0", + "minimatch": "^3.1.2", + "strip-json-comments": "^3.1.1" + }, + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" } }, - "node_modules/color-convert": { - "version": "1.9.3", - "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", - "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", + "node_modules/eslint-plugin-unicorn/node_modules/ajv": { + "version": "6.12.6", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", + "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", "dev": true, "dependencies": { - "color-name": "1.1.3" + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" } }, - "node_modules/color-name": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", - "integrity": "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw==", + "node_modules/eslint-plugin-unicorn/node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", "dev": true }, - "node_modules/color-string": { - "version": "1.9.1", - "resolved": "https://registry.npmjs.org/color-string/-/color-string-1.9.1.tgz", - "integrity": "sha512-shrVawQFojnZv6xM40anx4CkoDP+fZsw/ZerEMsW/pyzsRbElpsL/DBVW7q3ExxwusdNXI3lXpuhEZkzs8p5Eg==", + "node_modules/eslint-plugin-unicorn/node_modules/eslint-visitor-keys": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-4.0.0.tgz", + "integrity": "sha512-OtIRv/2GyiF6o/d8K7MYKKbXrOUBIK6SfkIRM4Z0dY3w+LiQ0vy3F57m0Z71bjbyeiWFiHJ8brqnmE6H6/jEuw==", + "dev": true, + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + } + }, + "node_modules/eslint-plugin-unicorn/node_modules/espree": { + "version": "10.1.0", + "resolved": "https://registry.npmjs.org/espree/-/espree-10.1.0.tgz", + "integrity": "sha512-M1M6CpiE6ffoigIOWYO9UDP8TMUw9kqb21tf+08IgDYjCsOvCuDt4jQcZmoYxx+w7zlKw9/N0KXfto+I8/FrXA==", "dev": true, "dependencies": { - "color-name": "^1.0.0", - "simple-swizzle": "^0.2.2" + "acorn": "^8.12.0", + "acorn-jsx": "^5.3.2", + "eslint-visitor-keys": "^4.0.0" + }, + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" } }, - "node_modules/colors": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/colors/-/colors-1.4.0.tgz", - "integrity": "sha512-a+UqTh4kgZg/SlGvfbzDHpgRu7AAQOmmqRHJnxhRZICKFUT91brVhNNt58CMWU9PsBbv3PDCZUHbVxuDiH2mtA==", + "node_modules/eslint-plugin-unicorn/node_modules/globals": { + "version": "14.0.0", + "resolved": "https://registry.npmjs.org/globals/-/globals-14.0.0.tgz", + "integrity": "sha512-oahGvuMGQlPw/ivIYBjVSrWAfWLBeku5tpPE2fOPLi+WHffIWbuh2tCjhyQhTBPMf5E9jDEH4FOmTYgYwbKwtQ==", "dev": true, "engines": { - "node": ">=0.1.90" + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/colorspace": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/colorspace/-/colorspace-1.1.4.tgz", - "integrity": "sha512-BgvKJiuVu1igBUF2kEjRCZXol6wiiGbY5ipL/oVPwm0BL9sIpMIzM8IK7vwuxIIzOXMV3Ey5w+vxhm0rR/TN8w==", + "node_modules/eslint-plugin-unicorn/node_modules/js-yaml": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", + "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", "dev": true, "dependencies": { - "color": "^3.1.3", - "text-hex": "1.0.x" + "argparse": "^2.0.1" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" } }, - "node_modules/combined-stream": { - "version": "1.0.8", - "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", - "integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==", + "node_modules/eslint-plugin-unicorn/node_modules/json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", + "dev": true + }, + "node_modules/eslint-scope": { + "version": "7.2.2", + "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-7.2.2.tgz", + "integrity": "sha512-dOt21O7lTMhDM+X9mB4GX+DZrZtCUJPL/wlcTqxyrx5IvO0IYtILdtrQGQp+8n5S0gwSVmOf9NQrjMOgfQZlIg==", "dev": true, "dependencies": { - "delayed-stream": "~1.0.0" + "esrecurse": "^4.3.0", + "estraverse": "^5.2.0" }, "engines": { - "node": ">= 0.8" + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" } }, - "node_modules/commander": { - "version": "11.1.0", - "resolved": "https://registry.npmjs.org/commander/-/commander-11.1.0.tgz", - "integrity": "sha512-yPVavfyCcRhmorC7rWlkHn15b4wDVgVmBA7kV4QVBsF7kv/9TKJAbAXVTxvTnwP8HHKjRCJDClKbciiYS7p0DQ==", + "node_modules/eslint-visitor-keys": { + "version": "3.4.3", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.4.3.tgz", + "integrity": "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==", "dev": true, "engines": { - "node": ">=16" + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" } }, - "node_modules/commonmark": { - "version": "0.29.3", - "resolved": "https://registry.npmjs.org/commonmark/-/commonmark-0.29.3.tgz", - "integrity": "sha512-fvt/NdOFKaL2gyhltSy6BC4LxbbxbnPxBMl923ittqO/JBM0wQHaoYZliE4tp26cRxX/ZZtRsJlZzQrVdUkXAA==", + "node_modules/eslint/node_modules/@eslint/js": { + "version": "8.57.0", + "resolved": "https://registry.npmjs.org/@eslint/js/-/js-8.57.0.tgz", + "integrity": "sha512-Ys+3g2TaW7gADOJzPt83SJtCDhMjndcDMFVQ/Tj9iA1BfJzFKD9mAUXT3OenpuPHbI6P/myECxRJrofUsDx/5g==", "dev": true, - "dependencies": { - "entities": "~2.0", - "mdurl": "~1.0.1", - "minimist": ">=1.2.2", - "string.prototype.repeat": "^0.2.0" - }, - "bin": { - "commonmark": "bin/commonmark" - }, "engines": { - "node": "*" + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" } }, - "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 - }, - "node_modules/confbox": { - "version": "0.1.7", - "resolved": "https://registry.npmjs.org/confbox/-/confbox-0.1.7.tgz", - "integrity": "sha512-uJcB/FKZtBMCJpK8MQji6bJHgu1tixKPxRLeGkNzBoOZzpnZUJm0jm2/sBDWcuBx1dYgxV4JU+g5hmNxCyAmdA==", - "dev": true - }, - "node_modules/core-util-is": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz", - "integrity": "sha512-3lqz5YjWTYnW6dlDa5TLaTCcShfar1e40rmcJVwCBJC6mWlFuj0eCHIElmG1g5kyuJ/GD+8Wn4FFCcz4gJPfaQ==", - "dev": true - }, - "node_modules/cross-spawn": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", - "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", + "node_modules/eslint/node_modules/ajv": { + "version": "6.12.6", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", + "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", "dev": true, "dependencies": { - "path-key": "^3.1.0", - "shebang-command": "^2.0.0", - "which": "^2.0.1" + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" }, - "engines": { - "node": ">= 8" + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" } }, - "node_modules/csv-parse": { - "version": "4.16.3", - "resolved": "https://registry.npmjs.org/csv-parse/-/csv-parse-4.16.3.tgz", - "integrity": "sha512-cO1I/zmz4w2dcKHVvpCr7JVRu8/FymG5OEpmvsZYlccYolPBLoVGKUHgNoc4ZGkFeFlWGEDmMyBM+TTqRdW/wg==", - "dev": true - }, - "node_modules/dashdash": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/dashdash/-/dashdash-1.14.1.tgz", - "integrity": "sha512-jRFi8UDGo6j+odZiEpjazZaWqEal3w/basFjQHQEwVtZJGDpxbH1MeYluwCS8Xq5wmLJooDlMgvVarmWfGM44g==", + "node_modules/eslint/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, "dependencies": { - "assert-plus": "^1.0.0" + "color-convert": "^2.0.1" }, "engines": { - "node": ">=0.10" + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" } }, - "node_modules/data-uri-to-buffer": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/data-uri-to-buffer/-/data-uri-to-buffer-4.0.1.tgz", - "integrity": "sha512-0R9ikRb668HB7QDxT1vkpuUBtqc53YyAwMwGeUFKRojY/NWKvdZ+9UYtRfGmhqNbRkTSVpMbmyhXipFFv2cb/A==", - "dev": true, - "engines": { - "node": ">= 12" - } + "node_modules/eslint/node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "dev": true }, - "node_modules/date-format": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/date-format/-/date-format-4.0.3.tgz", - "integrity": "sha512-7P3FyqDcfeznLZp2b+OMitV9Sz2lUnsT87WaTat9nVwqsBkTzPG3lPLNwW3en6F4pHUiWzr6vb8CLhjdK9bcxQ==", + "node_modules/eslint/node_modules/chalk": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", "dev": true, + "dependencies": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + }, "engines": { - "node": ">=4.0" + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" } }, - "node_modules/debug": { - "version": "4.3.5", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.5.tgz", - "integrity": "sha512-pt0bNEmneDIvdL1Xsd9oDQ/wrQRkXDT4AUWlNZNPKvW5x/jyO9VFXkJUP07vQ2upmw5PlaITaPKc31jK13V+jg==", + "node_modules/eslint/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, "dependencies": { - "ms": "2.1.2" + "color-name": "~1.1.4" }, "engines": { - "node": ">=6.0" - }, - "peerDependenciesMeta": { - "supports-color": { - "optional": true - } + "node": ">=7.0.0" } }, - "node_modules/debug/node_modules/ms": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", - "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "node_modules/eslint/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 }, - "node_modules/decamelize": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/decamelize/-/decamelize-1.2.0.tgz", - "integrity": "sha512-z2S+W9X73hAUUki+N+9Za2lBlun89zigOyGrsax+KUQ6wKW4ZoWpEYBkGhQjwAjjDCkWxhY0VKEhk8wzY7F5cA==", + "node_modules/eslint/node_modules/escape-string-regexp": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", + "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==", "dev": true, "engines": { - "node": ">=0.10.0" + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/deep-eql": { - "version": "4.1.4", - "resolved": "https://registry.npmjs.org/deep-eql/-/deep-eql-4.1.4.tgz", - "integrity": "sha512-SUwdGfqdKOwxCPeVYjwSyRpJ7Z+fhpwIAtmCUdZIWZ/YP5R9WAsyuSgpLVDi9bjWoN2LXHNss/dk3urXtdQxGg==", + "node_modules/eslint/node_modules/find-up": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-5.0.0.tgz", + "integrity": "sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng==", "dev": true, "dependencies": { - "type-detect": "^4.0.0" + "locate-path": "^6.0.0", + "path-exists": "^4.0.0" }, "engines": { - "node": ">=6" + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/deepdash": { - "version": "5.3.9", - "resolved": "https://registry.npmjs.org/deepdash/-/deepdash-5.3.9.tgz", - "integrity": "sha512-GRzJ0q9PDj2T+J2fX+b+TlUa2NlZ11l6vJ8LHNKVGeZ8CfxCuJaCychTq07iDRTvlfO8435jlvVS1QXBrW9kMg==", + "node_modules/eslint/node_modules/glob-parent": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-6.0.2.tgz", + "integrity": "sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A==", "dev": true, "dependencies": { - "lodash": "^4.17.21", - "lodash-es": "^4.17.21" + "is-glob": "^4.0.3" + }, + "engines": { + "node": ">=10.13.0" } }, - "node_modules/delayed-stream": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", - "integrity": "sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ==", + "node_modules/eslint/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, "engines": { - "node": ">=0.4.0" + "node": ">=8" } }, - "node_modules/des.js": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/des.js/-/des.js-1.1.0.tgz", - "integrity": "sha512-r17GxjhUCjSRy8aiJpr8/UadFIzMzJGexI3Nmz4ADi9LYSFx4gTBp80+NaX/YsXWWLhpZ7v/v/ubEc/bCNfKwg==", + "node_modules/eslint/node_modules/js-yaml": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", + "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", "dev": true, "dependencies": { - "inherits": "^2.0.1", - "minimalistic-assert": "^1.0.0" + "argparse": "^2.0.1" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" } }, - "node_modules/diff-sequences": { - "version": "29.6.3", - "resolved": "https://registry.npmjs.org/diff-sequences/-/diff-sequences-29.6.3.tgz", - "integrity": "sha512-EjePK1srD3P08o2j4f0ExnylqRs5B9tJjcp9t1krH2qRi8CCdsYfwe9JgSLurFBWwq4uOlipzfk5fHNvwFKr8Q==", + "node_modules/eslint/node_modules/json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", + "dev": true + }, + "node_modules/eslint/node_modules/locate-path": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz", + "integrity": "sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw==", "dev": true, + "dependencies": { + "p-locate": "^5.0.0" + }, "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/difflib": { - "version": "0.2.4", - "resolved": "https://registry.npmjs.org/difflib/-/difflib-0.2.4.tgz", - "integrity": "sha512-9YVwmMb0wQHQNr5J9m6BSj6fk4pfGITGQOOs+D9Fl+INODWFOfvhIU1hNv6GgR1RBoC/9NJcwu77zShxV0kT7w==", + "node_modules/eslint/node_modules/p-limit": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz", + "integrity": "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==", "dev": true, "dependencies": { - "heap": ">= 0.2.0" + "yocto-queue": "^0.1.0" }, "engines": { - "node": "*" + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/ecc-jsbn": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/ecc-jsbn/-/ecc-jsbn-0.1.2.tgz", - "integrity": "sha512-eh9O+hwRHNbG4BLTjEl3nw044CkGm5X6LoaCf7LPp7UU8Qrt47JYNi6nPX8xjW97TKGKm1ouctg0QSpZe9qrnw==", + "node_modules/eslint/node_modules/p-locate": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-5.0.0.tgz", + "integrity": "sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw==", "dev": true, "dependencies": { - "jsbn": "~0.1.0", - "safer-buffer": "^2.1.0" + "p-limit": "^3.0.2" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, - "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 - }, - "node_modules/enabled": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/enabled/-/enabled-2.0.0.tgz", - "integrity": "sha512-AKrN98kuwOzMIdAizXGI86UFBoo26CL21UM763y1h/GMSJ4/OHU9k2YlsmBpyScFo/wbLzWQJBMCW4+IO3/+OQ==", - "dev": true - }, - "node_modules/entities": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/entities/-/entities-2.0.3.tgz", - "integrity": "sha512-MyoZ0jgnLvB2X3Lg5HqpFmn1kybDiIfEQmKzTb5apr51Rb+T3KdmMiqa70T+bhGnyv7bQ6WMj2QMHpGMmlrUYQ==", - "dev": true - }, - "node_modules/esbuild": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.21.5.tgz", - "integrity": "sha512-mg3OPMV4hXywwpoDxu3Qda5xCKQi+vCTZq8S9J/EpkhB2HzKXq4SNFZE3+NK93JYxc8VMSep+lOUSC/RVKaBqw==", + "node_modules/eslint/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, - "hasInstallScript": true, - "bin": { - "esbuild": "bin/esbuild" + "dependencies": { + "has-flag": "^4.0.0" }, "engines": { - "node": ">=12" - }, - "optionalDependencies": { - "@esbuild/aix-ppc64": "0.21.5", - "@esbuild/android-arm": "0.21.5", - "@esbuild/android-arm64": "0.21.5", - "@esbuild/android-x64": "0.21.5", - "@esbuild/darwin-arm64": "0.21.5", - "@esbuild/darwin-x64": "0.21.5", - "@esbuild/freebsd-arm64": "0.21.5", - "@esbuild/freebsd-x64": "0.21.5", - "@esbuild/linux-arm": "0.21.5", - "@esbuild/linux-arm64": "0.21.5", - "@esbuild/linux-ia32": "0.21.5", - "@esbuild/linux-loong64": "0.21.5", - "@esbuild/linux-mips64el": "0.21.5", - "@esbuild/linux-ppc64": "0.21.5", - "@esbuild/linux-riscv64": "0.21.5", - "@esbuild/linux-s390x": "0.21.5", - "@esbuild/linux-x64": "0.21.5", - "@esbuild/netbsd-x64": "0.21.5", - "@esbuild/openbsd-x64": "0.21.5", - "@esbuild/sunos-x64": "0.21.5", - "@esbuild/win32-arm64": "0.21.5", - "@esbuild/win32-ia32": "0.21.5", - "@esbuild/win32-x64": "0.21.5" + "node": ">=8" } }, - "node_modules/escalade": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.1.2.tgz", - "integrity": "sha512-ErCHMCae19vR8vQGe50xIsVomy19rg6gFu3+r3jkEO46suLMWBksvVyoGgQV+jOfl84ZSOSlmv6Gxa89PmTGmA==", + "node_modules/eslint/node_modules/yocto-queue": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz", + "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==", "dev": true, "engines": { - "node": ">=6" + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/escape-string-regexp": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", - "integrity": "sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==", + "node_modules/espree": { + "version": "9.6.1", + "resolved": "https://registry.npmjs.org/espree/-/espree-9.6.1.tgz", + "integrity": "sha512-oruZaFkjorTpF32kDSI5/75ViwGeZginGGy2NoOSg3Q9bnwlnmDm4HLnkl0RE3n+njDXR037aY1+x58Z/zFdwQ==", "dev": true, + "dependencies": { + "acorn": "^8.9.0", + "acorn-jsx": "^5.3.2", + "eslint-visitor-keys": "^3.4.1" + }, "engines": { - "node": ">=0.8.0" + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" } }, "node_modules/esprima": { @@ -3042,6 +5030,39 @@ "node": ">=4" } }, + "node_modules/esquery": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.6.0.tgz", + "integrity": "sha512-ca9pw9fomFcKPvFLXhBKUK90ZvGibiGOvRJNbjljY7s7uq/5YO4BOzcYtJqExdx99rF6aAcnRxHmcUHcz6sQsg==", + "dev": true, + "dependencies": { + "estraverse": "^5.1.0" + }, + "engines": { + "node": ">=0.10" + } + }, + "node_modules/esrecurse": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz", + "integrity": "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==", + "dev": true, + "dependencies": { + "estraverse": "^5.2.0" + }, + "engines": { + "node": ">=4.0" + } + }, + "node_modules/estraverse": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz", + "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==", + "dev": true, + "engines": { + "node": ">=4.0" + } + }, "node_modules/estree-walker": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-3.0.3.tgz", @@ -3051,6 +5072,15 @@ "@types/estree": "^1.0.0" } }, + "node_modules/esutils": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz", + "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/event-target-shim": { "version": "5.0.1", "resolved": "https://registry.npmjs.org/event-target-shim/-/event-target-shim-5.0.1.tgz", @@ -3180,6 +5210,12 @@ "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", "dev": true }, + "node_modules/fast-levenshtein": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz", + "integrity": "sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw==", + "dev": true + }, "node_modules/fastq": { "version": "1.17.1", "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.17.1.tgz", @@ -3233,6 +5269,18 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/file-entry-cache": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-6.0.1.tgz", + "integrity": "sha512-7Gps/XWymbLk2QLYK4NzpMOrYjMhdIxXuIvy2QBsLE6ljuodKvdkWs/cpyJJ3CVIVpH0Oi1Hvg1ovbMzLdFBBg==", + "dev": true, + "dependencies": { + "flat-cache": "^3.0.4" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + } + }, "node_modules/file-type": { "version": "3.9.0", "resolved": "https://registry.npmjs.org/file-type/-/file-type-3.9.0.tgz", @@ -3276,6 +5324,26 @@ "node": ">=8" } }, + "node_modules/flat-cache": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-3.2.0.tgz", + "integrity": "sha512-CYcENa+FtcUKLmhhqyctpclsq7QF38pKjZHsGNiSQF5r4FtoKDWabFDl3hzaEQMvT1LHEysw5twgLvpYYb4vbw==", + "dev": true, + "dependencies": { + "flatted": "^3.2.9", + "keyv": "^4.5.3", + "rimraf": "^3.0.2" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + } + }, + "node_modules/flat-cache/node_modules/flatted": { + "version": "3.3.1", + "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.3.1.tgz", + "integrity": "sha512-X8cqMLLie7KsNUDSdzeN8FYK9rEt4Dt67OsG/DNGnYTSDBG4uFAJFBnUeiV+zCVAvwFy56IjM9sH51jVaEhNxw==", + "dev": true + }, "node_modules/flatted": { "version": "3.2.6", "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.2.6.tgz", @@ -3372,6 +5440,15 @@ "node": "^8.16.0 || ^10.6.0 || >=11.0.0" } }, + "node_modules/function-bind": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", + "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==", + "dev": true, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/get-caller-file": { "version": "2.0.5", "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz", @@ -3460,6 +5537,21 @@ "node": ">= 6" } }, + "node_modules/globals": { + "version": "13.24.0", + "resolved": "https://registry.npmjs.org/globals/-/globals-13.24.0.tgz", + "integrity": "sha512-AhO5QUcj8llrbG09iWhPU2B204J1xnPeL8kQmVorSsy+Sjj1sk8gIyh6cUocGmH4L0UuhAJy+hJMRA4mgA4mFQ==", + "dev": true, + "dependencies": { + "type-fest": "^0.20.2" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/globby": { "version": "14.0.2", "resolved": "https://registry.npmjs.org/globby/-/globby-14.0.2.tgz", @@ -3486,6 +5578,19 @@ "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==", "dev": true }, + "node_modules/grapheme-splitter": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/grapheme-splitter/-/grapheme-splitter-1.0.4.tgz", + "integrity": "sha512-bzh50DW9kTPM00T8y4o8vQg89Di9oLJVLW/KaOGIXJWP/iqCN6WKYkbNOF04vFLJhwcpYUh9ydh/+5vpOqV4YQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/graphemer": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/graphemer/-/graphemer-1.4.0.tgz", + "integrity": "sha512-EtKwoO6kxCL9WO5xipiHTZlSzBm7WLT627TqC/uVRd0HKmq8NXyebnNYxDoBi7wt8eTWrUrKXCOVaFq9x1kgag==", + "dev": true + }, "node_modules/growly": { "version": "1.3.0", "resolved": "https://registry.npmjs.org/growly/-/growly-1.3.0.tgz", @@ -3567,18 +5672,49 @@ "node": ">=4" } }, + "node_modules/hasown": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", + "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", + "dev": true, + "dependencies": { + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, "node_modules/heap": { "version": "0.2.7", "resolved": "https://registry.npmjs.org/heap/-/heap-0.2.7.tgz", "integrity": "sha512-2bsegYkkHO+h/9MGbn6KWcE45cHZgPANo5LXF7EvWdT0yT2EguSVO1nDgU5c8+ZOPwp2vMNa7YFsJhVcDR9Sdg==", "dev": true }, + "node_modules/hosted-git-info": { + "version": "2.8.9", + "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-2.8.9.tgz", + "integrity": "sha512-mxIDAb9Lsm6DoOJ7xH+5+X4y1LU/4Hi50L9C5sIswK3JzULS4bwk1FvjdBgvYR4bzT4tuUQiC15FE2f5HbLvYw==", + "dev": true + }, "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 }, + "node_modules/http-proxy-agent": { + "version": "7.0.2", + "resolved": "https://registry.npmjs.org/http-proxy-agent/-/http-proxy-agent-7.0.2.tgz", + "integrity": "sha512-T1gkAiYYDWYx3V5Bmyu7HcfcvL7mUrTWiM6yOfa3PIphViJ/gFPbvidQ+veqSOHci/PxBcDabeUNCzpOODJZig==", + "dev": true, + "dependencies": { + "agent-base": "^7.1.0", + "debug": "^4.3.4" + }, + "engines": { + "node": ">= 14" + } + }, "node_modules/http-reasons": { "version": "0.1.0", "resolved": "https://registry.npmjs.org/http-reasons/-/http-reasons-0.1.0.tgz", @@ -3633,6 +5769,19 @@ "node": ">= 6.15.1" } }, + "node_modules/https-proxy-agent": { + "version": "7.0.5", + "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-7.0.5.tgz", + "integrity": "sha512-1e4Wqeblerz+tMKPIq2EMGiiWW1dIjZOksyHWSUm1rmuvw/how9hBHZ38lAGj5ID4Ik6EdkOw7NmWPy6LAwalw==", + "dev": true, + "dependencies": { + "agent-base": "^7.0.2", + "debug": "4" + }, + "engines": { + "node": ">= 14" + } + }, "node_modules/human-signals": { "version": "7.0.0", "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-7.0.0.tgz", @@ -3669,6 +5818,40 @@ "node": ">= 4" } }, + "node_modules/import-fresh": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.0.tgz", + "integrity": "sha512-veYYhQa+D1QBKznvhUHxb8faxlrwUnxseDAbAp457E0wLNio2bOSKnjYDhMj+YiAq61xrMGhQk9iXVk5FzgQMw==", + "dev": true, + "dependencies": { + "parent-module": "^1.0.0", + "resolve-from": "^4.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/imurmurhash": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", + "integrity": "sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA==", + "dev": true, + "engines": { + "node": ">=0.8.19" + } + }, + "node_modules/indent-string": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/indent-string/-/indent-string-4.0.0.tgz", + "integrity": "sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg==", + "dev": true, + "engines": { + "node": ">=8" + } + }, "node_modules/inflight": { "version": "1.0.6", "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", @@ -3698,6 +5881,36 @@ "integrity": "sha512-eVRqCvVlZbuw3GrM63ovNSNAeA1K16kaR/LRY/92w0zxQ5/1YzwblUX652i4Xs9RwAGjW9d9y6X88t8OaAJfWQ==", "dev": true }, + "node_modules/is-builtin-module": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/is-builtin-module/-/is-builtin-module-3.2.1.tgz", + "integrity": "sha512-BSLE3HnV2syZ0FK0iMA/yUGplUeMmNz4AW5fnTunbCIqZi4vG3WjJT9FHMy5D69xmAYBHXQhJdALdpwVxV501A==", + "dev": true, + "dependencies": { + "builtin-modules": "^3.3.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-core-module": { + "version": "2.14.0", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.14.0.tgz", + "integrity": "sha512-a5dFJih5ZLYlRtDc0dZWP7RiKr6xIKzmn/oAYCDvdLThadVgyJwlaoQPmRtMSpz+rk0OGAgIu+TcM9HUF0fk1A==", + "dev": true, + "dependencies": { + "hasown": "^2.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/is-docker": { "version": "2.2.1", "resolved": "https://registry.npmjs.org/is-docker/-/is-docker-2.2.1.tgz", @@ -3752,6 +5965,15 @@ "node": ">=0.12.0" } }, + "node_modules/is-path-inside": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/is-path-inside/-/is-path-inside-3.0.3.tgz", + "integrity": "sha512-Fd4gABb+ycGAmKou8eMftCupSir5lRxqf4aD/vd0cD2qc4HL07OjCeuHMr8Ro4CoMaeCKDB0/ECBOVWjTwUvPQ==", + "dev": true, + "engines": { + "node": ">=8" + } + }, "node_modules/is-plain-obj": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-4.1.0.tgz", @@ -3950,6 +6172,24 @@ "integrity": "sha512-UVU9dibq2JcFWxQPA6KCqj5O42VOmAY3zQUfEKxU0KpTGXwNoCjkX1e13eHNvw/xPynt6pU0rZ1htjWTNTSXsg==", "dev": true }, + "node_modules/jsesc": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-3.0.2.tgz", + "integrity": "sha512-xKqzzWXDttJuOcawBt4KnKHHIf5oQ/Cxax+0PWFG+DFDgHNAdi+TXECADI+RYiFUMmx8792xsMbbgXj4CwnP4g==", + "dev": true, + "bin": { + "jsesc": "bin/jsesc" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/json-buffer": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/json-buffer/-/json-buffer-3.0.1.tgz", + "integrity": "sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ==", + "dev": true + }, "node_modules/json-merge-patch": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/json-merge-patch/-/json-merge-patch-1.0.2.tgz", @@ -3959,6 +6199,12 @@ "fast-deep-equal": "^3.1.3" } }, + "node_modules/json-parse-even-better-errors": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz", + "integrity": "sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==", + "dev": true + }, "node_modules/json-pointer": { "version": "0.6.2", "resolved": "https://registry.npmjs.org/json-pointer/-/json-pointer-0.6.2.tgz", @@ -3978,6 +6224,13 @@ "version": "1.0.0", "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", + "dev": true, + "license": "MIT" + }, + "node_modules/json-stable-stringify-without-jsonify": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz", + "integrity": "sha512-Bdboy+l7tA3OGW6FjyFHWkP5LuByj1Tk33Ljyq0axyzdk9//JSi2u3fP1QSmd1KNwq6VOKYGlAu87CisVir6Pw==", "dev": true }, "node_modules/json-stringify-safe": { @@ -3986,6 +6239,20 @@ "integrity": "sha512-ZClg6AaYvamvYEE82d3Iyd3vSSIjQ+odgjaTzRuO3s7toCdFKczob2i0zCh7JE8kWn17yvAWhUVxvqGwUalsRA==", "dev": true }, + "node_modules/json-to-ast": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/json-to-ast/-/json-to-ast-2.1.0.tgz", + "integrity": "sha512-W9Lq347r8tA1DfMvAGn9QNcgYm4Wm7Yc+k8e6vezpMnRT+NHbtlxgNBXRVjXe9YM6eTn6+p/MKOlV/aABJcSnQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "code-error-fragment": "0.0.230", + "grapheme-splitter": "^1.0.4" + }, + "engines": { + "node": ">= 4" + } + }, "node_modules/jsonfile": { "version": "6.1.0", "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", @@ -4007,6 +6274,16 @@ "node": ">=10.0.0" } }, + "node_modules/jsonpointer": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/jsonpointer/-/jsonpointer-5.0.1.tgz", + "integrity": "sha512-p/nXbhSEcu3pZRdkW1OfJhpsVtW1gd4Wa1fnQc9YLiTfAjn0312eMKimbdIQzuZl9aa9xUGaRlP9T/CJE/ditQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/jsprim": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/jsprim/-/jsprim-2.0.2.tgz", @@ -4037,6 +6314,15 @@ "node": ">=8" } }, + "node_modules/keyv": { + "version": "4.5.4", + "resolved": "https://registry.npmjs.org/keyv/-/keyv-4.5.4.tgz", + "integrity": "sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw==", + "dev": true, + "dependencies": { + "json-buffer": "3.0.1" + } + }, "node_modules/kleur": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/kleur/-/kleur-3.0.3.tgz", @@ -4052,6 +6338,35 @@ "integrity": "sha512-Xq9nH7KlWZmXAtodXDDRE7vs6DU1gTU8zYDHDiWLSip45Egwq3plLHzPn27NgvzL2r1LMPC1vdqh98sQxtqj4A==", "dev": true }, + "node_modules/leven": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/leven/-/leven-3.1.0.tgz", + "integrity": "sha512-qsda+H8jTaUaN/x5vzW2rzc+8Rw4TAQ/4KjB46IwK5VH+IlVeeeje/EoZRpiXvIqjFgK84QffqPztGI3VBLG1A==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/levn": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz", + "integrity": "sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==", + "dev": true, + "dependencies": { + "prelude-ls": "^1.2.1", + "type-check": "~0.4.0" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/lines-and-columns": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/lines-and-columns/-/lines-and-columns-1.2.4.tgz", + "integrity": "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==", + "dev": true + }, "node_modules/liquid-json": { "version": "0.3.1", "resolved": "https://registry.npmjs.org/liquid-json/-/liquid-json-0.3.1.tgz", @@ -4113,6 +6428,12 @@ "integrity": "sha512-pDo3lu8Jhfjqls6GkMgpahsF9kCyayhgykjyLMNFTKWrpVdAQtYyB4muAMWozBB4ig/dtWAmsMxLEI8wuz+DYQ==", "dev": true }, + "node_modules/lodash.merge": { + "version": "4.6.2", + "resolved": "https://registry.npmjs.org/lodash.merge/-/lodash.merge-4.6.2.tgz", + "integrity": "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==", + "dev": true + }, "node_modules/logform": { "version": "2.6.0", "resolved": "https://registry.npmjs.org/logform/-/logform-2.6.0.tgz", @@ -4292,6 +6613,15 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/min-indent": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/min-indent/-/min-indent-1.0.1.tgz", + "integrity": "sha512-I9jwMn07Sy/IwOj3zVkVik2JTvgpaykDZEigL6Rx6N9LbMywwUSMtxET+7lVoDLLd3O3IXwJwvuuns8UB/HeAg==", + "dev": true, + "engines": { + "node": ">=4" + } + }, "node_modules/minimalistic-assert": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/minimalistic-assert/-/minimalistic-assert-1.0.1.tgz", @@ -4385,6 +6715,12 @@ "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" } }, + "node_modules/natural-compare": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz", + "integrity": "sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw==", + "dev": true + }, "node_modules/neo-async": { "version": "2.6.2", "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz", @@ -4512,8 +6848,35 @@ "resolved": "https://registry.npmjs.org/node-object-hash/-/node-object-hash-1.4.2.tgz", "integrity": "sha512-UdS4swXs85fCGWWf6t6DMGgpN/vnlKeSGEQ7hJcrs7PBFoxoKLmibc3QRb7fwiYsjdL7PX8iI/TMSlZ90dgHhQ==", "dev": true, - "engines": { - "node": ">=0.10.0" + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/node-releases": { + "version": "2.0.14", + "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.14.tgz", + "integrity": "sha512-y10wOWt8yZpqXmOgRo77WaHEmhYQYGNA6y421PKsKYWEK8aW+cqAphborZDhqfyKrbZEN92CN1X2KbafY2s7Yw==", + "dev": true + }, + "node_modules/normalize-package-data": { + "version": "2.5.0", + "resolved": "https://registry.npmjs.org/normalize-package-data/-/normalize-package-data-2.5.0.tgz", + "integrity": "sha512-/5CMN3T0R4XTj4DcGaexo+roZSdSFW/0AOOTROrjxzCG1wrWXEsGbRKevjlIL+ZDE4sZlJr5ED4YW0yqmkK+eA==", + "dev": true, + "dependencies": { + "hosted-git-info": "^2.1.4", + "resolve": "^1.10.0", + "semver": "2 || 3 || 4 || 5", + "validate-npm-package-license": "^3.0.1" + } + }, + "node_modules/normalize-package-data/node_modules/semver": { + "version": "5.7.2", + "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.2.tgz", + "integrity": "sha512-cBznnQ9KjJqU67B52RMC65CMarK2600WFnbkcaiwWq3xy/5haFJlshgnpjovMVJ+Hff49d8GEn0b87C5pDQ10g==", + "dev": true, + "bin": { + "semver": "bin/semver" } }, "node_modules/npm-run-path": { @@ -4712,6 +7075,23 @@ "dev": true, "peer": true }, + "node_modules/optionator": { + "version": "0.9.4", + "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.4.tgz", + "integrity": "sha512-6IpQ7mKUxRcZNLIObR0hz7lxsapSSIYNZJwXPGeF0mTVqGKFIXj1DQcMoT22S3ROcLyY/rz0PWaWZ9ayWmad9g==", + "dev": true, + "dependencies": { + "deep-is": "^0.1.3", + "fast-levenshtein": "^2.0.6", + "levn": "^0.4.1", + "prelude-ls": "^1.2.1", + "type-check": "^0.4.0", + "word-wrap": "^1.2.5" + }, + "engines": { + "node": ">= 0.8.0" + } + }, "node_modules/p-limit": { "version": "2.3.0", "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", @@ -4748,6 +7128,36 @@ "node": ">=6" } }, + "node_modules/parent-module": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", + "integrity": "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==", + "dev": true, + "dependencies": { + "callsites": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/parse-json": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-5.2.0.tgz", + "integrity": "sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg==", + "dev": true, + "dependencies": { + "@babel/code-frame": "^7.0.0", + "error-ex": "^1.3.1", + "json-parse-even-better-errors": "^2.3.0", + "lines-and-columns": "^1.1.6" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/parse-ms": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/parse-ms/-/parse-ms-2.1.0.tgz", @@ -4784,6 +7194,12 @@ "node": ">=8" } }, + "node_modules/path-parse": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz", + "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", + "dev": true + }, "node_modules/path-to-regexp": { "version": "6.2.2", "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-6.2.2.tgz", @@ -5065,6 +7481,15 @@ "node": ">=10" } }, + "node_modules/prelude-ls": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz", + "integrity": "sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==", + "dev": true, + "engines": { + "node": ">= 0.8.0" + } + }, "node_modules/prettier": { "version": "3.2.5", "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.2.5.tgz", @@ -5130,6 +7555,36 @@ "node": ">= 0.6.0" } }, + "node_modules/prompt-sync": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/prompt-sync/-/prompt-sync-4.2.0.tgz", + "integrity": "sha512-BuEzzc5zptP5LsgV5MZETjDaKSWfchl5U9Luiu8SKp7iZWD5tZalOxvNcZRwv+d2phNFr8xlbxmFNcRKfJOzJw==", + "dev": true, + "dependencies": { + "strip-ansi": "^5.0.0" + } + }, + "node_modules/prompt-sync/node_modules/ansi-regex": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.1.tgz", + "integrity": "sha512-ILlv4k/3f6vfQ4OoP2AGvirOktlQ98ZEL1k9FaQjxa3L1abBgbuTDAdPOpvbGncC0BTVQrl+OM8xZGK6tWXt7g==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/prompt-sync/node_modules/strip-ansi": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz", + "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==", + "dev": true, + "dependencies": { + "ansi-regex": "^4.1.0" + }, + "engines": { + "node": ">=6" + } + }, "node_modules/prompts": { "version": "2.4.2", "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz", @@ -5143,6 +7598,28 @@ "node": ">= 6" } }, + "node_modules/proper-lockfile": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/proper-lockfile/-/proper-lockfile-2.0.1.tgz", + "integrity": "sha512-rjaeGbsmhNDcDInmwi4MuI6mRwJu6zq8GjYCLuSuE7GF+4UjgzkL69sVKKJ2T2xH61kK7rXvGYpvaTu909oXaQ==", + "dev": true, + "dependencies": { + "graceful-fs": "^4.1.2", + "retry": "^0.10.0" + }, + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/proper-lockfile/node_modules/retry": { + "version": "0.10.1", + "resolved": "https://registry.npmjs.org/retry/-/retry-0.10.1.tgz", + "integrity": "sha512-ZXUSQYTHdl3uS7IuCehYfMzKyIDBNoAuUblvy5oGO5UJSUTmStUUVPXbA9Qxd173Bgre53yCQczQuHgRWAdvJQ==", + "dev": true, + "engines": { + "node": "*" + } + }, "node_modules/psl": { "version": "1.9.0", "resolved": "https://registry.npmjs.org/psl/-/psl-1.9.0.tgz", @@ -5199,6 +7676,56 @@ "integrity": "sha512-/LLMVyas0ljjAtoYiPqYiL8VWXzUUdThrmU5+n20DZv+a+ClRoevUzw5JxU+Ieh5/c87ytoTBV9G1FiKfNJdmg==", "dev": true }, + "node_modules/read-pkg": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/read-pkg/-/read-pkg-5.2.0.tgz", + "integrity": "sha512-Ug69mNOpfvKDAc2Q8DRpMjjzdtrnv9HcSMX+4VsZxD1aZ6ZzrIE7rlzXBtWTyhULSMKg076AW6WR5iZpD0JiOg==", + "dev": true, + "dependencies": { + "@types/normalize-package-data": "^2.4.0", + "normalize-package-data": "^2.5.0", + "parse-json": "^5.0.0", + "type-fest": "^0.6.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/read-pkg-up": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/read-pkg-up/-/read-pkg-up-7.0.1.tgz", + "integrity": "sha512-zK0TB7Xd6JpCLmlLmufqykGE+/TlOePD6qKClNW7hHDKFh/J7/7gCWGR7joEQEW1bKq3a3yUZSObOoWLFQ4ohg==", + "dev": true, + "dependencies": { + "find-up": "^4.1.0", + "read-pkg": "^5.2.0", + "type-fest": "^0.8.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/read-pkg-up/node_modules/type-fest": { + "version": "0.8.1", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.8.1.tgz", + "integrity": "sha512-4dbzIzqvjtgiM5rw1k5rEHtBANKmdudhGyBEajN01fEyhaAIhsoKNy6y7+IN93IfpFtwY9iqi7kD+xwKhQsNJA==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/read-pkg/node_modules/type-fest": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.6.0.tgz", + "integrity": "sha512-q+MB8nYR1KDLrgr4G5yemftpMC7/QLqVndBmEEdqzmNj5dcFOO4Oo8qlwZE3ULT3+Zim1F8Kq4cBnikNhlCMlg==", + "dev": true, + "engines": { + "node": ">=8" + } + }, "node_modules/readable-stream": { "version": "3.6.2", "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz", @@ -5219,6 +7746,43 @@ "integrity": "sha512-ZhYeb6nRaXCfhnndflDK8qI6ZQ/YcWZCISRAWICW9XYqMUwjZM9Z0DveWX/ABN01oxSHwVxKQmxeYZSsm0jh5A==", "dev": true }, + "node_modules/regenerator-runtime": { + "version": "0.14.1", + "resolved": "https://registry.npmjs.org/regenerator-runtime/-/regenerator-runtime-0.14.1.tgz", + "integrity": "sha512-dYnhHh0nJoMfnkZs6GmmhFknAGRrLznOu5nc9ML+EJxGvrx6H7teuevqVqCuPcPK//3eDrrjQhehXVx9cnkGdw==", + "dev": true, + "license": "MIT" + }, + "node_modules/regexp-tree": { + "version": "0.1.27", + "resolved": "https://registry.npmjs.org/regexp-tree/-/regexp-tree-0.1.27.tgz", + "integrity": "sha512-iETxpjK6YoRWJG5o6hXLwvjYAoW+FEZn9os0PD/b6AP6xQwsa/Y7lCVgIixBbUPMfhu+i2LtdeAqVTgGlQarfA==", + "dev": true, + "bin": { + "regexp-tree": "bin/regexp-tree" + } + }, + "node_modules/regjsparser": { + "version": "0.10.0", + "resolved": "https://registry.npmjs.org/regjsparser/-/regjsparser-0.10.0.tgz", + "integrity": "sha512-qx+xQGZVsy55CH0a1hiVwHmqjLryfh7wQyF5HO07XJ9f7dQMY/gPQHhlyDkIzJKC+x2fUCpCcUODUUUFrm7SHA==", + "dev": true, + "dependencies": { + "jsesc": "~0.5.0" + }, + "bin": { + "regjsparser": "bin/parser" + } + }, + "node_modules/regjsparser/node_modules/jsesc": { + "version": "0.5.0", + "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-0.5.0.tgz", + "integrity": "sha512-uZz5UnB7u4T9LvwmFqXii7pZSouaRPorGs5who1Ip7VO0wxanFvBL7GkM6dTHlgX+jhBApRetaWpnDabOeTcnA==", + "dev": true, + "bin": { + "jsesc": "bin/jsesc" + } + }, "node_modules/require-directory": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", @@ -5233,6 +7797,7 @@ "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", "dev": true, + "license": "MIT", "engines": { "node": ">=0.10.0" } @@ -5249,6 +7814,32 @@ "integrity": "sha512-KigOCHcocU3XODJxsu8i/j8T9tzT4adHiecwORRQ0ZZFcp7ahwXuRU1m+yuO90C5ZUyGeGfocHDI14M3L3yDAQ==", "dev": true }, + "node_modules/resolve": { + "version": "1.22.8", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.8.tgz", + "integrity": "sha512-oKWePCxqpd6FlLvGV1VU0x7bkPmmCNolxzjMf4NczoDnQcIWrAF+cPtZn5i6n+RfD2d9i0tzpKnG6Yk168yIyw==", + "dev": true, + "dependencies": { + "is-core-module": "^2.13.0", + "path-parse": "^1.0.7", + "supports-preserve-symlinks-flag": "^1.0.0" + }, + "bin": { + "resolve": "bin/resolve" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/resolve-from": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", + "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", + "dev": true, + "engines": { + "node": ">=4" + } + }, "node_modules/retry": { "version": "0.13.1", "resolved": "https://registry.npmjs.org/retry/-/retry-0.13.1.tgz", @@ -5268,6 +7859,22 @@ "node": ">=0.10.0" } }, + "node_modules/rimraf": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz", + "integrity": "sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==", + "deprecated": "Rimraf versions prior to v4 are no longer supported", + "dev": true, + "dependencies": { + "glob": "^7.1.3" + }, + "bin": { + "rimraf": "bin.js" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, "node_modules/rollup": { "version": "4.18.0", "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.18.0.tgz", @@ -5511,6 +8118,44 @@ "node": ">=0.10.0" } }, + "node_modules/spdx-correct": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/spdx-correct/-/spdx-correct-3.2.0.tgz", + "integrity": "sha512-kN9dJbvnySHULIluDHy32WHRUu3Og7B9sbY7tsFLctQkIqnMh3hErYgdMjTYuqmcXX+lK5T1lnUt3G7zNswmZA==", + "dev": true, + "dependencies": { + "spdx-expression-parse": "^3.0.0", + "spdx-license-ids": "^3.0.0" + } + }, + "node_modules/spdx-exceptions": { + "version": "2.5.0", + "resolved": "https://registry.npmjs.org/spdx-exceptions/-/spdx-exceptions-2.5.0.tgz", + "integrity": "sha512-PiU42r+xO4UbUS1buo3LPJkjlO7430Xn5SVAhdpzzsPHsjbYVflnnFdATgabnLude+Cqu25p6N+g2lw/PFsa4w==", + "dev": true + }, + "node_modules/spdx-expression-parse": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/spdx-expression-parse/-/spdx-expression-parse-3.0.1.tgz", + "integrity": "sha512-cbqHunsQWnJNE6KhVSMsMeH5H/L9EpymbzqTQ3uLwNCLZ1Q481oWaofqH7nO6V07xlXwY6PhQdQ2IedWx/ZK4Q==", + "dev": true, + "dependencies": { + "spdx-exceptions": "^2.1.0", + "spdx-license-ids": "^3.0.0" + } + }, + "node_modules/spdx-license-ids": { + "version": "3.0.18", + "resolved": "https://registry.npmjs.org/spdx-license-ids/-/spdx-license-ids-3.0.18.tgz", + "integrity": "sha512-xxRs31BqRYHwiMzudOrpSiHtZ8i/GeionCBDSilhYRj+9gIcI8wCZTlXZKu9vZIVqViP3dcp9qE5G6AlIaD+TQ==", + "dev": true + }, + "node_modules/sponge-case": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/sponge-case/-/sponge-case-2.0.3.tgz", + "integrity": "sha512-i4h9ZGRfxV6Xw3mpZSFOfbXjf0cQcYmssGWutgNIfFZ2VM+YIWfD71N/kjjwK6X/AAHzBr+rciEcn/L34S8TGw==", + "dev": true + }, "node_modules/sprintf-js": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", @@ -5625,6 +8270,18 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/strip-indent": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/strip-indent/-/strip-indent-3.0.0.tgz", + "integrity": "sha512-laJTa3Jb+VQpaC6DseHhF7dXVqHTfJPCRDaEbid/drOhgitgYku/letMUqOXFoWV0zIIUbjpdH2t+tYj4bQMRQ==", + "dev": true, + "dependencies": { + "min-indent": "^1.0.0" + }, + "engines": { + "node": ">=8" + } + }, "node_modules/strip-json-comments": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", @@ -5667,16 +8324,51 @@ "node": ">=4" } }, + "node_modules/supports-preserve-symlinks-flag": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz", + "integrity": "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==", + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/suppressions": { "resolved": "eng/tools/suppressions", "link": true }, + "node_modules/swap-case": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/swap-case/-/swap-case-3.0.3.tgz", + "integrity": "sha512-6p4op8wE9CQv7uDFzulI6YXUw4lD9n4oQierdbFThEKVWVQcbQcUjdP27W8XE7V4QnWmnq9jueSHceyyQnqQVA==", + "dev": true + }, "node_modules/teleport-javascript": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/teleport-javascript/-/teleport-javascript-1.0.0.tgz", "integrity": "sha512-j1llvWVFyEn/6XIFDfX5LAU43DXe0GCt3NfXDwJ8XpRRMkS+i50SAkonAONBy+vxwPFBd50MFU8a2uj8R/ccLg==", "dev": true }, + "node_modules/temporal-polyfill": { + "version": "0.2.5", + "resolved": "https://registry.npmjs.org/temporal-polyfill/-/temporal-polyfill-0.2.5.tgz", + "integrity": "sha512-ye47xp8Cb0nDguAhrrDS1JT1SzwEV9e26sSsrWzVu+yPZ7LzceEcH0i2gci9jWfOfSCCgM3Qv5nOYShVUUFUXA==", + "dev": true, + "license": "MIT", + "dependencies": { + "temporal-spec": "^0.2.4" + } + }, + "node_modules/temporal-spec": { + "version": "0.2.4", + "resolved": "https://registry.npmjs.org/temporal-spec/-/temporal-spec-0.2.4.tgz", + "integrity": "sha512-lDMFv4nKQrSjlkHKAlHVqKrBG4DyFfa9F74cmBZ3Iy3ed8yvWnlWSIdi4IKfSqwmazAohBNwiN64qGx4y5Q3IQ==", + "dev": true, + "license": "ISC" + }, "node_modules/test-exclude": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-6.0.0.tgz", @@ -5697,6 +8389,12 @@ "integrity": "sha512-uuVGNWzgJ4yhRaNSiubPY7OjISw4sw4E5Uv0wbjp+OzcbmVU/rsT8ujgcXJhn9ypzsgr5vlzpPqP+MBBKcGvbg==", "dev": true }, + "node_modules/text-table": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/text-table/-/text-table-0.2.0.tgz", + "integrity": "sha512-N+8UisAXDGk8PFXP4HAzVR9nbfmVJ3zYLAWiTIoqC5v5isinhr+r5uaO8+7r3BMfuNIufIsA7RdpVgacC2cSpw==", + "dev": true + }, "node_modules/tinybench": { "version": "2.8.0", "resolved": "https://registry.npmjs.org/tinybench/-/tinybench-2.8.0.tgz", @@ -5721,6 +8419,15 @@ "node": ">=14.0.0" } }, + "node_modules/title-case": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/title-case/-/title-case-3.0.3.tgz", + "integrity": "sha512-e1zGYRvbffpcHIrnuqT0Dh+gEJtDaxDSoG4JAIpq4oDFyooziLBIiYQv0GBT4FUAnUop5uZ1hiIAj7oAF6sOCA==", + "dev": true, + "dependencies": { + "tslib": "^2.0.3" + } + }, "node_modules/to-fast-properties": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/to-fast-properties/-/to-fast-properties-2.0.0.tgz", @@ -5763,6 +8470,18 @@ "node": ">= 14.0.0" } }, + "node_modules/ts-api-utils": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-1.3.0.tgz", + "integrity": "sha512-UQMIo7pb8WRomKR1/+MFVLTroIvDVtMX3K6OUir8ynLyzB8Jeriont2bTAtmNPa1ekAgN7YPDyf6V+ygrdU+eQ==", + "dev": true, + "engines": { + "node": ">=16" + }, + "peerDependencies": { + "typescript": ">=4.2.0" + } + }, "node_modules/tslib": { "version": "2.6.3", "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.6.3.tgz", @@ -5784,6 +8503,18 @@ "integrity": "sha512-KXXFFdAbFXY4geFIwoyNK+f5Z1b7swfXABfL7HXCmoIWMKU3dmS26672A4EeQtDzLKy7SXmfBu51JolvEKwtGA==", "dev": true }, + "node_modules/type-check": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz", + "integrity": "sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==", + "dev": true, + "dependencies": { + "prelude-ls": "^1.2.1" + }, + "engines": { + "node": ">= 0.8.0" + } + }, "node_modules/type-detect": { "version": "4.0.8", "resolved": "https://registry.npmjs.org/type-detect/-/type-detect-4.0.8.tgz", @@ -5793,6 +8524,18 @@ "node": ">=4" } }, + "node_modules/type-fest": { + "version": "0.20.2", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz", + "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==", + "dev": true, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/typescript": { "version": "5.4.5", "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.4.5.tgz", @@ -5806,6 +8549,32 @@ "node": ">=14.17" } }, + "node_modules/typescript-eslint": { + "version": "7.16.1", + "resolved": "https://registry.npmjs.org/typescript-eslint/-/typescript-eslint-7.16.1.tgz", + "integrity": "sha512-889oE5qELj65q/tGeOSvlreNKhimitFwZqQ0o7PcWC7/lgRkAMknznsCsV8J8mZGTP/Z+cIbX8accf2DE33hrA==", + "dev": true, + "dependencies": { + "@typescript-eslint/eslint-plugin": "7.16.1", + "@typescript-eslint/parser": "7.16.1", + "@typescript-eslint/utils": "7.16.1" + }, + "engines": { + "node": "^18.18.0 || >=20.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "eslint": "^8.56.0" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, "node_modules/ufo": { "version": "1.5.3", "resolved": "https://registry.npmjs.org/ufo/-/ufo-1.5.3.tgz", @@ -5858,6 +8627,36 @@ "node": ">= 10.0.0" } }, + "node_modules/update-browserslist-db": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.1.0.tgz", + "integrity": "sha512-EdRAaAyk2cUE1wOf2DkEhzxqOQvFOoRJFNS6NeyJ01Gp2beMRpBAINjM2iDXE3KCuKhwnvHIQCJm6ThL2Z+HzQ==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/browserslist" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "dependencies": { + "escalade": "^3.1.2", + "picocolors": "^1.0.1" + }, + "bin": { + "update-browserslist-db": "cli.js" + }, + "peerDependencies": { + "browserslist": ">= 4.21.0" + } + }, "node_modules/uri-js": { "version": "4.4.1", "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", @@ -5904,6 +8703,16 @@ "node": ">=10" } }, + "node_modules/validate-npm-package-license": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/validate-npm-package-license/-/validate-npm-package-license-3.0.4.tgz", + "integrity": "sha512-DpKm2Ui/xN7/HQKCtpZxoRWBhZ9Z0kqtygG8XCgNQ8ZlDnxuQmWhj566j8fN4Cu3/JmbhsDo7fcAJq4s9h27Ew==", + "dev": true, + "dependencies": { + "spdx-correct": "^3.0.0", + "spdx-expression-parse": "^3.0.0" + } + }, "node_modules/validator": { "version": "13.12.0", "resolved": "https://registry.npmjs.org/validator/-/validator-13.12.0.tgz", diff --git a/package.json b/package.json index 9b953df05fc1..a57e2a376466 100644 --- a/package.json +++ b/package.json @@ -1,20 +1,21 @@ { "name": "azure-rest-api-specs", "devDependencies": { - "@azure-tools/typespec-apiview": "0.4.8", - "@azure-tools/typespec-autorest": "0.43.0", - "@azure-tools/typespec-azure-core": "0.43.0", - "@azure-tools/typespec-azure-portal-core": "0.43.0", - "@azure-tools/typespec-azure-resource-manager": "0.43.0", - "@azure-tools/typespec-client-generator-core": "0.43.0", - "@azure-tools/typespec-azure-rulesets": "0.43.0", + "@azure-tools/typespec-apiview": "0.4.9", + "@azure-tools/typespec-autorest": "0.44.0", + "@azure-tools/typespec-azure-core": "0.44.0", + "@azure-tools/typespec-azure-portal-core": "0.44.0", + "@azure-tools/typespec-azure-resource-manager": "0.44.0", + "@azure-tools/typespec-azure-rulesets": "0.44.0", + "@azure-tools/typespec-client-generator-cli": "0.9.3", + "@azure-tools/typespec-client-generator-core": "0.44.0", "@azure/avocado": "^0.8.4", - "@typespec/compiler": "0.57.0", - "@typespec/http": "0.57.0", - "@typespec/openapi": "0.57.0", - "@typespec/openapi3": "0.57.0", - "@typespec/rest": "0.57.0", - "@typespec/versioning": "0.57.0", + "@typespec/compiler": "0.58.1", + "@typespec/http": "0.58.0", + "@typespec/openapi": "0.58.0", + "@typespec/openapi3": "0.58.0", + "@typespec/rest": "0.58.0", + "@typespec/versioning": "0.58.0", "azure-rest-api-specs-eng-tools": "file:eng/tools", "oav": "^3.3.7", "prettier": "~3.2.5", diff --git a/specification/ai/Face/models.session.tsp b/specification/ai/Face/models.session.tsp index a3cda20247c6..bcf04fe373d2 100644 --- a/specification/ai/Face/models.session.tsp +++ b/specification/ai/Face/models.session.tsp @@ -267,10 +267,6 @@ model LivenessSessionAuditEntry { @doc("Request of liveness with verify session creation.") model CreateLivenessWithVerifySessionContent { - @doc("The content type for the operation. Always multipart/form-data for this operation.") - @header("content-type") - contentType: "multipart/form-data"; - #suppress "@azure-tools/typespec-azure-core/casing-style" @doc("The parameters for creating session.") Parameters: CreateLivenessSessionContent; @@ -279,3 +275,14 @@ model CreateLivenessWithVerifySessionContent { @doc("The image stream for verify. Content-Disposition header field for this part must have filename.") VerifyImage: bytes; } + +@doc("Request wrapper of liveness with verify session creation.") +model CreateLivenessWithVerifySessionRequest { + @doc("The content type for the operation. Always multipart/form-data for this operation.") + @header("content-type") + contentType: "multipart/form-data"; + + @doc("Request content of liveness with verify session creation.") + @body + body: CreateLivenessWithVerifySessionContent; +} diff --git a/specification/ai/Face/routes.session.tsp b/specification/ai/Face/routes.session.tsp index 4c5c59085f75..8878172142a5 100644 --- a/specification/ai/Face/routes.session.tsp +++ b/specification/ai/Face/routes.session.tsp @@ -102,7 +102,7 @@ interface LivenessSessionOperations { @sharedRoute createLivenessWithVerifySessionWithVerifyImage is FaceResourceCreateWithServiceProvidedName< LivenessWithVerifySession, - CreateLivenessWithVerifySessionContent, + CreateLivenessWithVerifySessionRequest, CreateLivenessWithVerifySessionResult >; diff --git a/specification/ai/Face/tspconfig.yaml b/specification/ai/Face/tspconfig.yaml index b96f9c05c0aa..6fcc4953bc9f 100644 --- a/specification/ai/Face/tspconfig.yaml +++ b/specification/ai/Face/tspconfig.yaml @@ -37,7 +37,6 @@ options: package-dir: "azure-ai-vision-face" namespace: com.azure.ai.vision.face partial-update: true - stream-style-serialization: false flavor: azure linter: extends: diff --git a/specification/ai/OpenAI.Assistants/assistants/routes.tsp b/specification/ai/OpenAI.Assistants/assistants/routes.tsp index e8746c12abf6..8c03597f64a0 100644 --- a/specification/ai/OpenAI.Assistants/assistants/routes.tsp +++ b/specification/ai/OpenAI.Assistants/assistants/routes.tsp @@ -20,7 +20,13 @@ namespace Azure.AI.OpenAI.Assistants; @post @added(ServiceApiVersions.v2024_02_15_preview) @route("/assistants") -op createAssistant(...BodyParameter): Assistant; +op createAssistant( + /** + * The request details to use when creating a new assistant. + */ + @bodyRoot + body: AssistantCreationOptions, +): Assistant; /** * Gets a list of assistants that were previously created. @@ -63,7 +69,13 @@ op getAssistant(@path assistantId: string): Assistant; @post @route("/assistants/{assistantId}") @added(ServiceApiVersions.v2024_02_15_preview) -op updateAssistant(...BodyParameter): Assistant; +op updateAssistant( + /** + * The request details to use when modifying an existing assistant. + */ + @bodyRoot + body: UpdateAssistantOptions, +): Assistant; /** * Deletes an assistant. diff --git a/specification/ai/OpenAI.Assistants/client.tsp b/specification/ai/OpenAI.Assistants/client.tsp index 09cbd97e3622..c7d3bf1c8a79 100644 --- a/specification/ai/OpenAI.Assistants/client.tsp +++ b/specification/ai/OpenAI.Assistants/client.tsp @@ -230,4 +230,35 @@ namespace Azure.AI.OpenAI.Assistants { // From https://platform.openai.com/docs/assistants/how-it-works // "Note that deleting an AssistantFile doesn’t delete the original File object, it simply deletes the association // between that File and the Assistant." + + @@clientName(createAssistant::parameters.body, + "assistantCreationOptions", + "java" + ); + @@clientName(updateAssistant::parameters.body, + "updateAssistantOptions", + "java" + ); + @@clientName(createThreadAndRun::parameters.body, + "createAndRunThreadOptions", + "java" + ); + @@clientName(createThread::parameters.body, + "assistantThreadCreationOptions", + "java" + ); + @@clientName(updateThread::parameters.body, + "updateAssistantThreadOptions", + "java" + ); + @@clientName(createVectorStore::parameters.body, + "vectorStoreOptions", + "java" + ); + @@clientName(modifyVectorStore::parameters.body, + "vectorStoreUpdateOptions", + "java" + ); + @@clientName(createRun::parameters.body, "createRunOptions", "java"); + @@clientName(createMessage::parameters.body, "threadMessageOptions", "java"); } diff --git a/specification/ai/OpenAI.Assistants/common/models.tsp b/specification/ai/OpenAI.Assistants/common/models.tsp index 85fb2d648611..5c446a1d1d42 100644 --- a/specification/ai/OpenAI.Assistants/common/models.tsp +++ b/specification/ai/OpenAI.Assistants/common/models.tsp @@ -148,14 +148,3 @@ union ApiResponseFormat { /** Using `json_object` format will limit the usage of ToolCall to only functions. */ jsonObject: "json_object", } - -alias BodyParameter< - T, - TName extends valueof string = "body", - TDoc extends valueof string = "Body parameter." -> = { - @doc(TDoc) - @friendlyName(TName) - @bodyRoot - body: T; -}; diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json new file mode 100644 index 000000000000..5317d558935b --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/cancel_run.json @@ -0,0 +1,38 @@ +{ + "title": "Cancels a run that is `in_progress`.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1699076126, + "assistant_id": "asst_BUf53eW0aua3EjHTyO3P3evb", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "cancelling", + "started_at": 1699076126, + "expires_at": 1699076726, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-1106", + "instructions": "You solve math problems.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "incomplete_details": null, + "metadata": {}, + "usage": null + } + } + }, + "operationId": "CancelRun" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json index 24f1208ac3df..5a9981a936b5 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json @@ -1,4 +1,37 @@ { - "title": "Assistants_CreateAssistant", - "operationId": "Assistants_CreateAssistant" + "title": "Create an assistant with a model and instructions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "body": { + "name": "Math Tutor", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "model": "gpt-4-1106-preview" + } + }, + "responses": { + "200": { + "body": { + "id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", + "object": "assistant", + "created_at": 1718875084, + "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": {} + } + } + }, + "operationId": "CreateAssistant" } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json new file mode 100644 index 000000000000..c0318a2f3364 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_message.json @@ -0,0 +1,40 @@ +{ + "title": "Create a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", + "body": { + "role": "user", + "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces." + } + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "assistant_id": null, + "run_id": null, + "metadata": {} + } + } + }, + "operationId": "CreateMessage" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json new file mode 100644 index 000000000000..b516adecefd2 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_run.json @@ -0,0 +1,36 @@ +{ + "title": "Create a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_2CTH1wOJezLOA3QRefyO3wyk", + "body": { + "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI" + } + }, + "responses": { + "200": { + "body": { + "id": "run_dmC5IgLBfaK8gBy0FKIXGtpr", + "object": "thread.run", + "created_at": 1707301142, + "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI", + "thread_id": "thread_2CTH1wOJezLOA3QRefyO3wyk", + "status": "queued", + "incomplete_details": null, + "usage": null, + "started_at": null, + "expires_at": 1707301742, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "metadata": {} + } + } + }, + "operationId": "CreateRun" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread.json new file mode 100644 index 000000000000..9b2b9a3a463c --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread.json @@ -0,0 +1,19 @@ +{ + "title": "Creates a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": {} + } + } + }, + "operationId": "CreateThread" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json new file mode 100644 index 000000000000..2babffbce6d5 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_thread_and_run.json @@ -0,0 +1,35 @@ +{ + "title": "Create a thread and run it in one request.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "body": { + "assistant_id": "{{assistants.id}}" + } + }, + "responses": { + "200": { + "body": { + "id": "run_jwY1tMUeOjSpq0Swwm6JqSi6", + "object": "thread.run", + "created_at": 1707300252, + "assistant_id": "asst_se10QpYqDv7RQx13zdpskKlz", + "thread_id": "thread_7CJfaYBtuRIOSksocRrYNQGV", + "status": "queued", + "started_at": null, + "expires_at": 1707300852, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "usage": null, + "incomplete_details": null, + "metadata": {} + } + } + }, + "operationId": "CreateThreadAndRun" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant.json new file mode 100644 index 000000000000..f300dfb2ad72 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_assistant.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "assistantId": "asst_4nsG2qgNzimRPE7MazXTXbU7" + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant.deleted", + "deleted": true + } + } + }, + "operationId": "DeleteAssistant" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_file.json new file mode 100644 index 000000000000..7d89fe77f52f --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_file.json @@ -0,0 +1,18 @@ +{ + "title": "Delete a previously uploaded file.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": { + "object": "file", + "deleted": true, + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + } + } + }, + "operationId": "DeleteFile" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_thread.json new file mode 100644 index 000000000000..e14eac104c85 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/delete_thread.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread.deleted", + "deleted": true + } + } + }, + "operationId": "DeleteThread" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant.json new file mode 100644 index 000000000000..09fa93da8abc --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_assistant.json @@ -0,0 +1,28 @@ +{ + "title": "Retrieves an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "assistantId": "asst_4nsG2qgNzimRPE7MazXTXbU7" + }, + "responses": { + "200": { + "body": { + "id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", + "object": "assistant", + "created_at": 1718875084, + "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": {} + } + } + }, + "operationId": "GetAssistant" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file.json new file mode 100644 index 000000000000..c0a99d1b7a24 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file.json @@ -0,0 +1,21 @@ +{ + "title": "Returns a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199 + } + } + }, + "operationId": "GetFile" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file_content.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file_content.json new file mode 100644 index 000000000000..9f05e09e75d2 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_file_content.json @@ -0,0 +1,14 @@ +{ + "title": "Returns the content of a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": "file content" + } + }, + "operationId": "GetFileContent" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json new file mode 100644 index 000000000000..20fd1c2f15c2 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_message.json @@ -0,0 +1,37 @@ +{ + "title": "Retrieve a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", + "messageId": "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": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "assistant_id": null, + "run_id": null, + "metadata": {} + } + } + }, + "operationId": "GetMessage" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json new file mode 100644 index 000000000000..6dab7987a07e --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run.json @@ -0,0 +1,34 @@ +{ + "title": "Gets a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1707303196, + "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "completed", + "incomplete_details": null, + "usage": null, + "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": [], + "metadata": {} + } + } + }, + "operationId": "GetRun" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run_step.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run_step.json new file mode 100644 index 000000000000..5f74b0d0067a --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_run_step.json @@ -0,0 +1,42 @@ +{ + "title": "Retrieves a run step.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "stepId": "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 + }, + "metadata": {} + } + } + }, + "operationId": "GetRunStep" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_thread.json new file mode 100644 index 000000000000..b2c902c476aa --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/get_thread.json @@ -0,0 +1,19 @@ +{ + "title": "Retrieves a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": {} + } + } + }, + "operationId": "GetThread" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistants.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistants.json new file mode 100644 index 000000000000..56f32fa4007a --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_assistants.json @@ -0,0 +1,52 @@ +{ + "title": "Returns a list of assistants.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "order": "desc", + "limit": 20 + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "asst_qOKETOiUwLnzEc3i3AGuyDi1", + "object": "assistant", + "created_at": 1707257477, + "name": "Stock Analyst", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {} + }, + { + "id": "asst_jBvPFZQ8dMqq4bXb84Gqe8O6", + "object": "assistant", + "created_at": 1707249683, + "name": "Math Tutor", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "You are a personal math tutor. Answer questions briefly, in a sentence or less.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {} + } + ], + "first_id": "asst_qOKETOiUwLnzEc3i3AGuyDi1", + "last_id": "asst_jBvPFZQ8dMqq4bXb84Gqe8O6", + "has_more": false + } + } + }, + "operationId": "ListAssistants" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_file.json new file mode 100644 index 000000000000..39b31a4aa1b6 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_file.json @@ -0,0 +1,34 @@ +{ + "title": "Returns a list of files filtered by purpose", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "purpose": "assistants" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199 + }, + { + "object": "file", + "id": "assistant-D6AmXzgJ6gyGcgT48OmJ8kYc", + "purpose": "assistants", + "filename": "test07a45e38-9b88-449a-9580-94fdb986eb75.txt", + "bytes": 4, + "created_at": 1718886043 + } + ] + } + } + }, + "operationId": "ListFiles" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json new file mode 100644 index 000000000000..20f01a6fda3f --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_messages.json @@ -0,0 +1,67 @@ +{ + "title": "List Messages", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "msg_UyL3BkA02z74QviiYnkBTG5C", + "object": "thread.message", + "created_at": 1707298439, + "thread_id": "thread_RPiAkxp7DKb4j7dzokX6itkR", + "role": "assistant", + "content": [ + { + "type": "text", + "text": { + "value": "The cube root of the sum of the given numbers, rounded to the nearest integer, is 12345.", + "annotations": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "assistant_id": "asst_iaScg6I4dkdYWoaPPTPT7EFy", + "run_id": "run_35BhBv0Ry4vVgjF0vO36Ajzf", + "metadata": {} + }, + { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_RPiAkxp7DKb4j7dzokX6itkR", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "assistant_id": null, + "run_id": null, + "metadata": {} + } + ], + "first_id": "msg_UyL3BkA02z74QviiYnkBTG5C", + "last_id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "has_more": false + } + } + }, + "operationId": "ListMessages" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_run_steps.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_run_steps.json new file mode 100644 index 000000000000..7378eddd2de5 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_run_steps.json @@ -0,0 +1,49 @@ +{ + "title": "Returns a list of run steps belonging to a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "step_abc123", + "object": "thread.run.step", + "created_at": 1699063291, + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "type": "message_creation", + "status": "completed", + "cancelled_at": null, + "completed_at": 1699063291, + "expired_at": null, + "failed_at": null, + "last_error": null, + "step_details": { + "type": "message_creation", + "message_creation": { + "message_id": "msg_abc123" + } + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "metadata": {} + } + ], + "first_id": "step_abc123", + "last_id": "step_abc456", + "has_more": false + } + } + }, + "operationId": "ListRunSteps" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json new file mode 100644 index 000000000000..c044c0365b3f --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/list_runs.json @@ -0,0 +1,45 @@ +{ + "title": "Returns a list of runs belonging to a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_7CJfaYBtuRIOSksocRrYNQGV" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "run_jwY1tMUeOjSpq0Swwm6JqSi6", + "object": "thread.run", + "created_at": 1707300252, + "assistant_id": "asst_se10QpYqDv7RQx13zdpskKlz", + "thread_id": "thread_7CJfaYBtuRIOSksocRrYNQGV", + "status": "completed", + "started_at": 1707300255, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1707300267, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "incomplete_details": null, + "usage": { + "completion_tokens": 1, + "prompt_tokens": 999, + "total_tokens": 1000 + }, + "metadata": {} + } + ], + "first_id": "run_jwY1tMUeOjSpq0Swwm6JqSi6", + "last_id": "run_jwY1tMUeOjSpq0Swwm6JqSi6", + "has_more": false + } + } + }, + "operationId": "ListRuns" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json new file mode 100644 index 000000000000..ff1009e9c1fc --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/submit_tool_outputs_to_run.json @@ -0,0 +1,69 @@ +{ + "title": "When a run has the `status: \"requires_action\"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "body": { + "tool_outputs": [ + { + "tool_call_id": "call_abc123", + "output": "28C" + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1699075592, + "assistant_id": "asst_abc123", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "queued", + "started_at": 1699075592, + "expires_at": 1699076192, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4", + "instructions": "You tell the weather.", + "incomplete_details": null, + "tools": [ + { + "type": "function", + "function": { + "name": "get_weather", + "description": "Determine weather in my location", + "parameters": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The city and state e.g. San Francisco, CA" + }, + "unit": { + "type": "string", + "enum": [ + "c", + "f" + ] + } + }, + "required": [ + "location" + ] + } + } + } + ], + "metadata": {}, + "usage": null + } + } + }, + "operationId": "SubmitToolOutputsToRun" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_assistant.json new file mode 100644 index 000000000000..f0fb253c5f64 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_assistant.json @@ -0,0 +1,31 @@ +{ + "title": "Modifies an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "assistantId": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", + "body": { + "name": "Math Tutor Improved" + } + }, + "responses": { + "200": { + "body": { + "id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", + "object": "assistant", + "created_at": 1718875084, + "name": "Math Tutor Improved", + "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": {} + } + } + }, + "operationId": "UpdateAssistant" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json new file mode 100644 index 000000000000..0021cd3ec12c --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_message.json @@ -0,0 +1,46 @@ +{ + "title": "Modify a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", + "messageId": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "body": { + "metadata": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "assistant_id": null, + "run_id": null, + "status": "incomplete", + "incomplete_details": null, + "completed_at": 1707298421, + "incomplete_at": null, + "metadata": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "operationId": "UpdateMessage" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_run.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_run.json new file mode 100644 index 000000000000..15e95dd58e30 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_run.json @@ -0,0 +1,43 @@ +{ + "title": "Modifies a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "body": { + "metadata": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1707303196, + "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "completed", + "started_at": 1707303197, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1707303201, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "incomplete_details": null, + "usage": null, + "metadata": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "operationId": "UpdateRun" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_thread.json new file mode 100644 index 000000000000..af3b0ddfef32 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/update_thread.json @@ -0,0 +1,28 @@ +{ + "title": "Modifies a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", + "body": { + "metadata": { + "modified": "true", + "user": "abc123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": { + "modified": "true", + "user": "abc123" + } + } + } + }, + "operationId": "UpdateThread" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/upload_file.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/upload_file.json new file mode 100644 index 000000000000..94fd2039a6db --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/upload_file.json @@ -0,0 +1,28 @@ +{ + "title": "Uploads a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "purpose": "assistants", + "file": [ + 0, + 1, + 0, + 1, + 0 + ] + }, + "responses": { + "200": { + "body": { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199 + } + } + }, + "operationId": "UploadFile" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json new file mode 100644 index 000000000000..7f3456272098 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_run.json @@ -0,0 +1,48 @@ +{ + "title": "Cancels a run that is `in_progress`.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_abc123", + "runId": "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_choice": "auto", + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "max_completion_tokens": 1000, + "max_prompt_tokens": 1000, + "incomplete_details": null, + "metadata": {}, + "usage": null, + "temperature": 1.0, + "top_p": 1.0, + "response_format": "auto" + } + } + }, + "operationId": "CancelRun" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_vector_store_file_batch.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_vector_store_file_batch.json new file mode 100644 index 000000000000..1d73787e8c47 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/cancel_vector_store_file_batch.json @@ -0,0 +1,28 @@ +{ + "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": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "batchId": "vsfb_abc123" + }, + "responses": { + "200": { + "body": { + "id": "vsfb_abc123", + "object": "vector_store.files_batch", + "created_at": 1699061776, + "vector_store_id": "vs_abc123", + "status": "cancelling", + "file_counts": { + "in_progress": 12, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 15 + } + } + } + }, + "operationId": "CancelVectorStoreFileBatch" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json index 24f1208ac3df..66b92133fe32 100644 --- a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_assistant.json @@ -1,4 +1,41 @@ { - "title": "Assistants_CreateAssistant", - "operationId": "Assistants_CreateAssistant" + "title": "Create an assistant with a model and instructions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-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" + } + ], + "tool_resources": {}, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + } + } + }, + "operationId": "CreateAssistant" } diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json new file mode 100644 index 000000000000..70ae2b1b9da1 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_message.json @@ -0,0 +1,41 @@ +{ + "title": "Create a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "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": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "attachments": [], + "metadata": {} + } + } + }, + "operationId": "CreateMessage" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json new file mode 100644 index 000000000000..97d2f5b79785 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_run.json @@ -0,0 +1,50 @@ +{ + "title": "Create a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "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": "", + "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" + } + } + }, + "operationId": "CreateRun" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread.json new file mode 100644 index 000000000000..101ade5b001f --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread.json @@ -0,0 +1,20 @@ +{ + "title": "Creates a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "tool_resources": {}, + "metadata": {} + } + } + }, + "operationId": "CreateThread" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json new file mode 100644 index 000000000000..5fdbcedb411f --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_thread_and_run.json @@ -0,0 +1,54 @@ +{ + "title": "Create a thread and run it in one request.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-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": [], + "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" + } + } + }, + "operationId": "CreateThreadAndRun" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store.json new file mode 100644 index 000000000000..60ae754b38c9 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store.json @@ -0,0 +1,32 @@ +{ + "title": "Creates a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "body": { + "name": "Support FAQ" + } + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "usage_bytes": 139920, + "status": "completed", + "last_active_at": 1699061776, + "metadata": {}, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + } + } + }, + "operationId": "CreateVectorStore" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file.json new file mode 100644 index 000000000000..404fe3f1caf9 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file.json @@ -0,0 +1,25 @@ +{ + "title": "Create a vector store file by attaching a File to a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "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 + } + } + }, + "operationId": "CreateVectorStoreFile" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file_batch.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file_batch.json new file mode 100644 index 000000000000..c985b6e7a580 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/create_vector_store_file_batch.json @@ -0,0 +1,33 @@ +{ + "title": "Create a vector store file batch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "body": { + "file_ids": [ + "file-abc123", + "file-abc456" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "vsfb_abc123", + "object": "vector_store.files_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 + } + } + } + }, + "operationId": "CreateVectorStoreFileBatch" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant.json new file mode 100644 index 000000000000..a4675ff13925 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_assistant.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "assistantId": "asst_4nsG2qgNzimRPE7MazXTXbU7" + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant.deleted", + "deleted": true + } + } + }, + "operationId": "DeleteAssistant" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_file.json new file mode 100644 index 000000000000..7c4d93ffd9a6 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_file.json @@ -0,0 +1,18 @@ +{ + "title": "Delete a previously uploaded file.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": { + "object": "file", + "deleted": true, + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + } + } + }, + "operationId": "DeleteFile" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_thread.json new file mode 100644 index 000000000000..fe2b6bc1b662 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_thread.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread.deleted", + "deleted": true + } + } + }, + "operationId": "DeleteThread" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store.json new file mode 100644 index 000000000000..1adda1765fb3 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123 " + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store.deleted", + "deleted": true + } + } + }, + "operationId": "DeleteVectorStore" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store_file.json new file mode 100644 index 000000000000..804790877bdb --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/delete_vector_store_file.json @@ -0,0 +1,19 @@ +{ + "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": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "fileId": "file_abc123" + }, + "responses": { + "200": { + "body": { + "id": "file_abc123", + "object": "vector_store.file.deleted", + "deleted": true + } + } + }, + "operationId": "DeleteVectorStoreFile" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant.json new file mode 100644 index 000000000000..514a7c390012 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_assistant.json @@ -0,0 +1,32 @@ +{ + "title": "Retrieves an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "assistantId": "asst_abc123" + }, + "responses": { + "200": { + "body": { + "id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", + "object": "assistant", + "created_at": 1718875084, + "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" + } + ], + "top_p": 1.0, + "temperature": 1.0, + "tool_resources": {}, + "metadata": {}, + "response_format": "auto" + } + } + }, + "operationId": "GetAssistant" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_file.json new file mode 100644 index 000000000000..af3ab4586d76 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_file.json @@ -0,0 +1,23 @@ +{ + "title": "Returns a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199, + "status": "processed", + "status_details": null + } + } + }, + "operationId": "GetFile" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_file_content.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_file_content.json new file mode 100644 index 000000000000..4b5fec6d67f7 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_file_content.json @@ -0,0 +1,14 @@ +{ + "title": "Returns the content of a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": "file content" + } + }, + "operationId": "GetFileContent" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json new file mode 100644 index 000000000000..03af4b1a4ebe --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_message.json @@ -0,0 +1,38 @@ +{ + "title": "Retrieve a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", + "messageId": "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": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "assistant_id": null, + "run_id": null, + "attachments": [], + "metadata": {} + } + } + }, + "operationId": "GetMessage" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json new file mode 100644 index 000000000000..2895df4dce16 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run.json @@ -0,0 +1,42 @@ +{ + "title": "Gets a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1707303196, + "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "completed", + "incomplete_details": null, + "usage": null, + "started_at": 1707303197, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1707303201, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto", + "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": [], + "metadata": {} + } + } + }, + "operationId": "GetRun" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run_step.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run_step.json new file mode 100644 index 000000000000..556262ddc1a4 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_run_step.json @@ -0,0 +1,42 @@ +{ + "title": "Retrieves a run step.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "stepId": "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 + }, + "metadata": {} + } + } + }, + "operationId": "GetRunStep" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_thread.json new file mode 100644 index 000000000000..8d95c82cfe2d --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_thread.json @@ -0,0 +1,24 @@ +{ + "title": "Retrieves a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": {}, + "tool_resources": { + "code_interpreter": { + "file_ids": [] + } + } + } + } + }, + "operationId": "GetThread" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store.json new file mode 100644 index 000000000000..a8cc51d89802 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store.json @@ -0,0 +1,30 @@ +{ + "title": "Retrieves a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123" + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "usage_bytes": 139920, + "status": "completed", + "last_active_at": 1699061776, + "metadata": {}, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + } + } + }, + "operationId": "GetVectorStore" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file.json new file mode 100644 index 000000000000..2f351de142b6 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file.json @@ -0,0 +1,23 @@ +{ + "title": "Retrieves a vector store file.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "fileId": "file-abc123" + }, + "responses": { + "200": { + "body": { + "id": "file-abc123", + "object": "vector_store.file", + "created_at": 1699061776, + "usage_bytes": 123456, + "vector_store_id": "vs_abcd", + "status": "completed", + "last_error": null + } + } + }, + "operationId": "GetVectorStoreFile" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file_batch.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file_batch.json new file mode 100644 index 000000000000..18f0a0f0a385 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/get_vector_store_file_batch.json @@ -0,0 +1,28 @@ +{ + "title": "Retrieves a vector store file batch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "batchId": "vsfb_abc123" + }, + "responses": { + "200": { + "body": { + "id": "vsfb_abc123", + "object": "vector_store.files_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 + } + } + } + }, + "operationId": "GetVectorStoreFileBatch" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistants.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistants.json new file mode 100644 index 000000000000..2e2a78969007 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_assistants.json @@ -0,0 +1,71 @@ +{ + "title": "Returns a list of assistants.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-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": "", + "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 + } + } + }, + "operationId": "ListAssistants" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_file.json new file mode 100644 index 000000000000..a8c406924328 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_file.json @@ -0,0 +1,38 @@ +{ + "title": "Returns a list of files filtered by purpose", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "purpose": "assistants" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199, + "status": "processed", + "status_details": null + }, + { + "object": "file", + "id": "assistant-D6AmXzgJ6gyGcgT48OmJ8kYc", + "purpose": "assistants", + "filename": "test07a45e38-9b88-449a-9580-94fdb986eb75.txt", + "bytes": 4, + "created_at": 1718886043, + "status": "processed", + "status_details": null + } + ] + } + } + }, + "operationId": "ListFiles" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json new file mode 100644 index 000000000000..4813900797ae --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_messages.json @@ -0,0 +1,69 @@ +{ + "title": "List Messages", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "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": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "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": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "attachments": [], + "metadata": {} + } + ], + "first_id": "msg_abc123", + "last_id": "msg_abc456", + "has_more": false + } + } + }, + "operationId": "ListMessages" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_run_steps.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_run_steps.json new file mode 100644 index 000000000000..e57f889c9165 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_run_steps.json @@ -0,0 +1,49 @@ +{ + "title": "Returns a list of run steps belonging to a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_abc123", + "runId": "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 + }, + "metadata": {} + } + ], + "first_id": "step_abc123", + "last_id": "step_abc456", + "has_more": false + } + } + }, + "operationId": "ListRunSteps" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json new file mode 100644 index 000000000000..e80a557e64c1 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_runs.json @@ -0,0 +1,97 @@ +{ + "title": "Returns a list of runs belonging to a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "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": "", + "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" + }, + { + "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": "", + "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" + } + ], + "first_id": "run_abc123", + "last_id": "run_abc456", + "has_more": false + } + } + }, + "operationId": "ListRuns" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch_files.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch_files.json new file mode 100644 index 000000000000..be54b92a08b5 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_file_batch_files.json @@ -0,0 +1,40 @@ +{ + "title": "Returns a list of vector store files of a given batch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "batchId": "batch-abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "file-abc123", + "usage_bytes": 1234, + "status": "completed", + "last_error": null, + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + }, + { + "id": "file-abc456", + "usage_bytes": 1234, + "status": "completed", + "last_error": null, + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + } + ], + "first_id": "file-abc123", + "last_id": "file-abc456", + "has_more": false + } + } + }, + "operationId": "ListVectorStoreFileBatchFiles" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_files.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_files.json new file mode 100644 index 000000000000..e6406462f735 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_store_files.json @@ -0,0 +1,39 @@ +{ + "title": "Returns a list of vector store files.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "file-abc123", + "usage_bytes": 1234, + "status": "completed", + "last_error": null, + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + }, + { + "id": "file-abc456", + "usage_bytes": 1234, + "status": "completed", + "last_error": null, + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + } + ], + "first_id": "file-abc123", + "last_id": "file-abc456", + "has_more": false + } + } + }, + "operationId": "ListVectorStoreFiles" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_stores.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_stores.json new file mode 100644 index 000000000000..df84331efbac --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/list_vector_stores.json @@ -0,0 +1,54 @@ +{ + "title": "Returns a list of vector stores.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "usage_bytes": 139920, + "status": "in_progress", + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + }, + "last_active_at": 1699061776, + "metadata": {} + }, + { + "id": "vs_abc456", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ v2", + "usage_bytes": 139920, + "status": "in_progress", + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + }, + "last_active_at": 1699061776, + "metadata": {} + } + ], + "first_id": "vs_abc123", + "last_id": "vs_abc456", + "has_more": false + } + } + }, + "operationId": "ListVectorStores" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_vector_store.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_vector_store.json new file mode 100644 index 000000000000..935bdadbd7d2 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/modify_vector_store.json @@ -0,0 +1,33 @@ +{ + "title": "Modifies a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "body": { + "name": "Support FAQ" + } + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "usage_bytes": 139920, + "status": "completed", + "last_active_at": 1699061776, + "metadata": {}, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + } + } + }, + "operationId": "ModifyVectorStore" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json new file mode 100644 index 000000000000..cd810dd4169a --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/submit_tool_outputs_to_run.json @@ -0,0 +1,79 @@ +{ + "title": "When a run has the `status: \"requires_action\"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_123", + "runId": "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": "", + "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, + "incomplete_details": null, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + } + }, + "operationId": "SubmitToolOutputsToRun" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_assistant.json new file mode 100644 index 000000000000..c0e7fc6ee699 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_assistant.json @@ -0,0 +1,45 @@ +{ + "title": "Modifies an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "assistantId": "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" + } + } + }, + "operationId": "UpdateAssistant" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json new file mode 100644 index 000000000000..7621cc8605c7 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_message.json @@ -0,0 +1,47 @@ +{ + "title": "Modify a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_abc123", + "messageId": "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", + "status": "complete", + "incomplete_details": null, + "completed_at": 1699017614, + "incomplete_at": null, + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "How does AI work? Explain it in simple terms.", + "annotations": [] + } + } + ], + "attachments": [], + "metadata": { + "modified": "true", + "user": "abc123" + } + } + } + }, + "operationId": "UpdateMessage" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json new file mode 100644 index 000000000000..709ed437a3ce --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_run.json @@ -0,0 +1,59 @@ +{ + "title": "Modifies a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_abc123", + "runId": "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": "", + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "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" + } + } + }, + "operationId": "UpdateRun" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_thread.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_thread.json new file mode 100644 index 000000000000..e7610f8ec4cf --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/update_thread.json @@ -0,0 +1,29 @@ +{ + "title": "Modifies a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "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": {} + } + } + }, + "operationId": "UpdateThread" +} diff --git a/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/upload_file.json b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/upload_file.json new file mode 100644 index 000000000000..933d5d59974e --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-05-01-preview/upload_file.json @@ -0,0 +1,30 @@ +{ + "title": "Uploads a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "purpose": "assistants", + "file": [ + 0, + 1, + 0, + 1, + 0 + ] + }, + "responses": { + "200": { + "body": { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199, + "status": "processed", + "status_details": null + } + } + }, + "operationId": "UploadFile" +} diff --git a/specification/ai/OpenAI.Assistants/messages/models.tsp b/specification/ai/OpenAI.Assistants/messages/models.tsp index 118cdf5a0d73..3f59eaed0f3c 100644 --- a/specification/ai/OpenAI.Assistants/messages/models.tsp +++ b/specification/ai/OpenAI.Assistants/messages/models.tsp @@ -8,7 +8,7 @@ namespace Azure.AI.OpenAI.Assistants; using TypeSpec.Versioning; /** A single message within an assistant thread, as provided during that thread's creation for its initial state. */ -@added(ServiceApiVersions.v2024_05_01_preview) +@added(ServiceApiVersions.v2024_02_15_preview) model ThreadMessageOptions { /** * The role of the entity that is creating the message. Allowed values include: @@ -25,6 +25,7 @@ model ThreadMessageOptions { /** A list of files attached to the message, and the tools they should be added to. */ #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @added(ServiceApiVersions.v2024_05_01_preview) attachments?: MessageAttachment[] | null; ...OptionalNullableMetadata; diff --git a/specification/ai/OpenAI.Assistants/messages/routes.tsp b/specification/ai/OpenAI.Assistants/messages/routes.tsp index 9d8b27ad11f1..bb8e40cbba3a 100644 --- a/specification/ai/OpenAI.Assistants/messages/routes.tsp +++ b/specification/ai/OpenAI.Assistants/messages/routes.tsp @@ -32,9 +32,7 @@ op createMessage( @path threadId: string, /** A single message within an assistant thread, as provided during that thread's creation for its initial state. */ - @added(ServiceApiVersions.v2024_05_01_preview) - @body - threadMessageOptions: ThreadMessageOptions, + @bodyRoot body: ThreadMessageOptions, ): ThreadMessage; /** diff --git a/specification/ai/OpenAI.Assistants/runs/routes.tsp b/specification/ai/OpenAI.Assistants/runs/routes.tsp index 45847257a2e7..dfe573ab50f1 100644 --- a/specification/ai/OpenAI.Assistants/runs/routes.tsp +++ b/specification/ai/OpenAI.Assistants/runs/routes.tsp @@ -30,7 +30,11 @@ namespace Azure.AI.OpenAI.Assistants; @added(ServiceApiVersions.v2024_02_15_preview) op createRun( @path threadId: string, - @bodyRoot createRunOptions: CreateRunOptions, + + /** + * The details used when creating a new run of an assistant thread. + */ + @bodyRoot body: CreateRunOptions, ): ThreadRun; /** @@ -139,4 +143,10 @@ op cancelRun(@path threadId: string, @path runId: string): ThreadRun; @route("/threads/runs") @doc("Creates a new assistant thread and immediately starts a run using that new thread.") @added(ServiceApiVersions.v2024_02_15_preview) -op createThreadAndRun(...BodyParameter): ThreadRun; +op createThreadAndRun( + /** + * The details used when creating and immediately running a new assistant thread. + */ + @bodyRoot + body: CreateAndRunThreadOptions, +): ThreadRun; diff --git a/specification/ai/OpenAI.Assistants/threads/routes.tsp b/specification/ai/OpenAI.Assistants/threads/routes.tsp index 2f06aacfb89d..84cb8de0b557 100644 --- a/specification/ai/OpenAI.Assistants/threads/routes.tsp +++ b/specification/ai/OpenAI.Assistants/threads/routes.tsp @@ -21,7 +21,11 @@ namespace Azure.AI.OpenAI.Assistants; @added(ServiceApiVersions.v2024_02_15_preview) @route("/threads") op createThread( - ...BodyParameter, + /** + * The details used to create a new assistant thread. + */ + @bodyRoot + body: AssistantThreadCreationOptions, ): AssistantThread; // list threads? @@ -55,7 +59,11 @@ op getThread(@path threadId: string): AssistantThread; @route("/threads/{threadId}") @added(ServiceApiVersions.v2024_02_15_preview) op updateThread( - ...BodyParameter, + /** + * The details used to update an existing assistant thread. + */ + @bodyRoot + body: UpdateAssistantThreadOptions, ): AssistantThread; /** diff --git a/specification/ai/OpenAI.Assistants/tspconfig.yaml b/specification/ai/OpenAI.Assistants/tspconfig.yaml index 564b8e16d05f..75c925ce08fa 100644 --- a/specification/ai/OpenAI.Assistants/tspconfig.yaml +++ b/specification/ai/OpenAI.Assistants/tspconfig.yaml @@ -3,25 +3,25 @@ parameters: default: "sdk/openai" "dependencies": default: "" + output-folder-base: + default: "data-plane/OpenAI.Assistants/" emit: - "@azure-tools/typespec-autorest" - "@typespec/openapi3" -# - "@azure-tools/typespec-java" -# - "@azure-tools/typespec-csharp" linter: extends: - "@azure-tools/typespec-azure-rulesets/data-plane" options: "@azure-tools/typespec-autorest": - azure-resource-provider-folder: "data-plane" - emit-lro-options: "none" emitter-output-dir: "{project-root}/../" - output-file: "data-plane/OpenAI.Assistants/OpenApiV2/{version-status}/{version}/assistants_generated.json" + azure-resource-provider-folder: "data-plane" examples-directory: "{project-root}/examples" + output-file: "{output-folder-base}/OpenApiV2/{version-status}/{version}/assistants_generated.json" omit-unreachable-types: true + emit-lro-options: "none" "@typespec/openapi3": emitter-output-dir: "{project-root}/../" - output-file: "data-plane/OpenAI.Assistants/OpenApiV3/{version}/assistants_generated.yaml" + output-file: "{output-folder-base}/OpenApiV3/{version}/assistants_generated.yaml" "@azure-tools/typespec-csharp": package-dir: "Azure.AI.OpenAI.Assistants" namespace: "Azure.AI.OpenAI.Assistants" diff --git a/specification/ai/OpenAI.Assistants/vector_stores/routes.tsp b/specification/ai/OpenAI.Assistants/vector_stores/routes.tsp index da0395283ad6..28bd617bcfc0 100644 --- a/specification/ai/OpenAI.Assistants/vector_stores/routes.tsp +++ b/specification/ai/OpenAI.Assistants/vector_stores/routes.tsp @@ -34,7 +34,13 @@ op listVectorStores( @post @route("/vector_stores") @added(ServiceApiVersions.v2024_05_01_preview) -op createVectorStore(...BodyParameter): VectorStore; +op createVectorStore( + /** + * Request object for creating a vector store. + */ + @bodyRoot + body: VectorStoreOptions, +): VectorStore; /** * Returns the vector store object matching the specified ID. @@ -63,7 +69,11 @@ op modifyVectorStore( /** The ID of the vector store to modify. */ @path vectorStoreId: string, - ...VectorStoreUpdateOptions, + /** + * Request object for updating a vector store. + */ + @bodyRoot + body: VectorStoreUpdateOptions, ): VectorStore; /** diff --git a/specification/ai/data-plane/Face/preview/v1.1-preview.1/Face.json b/specification/ai/data-plane/Face/preview/v1.1-preview.1/Face.json index 9ad89a4484f6..c2873f6fcae3 100644 --- a/specification/ai/data-plane/Face/preview/v1.1-preview.1/Face.json +++ b/specification/ai/data-plane/Face/preview/v1.1-preview.1/Face.json @@ -642,10 +642,18 @@ ], "parameters": [ { - "$ref": "#/parameters/CreateLivenessWithVerifySessionContent.Parameters" + "name": "Parameters", + "in": "formData", + "description": "The parameters for creating session.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/CreateLivenessWithVerifySessionContent.VerifyImage" + "name": "VerifyImage", + "in": "formData", + "description": "The image stream for verify. Content-Disposition header field for this part must have filename.", + "required": true, + "type": "file" } ], "responses": { @@ -9405,22 +9413,5 @@ "pattern": "^[a-z0-9-_]+$" } }, - "parameters": { - "CreateLivenessWithVerifySessionContent.Parameters": { - "name": "Parameters", - "in": "formData", - "description": "The parameters for creating session.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "CreateLivenessWithVerifySessionContent.VerifyImage": { - "name": "VerifyImage", - "in": "formData", - "description": "The image stream for verify. Content-Disposition header field for this part must have filename.", - "required": true, - "type": "file", - "x-ms-parameter-location": "method" - } - } + "parameters": {} } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2023-02-15-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2023-02-15-preview/assistants_generated.json deleted file mode 100644 index 436e3f654419..000000000000 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2023-02-15-preview/assistants_generated.json +++ /dev/null @@ -1,3452 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure OpenAI", - "version": "2023-02-15-preview", - "description": "Azure OpenAI APIs for Assistants.", - "x-typespec-generated": [ - { - "emitter": "@azure-tools/typespec-autorest" - } - ] - }, - "schemes": [ - "https" - ], - "x-ms-parameterized-host": { - "hostTemplate": "{endpoint}", - "useSchemePrefix": false, - "parameters": [ - { - "name": "endpoint", - "in": "path", - "description": "An OpenAI endpoint supporting assistants functionality.", - "required": true, - "type": "string" - } - ] - }, - "produces": [ - "application/json" - ], - "consumes": [ - "application/json" - ], - "security": [ - { - "ApiKeyAuth": [] - }, - { - "OAuth2Auth": [ - "https://cognitiveservices.azure.com/.default" - ] - } - ], - "securityDefinitions": { - "ApiKeyAuth": { - "type": "apiKey", - "name": "api-key", - "in": "header" - }, - "OAuth2Auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", - "scopes": { - "https://cognitiveservices.azure.com/.default": "" - } - } - }, - "tags": [], - "paths": { - "/assistants": { - "get": { - "operationId": "ListAssistants", - "description": "Gets a list of assistants that were previously created.", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of assistants.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/Assistant" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - }, - "post": { - "operationId": "CreateAssistant", - "description": "Creates a new assistant.", - "parameters": [ - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AssistantCreationOptions" - } - } - ], - "responses": { - "200": { - "description": "The new assistant instance.", - "schema": { - "$ref": "#/definitions/Assistant" - } - } - } - } - }, - "/assistants/{assistantId}": { - "get": { - "operationId": "GetAssistant", - "description": "Retrieves an existing assistant.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to retrieve.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested assistant instance.", - "schema": { - "$ref": "#/definitions/Assistant" - } - } - } - }, - "post": { - "operationId": "ModifyAssistant", - "description": "Modifies an existing assistant.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to modify.", - "required": true, - "type": "string" - }, - { - "name": "modificationOptions", - "in": "body", - "description": "The details of the modification to perform on the specified assistant.", - "required": true, - "schema": { - "$ref": "#/definitions/AssistantModificationOptions" - } - } - ], - "responses": { - "200": { - "description": "The updated assistant instance.", - "schema": { - "$ref": "#/definitions/Assistant" - } - } - } - }, - "delete": { - "operationId": "DeleteAssistant", - "description": "Deletes an assistant.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to delete.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Status information about the requested deletion operation.", - "schema": { - "$ref": "#/definitions/AssistantDeletionStatus" - } - } - } - } - }, - "/assistants/{assistantId}/files": { - "get": { - "operationId": "ListAssistantFiles", - "description": "Gets a list of files attached to a specific assistant, as used by tools that can read files.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to retrieve the list of attached files for.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of files attached to the specified assistant.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/AssistantFile" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - }, - "post": { - "operationId": "CreateAssistantFile", - "description": "Attaches a previously uploaded file to an assistant for use by tools that can read files.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to attach the file to.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the previously uploaded file to attach.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - } - } - ], - "responses": { - "200": { - "description": "Information about the attached file.", - "schema": { - "$ref": "#/definitions/AssistantFile" - } - } - } - } - }, - "/assistants/{assistantId}/files/{fileId}": { - "get": { - "operationId": "GetAssistantFile", - "description": "Retrieves a file attached to an assistant.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant associated with the attached file.", - "required": true, - "type": "string" - }, - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to retrieve.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "A representation of the attached file.", - "schema": { - "$ref": "#/definitions/AssistantFile" - } - } - } - }, - "delete": { - "operationId": "DeleteAssistantFile", - "description": "Unlinks a previously attached file from an assistant, rendering it unavailable for use by tools that can read\nfiles.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant from which the specified file should be unlinked.", - "required": true, - "type": "string" - }, - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to unlink from the specified assistant.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Status information about the requested file association deletion.", - "schema": { - "$ref": "#/definitions/AssistantFileDeletionStatus" - } - } - } - } - }, - "/files": { - "get": { - "operationId": "ListFiles", - "description": "Gets a list of previously uploaded files.", - "parameters": [ - { - "name": "purpose", - "in": "query", - "description": "A value that, when provided, limits list results to files matching the corresponding purpose.", - "required": false, - "type": "string", - "enum": [ - "fine-tune", - "fine-tune-results", - "assistants", - "assistants_output" - ], - "x-ms-enum": { - "name": "FilePurpose", - "modelAsString": true, - "values": [ - { - "name": "fineTune", - "value": "fine-tune", - "description": "Indicates a file is used for fine tuning input." - }, - { - "name": "fineTuneResults", - "value": "fine-tune-results", - "description": "Indicates a file is used for fine tuning results." - }, - { - "name": "assistants", - "value": "assistants", - "description": "Indicates a file is used as input to assistants." - }, - { - "name": "assistantsOutput", - "value": "assistants_output", - "description": "Indicates a file is used as output by assistants." - } - ] - } - } - ], - "responses": { - "200": { - "description": "The requested list of files.", - "schema": { - "$ref": "#/definitions/FileListResponse" - } - } - } - }, - "post": { - "operationId": "CreateFile", - "description": "Uploads a file for use by other operations.", - "consumes": [ - "multipart/form-data" - ], - "parameters": [ - { - "name": "file", - "in": "formData", - "description": "The file data (not filename) to upload.", - "required": true, - "type": "file" - }, - { - "name": "purpose", - "in": "formData", - "description": "The intended purpose of the file.", - "required": true, - "type": "string", - "enum": [ - "fine-tune", - "fine-tune-results", - "assistants", - "assistants_output" - ], - "x-ms-enum": { - "name": "FilePurpose", - "modelAsString": true, - "values": [ - { - "name": "fineTune", - "value": "fine-tune", - "description": "Indicates a file is used for fine tuning input." - }, - { - "name": "fineTuneResults", - "value": "fine-tune-results", - "description": "Indicates a file is used for fine tuning results." - }, - { - "name": "assistants", - "value": "assistants", - "description": "Indicates a file is used as input to assistants." - }, - { - "name": "assistantsOutput", - "value": "assistants_output", - "description": "Indicates a file is used as output by assistants." - } - ] - } - }, - { - "name": "filename", - "in": "formData", - "description": "A filename to associate with the uploaded data.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "A representation of the uploaded file.", - "schema": { - "$ref": "#/definitions/OpenAIFile" - } - } - } - } - }, - "/files/{fileId}": { - "get": { - "operationId": "RetrieveFile", - "description": "Returns information about a specific file. Does not retrieve file content.", - "parameters": [ - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to retrieve.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/OpenAIFile" - } - } - } - }, - "delete": { - "operationId": "DeleteFile", - "description": "Delete a previously uploaded file.", - "parameters": [ - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to delete.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/FileDeletionStatus" - } - } - } - } - }, - "/threads": { - "post": { - "operationId": "CreateThread", - "description": "Creates a new thread. Threads contain messages and can be run by assistants.", - "parameters": [ - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AssistantThreadCreationOptions" - } - } - ], - "responses": { - "200": { - "description": "Information about the newly created thread.", - "schema": { - "$ref": "#/definitions/AssistantThread" - } - } - } - } - }, - "/threads/{threadId}": { - "get": { - "operationId": "GetThread", - "description": "Gets information about an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to retrieve information about.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Information about the requested thread.", - "schema": { - "$ref": "#/definitions/AssistantThread" - } - } - } - }, - "post": { - "operationId": "ModifyThread", - "description": "Modifies an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to modify.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - } - } - ], - "responses": { - "200": { - "description": "Information about the modified thread.", - "schema": { - "$ref": "#/definitions/AssistantThread" - } - } - } - }, - "delete": { - "operationId": "DeleteThread", - "description": "Deletes an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to delete.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Status information about the requested thread deletion operation.", - "schema": { - "$ref": "#/definitions/ThreadDeletionStatus" - } - } - } - } - }, - "/threads/{threadId}/messages": { - "get": { - "operationId": "ListMessages", - "description": "Gets a list of messages that exist on a thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to list messages from.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of messages.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/ThreadMessage" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - }, - "post": { - "operationId": "CreateMessage", - "description": "Creates a new message on a specified thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to create the new message on.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "role": { - "$ref": "#/definitions/MessageRole", - "description": "The role to associate with the new message." - }, - "content": { - "type": "string", - "description": "The textual content for the new message." - }, - "file_ids": { - "type": "array", - "description": "A list of up to 10 file IDs to associate with the message, as used by tools like 'code_interpreter' or 'retrieval' that can read files.", - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "role", - "content" - ] - } - } - ], - "responses": { - "200": { - "description": "A representation of the new message.", - "schema": { - "$ref": "#/definitions/ThreadMessage" - } - } - } - } - }, - "/threads/{threadId}/messages/{messageId}": { - "get": { - "operationId": "GetMessage", - "description": "Gets an existing message from an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to retrieve the specified message from.", - "required": true, - "type": "string" - }, - { - "name": "messageId", - "in": "path", - "description": "The ID of the message to retrieve from the specified thread.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "A representation of the requested message.", - "schema": { - "$ref": "#/definitions/ThreadMessage" - } - } - } - }, - "post": { - "operationId": "ModifyMessage", - "description": "Modifies an existing message on an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread containing the specified message to modify.", - "required": true, - "type": "string" - }, - { - "name": "messageId", - "in": "path", - "description": "The ID of the message to modify on the specified thread.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - } - } - ], - "responses": { - "200": { - "description": "A representation of the modified message.", - "schema": { - "$ref": "#/definitions/ThreadMessage" - } - } - } - } - }, - "/threads/{threadId}/messages/{messageId}/files": { - "get": { - "operationId": "ListMessageFiles", - "description": "Gets a list of previously uploaded files associated with a message from a thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread containing the message to list files from.", - "required": true, - "type": "string" - }, - { - "name": "messageId", - "in": "path", - "description": "The ID of the message to list files from.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of files associated with the specified message.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/MessageFile" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - } - }, - "/threads/{threadId}/messages/{messageId}/files/{fileId}": { - "get": { - "operationId": "GetMessageFile", - "description": "Gets information about a file attachment to a message within a thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread containing the message to get information from.", - "required": true, - "type": "string" - }, - { - "name": "messageId", - "in": "path", - "description": "The ID of the message to get information from.", - "required": true, - "type": "string" - }, - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to get information about.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested file information.", - "schema": { - "$ref": "#/definitions/MessageFile" - } - } - } - } - }, - "/threads/{threadId}/runs": { - "get": { - "operationId": "ListRuns", - "description": "Gets a list of runs for a specified thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to list runs from.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of thread runs.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/ThreadRun" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - }, - "post": { - "operationId": "CreateRun", - "description": "Creates a new run for an assistant thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to run.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "assistant_id": { - "type": "string", - "description": "The ID of the assistant that should run the thread.", - "x-ms-client-name": "assistantId" - }, - "model": { - "type": "string", - "description": "The overridden model name that the assistant should use to run the thread." - }, - "instructions": { - "type": "string", - "description": "The overridden system instructions that the assistant should use to run the thread." - }, - "tools": { - "type": "array", - "description": "The overridden list of enabled tools that the assistant should use to run the thread.", - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "assistant_id" - ] - } - } - ], - "responses": { - "200": { - "description": "Information about the new thread run.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - } - }, - "/threads/{threadId}/runs/{runId}": { - "get": { - "operationId": "GetRun", - "description": "Gets an existing run from an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to retrieve run information from.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the thread to retrieve information about.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested information about the specified thread run.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - }, - "post": { - "operationId": "ModifyRun", - "description": "Modifies an existing thread run.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread associated with the specified run.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the run to modify.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - } - } - ], - "responses": { - "200": { - "description": "Information about the modified run.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - } - }, - "/threads/{threadId}/runs/{runId}/cancel": { - "post": { - "operationId": "CancelRun", - "description": "Cancels a run of an in progress thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread being run.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the run to cancel.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Updated information about the cancelled run.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - } - }, - "/threads/{threadId}/runs/{runId}/steps": { - "get": { - "operationId": "ListRunSteps", - "description": "Gets a list of run steps from a thread run.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread that was run.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the run to list steps from.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of run steps.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/RunStep" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - } - }, - "/threads/{threadId}/runs/{runId}/steps/{stepId}": { - "get": { - "operationId": "GetRunStep", - "description": "Gets a single run step from a thread run.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread that was run.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the specific run to retrieve the step from.", - "required": true, - "type": "string" - }, - { - "name": "stepId", - "in": "path", - "description": "The ID of the step to retrieve information about.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Information about the requested run step.", - "schema": { - "$ref": "#/definitions/RunStep" - } - } - } - } - }, - "/threads/{threadId}/runs/{runId}/submit_tool_outputs": { - "post": { - "operationId": "SubmitToolOutputsToRun", - "description": "Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread that was run.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the run that requires tool outputs.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "tool_outputs": { - "type": "array", - "description": "The list of tool outputs requested by tool calls from the specified run.", - "items": { - "$ref": "#/definitions/ToolOutput" - }, - "x-ms-client-name": "toolOutputs", - "x-ms-identifiers": [] - } - }, - "required": [ - "tool_outputs" - ] - } - } - ], - "responses": { - "200": { - "description": "Updated information about the run.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - } - }, - "/threads/runs": { - "post": { - "operationId": "CreateThreadAndRun", - "description": "Creates a new assistant thread and immediately starts a run using that new thread.", - "parameters": [ - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CreateAndRunThreadOptions" - } - } - ], - "responses": { - "200": { - "description": "Information about the newly created thread.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - } - } - }, - "definitions": { - "Assistant": { - "type": "object", - "description": "Represents an assistant that can call the model and use tools.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always assistant.", - "enum": [ - "assistant" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "name": { - "type": "string", - "description": "The name of the assistant.", - "x-nullable": true - }, - "description": { - "type": "string", - "description": "The description of the assistant.", - "x-nullable": true - }, - "model": { - "type": "string", - "description": "The ID of the model to use." - }, - "instructions": { - "type": "string", - "description": "The system instructions for the assistant to use.", - "x-nullable": true - }, - "tools": { - "type": "array", - "description": "The collection of tools enabled for the assistant.", - "default": [], - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "file_ids": { - "type": "array", - "description": "A list of attached file IDs, ordered by creation date in ascending order.", - "default": [], - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "id", - "object", - "created_at", - "name", - "description", - "model", - "instructions", - "tools", - "file_ids", - "metadata" - ] - }, - "AssistantCreationOptions": { - "type": "object", - "description": "The request details to use when creating a new assistant.", - "properties": { - "model": { - "type": "string", - "description": "The ID of the model to use." - }, - "name": { - "type": "string", - "description": "The name of the new assistant.", - "x-nullable": true - }, - "description": { - "type": "string", - "description": "The description of the new assistant.", - "x-nullable": true - }, - "instructions": { - "type": "string", - "description": "The system instructions for the new assistant to use.", - "x-nullable": true - }, - "tools": { - "type": "array", - "description": "The collection of tools to enable for the new assistant.", - "default": [], - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "file_ids": { - "type": "array", - "description": "A list of previously uploaded file IDs to attach to the assistant.", - "default": [], - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "model" - ] - }, - "AssistantDeletionStatus": { - "type": "object", - "description": "The status of an assistant deletion operation.", - "properties": { - "id": { - "type": "string", - "description": "The ID of the resource specified for deletion." - }, - "deleted": { - "type": "boolean", - "description": "A value indicating whether deletion was successful." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'assistant.deleted'.", - "enum": [ - "assistant.deleted" - ], - "x-ms-enum": { - "modelAsString": false - } - } - }, - "required": [ - "id", - "deleted", - "object" - ] - }, - "AssistantFile": { - "type": "object", - "description": "Information about a file attached to an assistant, as used by tools that can read files.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'assistant.file'.", - "enum": [ - "assistant.file" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "assistant_id": { - "type": "string", - "description": "The assistant ID that the file is attached to.", - "x-ms-client-name": "assistantId" - } - }, - "required": [ - "id", - "object", - "created_at", - "assistant_id" - ] - }, - "AssistantFileDeletionStatus": { - "type": "object", - "description": "The status of an assistant file deletion operation.", - "properties": { - "id": { - "type": "string", - "description": "The ID of the resource specified for deletion." - }, - "deleted": { - "type": "boolean", - "description": "A value indicating whether deletion was successful." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'assistant.file.deleted'.", - "enum": [ - "assistant.file.deleted" - ], - "x-ms-enum": { - "modelAsString": false - } - } - }, - "required": [ - "id", - "deleted", - "object" - ] - }, - "AssistantModificationOptions": { - "type": "object", - "description": "The request details to use when modifying an existing assistant.", - "properties": { - "model": { - "type": "string", - "description": "The ID of the model to use." - }, - "name": { - "type": "string", - "description": "The modified name for the assistant to use.", - "x-nullable": true - }, - "description": { - "type": "string", - "description": "The modified description for the assistant to use.", - "x-nullable": true - }, - "instructions": { - "type": "string", - "description": "The modified system instructions for the new assistant to use.", - "x-nullable": true - }, - "tools": { - "type": "array", - "description": "The modified collection of tools to enable for the assistant.", - "default": [], - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "file_ids": { - "type": "array", - "description": "The modified list of previously uploaded fileIDs to attach to the assistant.", - "default": [], - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - }, - "AssistantThread": { - "type": "object", - "description": "Information about a single thread associated with an assistant.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread'.", - "enum": [ - "thread" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "id", - "object", - "created_at", - "metadata" - ] - }, - "AssistantThreadCreationOptions": { - "type": "object", - "description": "The details used to create a new assistant thread.", - "properties": { - "messages": { - "type": "array", - "description": "The messages to associate with the new thread.", - "items": { - "$ref": "#/definitions/ThreadMessage" - } - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - }, - "CodeInterpreterImageOutput": { - "type": "object", - "description": "A representation of an image output emitted by a code interpreter tool in response to a tool call by the model.", - "properties": { - "image": { - "$ref": "#/definitions/CodeInterpreterImageReference", - "description": "Referential information for the image associated with this output." - } - }, - "required": [ - "image" - ], - "allOf": [ - { - "$ref": "#/definitions/CodeInterpreterToolCallOutput" - } - ], - "x-ms-discriminator-value": "image" - }, - "CodeInterpreterImageReference": { - "type": "object", - "description": "An image reference emitted by a code interpreter tool in response to a tool call by the model.", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the file associated with this image.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - }, - "CodeInterpreterLogOutput": { - "type": "object", - "description": "A representation of a log output emitted by a code interpreter tool in response to a tool call by the model.", - "properties": { - "logs": { - "type": "string", - "description": "The serialized log output emitted by the code interpreter." - } - }, - "required": [ - "logs" - ], - "allOf": [ - { - "$ref": "#/definitions/CodeInterpreterToolCallOutput" - } - ], - "x-ms-discriminator-value": "logs" - }, - "CodeInterpreterToolCall": { - "type": "object", - "description": "A tool call to a code interpreter tool, issued by the model in evaluation of a configured code interpreter tool, that\nrepresents submitted output needed or already fulfilled by the tool for the model to continue.", - "properties": { - "code_interpreter": { - "$ref": "#/definitions/CodeInterpreterToolCallDetails", - "description": "The details of the tool call to the code interpreter tool.", - "x-ms-client-name": "codeInterpreter" - } - }, - "required": [ - "code_interpreter" - ], - "allOf": [ - { - "$ref": "#/definitions/ToolCall" - } - ], - "x-ms-discriminator-value": "code_interpreter" - }, - "CodeInterpreterToolCallDetails": { - "type": "object", - "description": "The detailed information about a code interpreter invocation by the model.", - "properties": { - "input": { - "type": "string", - "description": "The input provided by the model to the code interpreter tool." - }, - "outputs": { - "type": "array", - "description": "The outputs produced by the code interpreter tool back to the model in response to the tool call.", - "items": { - "$ref": "#/definitions/CodeInterpreterToolCallOutput" - }, - "x-ms-identifiers": [] - } - }, - "required": [ - "input", - "outputs" - ] - }, - "CodeInterpreterToolCallOutput": { - "type": "object", - "description": "An abstract representation of an emitted output from a code interpreter tool.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "CodeInterpreterToolDefinition": { - "type": "object", - "description": "The input definition information for a code interpreter tool as used to configure an assistant.", - "allOf": [ - { - "$ref": "#/definitions/ToolDefinition" - } - ], - "x-ms-discriminator-value": "code_interpreter" - }, - "CreateAndRunThreadOptions": { - "type": "object", - "description": "The details used when creating and immediately running a new assistant thread.", - "properties": { - "assistant_id": { - "type": "string", - "description": "The ID of the assistant for which the thread should be created.", - "x-ms-client-name": "assistantId" - }, - "thread": { - "$ref": "#/definitions/AssistantThreadCreationOptions", - "description": "The details used to create the new thread." - }, - "model": { - "type": "string", - "description": "The overridden model that the assistant should use to run the thread." - }, - "instructions": { - "type": "string", - "description": "The overridden system instructions the assistant should use to run the thread." - }, - "tools": { - "type": "array", - "description": "The overridden list of enabled tools the assistant should use to run the thread.", - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "assistant_id" - ] - }, - "FileDeletionStatus": { - "type": "object", - "description": "A status response from a file deletion operation.", - "properties": { - "id": { - "type": "string", - "description": "The ID of the resource specified for deletion." - }, - "deleted": { - "type": "boolean", - "description": "A value indicating whether deletion was successful." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'file'.", - "enum": [ - "file" - ], - "x-ms-enum": { - "modelAsString": false - } - } - }, - "required": [ - "id", - "deleted", - "object" - ] - }, - "FileListResponse": { - "type": "object", - "description": "The response data from a file list operation.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always 'list'.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The files returned for the request.", - "items": { - "$ref": "#/definitions/OpenAIFile" - } - } - }, - "required": [ - "object", - "data" - ] - }, - "FilePurpose": { - "type": "string", - "description": "The possible values denoting the intended usage of a file.", - "enum": [ - "fine-tune", - "fine-tune-results", - "assistants", - "assistants_output" - ], - "x-ms-enum": { - "name": "FilePurpose", - "modelAsString": true, - "values": [ - { - "name": "fineTune", - "value": "fine-tune", - "description": "Indicates a file is used for fine tuning input." - }, - { - "name": "fineTuneResults", - "value": "fine-tune-results", - "description": "Indicates a file is used for fine tuning results." - }, - { - "name": "assistants", - "value": "assistants", - "description": "Indicates a file is used as input to assistants." - }, - { - "name": "assistantsOutput", - "value": "assistants_output", - "description": "Indicates a file is used as output by assistants." - } - ] - } - }, - "FunctionDefinition": { - "type": "object", - "description": "The input definition information for a function.", - "properties": { - "name": { - "type": "string", - "description": "The name of the function to be called." - }, - "description": { - "type": "string", - "description": "A description of what the function does, used by the model to choose when and how to call the function." - }, - "parameters": { - "description": "The parameters the functions accepts, described as a JSON Schema object." - } - }, - "required": [ - "name", - "parameters" - ] - }, - "FunctionToolCall": { - "type": "object", - "description": "A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents\ngiven function inputs and submitted function outputs needed or already fulfilled by the tool for the model to continue.", - "properties": { - "function": { - "$ref": "#/definitions/FunctionToolCallDetails", - "description": "The detailed information about the function called by the model." - } - }, - "required": [ - "function" - ], - "allOf": [ - { - "$ref": "#/definitions/ToolCall" - } - ], - "x-ms-discriminator-value": "function" - }, - "FunctionToolCallDetails": { - "type": "object", - "description": "The detailed information about the function called by the model.", - "properties": { - "name": { - "type": "string", - "description": "The name of the function." - }, - "arguments": { - "type": "string", - "description": "The arguments that the model requires are provided to the named function." - }, - "output": { - "type": "string", - "description": "The output of the function, only populated for function calls that have already have had their outputs submitted.", - "x-nullable": true - } - }, - "required": [ - "name", - "arguments", - "output" - ] - }, - "FunctionToolDefinition": { - "type": "object", - "description": "The input definition information for a function tool as used to configure an assistant.", - "properties": { - "function": { - "$ref": "#/definitions/FunctionDefinition", - "description": "The definition of the concrete function that the function tool should call." - } - }, - "required": [ - "function" - ], - "allOf": [ - { - "$ref": "#/definitions/ToolDefinition" - } - ], - "x-ms-discriminator-value": "function" - }, - "MessageContent": { - "type": "object", - "description": "An abstract representation of a single item of thread message content.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "MessageFile": { - "type": "object", - "description": "Information about a file attached to an assistant thread message.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.message.file'.", - "enum": [ - "thread.message.file" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "message_id": { - "type": "string", - "description": "The ID of the message that this file is attached to.", - "x-ms-client-name": "messageId" - } - }, - "required": [ - "id", - "object", - "created_at", - "message_id" - ] - }, - "MessageFileCitationTextAnnotation": { - "type": "object", - "description": "A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the 'retrieval' tool to search files.", - "properties": { - "file_citation": { - "$ref": "#/definitions/MessageTextFileCitationDetails", - "description": "A citation within the message that points to a specific quote from a specific file.\nGenerated when the assistant uses the \"retrieval\" tool to search files.", - "x-ms-client-name": "fileCitation" - } - }, - "required": [ - "file_citation" - ], - "allOf": [ - { - "$ref": "#/definitions/MessageTextAnnotation" - } - ], - "x-ms-discriminator-value": "file_citation" - }, - "MessageFilePathDetails": { - "type": "object", - "description": "An encapsulation of an image file ID, as used by message image content.", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the specific file that the citation is from.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - }, - "MessageFilePathTextAnnotation": { - "type": "object", - "description": "A citation within the message that points to a file located at a specific path.", - "properties": { - "file_path": { - "$ref": "#/definitions/MessageFilePathDetails", - "description": "A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file.", - "x-ms-client-name": "filePath" - } - }, - "required": [ - "file_path" - ], - "allOf": [ - { - "$ref": "#/definitions/MessageTextAnnotation" - } - ], - "x-ms-discriminator-value": "file_path" - }, - "MessageImageFileContent": { - "type": "object", - "description": "A representation of image file content in a thread message.", - "properties": { - "image_file": { - "$ref": "#/definitions/MessageImageFileDetails", - "description": "The image file for this thread message content item.", - "x-ms-client-name": "imageFile" - } - }, - "required": [ - "image_file" - ], - "allOf": [ - { - "$ref": "#/definitions/MessageContent" - } - ], - "x-ms-discriminator-value": "image_file" - }, - "MessageImageFileDetails": { - "type": "object", - "description": "An image reference, as represented in thread message content.", - "properties": { - "file_id": { - "$ref": "#/definitions/MessageImageFileIdDetails", - "description": "The ID for the file associated with this image.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - }, - "MessageImageFileIdDetails": { - "type": "object", - "description": "An encapsulation of an image file ID, as used by message image content.", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the specific image file.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - }, - "MessageRole": { - "type": "string", - "description": "The possible values for roles attributed to messages in a thread.", - "enum": [ - "user", - "assistant" - ], - "x-ms-enum": { - "name": "MessageRole", - "modelAsString": true, - "values": [ - { - "name": "user", - "value": "user", - "description": "The role representing the end-user." - }, - { - "name": "assistant", - "value": "assistant", - "description": "The role representing the assistant." - } - ] - } - }, - "MessageTextAnnotation": { - "type": "object", - "description": "An abstract representation of an annotation to text thread message content.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - }, - "text": { - "type": "string", - "description": "The textual content associated with this text annotation item." - }, - "start_index": { - "type": "integer", - "format": "int32", - "description": "The first text index associated with this text annotation.", - "x-ms-client-name": "startIndex" - }, - "end_index": { - "type": "integer", - "format": "int32", - "description": "The last text index associated with this text annotation.", - "x-ms-client-name": "endIndex" - } - }, - "discriminator": "type", - "required": [ - "type", - "text", - "start_index", - "end_index" - ] - }, - "MessageTextContent": { - "type": "object", - "description": "A representation of a textual item of thread message content.", - "properties": { - "text": { - "$ref": "#/definitions/MessageTextDetails", - "description": "The text and associated annotations for this thread message content item." - } - }, - "required": [ - "text" - ], - "allOf": [ - { - "$ref": "#/definitions/MessageContent" - } - ], - "x-ms-discriminator-value": "text" - }, - "MessageTextDetails": { - "type": "object", - "description": "The text and associated annotations for a single item of assistant thread message content.", - "properties": { - "value": { - "type": "string", - "description": "The text data." - }, - "annotations": { - "type": "array", - "description": "A list of annotations associated with this text.", - "items": { - "$ref": "#/definitions/MessageTextAnnotation" - }, - "x-ms-identifiers": [] - } - }, - "required": [ - "value", - "annotations" - ] - }, - "MessageTextFileCitationDetails": { - "type": "object", - "description": "A representation of a file-based text citation, as used in a file-based annotation of text thread message content.", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the file associated with this citation.", - "x-ms-client-name": "fileId" - }, - "quote": { - "type": "string", - "description": "The specific quote cited in the associated file." - } - }, - "required": [ - "file_id", - "quote" - ] - }, - "OpenAIFile": { - "type": "object", - "description": "Represents an assistant that can call the model and use tools.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always 'file'.", - "enum": [ - "file" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "bytes": { - "type": "integer", - "format": "int32", - "description": "The size of the file, in bytes." - }, - "filename": { - "type": "string", - "description": "The name of the file." - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "purpose": { - "$ref": "#/definitions/FilePurpose", - "description": "The intended purpose of a file." - } - }, - "required": [ - "object", - "id", - "bytes", - "filename", - "created_at", - "purpose" - ] - }, - "RequiredAction": { - "type": "object", - "description": "An abstract representation of a required action for an assistant thread run to continue.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "RetrievalToolCall": { - "type": "object", - "description": "A tool call to a retrieval tool, issued by the model in evaluation of a configured retrieval tool, that represents\nsubmitted output needed or already fulfilled by the tool for the model to continue.", - "properties": { - "retrieval": { - "type": "object", - "description": "The key/value pairs produced by the retrieval tool.", - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "retrieval" - ], - "allOf": [ - { - "$ref": "#/definitions/ToolCall" - } - ], - "x-ms-discriminator-value": "retrieval" - }, - "RetrievalToolDefinition": { - "type": "object", - "description": "The input definition information for a retrieval tool as used to configure an assistant.", - "allOf": [ - { - "$ref": "#/definitions/ToolDefinition" - } - ], - "x-ms-discriminator-value": "retrieval" - }, - "RunError": { - "type": "object", - "description": "The details of an error as encountered by an assistant thread run.", - "properties": { - "code": { - "type": "string", - "description": "The status for the error." - }, - "message": { - "type": "string", - "description": "The human-readable text associated with the error." - } - }, - "required": [ - "code", - "message" - ] - }, - "RunStatus": { - "type": "string", - "description": "Possible values for the status of an assistant thread run.", - "enum": [ - "queued", - "in_progress", - "requires_action", - "cancelling", - "cancelled", - "failed", - "completed", - "expired" - ], - "x-ms-enum": { - "name": "RunStatus", - "modelAsString": true, - "values": [ - { - "name": "queued", - "value": "queued", - "description": "Represents a run that is queued to start." - }, - { - "name": "inProgress", - "value": "in_progress", - "description": "Represents a run that is in progress." - }, - { - "name": "requiresAction", - "value": "requires_action", - "description": "Represents a run that needs another operation, such as tool output submission, to continue." - }, - { - "name": "cancelling", - "value": "cancelling", - "description": "Represents a run that is in the process of cancellation." - }, - { - "name": "cancelled", - "value": "cancelled", - "description": "Represents a run that has been cancelled." - }, - { - "name": "failed", - "value": "failed", - "description": "Represents a run that failed." - }, - { - "name": "completed", - "value": "completed", - "description": "Represents a run that successfully completed." - }, - { - "name": "expired", - "value": "expired", - "description": "Represents a run that expired before it could otherwise finish." - } - ] - } - }, - "RunStep": { - "type": "object", - "description": "Detailed information about a single step of an assistant thread run.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.run.step'.", - "enum": [ - "thread.run.step" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "type": { - "$ref": "#/definitions/RunStepType", - "description": "The type of run step, which can be either message_creation or tool_calls." - }, - "assistant_id": { - "type": "string", - "description": "The ID of the assistant associated with the run step.", - "x-ms-client-name": "assistantId" - }, - "thread_id": { - "type": "string", - "description": "The ID of the thread that was run.", - "x-ms-client-name": "threadId" - }, - "run_id": { - "type": "string", - "description": "The ID of the run that this run step is a part of.", - "x-ms-client-name": "runId" - }, - "status": { - "$ref": "#/definitions/RunStepStatus", - "description": "The status of this run step." - }, - "step_details": { - "$ref": "#/definitions/RunStepDetails", - "description": "The details for this run step.", - "x-ms-client-name": "stepDetails" - }, - "last_error": { - "type": "object", - "description": "If applicable, information about the last error encountered by this run step.", - "x-nullable": true, - "allOf": [ - { - "$ref": "#/definitions/RunStepError" - } - ], - "x-ms-client-name": "lastError" - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "expired_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this item expired.", - "x-nullable": true, - "x-ms-client-name": "expiredAt" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this completed.", - "x-nullable": true, - "x-ms-client-name": "completedAt" - }, - "cancelled_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this was cancelled.", - "x-nullable": true, - "x-ms-client-name": "cancelledAt" - }, - "failed_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this failed.", - "x-nullable": true, - "x-ms-client-name": "failedAt" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "id", - "object", - "type", - "assistant_id", - "thread_id", - "run_id", - "status", - "step_details", - "last_error", - "created_at", - "expired_at", - "completed_at", - "cancelled_at", - "failed_at", - "metadata" - ] - }, - "RunStepDetails": { - "type": "object", - "description": "An abstract representation of the details for a run step.", - "properties": { - "type": { - "$ref": "#/definitions/RunStepType", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "RunStepError": { - "type": "object", - "description": "The error information associated with a failed run step.", - "properties": { - "code": { - "$ref": "#/definitions/RunStepErrorCode", - "description": "The error code for this error." - }, - "message": { - "type": "string", - "description": "The human-readable text associated with this error." - } - }, - "required": [ - "code", - "message" - ] - }, - "RunStepErrorCode": { - "type": "string", - "description": "Possible error code values attributable to a failed run step.", - "enum": [ - "server_error", - "rate_limit_exceeded" - ], - "x-ms-enum": { - "name": "RunStepErrorCode", - "modelAsString": true, - "values": [ - { - "name": "serverError", - "value": "server_error", - "description": "Represents a server error." - }, - { - "name": "rateLimitExceeded", - "value": "rate_limit_exceeded", - "description": "Represents an error indicating configured rate limits were exceeded." - } - ] - } - }, - "RunStepMessageCreationDetails": { - "type": "object", - "description": "The detailed information associated with a message creation run step.", - "properties": { - "message_creation": { - "$ref": "#/definitions/RunStepMessageCreationReference", - "description": "Information about the message creation associated with this run step.", - "x-ms-client-name": "messageCreation" - } - }, - "required": [ - "message_creation" - ], - "allOf": [ - { - "$ref": "#/definitions/RunStepDetails" - } - ], - "x-ms-discriminator-value": "message_creation" - }, - "RunStepMessageCreationReference": { - "type": "object", - "description": "The details of a message created as a part of a run step.", - "properties": { - "message_id": { - "type": "string", - "description": "The ID of the message created by this run step.", - "x-ms-client-name": "messageId" - } - }, - "required": [ - "message_id" - ] - }, - "RunStepStatus": { - "type": "string", - "description": "Possible values for the status of a run step.", - "enum": [ - "in_progress", - "cancelled", - "failed", - "completed", - "expired" - ], - "x-ms-enum": { - "name": "RunStepStatus", - "modelAsString": true, - "values": [ - { - "name": "inProgress", - "value": "in_progress", - "description": "Represents a run step still in progress." - }, - { - "name": "cancelled", - "value": "cancelled", - "description": "Represents a run step that was cancelled." - }, - { - "name": "failed", - "value": "failed", - "description": "Represents a run step that failed." - }, - { - "name": "completed", - "value": "completed", - "description": "Represents a run step that successfully completed." - }, - { - "name": "expired", - "value": "expired", - "description": "Represents a run step that expired before otherwise finishing." - } - ] - } - }, - "RunStepToolCallDetails": { - "type": "object", - "description": "The detailed information associated with a run step calling tools.", - "properties": { - "tool_calls": { - "type": "array", - "description": "A list tool call details for this run step.", - "items": { - "$ref": "#/definitions/ToolCall" - }, - "x-ms-client-name": "toolCalls" - } - }, - "required": [ - "tool_calls" - ], - "allOf": [ - { - "$ref": "#/definitions/RunStepDetails" - } - ], - "x-ms-discriminator-value": "tool_calls" - }, - "RunStepType": { - "type": "string", - "description": "The possible types of run steps.", - "enum": [ - "message_creation", - "tool_calls" - ], - "x-ms-enum": { - "name": "RunStepType", - "modelAsString": true, - "values": [ - { - "name": "messageCreation", - "value": "message_creation", - "description": "Represents a run step to create a message." - }, - { - "name": "toolCalls", - "value": "tool_calls", - "description": "Represents a run step that calls tools." - } - ] - } - }, - "SubmitToolOutputsAction": { - "type": "object", - "description": "The details for required tool calls that must be submitted for an assistant thread run to continue.", - "properties": { - "submit_tool_outputs": { - "$ref": "#/definitions/SubmitToolOutputsDetails", - "description": "The details describing tools that should be called to submit tool outputs.", - "x-ms-client-name": "submitToolOutputs" - } - }, - "required": [ - "submit_tool_outputs" - ], - "allOf": [ - { - "$ref": "#/definitions/RequiredAction" - } - ], - "x-ms-discriminator-value": "submit_tool_outputs" - }, - "SubmitToolOutputsDetails": { - "type": "object", - "description": "The details describing tools that should be called to submit tool outputs.", - "properties": { - "tool_calls": { - "type": "array", - "description": "The list of tool calls that must be resolved for the assistant thread run to continue.", - "items": { - "$ref": "#/definitions/ToolCall" - }, - "x-ms-client-name": "toolCalls" - } - }, - "required": [ - "tool_calls" - ] - }, - "ThreadDeletionStatus": { - "type": "object", - "description": "The status of a thread deletion operation.", - "properties": { - "id": { - "type": "string", - "description": "The ID of the resource specified for deletion." - }, - "deleted": { - "type": "boolean", - "description": "A value indicating whether deletion was successful." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.deleted'.", - "enum": [ - "thread.deleted" - ], - "x-ms-enum": { - "modelAsString": false - } - } - }, - "required": [ - "id", - "deleted", - "object" - ] - }, - "ThreadMessage": { - "type": "object", - "description": "A single message within an assistant thread.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.message'.", - "enum": [ - "thread.message" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "thread_id": { - "type": "string", - "description": "The ID of the thread that this message belongs to.", - "x-ms-client-name": "threadId" - }, - "role": { - "$ref": "#/definitions/MessageRole", - "description": "The role associated with the assistant thread message." - }, - "content": { - "type": "array", - "description": "The list of content items associated with the assistant thread message.", - "items": { - "$ref": "#/definitions/MessageContent" - }, - "x-ms-identifiers": [] - }, - "assistant_id": { - "type": "string", - "description": "If applicable, the ID of the assistant that authored this message.", - "x-ms-client-name": "assistantId" - }, - "run_id": { - "type": "string", - "description": "If applicable, the ID of the run associated with the authoring of this message.", - "x-ms-client-name": "runId" - }, - "file_ids": { - "type": "array", - "description": "A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can\naccess files.", - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "id", - "object", - "created_at", - "thread_id", - "role", - "content", - "file_ids", - "metadata" - ] - }, - "ThreadRun": { - "type": "object", - "description": "Data representing a single evaluation run of an assistant thread.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.run'.", - "enum": [ - "thread.run" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "thread_id": { - "type": "string", - "description": "The ID of the thread associated with this run.", - "x-ms-client-name": "threadId" - }, - "assistant_id": { - "type": "string", - "description": "The ID of the assistant associated with the thread this run was performed against.", - "x-ms-client-name": "assistantId" - }, - "status": { - "$ref": "#/definitions/RunStatus", - "description": "The status of the assistant thread run." - }, - "required_action": { - "type": "object", - "description": "The details of the action required for the assistant thread run to continue.", - "x-nullable": true, - "allOf": [ - { - "$ref": "#/definitions/RequiredAction" - } - ], - "x-ms-client-name": "requiredAction" - }, - "last_error": { - "type": "object", - "description": "The last error, if any, encountered by this assistant thread run.", - "x-nullable": true, - "allOf": [ - { - "$ref": "#/definitions/RunError" - } - ], - "x-ms-client-name": "lastError" - }, - "model": { - "type": "string", - "description": "The ID of the model to use." - }, - "instructions": { - "type": "string", - "description": "The overridden system instructions used for this assistant thread run." - }, - "tools": { - "type": "array", - "description": "The overridden enabled tools used for this assistant thread run.", - "default": [], - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "file_ids": { - "type": "array", - "description": "A list of attached file IDs, ordered by creation date in ascending order.", - "default": [], - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "expires_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this item expires.", - "x-nullable": true, - "x-ms-client-name": "expiresAt" - }, - "started_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this item was started.", - "x-nullable": true, - "x-ms-client-name": "startedAt" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this completed.", - "x-nullable": true, - "x-ms-client-name": "completedAt" - }, - "cancelled_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this was cancelled.", - "x-nullable": true, - "x-ms-client-name": "cancelledAt" - }, - "failed_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this failed.", - "x-nullable": true, - "x-ms-client-name": "failedAt" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "id", - "object", - "thread_id", - "assistant_id", - "status", - "last_error", - "model", - "instructions", - "tools", - "file_ids", - "created_at", - "expires_at", - "started_at", - "completed_at", - "cancelled_at", - "failed_at", - "metadata" - ] - }, - "ToolCall": { - "type": "object", - "description": "An abstract representation a tool call, issued by the model in evaluation of a configured tool definition, that must\nbe fulfilled and have its outputs submitted before the model can continue.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - }, - "id": { - "type": "string", - "description": "The ID of the tool call. This ID must be referenced when you submit tool outputs." - } - }, - "discriminator": "type", - "required": [ - "type", - "id" - ] - }, - "ToolDefinition": { - "type": "object", - "description": "An abstract representation of an input tool definition that an assistant can use.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "ToolOutput": { - "type": "object", - "description": "The data provided during a tool outputs submission to resolve pending tool calls and allow the model to continue.", - "properties": { - "tool_call_id": { - "type": "string", - "description": "The ID of the tool call being resolved, as provided in the tool calls of a required action from a run.", - "x-ms-client-name": "toolCallId" - }, - "output": { - "type": "string", - "description": "The output from the tool to be submitted." - } - } - } - }, - "parameters": {} -} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json index 6e871cf81b9c..e0e6a4265818 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json @@ -165,6 +165,11 @@ ] } } + }, + "x-ms-examples": { + "Returns a list of assistants.": { + "$ref": "./examples/list_assistants.json" + } } }, "post": { @@ -174,7 +179,7 @@ { "name": "body", "in": "body", - "description": "Body parameter.", + "description": "The request details to use when creating a new assistant.", "required": true, "schema": { "$ref": "#/definitions/AssistantCreationOptions" @@ -188,6 +193,11 @@ "$ref": "#/definitions/Assistant" } } + }, + "x-ms-examples": { + "Create an assistant with a model and instructions.": { + "$ref": "./examples/create_assistant.json" + } } } }, @@ -211,6 +221,11 @@ "$ref": "#/definitions/Assistant" } } + }, + "x-ms-examples": { + "Retrieves an assistant.": { + "$ref": "./examples/get_assistant.json" + } } }, "post": { @@ -227,7 +242,7 @@ { "name": "body", "in": "body", - "description": "Body parameter.", + "description": "The request details to use when modifying an existing assistant.", "required": true, "schema": { "$ref": "#/definitions/UpdateAssistantOptions" @@ -241,6 +256,11 @@ "$ref": "#/definitions/Assistant" } } + }, + "x-ms-examples": { + "Modifies an assistant.": { + "$ref": "./examples/update_assistant.json" + } } }, "delete": { @@ -262,6 +282,11 @@ "$ref": "#/definitions/AssistantDeletionStatus" } } + }, + "x-ms-examples": { + "Deletes an assistant.": { + "$ref": "./examples/delete_assistant.json" + } } } }, @@ -317,6 +342,11 @@ "$ref": "#/definitions/FileListResponse" } } + }, + "x-ms-examples": { + "Returns a list of files filtered by purpose": { + "$ref": "./examples/list_file.json" + } } }, "post": { @@ -387,6 +417,11 @@ "$ref": "#/definitions/OpenAIFile" } } + }, + "x-ms-examples": { + "Uploads a file": { + "$ref": "./examples/upload_file.json" + } } } }, @@ -410,6 +445,11 @@ "$ref": "#/definitions/OpenAIFile" } } + }, + "x-ms-examples": { + "Returns a file": { + "$ref": "./examples/get_file.json" + } } }, "delete": { @@ -431,6 +471,11 @@ "$ref": "#/definitions/FileDeletionStatus" } } + }, + "x-ms-examples": { + "Delete a previously uploaded file.": { + "$ref": "./examples/delete_file.json" + } } } }, @@ -455,6 +500,11 @@ "format": "byte" } } + }, + "x-ms-examples": { + "Returns the content of a file": { + "$ref": "./examples/get_file_content.json" + } } } }, @@ -466,7 +516,7 @@ { "name": "body", "in": "body", - "description": "Body parameter.", + "description": "The details used to create a new assistant thread.", "required": true, "schema": { "$ref": "#/definitions/AssistantThreadCreationOptions" @@ -480,6 +530,11 @@ "$ref": "#/definitions/AssistantThread" } } + }, + "x-ms-examples": { + "Creates a thread.": { + "$ref": "./examples/create_thread.json" + } } } }, @@ -503,6 +558,11 @@ "$ref": "#/definitions/AssistantThread" } } + }, + "x-ms-examples": { + "Retrieves a thread.": { + "$ref": "./examples/get_thread.json" + } } }, "post": { @@ -519,7 +579,7 @@ { "name": "body", "in": "body", - "description": "Body parameter.", + "description": "The details used to update an existing assistant thread.", "required": true, "schema": { "$ref": "#/definitions/UpdateAssistantThreadOptions" @@ -533,6 +593,11 @@ "$ref": "#/definitions/AssistantThread" } } + }, + "x-ms-examples": { + "Modifies a thread.": { + "$ref": "./examples/update_thread.json" + } } }, "delete": { @@ -554,6 +619,11 @@ "$ref": "#/definitions/ThreadDeletionStatus" } } + }, + "x-ms-examples": { + "Deletes a thread.": { + "$ref": "./examples/delete_thread.json" + } } } }, @@ -670,6 +740,11 @@ ] } } + }, + "x-ms-examples": { + "List Messages": { + "$ref": "./examples/list_messages.json" + } } }, "post": { @@ -682,6 +757,15 @@ "description": "The ID of the thread to create the new message on.", "required": true, "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "A single message within an assistant thread, as provided during that thread's creation for its initial state.", + "required": true, + "schema": { + "$ref": "#/definitions/ThreadMessageOptions" + } } ], "responses": { @@ -691,6 +775,11 @@ "$ref": "#/definitions/ThreadMessage" } } + }, + "x-ms-examples": { + "Create a message.": { + "$ref": "./examples/create_message.json" + } } } }, @@ -721,6 +810,11 @@ "$ref": "#/definitions/ThreadMessage" } } + }, + "x-ms-examples": { + "Retrieve a message.": { + "$ref": "./examples/get_message.json" + } } }, "post": { @@ -767,6 +861,11 @@ "$ref": "#/definitions/ThreadMessage" } } + }, + "x-ms-examples": { + "Modify a message.": { + "$ref": "./examples/update_message.json" + } } } }, @@ -883,6 +982,11 @@ ] } } + }, + "x-ms-examples": { + "Returns a list of runs belonging to a thread.": { + "$ref": "./examples/list_runs.json" + } } }, "post": { @@ -897,9 +1001,9 @@ "type": "string" }, { - "name": "createRunOptions", + "name": "body", "in": "body", - "description": "The details for the run to create.", + "description": "The details used when creating a new run of an assistant thread.", "required": true, "schema": { "$ref": "#/definitions/CreateRunOptions" @@ -913,6 +1017,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "Create a run.": { + "$ref": "./examples/create_run.json" + } } } }, @@ -943,6 +1052,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "Gets a run.": { + "$ref": "./examples/get_run.json" + } } }, "post": { @@ -989,6 +1103,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "Modifies a run.": { + "$ref": "./examples/update_run.json" + } } } }, @@ -1019,6 +1138,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "Cancels a run that is `in_progress`.\n": { + "$ref": "./examples/cancel_run.json" + } } } }, @@ -1142,6 +1266,11 @@ ] } } + }, + "x-ms-examples": { + "Returns a list of run steps belonging to a run.": { + "$ref": "./examples/list_run_steps.json" + } } } }, @@ -1179,6 +1308,11 @@ "$ref": "#/definitions/RunStep" } } + }, + "x-ms-examples": { + "Retrieves a run step.": { + "$ref": "./examples/get_run_step.json" + } } } }, @@ -1236,6 +1370,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "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": { + "$ref": "./examples/submit_tool_outputs_to_run.json" + } } } }, @@ -1247,7 +1386,7 @@ { "name": "body", "in": "body", - "description": "Body parameter.", + "description": "The details used when creating and immediately running a new assistant thread.", "required": true, "schema": { "$ref": "#/definitions/CreateAndRunThreadOptions" @@ -1261,6 +1400,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "Create a thread and run it in one request.": { + "$ref": "./examples/create_thread_and_run.json" + } } } } @@ -2950,6 +3094,32 @@ "metadata" ] }, + "ThreadMessageOptions": { + "type": "object", + "description": "A single message within an assistant thread, as provided during that thread's creation for its initial state.", + "properties": { + "role": { + "$ref": "#/definitions/MessageRole", + "description": "The role 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\nthe conversation." + }, + "content": { + "type": "string", + "description": "The textual content of the initial message. Currently, robust input including images and annotated text may only be provided via\na separate call to the create message API." + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "role", + "content" + ] + }, "ThreadRun": { "type": "object", "description": "Data representing a single evaluation run of an assistant thread.", diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json new file mode 100644 index 000000000000..5317d558935b --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/cancel_run.json @@ -0,0 +1,38 @@ +{ + "title": "Cancels a run that is `in_progress`.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1699076126, + "assistant_id": "asst_BUf53eW0aua3EjHTyO3P3evb", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "cancelling", + "started_at": 1699076126, + "expires_at": 1699076726, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-1106", + "instructions": "You solve math problems.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "incomplete_details": null, + "metadata": {}, + "usage": null + } + } + }, + "operationId": "CancelRun" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json new file mode 100644 index 000000000000..5a9981a936b5 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_assistant.json @@ -0,0 +1,37 @@ +{ + "title": "Create an assistant with a model and instructions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "body": { + "name": "Math Tutor", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "model": "gpt-4-1106-preview" + } + }, + "responses": { + "200": { + "body": { + "id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", + "object": "assistant", + "created_at": 1718875084, + "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": {} + } + } + }, + "operationId": "CreateAssistant" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json new file mode 100644 index 000000000000..c0318a2f3364 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_message.json @@ -0,0 +1,40 @@ +{ + "title": "Create a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", + "body": { + "role": "user", + "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces." + } + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "assistant_id": null, + "run_id": null, + "metadata": {} + } + } + }, + "operationId": "CreateMessage" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json new file mode 100644 index 000000000000..b516adecefd2 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_run.json @@ -0,0 +1,36 @@ +{ + "title": "Create a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_2CTH1wOJezLOA3QRefyO3wyk", + "body": { + "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI" + } + }, + "responses": { + "200": { + "body": { + "id": "run_dmC5IgLBfaK8gBy0FKIXGtpr", + "object": "thread.run", + "created_at": 1707301142, + "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI", + "thread_id": "thread_2CTH1wOJezLOA3QRefyO3wyk", + "status": "queued", + "incomplete_details": null, + "usage": null, + "started_at": null, + "expires_at": 1707301742, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "metadata": {} + } + } + }, + "operationId": "CreateRun" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread.json new file mode 100644 index 000000000000..9b2b9a3a463c --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread.json @@ -0,0 +1,19 @@ +{ + "title": "Creates a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": {} + } + } + }, + "operationId": "CreateThread" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json new file mode 100644 index 000000000000..2babffbce6d5 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/create_thread_and_run.json @@ -0,0 +1,35 @@ +{ + "title": "Create a thread and run it in one request.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "body": { + "assistant_id": "{{assistants.id}}" + } + }, + "responses": { + "200": { + "body": { + "id": "run_jwY1tMUeOjSpq0Swwm6JqSi6", + "object": "thread.run", + "created_at": 1707300252, + "assistant_id": "asst_se10QpYqDv7RQx13zdpskKlz", + "thread_id": "thread_7CJfaYBtuRIOSksocRrYNQGV", + "status": "queued", + "started_at": null, + "expires_at": 1707300852, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "usage": null, + "incomplete_details": null, + "metadata": {} + } + } + }, + "operationId": "CreateThreadAndRun" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_assistant.json new file mode 100644 index 000000000000..f300dfb2ad72 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_assistant.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "assistantId": "asst_4nsG2qgNzimRPE7MazXTXbU7" + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant.deleted", + "deleted": true + } + } + }, + "operationId": "DeleteAssistant" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_file.json new file mode 100644 index 000000000000..7d89fe77f52f --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_file.json @@ -0,0 +1,18 @@ +{ + "title": "Delete a previously uploaded file.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": { + "object": "file", + "deleted": true, + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + } + } + }, + "operationId": "DeleteFile" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_thread.json new file mode 100644 index 000000000000..e14eac104c85 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/delete_thread.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread.deleted", + "deleted": true + } + } + }, + "operationId": "DeleteThread" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_assistant.json new file mode 100644 index 000000000000..09fa93da8abc --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_assistant.json @@ -0,0 +1,28 @@ +{ + "title": "Retrieves an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "assistantId": "asst_4nsG2qgNzimRPE7MazXTXbU7" + }, + "responses": { + "200": { + "body": { + "id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", + "object": "assistant", + "created_at": 1718875084, + "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": {} + } + } + }, + "operationId": "GetAssistant" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file.json new file mode 100644 index 000000000000..c0a99d1b7a24 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file.json @@ -0,0 +1,21 @@ +{ + "title": "Returns a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199 + } + } + }, + "operationId": "GetFile" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file_content.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file_content.json new file mode 100644 index 000000000000..9f05e09e75d2 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_file_content.json @@ -0,0 +1,14 @@ +{ + "title": "Returns the content of a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": "file content" + } + }, + "operationId": "GetFileContent" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json new file mode 100644 index 000000000000..20fd1c2f15c2 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_message.json @@ -0,0 +1,37 @@ +{ + "title": "Retrieve a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", + "messageId": "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": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "assistant_id": null, + "run_id": null, + "metadata": {} + } + } + }, + "operationId": "GetMessage" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json new file mode 100644 index 000000000000..6dab7987a07e --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run.json @@ -0,0 +1,34 @@ +{ + "title": "Gets a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1707303196, + "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "completed", + "incomplete_details": null, + "usage": null, + "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": [], + "metadata": {} + } + } + }, + "operationId": "GetRun" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run_step.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run_step.json new file mode 100644 index 000000000000..5f74b0d0067a --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_run_step.json @@ -0,0 +1,42 @@ +{ + "title": "Retrieves a run step.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "stepId": "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 + }, + "metadata": {} + } + } + }, + "operationId": "GetRunStep" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_thread.json new file mode 100644 index 000000000000..b2c902c476aa --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/get_thread.json @@ -0,0 +1,19 @@ +{ + "title": "Retrieves a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": {} + } + } + }, + "operationId": "GetThread" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_assistants.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_assistants.json new file mode 100644 index 000000000000..56f32fa4007a --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_assistants.json @@ -0,0 +1,52 @@ +{ + "title": "Returns a list of assistants.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "order": "desc", + "limit": 20 + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "asst_qOKETOiUwLnzEc3i3AGuyDi1", + "object": "assistant", + "created_at": 1707257477, + "name": "Stock Analyst", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {} + }, + { + "id": "asst_jBvPFZQ8dMqq4bXb84Gqe8O6", + "object": "assistant", + "created_at": 1707249683, + "name": "Math Tutor", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "You are a personal math tutor. Answer questions briefly, in a sentence or less.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {} + } + ], + "first_id": "asst_qOKETOiUwLnzEc3i3AGuyDi1", + "last_id": "asst_jBvPFZQ8dMqq4bXb84Gqe8O6", + "has_more": false + } + } + }, + "operationId": "ListAssistants" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_file.json new file mode 100644 index 000000000000..39b31a4aa1b6 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_file.json @@ -0,0 +1,34 @@ +{ + "title": "Returns a list of files filtered by purpose", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "purpose": "assistants" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199 + }, + { + "object": "file", + "id": "assistant-D6AmXzgJ6gyGcgT48OmJ8kYc", + "purpose": "assistants", + "filename": "test07a45e38-9b88-449a-9580-94fdb986eb75.txt", + "bytes": 4, + "created_at": 1718886043 + } + ] + } + } + }, + "operationId": "ListFiles" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json new file mode 100644 index 000000000000..20f01a6fda3f --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_messages.json @@ -0,0 +1,67 @@ +{ + "title": "List Messages", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "msg_UyL3BkA02z74QviiYnkBTG5C", + "object": "thread.message", + "created_at": 1707298439, + "thread_id": "thread_RPiAkxp7DKb4j7dzokX6itkR", + "role": "assistant", + "content": [ + { + "type": "text", + "text": { + "value": "The cube root of the sum of the given numbers, rounded to the nearest integer, is 12345.", + "annotations": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "assistant_id": "asst_iaScg6I4dkdYWoaPPTPT7EFy", + "run_id": "run_35BhBv0Ry4vVgjF0vO36Ajzf", + "metadata": {} + }, + { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_RPiAkxp7DKb4j7dzokX6itkR", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "assistant_id": null, + "run_id": null, + "metadata": {} + } + ], + "first_id": "msg_UyL3BkA02z74QviiYnkBTG5C", + "last_id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "has_more": false + } + } + }, + "operationId": "ListMessages" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_run_steps.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_run_steps.json new file mode 100644 index 000000000000..7378eddd2de5 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_run_steps.json @@ -0,0 +1,49 @@ +{ + "title": "Returns a list of run steps belonging to a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "step_abc123", + "object": "thread.run.step", + "created_at": 1699063291, + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "type": "message_creation", + "status": "completed", + "cancelled_at": null, + "completed_at": 1699063291, + "expired_at": null, + "failed_at": null, + "last_error": null, + "step_details": { + "type": "message_creation", + "message_creation": { + "message_id": "msg_abc123" + } + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "metadata": {} + } + ], + "first_id": "step_abc123", + "last_id": "step_abc456", + "has_more": false + } + } + }, + "operationId": "ListRunSteps" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json new file mode 100644 index 000000000000..c044c0365b3f --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/list_runs.json @@ -0,0 +1,45 @@ +{ + "title": "Returns a list of runs belonging to a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_7CJfaYBtuRIOSksocRrYNQGV" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "run_jwY1tMUeOjSpq0Swwm6JqSi6", + "object": "thread.run", + "created_at": 1707300252, + "assistant_id": "asst_se10QpYqDv7RQx13zdpskKlz", + "thread_id": "thread_7CJfaYBtuRIOSksocRrYNQGV", + "status": "completed", + "started_at": 1707300255, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1707300267, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "incomplete_details": null, + "usage": { + "completion_tokens": 1, + "prompt_tokens": 999, + "total_tokens": 1000 + }, + "metadata": {} + } + ], + "first_id": "run_jwY1tMUeOjSpq0Swwm6JqSi6", + "last_id": "run_jwY1tMUeOjSpq0Swwm6JqSi6", + "has_more": false + } + } + }, + "operationId": "ListRuns" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json new file mode 100644 index 000000000000..ff1009e9c1fc --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json @@ -0,0 +1,69 @@ +{ + "title": "When a run has the `status: \"requires_action\"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "body": { + "tool_outputs": [ + { + "tool_call_id": "call_abc123", + "output": "28C" + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1699075592, + "assistant_id": "asst_abc123", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "queued", + "started_at": 1699075592, + "expires_at": 1699076192, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4", + "instructions": "You tell the weather.", + "incomplete_details": null, + "tools": [ + { + "type": "function", + "function": { + "name": "get_weather", + "description": "Determine weather in my location", + "parameters": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The city and state e.g. San Francisco, CA" + }, + "unit": { + "type": "string", + "enum": [ + "c", + "f" + ] + } + }, + "required": [ + "location" + ] + } + } + } + ], + "metadata": {}, + "usage": null + } + } + }, + "operationId": "SubmitToolOutputsToRun" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_assistant.json new file mode 100644 index 000000000000..f0fb253c5f64 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_assistant.json @@ -0,0 +1,31 @@ +{ + "title": "Modifies an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "assistantId": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", + "body": { + "name": "Math Tutor Improved" + } + }, + "responses": { + "200": { + "body": { + "id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", + "object": "assistant", + "created_at": 1718875084, + "name": "Math Tutor Improved", + "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": {} + } + } + }, + "operationId": "UpdateAssistant" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json new file mode 100644 index 000000000000..0021cd3ec12c --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_message.json @@ -0,0 +1,46 @@ +{ + "title": "Modify a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", + "messageId": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "body": { + "metadata": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "assistant_id": null, + "run_id": null, + "status": "incomplete", + "incomplete_details": null, + "completed_at": 1707298421, + "incomplete_at": null, + "metadata": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "operationId": "UpdateMessage" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json new file mode 100644 index 000000000000..15e95dd58e30 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_run.json @@ -0,0 +1,43 @@ +{ + "title": "Modifies a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "body": { + "metadata": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1707303196, + "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "completed", + "started_at": 1707303197, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1707303201, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "incomplete_details": null, + "usage": null, + "metadata": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "operationId": "UpdateRun" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_thread.json new file mode 100644 index 000000000000..af3b0ddfef32 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/update_thread.json @@ -0,0 +1,28 @@ +{ + "title": "Modifies a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", + "body": { + "metadata": { + "modified": "true", + "user": "abc123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": { + "modified": "true", + "user": "abc123" + } + } + } + }, + "operationId": "UpdateThread" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/upload_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/upload_file.json new file mode 100644 index 000000000000..94fd2039a6db --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/examples/upload_file.json @@ -0,0 +1,28 @@ +{ + "title": "Uploads a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "purpose": "assistants", + "file": [ + 0, + 1, + 0, + 1, + 0 + ] + }, + "responses": { + "200": { + "body": { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199 + } + } + }, + "operationId": "UploadFile" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json index 5fcda9a56c31..4865bb16194e 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json @@ -165,6 +165,11 @@ ] } } + }, + "x-ms-examples": { + "Returns a list of assistants.": { + "$ref": "./examples/list_assistants.json" + } } }, "post": { @@ -174,7 +179,7 @@ { "name": "body", "in": "body", - "description": "Body parameter.", + "description": "The request details to use when creating a new assistant.", "required": true, "schema": { "$ref": "#/definitions/AssistantCreationOptions" @@ -188,6 +193,11 @@ "$ref": "#/definitions/Assistant" } } + }, + "x-ms-examples": { + "Create an assistant with a model and instructions.": { + "$ref": "./examples/create_assistant.json" + } } } }, @@ -211,6 +221,11 @@ "$ref": "#/definitions/Assistant" } } + }, + "x-ms-examples": { + "Retrieves an assistant.": { + "$ref": "./examples/get_assistant.json" + } } }, "post": { @@ -227,7 +242,7 @@ { "name": "body", "in": "body", - "description": "Body parameter.", + "description": "The request details to use when modifying an existing assistant.", "required": true, "schema": { "$ref": "#/definitions/UpdateAssistantOptions" @@ -241,6 +256,11 @@ "$ref": "#/definitions/Assistant" } } + }, + "x-ms-examples": { + "Modifies an assistant.": { + "$ref": "./examples/update_assistant.json" + } } }, "delete": { @@ -262,6 +282,11 @@ "$ref": "#/definitions/AssistantDeletionStatus" } } + }, + "x-ms-examples": { + "Deletes an assistant.": { + "$ref": "./examples/delete_assistant.json" + } } } }, @@ -335,6 +360,11 @@ "$ref": "#/definitions/FileListResponse" } } + }, + "x-ms-examples": { + "Returns a list of files filtered by purpose": { + "$ref": "./examples/list_file.json" + } } }, "post": { @@ -423,6 +453,11 @@ "$ref": "#/definitions/OpenAIFile" } } + }, + "x-ms-examples": { + "Uploads a file": { + "$ref": "./examples/upload_file.json" + } } } }, @@ -446,6 +481,11 @@ "$ref": "#/definitions/OpenAIFile" } } + }, + "x-ms-examples": { + "Returns a file": { + "$ref": "./examples/get_file.json" + } } }, "delete": { @@ -467,6 +507,11 @@ "$ref": "#/definitions/FileDeletionStatus" } } + }, + "x-ms-examples": { + "Delete a previously uploaded file.": { + "$ref": "./examples/delete_file.json" + } } } }, @@ -491,6 +536,11 @@ "format": "byte" } } + }, + "x-ms-examples": { + "Returns the content of a file": { + "$ref": "./examples/get_file_content.json" + } } } }, @@ -502,7 +552,7 @@ { "name": "body", "in": "body", - "description": "Body parameter.", + "description": "The details used to create a new assistant thread.", "required": true, "schema": { "$ref": "#/definitions/AssistantThreadCreationOptions" @@ -516,6 +566,11 @@ "$ref": "#/definitions/AssistantThread" } } + }, + "x-ms-examples": { + "Creates a thread.": { + "$ref": "./examples/create_thread.json" + } } } }, @@ -539,6 +594,11 @@ "$ref": "#/definitions/AssistantThread" } } + }, + "x-ms-examples": { + "Retrieves a thread.": { + "$ref": "./examples/get_thread.json" + } } }, "post": { @@ -555,7 +615,7 @@ { "name": "body", "in": "body", - "description": "Body parameter.", + "description": "The details used to update an existing assistant thread.", "required": true, "schema": { "$ref": "#/definitions/UpdateAssistantThreadOptions" @@ -569,6 +629,11 @@ "$ref": "#/definitions/AssistantThread" } } + }, + "x-ms-examples": { + "Modifies a thread.": { + "$ref": "./examples/update_thread.json" + } } }, "delete": { @@ -590,6 +655,11 @@ "$ref": "#/definitions/ThreadDeletionStatus" } } + }, + "x-ms-examples": { + "Deletes a thread.": { + "$ref": "./examples/delete_thread.json" + } } } }, @@ -713,6 +783,11 @@ ] } } + }, + "x-ms-examples": { + "List Messages": { + "$ref": "./examples/list_messages.json" + } } }, "post": { @@ -727,7 +802,7 @@ "type": "string" }, { - "name": "threadMessageOptions", + "name": "body", "in": "body", "description": "A single message within an assistant thread, as provided during that thread's creation for its initial state.", "required": true, @@ -743,6 +818,11 @@ "$ref": "#/definitions/ThreadMessage" } } + }, + "x-ms-examples": { + "Create a message.": { + "$ref": "./examples/create_message.json" + } } } }, @@ -773,6 +853,11 @@ "$ref": "#/definitions/ThreadMessage" } } + }, + "x-ms-examples": { + "Retrieve a message.": { + "$ref": "./examples/get_message.json" + } } }, "post": { @@ -819,6 +904,11 @@ "$ref": "#/definitions/ThreadMessage" } } + }, + "x-ms-examples": { + "Modify a message.": { + "$ref": "./examples/update_message.json" + } } } }, @@ -935,6 +1025,11 @@ ] } } + }, + "x-ms-examples": { + "Returns a list of runs belonging to a thread.": { + "$ref": "./examples/list_runs.json" + } } }, "post": { @@ -949,9 +1044,9 @@ "type": "string" }, { - "name": "createRunOptions", + "name": "body", "in": "body", - "description": "The details for the run to create.", + "description": "The details used when creating a new run of an assistant thread.", "required": true, "schema": { "$ref": "#/definitions/CreateRunOptions" @@ -965,6 +1060,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "Create a run.": { + "$ref": "./examples/create_run.json" + } } } }, @@ -995,6 +1095,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "Gets a run.": { + "$ref": "./examples/get_run.json" + } } }, "post": { @@ -1041,6 +1146,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "Modifies a run.": { + "$ref": "./examples/update_run.json" + } } } }, @@ -1071,6 +1181,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "Cancels a run that is `in_progress`.\n": { + "$ref": "./examples/cancel_run.json" + } } } }, @@ -1194,6 +1309,11 @@ ] } } + }, + "x-ms-examples": { + "Returns a list of run steps belonging to a run.": { + "$ref": "./examples/list_run_steps.json" + } } } }, @@ -1231,6 +1351,11 @@ "$ref": "#/definitions/RunStep" } } + }, + "x-ms-examples": { + "Retrieves a run step.": { + "$ref": "./examples/get_run_step.json" + } } } }, @@ -1288,6 +1413,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "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": { + "$ref": "./examples/submit_tool_outputs_to_run.json" + } } } }, @@ -1299,7 +1429,7 @@ { "name": "body", "in": "body", - "description": "Body parameter.", + "description": "The details used when creating and immediately running a new assistant thread.", "required": true, "schema": { "$ref": "#/definitions/CreateAndRunThreadOptions" @@ -1313,6 +1443,11 @@ "$ref": "#/definitions/ThreadRun" } } + }, + "x-ms-examples": { + "Create a thread and run it in one request.": { + "$ref": "./examples/create_thread_and_run.json" + } } } }, @@ -1422,6 +1557,11 @@ ] } } + }, + "x-ms-examples": { + "Returns a list of vector stores.": { + "$ref": "./examples/list_vector_stores.json" + } } }, "post": { @@ -1431,7 +1571,7 @@ { "name": "body", "in": "body", - "description": "Body parameter.", + "description": "Request object for creating a vector store.", "required": true, "schema": { "$ref": "#/definitions/VectorStoreOptions" @@ -1445,6 +1585,11 @@ "$ref": "#/definitions/VectorStore" } } + }, + "x-ms-examples": { + "Creates a vector store.": { + "$ref": "./examples/create_vector_store.json" + } } } }, @@ -1468,6 +1613,11 @@ "$ref": "#/definitions/VectorStore" } } + }, + "x-ms-examples": { + "Retrieves a vector store.": { + "$ref": "./examples/get_vector_store.json" + } } }, "post": { @@ -1484,6 +1634,7 @@ { "name": "body", "in": "body", + "description": "Request object for updating a vector store.", "required": true, "schema": { "$ref": "#/definitions/VectorStoreUpdateOptions" @@ -1497,6 +1648,11 @@ "$ref": "#/definitions/VectorStore" } } + }, + "x-ms-examples": { + "Modifies a vector store.": { + "$ref": "./examples/modify_vector_store.json" + } } }, "delete": { @@ -1518,6 +1674,11 @@ "$ref": "#/definitions/VectorStoreDeletionStatus" } } + }, + "x-ms-examples": { + "Deletes a vector store.": { + "$ref": "./examples/delete_vector_store.json" + } } } }, @@ -1564,6 +1725,11 @@ "$ref": "#/definitions/VectorStoreFileBatch" } } + }, + "x-ms-examples": { + "Create a vector store file batch.": { + "$ref": "./examples/create_vector_store_file_batch.json" + } } } }, @@ -1594,6 +1760,11 @@ "$ref": "#/definitions/VectorStoreFileBatch" } } + }, + "x-ms-examples": { + "Retrieves a vector store file batch.": { + "$ref": "./examples/get_vector_store_file_batch.json" + } } } }, @@ -1624,6 +1795,11 @@ "$ref": "#/definitions/VectorStoreFileBatch" } } + }, + "x-ms-examples": { + "Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.": { + "$ref": "./examples/cancel_vector_store_file_batch.json" + } } } }, @@ -1786,6 +1962,11 @@ ] } } + }, + "x-ms-examples": { + "Returns a list of vector store files of a given batch.": { + "$ref": "./examples/list_vector_store_file_batch_files.json" + } } } }, @@ -1941,6 +2122,11 @@ ] } } + }, + "x-ms-examples": { + "Returns a list of vector store files.": { + "$ref": "./examples/list_vector_store_files.json" + } } }, "post": { @@ -1980,6 +2166,11 @@ "$ref": "#/definitions/VectorStoreFile" } } + }, + "x-ms-examples": { + "Create a vector store file by attaching a File to a vector store.": { + "$ref": "./examples/create_vector_store_file.json" + } } } }, @@ -2010,6 +2201,11 @@ "$ref": "#/definitions/VectorStoreFile" } } + }, + "x-ms-examples": { + "Retrieves a vector store file.": { + "$ref": "./examples/get_vector_store_file.json" + } } }, "delete": { @@ -2038,6 +2234,11 @@ "$ref": "#/definitions/VectorStoreFileDeletionStatus" } } + }, + "x-ms-examples": { + "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.": { + "$ref": "./examples/delete_vector_store_file.json" + } } } } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json new file mode 100644 index 000000000000..7f3456272098 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_run.json @@ -0,0 +1,48 @@ +{ + "title": "Cancels a run that is `in_progress`.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_abc123", + "runId": "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_choice": "auto", + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "max_completion_tokens": 1000, + "max_prompt_tokens": 1000, + "incomplete_details": null, + "metadata": {}, + "usage": null, + "temperature": 1.0, + "top_p": 1.0, + "response_format": "auto" + } + } + }, + "operationId": "CancelRun" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_vector_store_file_batch.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_vector_store_file_batch.json new file mode 100644 index 000000000000..1d73787e8c47 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/cancel_vector_store_file_batch.json @@ -0,0 +1,28 @@ +{ + "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": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "batchId": "vsfb_abc123" + }, + "responses": { + "200": { + "body": { + "id": "vsfb_abc123", + "object": "vector_store.files_batch", + "created_at": 1699061776, + "vector_store_id": "vs_abc123", + "status": "cancelling", + "file_counts": { + "in_progress": 12, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 15 + } + } + } + }, + "operationId": "CancelVectorStoreFileBatch" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_assistant.json new file mode 100644 index 000000000000..66b92133fe32 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_assistant.json @@ -0,0 +1,41 @@ +{ + "title": "Create an assistant with a model and instructions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-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" + } + ], + "tool_resources": {}, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + } + } + }, + "operationId": "CreateAssistant" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json new file mode 100644 index 000000000000..70ae2b1b9da1 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_message.json @@ -0,0 +1,41 @@ +{ + "title": "Create a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "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": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "attachments": [], + "metadata": {} + } + } + }, + "operationId": "CreateMessage" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json new file mode 100644 index 000000000000..97d2f5b79785 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_run.json @@ -0,0 +1,50 @@ +{ + "title": "Create a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "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": "", + "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" + } + } + }, + "operationId": "CreateRun" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread.json new file mode 100644 index 000000000000..101ade5b001f --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread.json @@ -0,0 +1,20 @@ +{ + "title": "Creates a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "tool_resources": {}, + "metadata": {} + } + } + }, + "operationId": "CreateThread" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_thread_and_run.json new file mode 100644 index 000000000000..5fdbcedb411f --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-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": "2024-05-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": [], + "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" + } + } + }, + "operationId": "CreateThreadAndRun" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store.json new file mode 100644 index 000000000000..60ae754b38c9 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store.json @@ -0,0 +1,32 @@ +{ + "title": "Creates a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "body": { + "name": "Support FAQ" + } + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "usage_bytes": 139920, + "status": "completed", + "last_active_at": 1699061776, + "metadata": {}, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + } + } + }, + "operationId": "CreateVectorStore" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file.json new file mode 100644 index 000000000000..404fe3f1caf9 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file.json @@ -0,0 +1,25 @@ +{ + "title": "Create a vector store file by attaching a File to a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "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 + } + } + }, + "operationId": "CreateVectorStoreFile" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file_batch.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file_batch.json new file mode 100644 index 000000000000..c985b6e7a580 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/create_vector_store_file_batch.json @@ -0,0 +1,33 @@ +{ + "title": "Create a vector store file batch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "body": { + "file_ids": [ + "file-abc123", + "file-abc456" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "vsfb_abc123", + "object": "vector_store.files_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 + } + } + } + }, + "operationId": "CreateVectorStoreFileBatch" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_assistant.json new file mode 100644 index 000000000000..a4675ff13925 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_assistant.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "assistantId": "asst_4nsG2qgNzimRPE7MazXTXbU7" + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant.deleted", + "deleted": true + } + } + }, + "operationId": "DeleteAssistant" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_file.json new file mode 100644 index 000000000000..7c4d93ffd9a6 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_file.json @@ -0,0 +1,18 @@ +{ + "title": "Delete a previously uploaded file.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": { + "object": "file", + "deleted": true, + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + } + } + }, + "operationId": "DeleteFile" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_thread.json new file mode 100644 index 000000000000..fe2b6bc1b662 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_thread.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread.deleted", + "deleted": true + } + } + }, + "operationId": "DeleteThread" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_vector_store.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_vector_store.json new file mode 100644 index 000000000000..1adda1765fb3 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_vector_store.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123 " + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store.deleted", + "deleted": true + } + } + }, + "operationId": "DeleteVectorStore" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_vector_store_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_vector_store_file.json new file mode 100644 index 000000000000..804790877bdb --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/delete_vector_store_file.json @@ -0,0 +1,19 @@ +{ + "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": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "fileId": "file_abc123" + }, + "responses": { + "200": { + "body": { + "id": "file_abc123", + "object": "vector_store.file.deleted", + "deleted": true + } + } + }, + "operationId": "DeleteVectorStoreFile" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_assistant.json new file mode 100644 index 000000000000..514a7c390012 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_assistant.json @@ -0,0 +1,32 @@ +{ + "title": "Retrieves an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "assistantId": "asst_abc123" + }, + "responses": { + "200": { + "body": { + "id": "asst_4lMdCUN4lS2SQcHEy9CM1QIt", + "object": "assistant", + "created_at": 1718875084, + "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" + } + ], + "top_p": 1.0, + "temperature": 1.0, + "tool_resources": {}, + "metadata": {}, + "response_format": "auto" + } + } + }, + "operationId": "GetAssistant" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_file.json new file mode 100644 index 000000000000..af3ab4586d76 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_file.json @@ -0,0 +1,23 @@ +{ + "title": "Returns a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199, + "status": "processed", + "status_details": null + } + } + }, + "operationId": "GetFile" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_file_content.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_file_content.json new file mode 100644 index 000000000000..4b5fec6d67f7 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_file_content.json @@ -0,0 +1,14 @@ +{ + "title": "Returns the content of a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "fileId": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3" + }, + "responses": { + "200": { + "body": "file content" + } + }, + "operationId": "GetFileContent" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json new file mode 100644 index 000000000000..03af4b1a4ebe --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_message.json @@ -0,0 +1,38 @@ +{ + "title": "Retrieve a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx", + "messageId": "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": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "assistant_id": null, + "run_id": null, + "attachments": [], + "metadata": {} + } + } + }, + "operationId": "GetMessage" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json new file mode 100644 index 000000000000..2895df4dce16 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run.json @@ -0,0 +1,42 @@ +{ + "title": "Gets a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1707303196, + "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "completed", + "incomplete_details": null, + "usage": null, + "started_at": 1707303197, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1707303201, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto", + "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": [], + "metadata": {} + } + } + }, + "operationId": "GetRun" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run_step.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run_step.json new file mode 100644 index 000000000000..556262ddc1a4 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_run_step.json @@ -0,0 +1,42 @@ +{ + "title": "Retrieves a run step.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_eRNwflE3ncDYak1np6MdMHJh", + "runId": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "stepId": "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 + }, + "metadata": {} + } + } + }, + "operationId": "GetRunStep" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_thread.json new file mode 100644 index 000000000000..8d95c82cfe2d --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_thread.json @@ -0,0 +1,24 @@ +{ + "title": "Retrieves a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": {}, + "tool_resources": { + "code_interpreter": { + "file_ids": [] + } + } + } + } + }, + "operationId": "GetThread" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store.json new file mode 100644 index 000000000000..a8cc51d89802 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store.json @@ -0,0 +1,30 @@ +{ + "title": "Retrieves a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123" + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "usage_bytes": 139920, + "status": "completed", + "last_active_at": 1699061776, + "metadata": {}, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + } + } + }, + "operationId": "GetVectorStore" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file.json new file mode 100644 index 000000000000..2f351de142b6 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file.json @@ -0,0 +1,23 @@ +{ + "title": "Retrieves a vector store file.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "fileId": "file-abc123" + }, + "responses": { + "200": { + "body": { + "id": "file-abc123", + "object": "vector_store.file", + "created_at": 1699061776, + "usage_bytes": 123456, + "vector_store_id": "vs_abcd", + "status": "completed", + "last_error": null + } + } + }, + "operationId": "GetVectorStoreFile" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file_batch.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file_batch.json new file mode 100644 index 000000000000..18f0a0f0a385 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/get_vector_store_file_batch.json @@ -0,0 +1,28 @@ +{ + "title": "Retrieves a vector store file batch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "batchId": "vsfb_abc123" + }, + "responses": { + "200": { + "body": { + "id": "vsfb_abc123", + "object": "vector_store.files_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 + } + } + } + }, + "operationId": "GetVectorStoreFileBatch" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_assistants.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_assistants.json new file mode 100644 index 000000000000..2e2a78969007 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_assistants.json @@ -0,0 +1,71 @@ +{ + "title": "Returns a list of assistants.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-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": "", + "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 + } + } + }, + "operationId": "ListAssistants" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_file.json new file mode 100644 index 000000000000..a8c406924328 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_file.json @@ -0,0 +1,38 @@ +{ + "title": "Returns a list of files filtered by purpose", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "purpose": "assistants" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199, + "status": "processed", + "status_details": null + }, + { + "object": "file", + "id": "assistant-D6AmXzgJ6gyGcgT48OmJ8kYc", + "purpose": "assistants", + "filename": "test07a45e38-9b88-449a-9580-94fdb986eb75.txt", + "bytes": 4, + "created_at": 1718886043, + "status": "processed", + "status_details": null + } + ] + } + } + }, + "operationId": "ListFiles" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json new file mode 100644 index 000000000000..4813900797ae --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_messages.json @@ -0,0 +1,69 @@ +{ + "title": "List Messages", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "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": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "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": [] + } + } + ], + "status": "completed", + "incomplete_details": null, + "incomplete_at": null, + "completed_at": 1707298439, + "attachments": [], + "metadata": {} + } + ], + "first_id": "msg_abc123", + "last_id": "msg_abc456", + "has_more": false + } + } + }, + "operationId": "ListMessages" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_run_steps.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_run_steps.json new file mode 100644 index 000000000000..e57f889c9165 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_run_steps.json @@ -0,0 +1,49 @@ +{ + "title": "Returns a list of run steps belonging to a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_abc123", + "runId": "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 + }, + "metadata": {} + } + ], + "first_id": "step_abc123", + "last_id": "step_abc456", + "has_more": false + } + } + }, + "operationId": "ListRunSteps" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json new file mode 100644 index 000000000000..e80a557e64c1 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_runs.json @@ -0,0 +1,97 @@ +{ + "title": "Returns a list of runs belonging to a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "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": "", + "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" + }, + { + "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": "", + "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" + } + ], + "first_id": "run_abc123", + "last_id": "run_abc456", + "has_more": false + } + } + }, + "operationId": "ListRuns" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_file_batch_files.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_file_batch_files.json new file mode 100644 index 000000000000..be54b92a08b5 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_file_batch_files.json @@ -0,0 +1,40 @@ +{ + "title": "Returns a list of vector store files of a given batch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "batchId": "batch-abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "file-abc123", + "usage_bytes": 1234, + "status": "completed", + "last_error": null, + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + }, + { + "id": "file-abc456", + "usage_bytes": 1234, + "status": "completed", + "last_error": null, + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + } + ], + "first_id": "file-abc123", + "last_id": "file-abc456", + "has_more": false + } + } + }, + "operationId": "ListVectorStoreFileBatchFiles" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_files.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_files.json new file mode 100644 index 000000000000..e6406462f735 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_store_files.json @@ -0,0 +1,39 @@ +{ + "title": "Returns a list of vector store files.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "file-abc123", + "usage_bytes": 1234, + "status": "completed", + "last_error": null, + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + }, + { + "id": "file-abc456", + "usage_bytes": 1234, + "status": "completed", + "last_error": null, + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + } + ], + "first_id": "file-abc123", + "last_id": "file-abc456", + "has_more": false + } + } + }, + "operationId": "ListVectorStoreFiles" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_stores.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_stores.json new file mode 100644 index 000000000000..df84331efbac --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/list_vector_stores.json @@ -0,0 +1,54 @@ +{ + "title": "Returns a list of vector stores.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "usage_bytes": 139920, + "status": "in_progress", + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + }, + "last_active_at": 1699061776, + "metadata": {} + }, + { + "id": "vs_abc456", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ v2", + "usage_bytes": 139920, + "status": "in_progress", + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + }, + "last_active_at": 1699061776, + "metadata": {} + } + ], + "first_id": "vs_abc123", + "last_id": "vs_abc456", + "has_more": false + } + } + }, + "operationId": "ListVectorStores" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/modify_vector_store.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/modify_vector_store.json new file mode 100644 index 000000000000..935bdadbd7d2 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/modify_vector_store.json @@ -0,0 +1,33 @@ +{ + "title": "Modifies a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "vectorStoreId": "vs_abc123", + "body": { + "name": "Support FAQ" + } + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "usage_bytes": 139920, + "status": "completed", + "last_active_at": 1699061776, + "metadata": {}, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + } + } + }, + "operationId": "ModifyVectorStore" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json new file mode 100644 index 000000000000..cd810dd4169a --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/submit_tool_outputs_to_run.json @@ -0,0 +1,79 @@ +{ + "title": "When a run has the `status: \"requires_action\"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_123", + "runId": "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": "", + "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, + "incomplete_details": null, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + } + }, + "operationId": "SubmitToolOutputsToRun" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_assistant.json new file mode 100644 index 000000000000..c0e7fc6ee699 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_assistant.json @@ -0,0 +1,45 @@ +{ + "title": "Modifies an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "assistantId": "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" + } + } + }, + "operationId": "UpdateAssistant" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json new file mode 100644 index 000000000000..7621cc8605c7 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_message.json @@ -0,0 +1,47 @@ +{ + "title": "Modify a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_abc123", + "messageId": "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", + "status": "complete", + "incomplete_details": null, + "completed_at": 1699017614, + "incomplete_at": null, + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "How does AI work? Explain it in simple terms.", + "annotations": [] + } + } + ], + "attachments": [], + "metadata": { + "modified": "true", + "user": "abc123" + } + } + } + }, + "operationId": "UpdateMessage" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json new file mode 100644 index 000000000000..709ed437a3ce --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_run.json @@ -0,0 +1,59 @@ +{ + "title": "Modifies a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "thread_abc123", + "runId": "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": "", + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "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" + } + } + }, + "operationId": "UpdateRun" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_thread.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_thread.json new file mode 100644 index 000000000000..e7610f8ec4cf --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/update_thread.json @@ -0,0 +1,29 @@ +{ + "title": "Modifies a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "threadId": "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": {} + } + } + }, + "operationId": "UpdateThread" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/upload_file.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/upload_file.json new file mode 100644 index 000000000000..933d5d59974e --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/examples/upload_file.json @@ -0,0 +1,30 @@ +{ + "title": "Uploads a file", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-05-01-preview", + "purpose": "assistants", + "file": [ + 0, + 1, + 0, + 1, + 0 + ] + }, + "responses": { + "200": { + "body": { + "object": "file", + "id": "assistant-uzdgnx4i8PPe96zgXQ1vJ9W3", + "purpose": "assistants", + "filename": "test78686269-a3d7-4c96-be67-fecdf3f39de8.txt", + "bytes": 4, + "created_at": 1718886199, + "status": "processed", + "status_details": null + } + } + }, + "operationId": "UploadFile" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/assistants_generated.json deleted file mode 100644 index 7b5bd59f8c14..000000000000 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/assistants_generated.json +++ /dev/null @@ -1,3452 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure OpenAI", - "version": "2023-11-06-beta", - "description": "Azure OpenAI APIs for Assistants.", - "x-typespec-generated": [ - { - "emitter": "@azure-tools/typespec-autorest" - } - ] - }, - "schemes": [ - "https" - ], - "x-ms-parameterized-host": { - "hostTemplate": "{endpoint}", - "useSchemePrefix": false, - "parameters": [ - { - "name": "endpoint", - "in": "path", - "description": "An OpenAI endpoint supporting assistants functionality.", - "required": true, - "type": "string" - } - ] - }, - "produces": [ - "application/json" - ], - "consumes": [ - "application/json" - ], - "security": [ - { - "ApiKeyAuth": [] - }, - { - "OAuth2Auth": [ - "https://cognitiveservices.azure.com/.default" - ] - } - ], - "securityDefinitions": { - "ApiKeyAuth": { - "type": "apiKey", - "name": "api-key", - "in": "header" - }, - "OAuth2Auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", - "scopes": { - "https://cognitiveservices.azure.com/.default": "" - } - } - }, - "tags": [], - "paths": { - "/assistants": { - "get": { - "operationId": "ListAssistants", - "description": "Gets a list of assistants that were previously created.", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of assistants.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/Assistant" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - }, - "post": { - "operationId": "CreateAssistant", - "description": "Creates a new assistant.", - "parameters": [ - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AssistantCreationOptions" - } - } - ], - "responses": { - "200": { - "description": "The new assistant instance.", - "schema": { - "$ref": "#/definitions/Assistant" - } - } - } - } - }, - "/assistants/{assistantId}": { - "get": { - "operationId": "GetAssistant", - "description": "Retrieves an existing assistant.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to retrieve.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested assistant instance.", - "schema": { - "$ref": "#/definitions/Assistant" - } - } - } - }, - "post": { - "operationId": "ModifyAssistant", - "description": "Modifies an existing assistant.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to modify.", - "required": true, - "type": "string" - }, - { - "name": "modificationOptions", - "in": "body", - "description": "The details of the modification to perform on the specified assistant.", - "required": true, - "schema": { - "$ref": "#/definitions/AssistantModificationOptions" - } - } - ], - "responses": { - "200": { - "description": "The updated assistant instance.", - "schema": { - "$ref": "#/definitions/Assistant" - } - } - } - }, - "delete": { - "operationId": "DeleteAssistant", - "description": "Deletes an assistant.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to delete.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Status information about the requested deletion operation.", - "schema": { - "$ref": "#/definitions/AssistantDeletionStatus" - } - } - } - } - }, - "/assistants/{assistantId}/files": { - "get": { - "operationId": "ListAssistantFiles", - "description": "Gets a list of files attached to a specific assistant, as used by tools that can read files.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to retrieve the list of attached files for.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of files attached to the specified assistant.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/AssistantFile" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - }, - "post": { - "operationId": "CreateAssistantFile", - "description": "Attaches a previously uploaded file to an assistant for use by tools that can read files.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant to attach the file to.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the previously uploaded file to attach.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - } - } - ], - "responses": { - "200": { - "description": "Information about the attached file.", - "schema": { - "$ref": "#/definitions/AssistantFile" - } - } - } - } - }, - "/assistants/{assistantId}/files/{fileId}": { - "get": { - "operationId": "GetAssistantFile", - "description": "Retrieves a file attached to an assistant.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant associated with the attached file.", - "required": true, - "type": "string" - }, - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to retrieve.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "A representation of the attached file.", - "schema": { - "$ref": "#/definitions/AssistantFile" - } - } - } - }, - "delete": { - "operationId": "DeleteAssistantFile", - "description": "Unlinks a previously attached file from an assistant, rendering it unavailable for use by tools that can read\nfiles.", - "parameters": [ - { - "name": "assistantId", - "in": "path", - "description": "The ID of the assistant from which the specified file should be unlinked.", - "required": true, - "type": "string" - }, - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to unlink from the specified assistant.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Status information about the requested file association deletion.", - "schema": { - "$ref": "#/definitions/AssistantFileDeletionStatus" - } - } - } - } - }, - "/files": { - "get": { - "operationId": "ListFiles", - "description": "Gets a list of previously uploaded files.", - "parameters": [ - { - "name": "purpose", - "in": "query", - "description": "A value that, when provided, limits list results to files matching the corresponding purpose.", - "required": false, - "type": "string", - "enum": [ - "fine-tune", - "fine-tune-results", - "assistants", - "assistants_output" - ], - "x-ms-enum": { - "name": "FilePurpose", - "modelAsString": true, - "values": [ - { - "name": "fineTune", - "value": "fine-tune", - "description": "Indicates a file is used for fine tuning input." - }, - { - "name": "fineTuneResults", - "value": "fine-tune-results", - "description": "Indicates a file is used for fine tuning results." - }, - { - "name": "assistants", - "value": "assistants", - "description": "Indicates a file is used as input to assistants." - }, - { - "name": "assistantsOutput", - "value": "assistants_output", - "description": "Indicates a file is used as output by assistants." - } - ] - } - } - ], - "responses": { - "200": { - "description": "The requested list of files.", - "schema": { - "$ref": "#/definitions/FileListResponse" - } - } - } - }, - "post": { - "operationId": "CreateFile", - "description": "Uploads a file for use by other operations.", - "consumes": [ - "multipart/form-data" - ], - "parameters": [ - { - "name": "file", - "in": "formData", - "description": "The file data (not filename) to upload.", - "required": true, - "type": "file" - }, - { - "name": "purpose", - "in": "formData", - "description": "The intended purpose of the file.", - "required": true, - "type": "string", - "enum": [ - "fine-tune", - "fine-tune-results", - "assistants", - "assistants_output" - ], - "x-ms-enum": { - "name": "FilePurpose", - "modelAsString": true, - "values": [ - { - "name": "fineTune", - "value": "fine-tune", - "description": "Indicates a file is used for fine tuning input." - }, - { - "name": "fineTuneResults", - "value": "fine-tune-results", - "description": "Indicates a file is used for fine tuning results." - }, - { - "name": "assistants", - "value": "assistants", - "description": "Indicates a file is used as input to assistants." - }, - { - "name": "assistantsOutput", - "value": "assistants_output", - "description": "Indicates a file is used as output by assistants." - } - ] - } - }, - { - "name": "filename", - "in": "formData", - "description": "A filename to associate with the uploaded data.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "A representation of the uploaded file.", - "schema": { - "$ref": "#/definitions/OpenAIFile" - } - } - } - } - }, - "/files/{fileId}": { - "get": { - "operationId": "RetrieveFile", - "description": "Returns information about a specific file. Does not retrieve file content.", - "parameters": [ - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to retrieve.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/OpenAIFile" - } - } - } - }, - "delete": { - "operationId": "DeleteFile", - "description": "Delete a previously uploaded file.", - "parameters": [ - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to delete.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/FileDeletionStatus" - } - } - } - } - }, - "/threads": { - "post": { - "operationId": "CreateThread", - "description": "Creates a new thread. Threads contain messages and can be run by assistants.", - "parameters": [ - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AssistantThreadCreationOptions" - } - } - ], - "responses": { - "200": { - "description": "Information about the newly created thread.", - "schema": { - "$ref": "#/definitions/AssistantThread" - } - } - } - } - }, - "/threads/{threadId}": { - "get": { - "operationId": "GetThread", - "description": "Gets information about an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to retrieve information about.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Information about the requested thread.", - "schema": { - "$ref": "#/definitions/AssistantThread" - } - } - } - }, - "post": { - "operationId": "ModifyThread", - "description": "Modifies an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to modify.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - } - } - ], - "responses": { - "200": { - "description": "Information about the modified thread.", - "schema": { - "$ref": "#/definitions/AssistantThread" - } - } - } - }, - "delete": { - "operationId": "DeleteThread", - "description": "Deletes an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to delete.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Status information about the requested thread deletion operation.", - "schema": { - "$ref": "#/definitions/ThreadDeletionStatus" - } - } - } - } - }, - "/threads/{threadId}/messages": { - "get": { - "operationId": "ListMessages", - "description": "Gets a list of messages that exist on a thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to list messages from.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of messages.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/ThreadMessage" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - }, - "post": { - "operationId": "CreateMessage", - "description": "Creates a new message on a specified thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to create the new message on.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "role": { - "$ref": "#/definitions/MessageRole", - "description": "The role to associate with the new message." - }, - "content": { - "type": "string", - "description": "The textual content for the new message." - }, - "file_ids": { - "type": "array", - "description": "A list of up to 10 file IDs to associate with the message, as used by tools like 'code_interpreter' or 'retrieval' that can read files.", - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "role", - "content" - ] - } - } - ], - "responses": { - "200": { - "description": "A representation of the new message.", - "schema": { - "$ref": "#/definitions/ThreadMessage" - } - } - } - } - }, - "/threads/{threadId}/messages/{messageId}": { - "get": { - "operationId": "GetMessage", - "description": "Gets an existing message from an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to retrieve the specified message from.", - "required": true, - "type": "string" - }, - { - "name": "messageId", - "in": "path", - "description": "The ID of the message to retrieve from the specified thread.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "A representation of the requested message.", - "schema": { - "$ref": "#/definitions/ThreadMessage" - } - } - } - }, - "post": { - "operationId": "ModifyMessage", - "description": "Modifies an existing message on an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread containing the specified message to modify.", - "required": true, - "type": "string" - }, - { - "name": "messageId", - "in": "path", - "description": "The ID of the message to modify on the specified thread.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - } - } - ], - "responses": { - "200": { - "description": "A representation of the modified message.", - "schema": { - "$ref": "#/definitions/ThreadMessage" - } - } - } - } - }, - "/threads/{threadId}/messages/{messageId}/files": { - "get": { - "operationId": "ListMessageFiles", - "description": "Gets a list of previously uploaded files associated with a message from a thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread containing the message to list files from.", - "required": true, - "type": "string" - }, - { - "name": "messageId", - "in": "path", - "description": "The ID of the message to list files from.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of files associated with the specified message.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/MessageFile" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - } - }, - "/threads/{threadId}/messages/{messageId}/files/{fileId}": { - "get": { - "operationId": "GetMessageFile", - "description": "Gets information about a file attachment to a message within a thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread containing the message to get information from.", - "required": true, - "type": "string" - }, - { - "name": "messageId", - "in": "path", - "description": "The ID of the message to get information from.", - "required": true, - "type": "string" - }, - { - "name": "fileId", - "in": "path", - "description": "The ID of the file to get information about.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested file information.", - "schema": { - "$ref": "#/definitions/MessageFile" - } - } - } - } - }, - "/threads/{threadId}/runs": { - "get": { - "operationId": "ListRuns", - "description": "Gets a list of runs for a specified thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to list runs from.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of thread runs.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/ThreadRun" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - }, - "post": { - "operationId": "CreateRun", - "description": "Creates a new run for an assistant thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to run.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "assistant_id": { - "type": "string", - "description": "The ID of the assistant that should run the thread.", - "x-ms-client-name": "assistantId" - }, - "model": { - "type": "string", - "description": "The overridden model name that the assistant should use to run the thread." - }, - "instructions": { - "type": "string", - "description": "The overridden system instructions that the assistant should use to run the thread." - }, - "tools": { - "type": "array", - "description": "The overridden list of enabled tools that the assistant should use to run the thread.", - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "assistant_id" - ] - } - } - ], - "responses": { - "200": { - "description": "Information about the new thread run.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - } - }, - "/threads/{threadId}/runs/{runId}": { - "get": { - "operationId": "GetRun", - "description": "Gets an existing run from an existing thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread to retrieve run information from.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the thread to retrieve information about.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested information about the specified thread run.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - }, - "post": { - "operationId": "ModifyRun", - "description": "Modifies an existing thread run.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread associated with the specified run.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the run to modify.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - } - } - ], - "responses": { - "200": { - "description": "Information about the modified run.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - } - }, - "/threads/{threadId}/runs/{runId}/cancel": { - "post": { - "operationId": "CancelRun", - "description": "Cancels a run of an in progress thread.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread being run.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the run to cancel.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Updated information about the cancelled run.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - } - }, - "/threads/{threadId}/runs/{runId}/steps": { - "get": { - "operationId": "ListRunSteps", - "description": "Gets a list of run steps from a thread run.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread that was run.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the run to list steps from.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", - "required": false, - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "name": "order", - "in": "query", - "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", - "required": false, - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "ListSortOrder", - "modelAsString": true, - "values": [ - { - "name": "ascending", - "value": "asc", - "description": "Specifies an ascending sort order." - }, - { - "name": "descending", - "value": "desc", - "description": "Specifies a descending sort order." - } - ] - } - }, - { - "name": "after", - "in": "query", - "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", - "required": false, - "type": "string" - }, - { - "name": "before", - "in": "query", - "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The requested list of run steps.", - "schema": { - "type": "object", - "description": "The response data for a requested list of items.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always list.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The requested list of items.", - "items": { - "$ref": "#/definitions/RunStep" - } - }, - "first_id": { - "type": "string", - "description": "The first ID represented in this list.", - "x-ms-client-name": "firstId" - }, - "last_id": { - "type": "string", - "description": "The last ID represented in this list.", - "x-ms-client-name": "lastId" - }, - "has_more": { - "type": "boolean", - "description": "A value indicating whether there are additional values available not captured in this list.", - "x-ms-client-name": "hasMore" - } - }, - "required": [ - "object", - "data", - "first_id", - "last_id", - "has_more" - ] - } - } - } - } - }, - "/threads/{threadId}/runs/{runId}/steps/{stepId}": { - "get": { - "operationId": "GetRunStep", - "description": "Gets a single run step from a thread run.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread that was run.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the specific run to retrieve the step from.", - "required": true, - "type": "string" - }, - { - "name": "stepId", - "in": "path", - "description": "The ID of the step to retrieve information about.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Information about the requested run step.", - "schema": { - "$ref": "#/definitions/RunStep" - } - } - } - } - }, - "/threads/{threadId}/runs/{runId}/submit_tool_outputs": { - "post": { - "operationId": "SubmitToolOutputsToRun", - "description": "Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'.", - "parameters": [ - { - "name": "threadId", - "in": "path", - "description": "The ID of the thread that was run.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The ID of the run that requires tool outputs.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "tool_outputs": { - "type": "array", - "description": "The list of tool outputs requested by tool calls from the specified run.", - "items": { - "$ref": "#/definitions/ToolOutput" - }, - "x-ms-client-name": "toolOutputs", - "x-ms-identifiers": [] - } - }, - "required": [ - "tool_outputs" - ] - } - } - ], - "responses": { - "200": { - "description": "Updated information about the run.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - } - }, - "/threads/runs": { - "post": { - "operationId": "CreateThreadAndRun", - "description": "Creates a new assistant thread and immediately starts a run using that new thread.", - "parameters": [ - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CreateAndRunThreadOptions" - } - } - ], - "responses": { - "200": { - "description": "Information about the newly created thread.", - "schema": { - "$ref": "#/definitions/ThreadRun" - } - } - } - } - } - }, - "definitions": { - "Assistant": { - "type": "object", - "description": "Represents an assistant that can call the model and use tools.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always assistant.", - "enum": [ - "assistant" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "name": { - "type": "string", - "description": "The name of the assistant.", - "x-nullable": true - }, - "description": { - "type": "string", - "description": "The description of the assistant.", - "x-nullable": true - }, - "model": { - "type": "string", - "description": "The ID of the model to use." - }, - "instructions": { - "type": "string", - "description": "The system instructions for the assistant to use.", - "x-nullable": true - }, - "tools": { - "type": "array", - "description": "The collection of tools enabled for the assistant.", - "default": [], - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "file_ids": { - "type": "array", - "description": "A list of attached file IDs, ordered by creation date in ascending order.", - "default": [], - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "id", - "object", - "created_at", - "name", - "description", - "model", - "instructions", - "tools", - "file_ids", - "metadata" - ] - }, - "AssistantCreationOptions": { - "type": "object", - "description": "The request details to use when creating a new assistant.", - "properties": { - "model": { - "type": "string", - "description": "The ID of the model to use." - }, - "name": { - "type": "string", - "description": "The name of the new assistant.", - "x-nullable": true - }, - "description": { - "type": "string", - "description": "The description of the new assistant.", - "x-nullable": true - }, - "instructions": { - "type": "string", - "description": "The system instructions for the new assistant to use.", - "x-nullable": true - }, - "tools": { - "type": "array", - "description": "The collection of tools to enable for the new assistant.", - "default": [], - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "file_ids": { - "type": "array", - "description": "A list of previously uploaded file IDs to attach to the assistant.", - "default": [], - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "model" - ] - }, - "AssistantDeletionStatus": { - "type": "object", - "description": "The status of an assistant deletion operation.", - "properties": { - "id": { - "type": "string", - "description": "The ID of the resource specified for deletion." - }, - "deleted": { - "type": "boolean", - "description": "A value indicating whether deletion was successful." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'assistant.deleted'.", - "enum": [ - "assistant.deleted" - ], - "x-ms-enum": { - "modelAsString": false - } - } - }, - "required": [ - "id", - "deleted", - "object" - ] - }, - "AssistantFile": { - "type": "object", - "description": "Information about a file attached to an assistant, as used by tools that can read files.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'assistant.file'.", - "enum": [ - "assistant.file" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "assistant_id": { - "type": "string", - "description": "The assistant ID that the file is attached to.", - "x-ms-client-name": "assistantId" - } - }, - "required": [ - "id", - "object", - "created_at", - "assistant_id" - ] - }, - "AssistantFileDeletionStatus": { - "type": "object", - "description": "The status of an assistant file deletion operation.", - "properties": { - "id": { - "type": "string", - "description": "The ID of the resource specified for deletion." - }, - "deleted": { - "type": "boolean", - "description": "A value indicating whether deletion was successful." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'assistant.file.deleted'.", - "enum": [ - "assistant.file.deleted" - ], - "x-ms-enum": { - "modelAsString": false - } - } - }, - "required": [ - "id", - "deleted", - "object" - ] - }, - "AssistantModificationOptions": { - "type": "object", - "description": "The request details to use when modifying an existing assistant.", - "properties": { - "model": { - "type": "string", - "description": "The ID of the model to use." - }, - "name": { - "type": "string", - "description": "The modified name for the assistant to use.", - "x-nullable": true - }, - "description": { - "type": "string", - "description": "The modified description for the assistant to use.", - "x-nullable": true - }, - "instructions": { - "type": "string", - "description": "The modified system instructions for the new assistant to use.", - "x-nullable": true - }, - "tools": { - "type": "array", - "description": "The modified collection of tools to enable for the assistant.", - "default": [], - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "file_ids": { - "type": "array", - "description": "The modified list of previously uploaded fileIDs to attach to the assistant.", - "default": [], - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - }, - "AssistantThread": { - "type": "object", - "description": "Information about a single thread associated with an assistant.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread'.", - "enum": [ - "thread" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "id", - "object", - "created_at", - "metadata" - ] - }, - "AssistantThreadCreationOptions": { - "type": "object", - "description": "The details used to create a new assistant thread.", - "properties": { - "messages": { - "type": "array", - "description": "The messages to associate with the new thread.", - "items": { - "$ref": "#/definitions/ThreadMessage" - } - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - } - }, - "CodeInterpreterImageOutput": { - "type": "object", - "description": "A representation of an image output emitted by a code interpreter tool in response to a tool call by the model.", - "properties": { - "image": { - "$ref": "#/definitions/CodeInterpreterImageReference", - "description": "Referential information for the image associated with this output." - } - }, - "required": [ - "image" - ], - "allOf": [ - { - "$ref": "#/definitions/CodeInterpreterToolCallOutput" - } - ], - "x-ms-discriminator-value": "image" - }, - "CodeInterpreterImageReference": { - "type": "object", - "description": "An image reference emitted by a code interpreter tool in response to a tool call by the model.", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the file associated with this image.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - }, - "CodeInterpreterLogOutput": { - "type": "object", - "description": "A representation of a log output emitted by a code interpreter tool in response to a tool call by the model.", - "properties": { - "logs": { - "type": "string", - "description": "The serialized log output emitted by the code interpreter." - } - }, - "required": [ - "logs" - ], - "allOf": [ - { - "$ref": "#/definitions/CodeInterpreterToolCallOutput" - } - ], - "x-ms-discriminator-value": "logs" - }, - "CodeInterpreterToolCall": { - "type": "object", - "description": "A tool call to a code interpreter tool, issued by the model in evaluation of a configured code interpreter tool, that\nrepresents submitted output needed or already fulfilled by the tool for the model to continue.", - "properties": { - "code_interpreter": { - "$ref": "#/definitions/CodeInterpreterToolCallDetails", - "description": "The details of the tool call to the code interpreter tool.", - "x-ms-client-name": "codeInterpreter" - } - }, - "required": [ - "code_interpreter" - ], - "allOf": [ - { - "$ref": "#/definitions/ToolCall" - } - ], - "x-ms-discriminator-value": "code_interpreter" - }, - "CodeInterpreterToolCallDetails": { - "type": "object", - "description": "The detailed information about a code interpreter invocation by the model.", - "properties": { - "input": { - "type": "string", - "description": "The input provided by the model to the code interpreter tool." - }, - "outputs": { - "type": "array", - "description": "The outputs produced by the code interpreter tool back to the model in response to the tool call.", - "items": { - "$ref": "#/definitions/CodeInterpreterToolCallOutput" - }, - "x-ms-identifiers": [] - } - }, - "required": [ - "input", - "outputs" - ] - }, - "CodeInterpreterToolCallOutput": { - "type": "object", - "description": "An abstract representation of an emitted output from a code interpreter tool.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "CodeInterpreterToolDefinition": { - "type": "object", - "description": "The input definition information for a code interpreter tool as used to configure an assistant.", - "allOf": [ - { - "$ref": "#/definitions/ToolDefinition" - } - ], - "x-ms-discriminator-value": "code_interpreter" - }, - "CreateAndRunThreadOptions": { - "type": "object", - "description": "The details used when creating and immediately running a new assistant thread.", - "properties": { - "assistant_id": { - "type": "string", - "description": "The ID of the assistant for which the thread should be created.", - "x-ms-client-name": "assistantId" - }, - "thread": { - "$ref": "#/definitions/AssistantThreadCreationOptions", - "description": "The details used to create the new thread." - }, - "model": { - "type": "string", - "description": "The overridden model that the assistant should use to run the thread." - }, - "instructions": { - "type": "string", - "description": "The overridden system instructions the assistant should use to run the thread." - }, - "tools": { - "type": "array", - "description": "The overridden list of enabled tools the assistant should use to run the thread.", - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "assistant_id" - ] - }, - "FileDeletionStatus": { - "type": "object", - "description": "A status response from a file deletion operation.", - "properties": { - "id": { - "type": "string", - "description": "The ID of the resource specified for deletion." - }, - "deleted": { - "type": "boolean", - "description": "A value indicating whether deletion was successful." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'file'.", - "enum": [ - "file" - ], - "x-ms-enum": { - "modelAsString": false - } - } - }, - "required": [ - "id", - "deleted", - "object" - ] - }, - "FileListResponse": { - "type": "object", - "description": "The response data from a file list operation.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always 'list'.", - "enum": [ - "list" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "data": { - "type": "array", - "description": "The files returned for the request.", - "items": { - "$ref": "#/definitions/OpenAIFile" - } - } - }, - "required": [ - "object", - "data" - ] - }, - "FilePurpose": { - "type": "string", - "description": "The possible values denoting the intended usage of a file.", - "enum": [ - "fine-tune", - "fine-tune-results", - "assistants", - "assistants_output" - ], - "x-ms-enum": { - "name": "FilePurpose", - "modelAsString": true, - "values": [ - { - "name": "fineTune", - "value": "fine-tune", - "description": "Indicates a file is used for fine tuning input." - }, - { - "name": "fineTuneResults", - "value": "fine-tune-results", - "description": "Indicates a file is used for fine tuning results." - }, - { - "name": "assistants", - "value": "assistants", - "description": "Indicates a file is used as input to assistants." - }, - { - "name": "assistantsOutput", - "value": "assistants_output", - "description": "Indicates a file is used as output by assistants." - } - ] - } - }, - "FunctionDefinition": { - "type": "object", - "description": "The input definition information for a function.", - "properties": { - "name": { - "type": "string", - "description": "The name of the function to be called." - }, - "description": { - "type": "string", - "description": "A description of what the function does, used by the model to choose when and how to call the function." - }, - "parameters": { - "description": "The parameters the functions accepts, described as a JSON Schema object." - } - }, - "required": [ - "name", - "parameters" - ] - }, - "FunctionToolCall": { - "type": "object", - "description": "A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents\ngiven function inputs and submitted function outputs needed or already fulfilled by the tool for the model to continue.", - "properties": { - "function": { - "$ref": "#/definitions/FunctionToolCallDetails", - "description": "The detailed information about the function called by the model." - } - }, - "required": [ - "function" - ], - "allOf": [ - { - "$ref": "#/definitions/ToolCall" - } - ], - "x-ms-discriminator-value": "function" - }, - "FunctionToolCallDetails": { - "type": "object", - "description": "The detailed information about the function called by the model.", - "properties": { - "name": { - "type": "string", - "description": "The name of the function." - }, - "arguments": { - "type": "string", - "description": "The arguments that the model requires are provided to the named function." - }, - "output": { - "type": "string", - "description": "The output of the function, only populated for function calls that have already have had their outputs submitted.", - "x-nullable": true - } - }, - "required": [ - "name", - "arguments", - "output" - ] - }, - "FunctionToolDefinition": { - "type": "object", - "description": "The input definition information for a function tool as used to configure an assistant.", - "properties": { - "function": { - "$ref": "#/definitions/FunctionDefinition", - "description": "The definition of the concrete function that the function tool should call." - } - }, - "required": [ - "function" - ], - "allOf": [ - { - "$ref": "#/definitions/ToolDefinition" - } - ], - "x-ms-discriminator-value": "function" - }, - "MessageContent": { - "type": "object", - "description": "An abstract representation of a single item of thread message content.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "MessageFile": { - "type": "object", - "description": "Information about a file attached to an assistant thread message.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.message.file'.", - "enum": [ - "thread.message.file" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "message_id": { - "type": "string", - "description": "The ID of the message that this file is attached to.", - "x-ms-client-name": "messageId" - } - }, - "required": [ - "id", - "object", - "created_at", - "message_id" - ] - }, - "MessageFileCitationTextAnnotation": { - "type": "object", - "description": "A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the 'retrieval' tool to search files.", - "properties": { - "file_citation": { - "$ref": "#/definitions/MessageTextFileCitationDetails", - "description": "A citation within the message that points to a specific quote from a specific file.\nGenerated when the assistant uses the \"retrieval\" tool to search files.", - "x-ms-client-name": "fileCitation" - } - }, - "required": [ - "file_citation" - ], - "allOf": [ - { - "$ref": "#/definitions/MessageTextAnnotation" - } - ], - "x-ms-discriminator-value": "file_citation" - }, - "MessageFilePathDetails": { - "type": "object", - "description": "An encapsulation of an image file ID, as used by message image content.", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the specific file that the citation is from.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - }, - "MessageFilePathTextAnnotation": { - "type": "object", - "description": "A citation within the message that points to a file located at a specific path.", - "properties": { - "file_path": { - "$ref": "#/definitions/MessageFilePathDetails", - "description": "A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file.", - "x-ms-client-name": "filePath" - } - }, - "required": [ - "file_path" - ], - "allOf": [ - { - "$ref": "#/definitions/MessageTextAnnotation" - } - ], - "x-ms-discriminator-value": "file_path" - }, - "MessageImageFileContent": { - "type": "object", - "description": "A representation of image file content in a thread message.", - "properties": { - "image_file": { - "$ref": "#/definitions/MessageImageFileDetails", - "description": "The image file for this thread message content item.", - "x-ms-client-name": "imageFile" - } - }, - "required": [ - "image_file" - ], - "allOf": [ - { - "$ref": "#/definitions/MessageContent" - } - ], - "x-ms-discriminator-value": "image_file" - }, - "MessageImageFileDetails": { - "type": "object", - "description": "An image reference, as represented in thread message content.", - "properties": { - "file_id": { - "$ref": "#/definitions/MessageImageFileIdDetails", - "description": "The ID for the file associated with this image.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - }, - "MessageImageFileIdDetails": { - "type": "object", - "description": "An encapsulation of an image file ID, as used by message image content.", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the specific image file.", - "x-ms-client-name": "fileId" - } - }, - "required": [ - "file_id" - ] - }, - "MessageRole": { - "type": "string", - "description": "The possible values for roles attributed to messages in a thread.", - "enum": [ - "user", - "assistant" - ], - "x-ms-enum": { - "name": "MessageRole", - "modelAsString": true, - "values": [ - { - "name": "user", - "value": "user", - "description": "The role representing the end-user." - }, - { - "name": "assistant", - "value": "assistant", - "description": "The role representing the assistant." - } - ] - } - }, - "MessageTextAnnotation": { - "type": "object", - "description": "An abstract representation of an annotation to text thread message content.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - }, - "text": { - "type": "string", - "description": "The textual content associated with this text annotation item." - }, - "start_index": { - "type": "integer", - "format": "int32", - "description": "The first text index associated with this text annotation.", - "x-ms-client-name": "startIndex" - }, - "end_index": { - "type": "integer", - "format": "int32", - "description": "The last text index associated with this text annotation.", - "x-ms-client-name": "endIndex" - } - }, - "discriminator": "type", - "required": [ - "type", - "text", - "start_index", - "end_index" - ] - }, - "MessageTextContent": { - "type": "object", - "description": "A representation of a textual item of thread message content.", - "properties": { - "text": { - "$ref": "#/definitions/MessageTextDetails", - "description": "The text and associated annotations for this thread message content item." - } - }, - "required": [ - "text" - ], - "allOf": [ - { - "$ref": "#/definitions/MessageContent" - } - ], - "x-ms-discriminator-value": "text" - }, - "MessageTextDetails": { - "type": "object", - "description": "The text and associated annotations for a single item of assistant thread message content.", - "properties": { - "value": { - "type": "string", - "description": "The text data." - }, - "annotations": { - "type": "array", - "description": "A list of annotations associated with this text.", - "items": { - "$ref": "#/definitions/MessageTextAnnotation" - }, - "x-ms-identifiers": [] - } - }, - "required": [ - "value", - "annotations" - ] - }, - "MessageTextFileCitationDetails": { - "type": "object", - "description": "A representation of a file-based text citation, as used in a file-based annotation of text thread message content.", - "properties": { - "file_id": { - "type": "string", - "description": "The ID of the file associated with this citation.", - "x-ms-client-name": "fileId" - }, - "quote": { - "type": "string", - "description": "The specific quote cited in the associated file." - } - }, - "required": [ - "file_id", - "quote" - ] - }, - "OpenAIFile": { - "type": "object", - "description": "Represents an assistant that can call the model and use tools.", - "properties": { - "object": { - "type": "string", - "description": "The object type, which is always 'file'.", - "enum": [ - "file" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "bytes": { - "type": "integer", - "format": "int32", - "description": "The size of the file, in bytes." - }, - "filename": { - "type": "string", - "description": "The name of the file." - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "purpose": { - "$ref": "#/definitions/FilePurpose", - "description": "The intended purpose of a file." - } - }, - "required": [ - "object", - "id", - "bytes", - "filename", - "created_at", - "purpose" - ] - }, - "RequiredAction": { - "type": "object", - "description": "An abstract representation of a required action for an assistant thread run to continue.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "RetrievalToolCall": { - "type": "object", - "description": "A tool call to a retrieval tool, issued by the model in evaluation of a configured retrieval tool, that represents\nsubmitted output needed or already fulfilled by the tool for the model to continue.", - "properties": { - "retrieval": { - "type": "object", - "description": "The key/value pairs produced by the retrieval tool.", - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "retrieval" - ], - "allOf": [ - { - "$ref": "#/definitions/ToolCall" - } - ], - "x-ms-discriminator-value": "retrieval" - }, - "RetrievalToolDefinition": { - "type": "object", - "description": "The input definition information for a retrieval tool as used to configure an assistant.", - "allOf": [ - { - "$ref": "#/definitions/ToolDefinition" - } - ], - "x-ms-discriminator-value": "retrieval" - }, - "RunError": { - "type": "object", - "description": "The details of an error as encountered by an assistant thread run.", - "properties": { - "code": { - "type": "string", - "description": "The status for the error." - }, - "message": { - "type": "string", - "description": "The human-readable text associated with the error." - } - }, - "required": [ - "code", - "message" - ] - }, - "RunStatus": { - "type": "string", - "description": "Possible values for the status of an assistant thread run.", - "enum": [ - "queued", - "in_progress", - "requires_action", - "cancelling", - "cancelled", - "failed", - "completed", - "expired" - ], - "x-ms-enum": { - "name": "RunStatus", - "modelAsString": true, - "values": [ - { - "name": "queued", - "value": "queued", - "description": "Represents a run that is queued to start." - }, - { - "name": "inProgress", - "value": "in_progress", - "description": "Represents a run that is in progress." - }, - { - "name": "requiresAction", - "value": "requires_action", - "description": "Represents a run that needs another operation, such as tool output submission, to continue." - }, - { - "name": "cancelling", - "value": "cancelling", - "description": "Represents a run that is in the process of cancellation." - }, - { - "name": "cancelled", - "value": "cancelled", - "description": "Represents a run that has been cancelled." - }, - { - "name": "failed", - "value": "failed", - "description": "Represents a run that failed." - }, - { - "name": "completed", - "value": "completed", - "description": "Represents a run that successfully completed." - }, - { - "name": "expired", - "value": "expired", - "description": "Represents a run that expired before it could otherwise finish." - } - ] - } - }, - "RunStep": { - "type": "object", - "description": "Detailed information about a single step of an assistant thread run.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.run.step'.", - "enum": [ - "thread.run.step" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "type": { - "$ref": "#/definitions/RunStepType", - "description": "The type of run step, which can be either message_creation or tool_calls." - }, - "assistant_id": { - "type": "string", - "description": "The ID of the assistant associated with the run step.", - "x-ms-client-name": "assistantId" - }, - "thread_id": { - "type": "string", - "description": "The ID of the thread that was run.", - "x-ms-client-name": "threadId" - }, - "run_id": { - "type": "string", - "description": "The ID of the run that this run step is a part of.", - "x-ms-client-name": "runId" - }, - "status": { - "$ref": "#/definitions/RunStepStatus", - "description": "The status of this run step." - }, - "step_details": { - "$ref": "#/definitions/RunStepDetails", - "description": "The details for this run step.", - "x-ms-client-name": "stepDetails" - }, - "last_error": { - "type": "object", - "description": "If applicable, information about the last error encountered by this run step.", - "x-nullable": true, - "allOf": [ - { - "$ref": "#/definitions/RunStepError" - } - ], - "x-ms-client-name": "lastError" - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "expired_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this item expired.", - "x-nullable": true, - "x-ms-client-name": "expiredAt" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this completed.", - "x-nullable": true, - "x-ms-client-name": "completedAt" - }, - "cancelled_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this was cancelled.", - "x-nullable": true, - "x-ms-client-name": "cancelledAt" - }, - "failed_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this failed.", - "x-nullable": true, - "x-ms-client-name": "failedAt" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "id", - "object", - "type", - "assistant_id", - "thread_id", - "run_id", - "status", - "step_details", - "last_error", - "created_at", - "expired_at", - "completed_at", - "cancelled_at", - "failed_at", - "metadata" - ] - }, - "RunStepDetails": { - "type": "object", - "description": "An abstract representation of the details for a run step.", - "properties": { - "type": { - "$ref": "#/definitions/RunStepType", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "RunStepError": { - "type": "object", - "description": "The error information associated with a failed run step.", - "properties": { - "code": { - "$ref": "#/definitions/RunStepErrorCode", - "description": "The error code for this error." - }, - "message": { - "type": "string", - "description": "The human-readable text associated with this error." - } - }, - "required": [ - "code", - "message" - ] - }, - "RunStepErrorCode": { - "type": "string", - "description": "Possible error code values attributable to a failed run step.", - "enum": [ - "server_error", - "rate_limit_exceeded" - ], - "x-ms-enum": { - "name": "RunStepErrorCode", - "modelAsString": true, - "values": [ - { - "name": "serverError", - "value": "server_error", - "description": "Represents a server error." - }, - { - "name": "rateLimitExceeded", - "value": "rate_limit_exceeded", - "description": "Represents an error indicating configured rate limits were exceeded." - } - ] - } - }, - "RunStepMessageCreationDetails": { - "type": "object", - "description": "The detailed information associated with a message creation run step.", - "properties": { - "message_creation": { - "$ref": "#/definitions/RunStepMessageCreationReference", - "description": "Information about the message creation associated with this run step.", - "x-ms-client-name": "messageCreation" - } - }, - "required": [ - "message_creation" - ], - "allOf": [ - { - "$ref": "#/definitions/RunStepDetails" - } - ], - "x-ms-discriminator-value": "message_creation" - }, - "RunStepMessageCreationReference": { - "type": "object", - "description": "The details of a message created as a part of a run step.", - "properties": { - "message_id": { - "type": "string", - "description": "The ID of the message created by this run step.", - "x-ms-client-name": "messageId" - } - }, - "required": [ - "message_id" - ] - }, - "RunStepStatus": { - "type": "string", - "description": "Possible values for the status of a run step.", - "enum": [ - "in_progress", - "cancelled", - "failed", - "completed", - "expired" - ], - "x-ms-enum": { - "name": "RunStepStatus", - "modelAsString": true, - "values": [ - { - "name": "inProgress", - "value": "in_progress", - "description": "Represents a run step still in progress." - }, - { - "name": "cancelled", - "value": "cancelled", - "description": "Represents a run step that was cancelled." - }, - { - "name": "failed", - "value": "failed", - "description": "Represents a run step that failed." - }, - { - "name": "completed", - "value": "completed", - "description": "Represents a run step that successfully completed." - }, - { - "name": "expired", - "value": "expired", - "description": "Represents a run step that expired before otherwise finishing." - } - ] - } - }, - "RunStepToolCallDetails": { - "type": "object", - "description": "The detailed information associated with a run step calling tools.", - "properties": { - "tool_calls": { - "type": "array", - "description": "A list tool call details for this run step.", - "items": { - "$ref": "#/definitions/ToolCall" - }, - "x-ms-client-name": "toolCalls" - } - }, - "required": [ - "tool_calls" - ], - "allOf": [ - { - "$ref": "#/definitions/RunStepDetails" - } - ], - "x-ms-discriminator-value": "tool_calls" - }, - "RunStepType": { - "type": "string", - "description": "The possible types of run steps.", - "enum": [ - "message_creation", - "tool_calls" - ], - "x-ms-enum": { - "name": "RunStepType", - "modelAsString": true, - "values": [ - { - "name": "messageCreation", - "value": "message_creation", - "description": "Represents a run step to create a message." - }, - { - "name": "toolCalls", - "value": "tool_calls", - "description": "Represents a run step that calls tools." - } - ] - } - }, - "SubmitToolOutputsAction": { - "type": "object", - "description": "The details for required tool calls that must be submitted for an assistant thread run to continue.", - "properties": { - "submit_tool_outputs": { - "$ref": "#/definitions/SubmitToolOutputsDetails", - "description": "The details describing tools that should be called to submit tool outputs.", - "x-ms-client-name": "submitToolOutputs" - } - }, - "required": [ - "submit_tool_outputs" - ], - "allOf": [ - { - "$ref": "#/definitions/RequiredAction" - } - ], - "x-ms-discriminator-value": "submit_tool_outputs" - }, - "SubmitToolOutputsDetails": { - "type": "object", - "description": "The details describing tools that should be called to submit tool outputs.", - "properties": { - "tool_calls": { - "type": "array", - "description": "The list of tool calls that must be resolved for the assistant thread run to continue.", - "items": { - "$ref": "#/definitions/ToolCall" - }, - "x-ms-client-name": "toolCalls" - } - }, - "required": [ - "tool_calls" - ] - }, - "ThreadDeletionStatus": { - "type": "object", - "description": "The status of a thread deletion operation.", - "properties": { - "id": { - "type": "string", - "description": "The ID of the resource specified for deletion." - }, - "deleted": { - "type": "boolean", - "description": "A value indicating whether deletion was successful." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.deleted'.", - "enum": [ - "thread.deleted" - ], - "x-ms-enum": { - "modelAsString": false - } - } - }, - "required": [ - "id", - "deleted", - "object" - ] - }, - "ThreadMessage": { - "type": "object", - "description": "A single message within an assistant thread.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.message'.", - "enum": [ - "thread.message" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "thread_id": { - "type": "string", - "description": "The ID of the thread that this message belongs to.", - "x-ms-client-name": "threadId" - }, - "role": { - "$ref": "#/definitions/MessageRole", - "description": "The role associated with the assistant thread message." - }, - "content": { - "type": "array", - "description": "The list of content items associated with the assistant thread message.", - "items": { - "$ref": "#/definitions/MessageContent" - }, - "x-ms-identifiers": [] - }, - "assistant_id": { - "type": "string", - "description": "If applicable, the ID of the assistant that authored this message.", - "x-ms-client-name": "assistantId" - }, - "run_id": { - "type": "string", - "description": "If applicable, the ID of the run associated with the authoring of this message.", - "x-ms-client-name": "runId" - }, - "file_ids": { - "type": "array", - "description": "A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can\naccess files.", - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "id", - "object", - "created_at", - "thread_id", - "role", - "content", - "file_ids", - "metadata" - ] - }, - "ThreadRun": { - "type": "object", - "description": "Data representing a single evaluation run of an assistant thread.", - "properties": { - "id": { - "type": "string", - "description": "The identifier, which can be referenced in API endpoints." - }, - "object": { - "type": "string", - "description": "The object type, which is always 'thread.run'.", - "enum": [ - "thread.run" - ], - "x-ms-enum": { - "modelAsString": false - } - }, - "thread_id": { - "type": "string", - "description": "The ID of the thread associated with this run.", - "x-ms-client-name": "threadId" - }, - "assistant_id": { - "type": "string", - "description": "The ID of the assistant associated with the thread this run was performed against.", - "x-ms-client-name": "assistantId" - }, - "status": { - "$ref": "#/definitions/RunStatus", - "description": "The status of the assistant thread run." - }, - "required_action": { - "type": "object", - "description": "The details of the action required for the assistant thread run to continue.", - "x-nullable": true, - "allOf": [ - { - "$ref": "#/definitions/RequiredAction" - } - ], - "x-ms-client-name": "requiredAction" - }, - "last_error": { - "type": "object", - "description": "The last error, if any, encountered by this assistant thread run.", - "x-nullable": true, - "allOf": [ - { - "$ref": "#/definitions/RunError" - } - ], - "x-ms-client-name": "lastError" - }, - "model": { - "type": "string", - "description": "The ID of the model to use." - }, - "instructions": { - "type": "string", - "description": "The overridden system instructions used for this assistant thread run." - }, - "tools": { - "type": "array", - "description": "The overridden enabled tools used for this assistant thread run.", - "default": [], - "items": { - "$ref": "#/definitions/ToolDefinition" - }, - "x-ms-identifiers": [] - }, - "file_ids": { - "type": "array", - "description": "A list of attached file IDs, ordered by creation date in ascending order.", - "default": [], - "items": { - "type": "string" - }, - "x-ms-client-name": "fileIds" - }, - "created_at": { - "type": "integer", - "format": "unixtime", - "description": "The Unix timestamp, in seconds, representing when this object was created.", - "x-ms-client-name": "createdAt" - }, - "expires_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this item expires.", - "x-nullable": true, - "x-ms-client-name": "expiresAt" - }, - "started_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this item was started.", - "x-nullable": true, - "x-ms-client-name": "startedAt" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this completed.", - "x-nullable": true, - "x-ms-client-name": "completedAt" - }, - "cancelled_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this was cancelled.", - "x-nullable": true, - "x-ms-client-name": "cancelledAt" - }, - "failed_at": { - "type": "string", - "format": "date-time", - "description": "The Unix timestamp, in seconds, representing when this failed.", - "x-nullable": true, - "x-ms-client-name": "failedAt" - }, - "metadata": { - "type": "object", - "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", - "x-nullable": true, - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "id", - "object", - "thread_id", - "assistant_id", - "status", - "last_error", - "model", - "instructions", - "tools", - "file_ids", - "created_at", - "expires_at", - "started_at", - "completed_at", - "cancelled_at", - "failed_at", - "metadata" - ] - }, - "ToolCall": { - "type": "object", - "description": "An abstract representation a tool call, issued by the model in evaluation of a configured tool definition, that must\nbe fulfilled and have its outputs submitted before the model can continue.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - }, - "id": { - "type": "string", - "description": "The ID of the tool call. This ID must be referenced when you submit tool outputs." - } - }, - "discriminator": "type", - "required": [ - "type", - "id" - ] - }, - "ToolDefinition": { - "type": "object", - "description": "An abstract representation of an input tool definition that an assistant can use.", - "properties": { - "type": { - "type": "string", - "description": "The object type." - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "ToolOutput": { - "type": "object", - "description": "The data provided during a tool outputs submission to resolve pending tool calls and allow the model to continue.", - "properties": { - "tool_call_id": { - "type": "string", - "description": "The ID of the tool call being resolved, as provided in the tool calls of a required action from a run.", - "x-ms-client-name": "toolCallId" - }, - "output": { - "type": "string", - "description": "The output from the tool to be submitted." - } - } - } - }, - "parameters": {} -} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/examples/create_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/examples/create_assistant.json deleted file mode 100644 index 24f1208ac3df..000000000000 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/examples/create_assistant.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "title": "Assistants_CreateAssistant", - "operationId": "Assistants_CreateAssistant" -} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2023-02-15-preview/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2023-02-15-preview/assistants_generated.yaml deleted file mode 100644 index 8a83ec762134..000000000000 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2023-02-15-preview/assistants_generated.yaml +++ /dev/null @@ -1,2388 +0,0 @@ -openapi: 3.0.0 -info: - title: Azure OpenAI - version: 2023-02-15-preview - description: Azure OpenAI APIs for Assistants. -tags: [] -paths: - /assistants: - post: - operationId: createAssistant - description: Creates a new assistant. - parameters: [] - responses: - '200': - description: The new assistant instance. - content: - application/json: - schema: - $ref: '#/components/schemas/Assistant' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantCreationOptions' - get: - operationId: listAssistants - description: Gets a list of assistants that were previously created. - parameters: - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - - name: before - in: query - required: false - description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - responses: - '200': - description: The requested list of assistants. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/Assistant' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /assistants/{assistantId}: - get: - operationId: getAssistant - description: Retrieves an existing assistant. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to retrieve. - schema: - type: string - responses: - '200': - description: The requested assistant instance. - content: - application/json: - schema: - $ref: '#/components/schemas/Assistant' - post: - operationId: modifyAssistant - description: Modifies an existing assistant. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to modify. - schema: - type: string - responses: - '200': - description: The updated assistant instance. - content: - application/json: - schema: - $ref: '#/components/schemas/Assistant' - requestBody: - description: The details of the modification to perform on the specified assistant. - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantModificationOptions' - delete: - operationId: deleteAssistant - description: Deletes an assistant. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to delete. - schema: - type: string - responses: - '200': - description: Status information about the requested deletion operation. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantDeletionStatus' - /assistants/{assistantId}/files: - post: - operationId: createAssistantFile - description: Attaches a previously uploaded file to an assistant for use by tools that can read files. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to attach the file to. - schema: - type: string - responses: - '200': - description: Information about the attached file. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantFile' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - file_id: - type: string - description: The ID of the previously uploaded file to attach. - required: - - file_id - get: - operationId: listAssistantFiles - description: Gets a list of files attached to a specific assistant, as used by tools that can read files. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to retrieve the list of attached files for. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - - name: before - in: query - required: false - description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - responses: - '200': - description: The requested list of files attached to the specified assistant. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/AssistantFile' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /assistants/{assistantId}/files/{fileId}: - get: - operationId: getAssistantFile - description: Retrieves a file attached to an assistant. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant associated with the attached file. - schema: - type: string - - name: fileId - in: path - required: true - description: The ID of the file to retrieve. - schema: - type: string - responses: - '200': - description: A representation of the attached file. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantFile' - delete: - operationId: deleteAssistantFile - description: |- - Unlinks a previously attached file from an assistant, rendering it unavailable for use by tools that can read - files. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant from which the specified file should be unlinked. - schema: - type: string - - name: fileId - in: path - required: true - description: The ID of the file to unlink from the specified assistant. - schema: - type: string - responses: - '200': - description: Status information about the requested file association deletion. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantFileDeletionStatus' - /files: - get: - operationId: listFiles - description: Gets a list of previously uploaded files. - parameters: - - name: purpose - in: query - required: false - description: A value that, when provided, limits list results to files matching the corresponding purpose. - schema: - $ref: '#/components/schemas/FilePurpose' - responses: - '200': - description: The requested list of files. - content: - application/json: - schema: - $ref: '#/components/schemas/FileListResponse' - post: - operationId: createFile - description: Uploads a file for use by other operations. - parameters: [] - responses: - '200': - description: A representation of the uploaded file. - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAIFile' - requestBody: - required: true - content: - multipart/form-data: - schema: - type: object - properties: - file: - type: string - format: binary - purpose: - allOf: - - $ref: '#/components/schemas/FilePurpose' - description: The intended purpose of the file. - filename: - type: string - description: A filename to associate with the uploaded data. - required: - - file - - purpose - /files/{fileId}/{file_id}: - delete: - operationId: deleteFile - description: Delete a previously uploaded file. - parameters: - - name: fileId - in: path - required: true - description: The ID of the file to delete. - schema: - type: string - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - $ref: '#/components/schemas/FileDeletionStatus' - get: - operationId: retrieveFile - description: Returns information about a specific file. Does not retrieve file content. - parameters: - - name: fileId - in: path - required: true - description: The ID of the file to retrieve. - schema: - type: string - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAIFile' - /threads: - post: - operationId: createThread - description: Creates a new thread. Threads contain messages and can be run by assistants. - parameters: [] - responses: - '200': - description: Information about the newly created thread. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantThread' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantThreadCreationOptions' - /threads/runs: - post: - operationId: createThreadAndRun - description: Creates a new assistant thread and immediately starts a run using that new thread. - parameters: [] - responses: - '200': - description: Information about the newly created thread. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/CreateAndRunThreadOptions' - /threads/{threadId}: - get: - operationId: getThread - description: Gets information about an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to retrieve information about. - schema: - type: string - responses: - '200': - description: Information about the requested thread. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantThread' - post: - operationId: modifyThread - description: Modifies an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to modify. - schema: - type: string - responses: - '200': - description: Information about the modified thread. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantThread' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - delete: - operationId: deleteThread - description: Deletes an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to delete. - schema: - type: string - responses: - '200': - description: Status information about the requested thread deletion operation. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadDeletionStatus' - /threads/{threadId}/messages: - post: - operationId: createMessage - description: Creates a new message on a specified thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to create the new message on. - schema: - type: string - responses: - '200': - description: A representation of the new message. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadMessage' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - role: - allOf: - - $ref: '#/components/schemas/MessageRole' - description: The role to associate with the new message. - content: - type: string - description: The textual content for the new message. - file_ids: - type: array - items: - type: string - description: A list of up to 10 file IDs to associate with the message, as used by tools like 'code_interpreter' or 'retrieval' that can read files. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - required: - - role - - content - get: - operationId: listMessages - description: Gets a list of messages that exist on a thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to list messages from. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - - name: before - in: query - required: false - description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - responses: - '200': - description: The requested list of messages. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/ThreadMessage' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /threads/{threadId}/messages/{messageId}: - get: - operationId: getMessage - description: Gets an existing message from an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to retrieve the specified message from. - schema: - type: string - - name: messageId - in: path - required: true - description: The ID of the message to retrieve from the specified thread. - schema: - type: string - responses: - '200': - description: A representation of the requested message. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadMessage' - post: - operationId: modifyMessage - description: Modifies an existing message on an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread containing the specified message to modify. - schema: - type: string - - name: messageId - in: path - required: true - description: The ID of the message to modify on the specified thread. - schema: - type: string - responses: - '200': - description: A representation of the modified message. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadMessage' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - /threads/{threadId}/messages/{messageId}/files: - get: - operationId: listMessageFiles - description: Gets a list of previously uploaded files associated with a message from a thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread containing the message to list files from. - schema: - type: string - - name: messageId - in: path - required: true - description: The ID of the message to list files from. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - - name: before - in: query - required: false - description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - responses: - '200': - description: The requested list of files associated with the specified message. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/MessageFile' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /threads/{threadId}/messages/{messageId}/files/{fileId}: - get: - operationId: getMessageFile - description: Gets information about a file attachment to a message within a thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread containing the message to get information from. - schema: - type: string - - name: messageId - in: path - required: true - description: The ID of the message to get information from. - schema: - type: string - - name: fileId - in: path - required: true - description: The ID of the file to get information about. - schema: - type: string - responses: - '200': - description: The requested file information. - content: - application/json: - schema: - $ref: '#/components/schemas/MessageFile' - /threads/{threadId}/runs: - post: - operationId: createRun - description: Creates a new run for an assistant thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to run. - schema: - type: string - responses: - '200': - description: Information about the new thread run. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - assistant_id: - type: string - description: The ID of the assistant that should run the thread. - model: - type: string - description: The overridden model name that the assistant should use to run the thread. - instructions: - type: string - description: The overridden system instructions that the assistant should use to run the thread. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The overridden list of enabled tools that the assistant should use to run the thread. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - required: - - assistant_id - get: - operationId: listRuns - description: Gets a list of runs for a specified thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to list runs from. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - - name: before - in: query - required: false - description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - responses: - '200': - description: The requested list of thread runs. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/ThreadRun' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /threads/{threadId}/runs/{runId}: - get: - operationId: getRun - description: Gets an existing run from an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to retrieve run information from. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the thread to retrieve information about. - schema: - type: string - responses: - '200': - description: The requested information about the specified thread run. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - post: - operationId: modifyRun - description: Modifies an existing thread run. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread associated with the specified run. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the run to modify. - schema: - type: string - responses: - '200': - description: Information about the modified run. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - /threads/{threadId}/runs/{runId}/cancel: - post: - operationId: cancelRun - description: Cancels a run of an in progress thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread being run. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the run to cancel. - schema: - type: string - responses: - '200': - description: Updated information about the cancelled run. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - /threads/{threadId}/runs/{runId}/steps: - get: - operationId: listRunSteps - description: Gets a list of run steps from a thread run. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread that was run. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the run to list steps from. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - - name: before - in: query - required: false - description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - responses: - '200': - description: The requested list of run steps. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/RunStep' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /threads/{threadId}/runs/{runId}/steps/{stepId}: - get: - operationId: getRunStep - description: Gets a single run step from a thread run. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread that was run. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the specific run to retrieve the step from. - schema: - type: string - - name: stepId - in: path - required: true - description: The ID of the step to retrieve information about. - schema: - type: string - responses: - '200': - description: Information about the requested run step. - content: - application/json: - schema: - $ref: '#/components/schemas/RunStep' - /threads/{threadId}/runs/{runId}/submit_tool_outputs: - post: - operationId: submitToolOutputsToRun - description: Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread that was run. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the run that requires tool outputs. - schema: - type: string - responses: - '200': - description: Updated information about the run. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - tool_outputs: - type: array - items: - $ref: '#/components/schemas/ToolOutput' - description: The list of tool outputs requested by tool calls from the specified run. - required: - - tool_outputs -security: - - ApiKeyAuth: [] - - OAuth2Auth: - - https://cognitiveservices.azure.com/.default -components: - schemas: - Assistant: - type: object - required: - - id - - object - - created_at - - name - - description - - model - - instructions - - tools - - file_ids - - metadata - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - assistant - description: The object type, which is always assistant. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - name: - type: string - nullable: true - description: The name of the assistant. - description: - type: string - nullable: true - description: The description of the assistant. - model: - type: string - description: The ID of the model to use. - instructions: - type: string - nullable: true - description: The system instructions for the assistant to use. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The collection of tools enabled for the assistant. - default: [] - file_ids: - type: array - items: - type: string - description: A list of attached file IDs, ordered by creation date in ascending order. - default: [] - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: Represents an assistant that can call the model and use tools. - AssistantCreationOptions: - type: object - required: - - model - properties: - model: - type: string - description: The ID of the model to use. - name: - type: string - nullable: true - description: The name of the new assistant. - description: - type: string - nullable: true - description: The description of the new assistant. - instructions: - type: string - nullable: true - description: The system instructions for the new assistant to use. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The collection of tools to enable for the new assistant. - default: [] - file_ids: - type: array - items: - type: string - description: A list of previously uploaded file IDs to attach to the assistant. - default: [] - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: The request details to use when creating a new assistant. - AssistantDeletionStatus: - type: object - required: - - id - - deleted - - object - properties: - id: - type: string - description: The ID of the resource specified for deletion. - deleted: - type: boolean - description: A value indicating whether deletion was successful. - object: - type: string - enum: - - assistant.deleted - description: The object type, which is always 'assistant.deleted'. - description: The status of an assistant deletion operation. - AssistantFile: - type: object - required: - - id - - object - - created_at - - assistant_id - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - assistant.file - description: The object type, which is always 'assistant.file'. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - assistant_id: - type: string - description: The assistant ID that the file is attached to. - description: Information about a file attached to an assistant, as used by tools that can read files. - AssistantFileDeletionStatus: - type: object - required: - - id - - deleted - - object - properties: - id: - type: string - description: The ID of the resource specified for deletion. - deleted: - type: boolean - description: A value indicating whether deletion was successful. - object: - type: string - enum: - - assistant.file.deleted - description: The object type, which is always 'assistant.file.deleted'. - description: The status of an assistant file deletion operation. - AssistantModificationOptions: - type: object - properties: - model: - type: string - description: The ID of the model to use. - name: - type: string - nullable: true - description: The modified name for the assistant to use. - description: - type: string - nullable: true - description: The modified description for the assistant to use. - instructions: - type: string - nullable: true - description: The modified system instructions for the new assistant to use. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The modified collection of tools to enable for the assistant. - default: [] - file_ids: - type: array - items: - type: string - description: The modified list of previously uploaded fileIDs to attach to the assistant. - default: [] - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: The request details to use when modifying an existing assistant. - AssistantThread: - type: object - required: - - id - - object - - created_at - - metadata - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread - description: The object type, which is always 'thread'. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: Information about a single thread associated with an assistant. - AssistantThreadCreationOptions: - type: object - properties: - messages: - type: array - items: - $ref: '#/components/schemas/ThreadMessage' - description: The messages to associate with the new thread. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: The details used to create a new assistant thread. - CodeInterpreterImageOutput: - type: object - required: - - type - - image - properties: - type: - type: string - enum: - - image - description: The object type, which is always 'image'. - image: - allOf: - - $ref: '#/components/schemas/CodeInterpreterImageReference' - description: Referential information for the image associated with this output. - allOf: - - $ref: '#/components/schemas/CodeInterpreterToolCallOutput' - description: A representation of an image output emitted by a code interpreter tool in response to a tool call by the model. - CodeInterpreterImageReference: - type: object - required: - - file_id - properties: - file_id: - type: string - description: The ID of the file associated with this image. - description: An image reference emitted by a code interpreter tool in response to a tool call by the model. - CodeInterpreterLogOutput: - type: object - required: - - type - - logs - properties: - type: - type: string - enum: - - logs - description: The object type, which is always 'logs'. - logs: - type: string - description: The serialized log output emitted by the code interpreter. - allOf: - - $ref: '#/components/schemas/CodeInterpreterToolCallOutput' - description: A representation of a log output emitted by a code interpreter tool in response to a tool call by the model. - CodeInterpreterToolCall: - type: object - required: - - type - - code_interpreter - properties: - type: - type: string - enum: - - code_interpreter - description: The object type, which is always 'code_interpreter'. - code_interpreter: - allOf: - - $ref: '#/components/schemas/CodeInterpreterToolCallDetails' - description: The details of the tool call to the code interpreter tool. - allOf: - - $ref: '#/components/schemas/ToolCall' - description: |- - A tool call to a code interpreter tool, issued by the model in evaluation of a configured code interpreter tool, that - represents submitted output needed or already fulfilled by the tool for the model to continue. - CodeInterpreterToolCallDetails: - type: object - required: - - input - - outputs - properties: - input: - type: string - description: The input provided by the model to the code interpreter tool. - outputs: - type: array - items: - $ref: '#/components/schemas/CodeInterpreterToolCallOutput' - description: The outputs produced by the code interpreter tool back to the model in response to the tool call. - description: The detailed information about a code interpreter invocation by the model. - CodeInterpreterToolCallOutput: - type: object - required: - - type - properties: - type: - type: string - description: The object type. - discriminator: - propertyName: type - mapping: - logs: '#/components/schemas/CodeInterpreterLogOutput' - image: '#/components/schemas/CodeInterpreterImageOutput' - description: An abstract representation of an emitted output from a code interpreter tool. - CodeInterpreterToolDefinition: - type: object - required: - - type - properties: - type: - type: string - enum: - - code_interpreter - description: The object type, which is always 'code_interpreter'. - allOf: - - $ref: '#/components/schemas/ToolDefinition' - description: The input definition information for a code interpreter tool as used to configure an assistant. - CreateAndRunThreadOptions: - type: object - required: - - assistant_id - properties: - assistant_id: - type: string - description: The ID of the assistant for which the thread should be created. - thread: - allOf: - - $ref: '#/components/schemas/AssistantThreadCreationOptions' - description: The details used to create the new thread. - model: - type: string - description: The overridden model that the assistant should use to run the thread. - instructions: - type: string - description: The overridden system instructions the assistant should use to run the thread. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The overridden list of enabled tools the assistant should use to run the thread. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: The details used when creating and immediately running a new assistant thread. - FileDeletionStatus: - type: object - required: - - id - - deleted - - object - properties: - id: - type: string - description: The ID of the resource specified for deletion. - deleted: - type: boolean - description: A value indicating whether deletion was successful. - object: - type: string - enum: - - file - description: The object type, which is always 'file'. - description: A status response from a file deletion operation. - FileListResponse: - type: object - required: - - object - - data - properties: - object: - type: string - enum: - - list - description: The object type, which is always 'list'. - data: - type: array - items: - $ref: '#/components/schemas/OpenAIFile' - description: The files returned for the request. - description: The response data from a file list operation. - FilePurpose: - type: string - enum: - - fine-tune - - fine-tune-results - - assistants - - assistants_output - description: The possible values denoting the intended usage of a file. - FunctionDefinition: - type: object - required: - - name - - parameters - properties: - name: - type: string - description: The name of the function to be called. - description: - type: string - description: A description of what the function does, used by the model to choose when and how to call the function. - parameters: - description: The parameters the functions accepts, described as a JSON Schema object. - description: The input definition information for a function. - FunctionToolCall: - type: object - required: - - type - - function - properties: - type: - type: string - enum: - - function - description: The object type, which is always 'function'. - function: - allOf: - - $ref: '#/components/schemas/FunctionToolCallDetails' - description: The detailed information about the function called by the model. - allOf: - - $ref: '#/components/schemas/ToolCall' - description: |- - A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents - given function inputs and submitted function outputs needed or already fulfilled by the tool for the model to continue. - FunctionToolCallDetails: - type: object - required: - - name - - arguments - - output - properties: - name: - type: string - description: The name of the function. - arguments: - type: string - description: The arguments that the model requires are provided to the named function. - output: - type: string - nullable: true - description: The output of the function, only populated for function calls that have already have had their outputs submitted. - description: The detailed information about the function called by the model. - FunctionToolDefinition: - type: object - required: - - type - - function - properties: - type: - type: string - enum: - - function - description: The object type, which is always 'function'. - function: - allOf: - - $ref: '#/components/schemas/FunctionDefinition' - description: The definition of the concrete function that the function tool should call. - allOf: - - $ref: '#/components/schemas/ToolDefinition' - description: The input definition information for a function tool as used to configure an assistant. - ListSortOrder: - type: string - enum: - - asc - - desc - description: The available sorting options when requesting a list of response objects. - MessageContent: - type: object - required: - - type - properties: - type: - type: string - description: The object type. - discriminator: - propertyName: type - mapping: - text: '#/components/schemas/MessageTextContent' - image_file: '#/components/schemas/MessageImageFileContent' - description: An abstract representation of a single item of thread message content. - MessageFile: - type: object - required: - - id - - object - - created_at - - message_id - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread.message.file - description: The object type, which is always 'thread.message.file'. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - message_id: - type: string - description: The ID of the message that this file is attached to. - description: Information about a file attached to an assistant thread message. - MessageFileCitationTextAnnotation: - type: object - required: - - type - - file_citation - properties: - type: - type: string - enum: - - file_citation - description: The object type, which is always 'file_citation'. - file_citation: - allOf: - - $ref: '#/components/schemas/MessageTextFileCitationDetails' - description: |- - A citation within the message that points to a specific quote from a specific file. - Generated when the assistant uses the "retrieval" tool to search files. - allOf: - - $ref: '#/components/schemas/MessageTextAnnotation' - description: A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the 'retrieval' tool to search files. - MessageFilePathDetails: - type: object - required: - - file_id - properties: - file_id: - type: string - description: The ID of the specific file that the citation is from. - description: An encapsulation of an image file ID, as used by message image content. - MessageFilePathTextAnnotation: - type: object - required: - - type - - file_path - properties: - type: - type: string - enum: - - file_path - description: The object type, which is always 'file_path'. - file_path: - allOf: - - $ref: '#/components/schemas/MessageFilePathDetails' - description: A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file. - allOf: - - $ref: '#/components/schemas/MessageTextAnnotation' - description: A citation within the message that points to a file located at a specific path. - MessageImageFileContent: - type: object - required: - - type - - image_file - properties: - type: - type: string - enum: - - image_file - description: The object type, which is always 'image_file'. - image_file: - allOf: - - $ref: '#/components/schemas/MessageImageFileDetails' - description: The image file for this thread message content item. - allOf: - - $ref: '#/components/schemas/MessageContent' - description: A representation of image file content in a thread message. - MessageImageFileDetails: - type: object - required: - - file_id - properties: - file_id: - allOf: - - $ref: '#/components/schemas/MessageImageFileIdDetails' - description: The ID for the file associated with this image. - description: An image reference, as represented in thread message content. - MessageImageFileIdDetails: - type: object - required: - - file_id - properties: - file_id: - type: string - description: The ID of the specific image file. - description: An encapsulation of an image file ID, as used by message image content. - MessageRole: - type: string - enum: - - user - - assistant - description: The possible values for roles attributed to messages in a thread. - MessageTextAnnotation: - type: object - required: - - type - - text - - start_index - - end_index - properties: - type: - type: string - description: The object type. - text: - type: string - description: The textual content associated with this text annotation item. - start_index: - type: integer - format: int32 - description: The first text index associated with this text annotation. - end_index: - type: integer - format: int32 - description: The last text index associated with this text annotation. - discriminator: - propertyName: type - mapping: - file_citation: '#/components/schemas/MessageFileCitationTextAnnotation' - file_path: '#/components/schemas/MessageFilePathTextAnnotation' - description: An abstract representation of an annotation to text thread message content. - MessageTextContent: - type: object - required: - - type - - text - properties: - type: - type: string - enum: - - text - description: The object type, which is always 'text'. - text: - allOf: - - $ref: '#/components/schemas/MessageTextDetails' - description: The text and associated annotations for this thread message content item. - allOf: - - $ref: '#/components/schemas/MessageContent' - description: A representation of a textual item of thread message content. - MessageTextDetails: - type: object - required: - - value - - annotations - properties: - value: - type: string - description: The text data. - annotations: - type: array - items: - $ref: '#/components/schemas/MessageTextAnnotation' - description: A list of annotations associated with this text. - description: The text and associated annotations for a single item of assistant thread message content. - MessageTextFileCitationDetails: - type: object - required: - - file_id - - quote - properties: - file_id: - type: string - description: The ID of the file associated with this citation. - quote: - type: string - description: The specific quote cited in the associated file. - description: A representation of a file-based text citation, as used in a file-based annotation of text thread message content. - OpenAIFile: - type: object - required: - - object - - id - - bytes - - filename - - created_at - - purpose - properties: - object: - type: string - enum: - - file - description: The object type, which is always 'file'. - id: - type: string - description: The identifier, which can be referenced in API endpoints. - bytes: - type: integer - format: int32 - description: The size of the file, in bytes. - filename: - type: string - description: The name of the file. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - purpose: - allOf: - - $ref: '#/components/schemas/FilePurpose' - description: The intended purpose of a file. - description: Represents an assistant that can call the model and use tools. - RequiredAction: - type: object - required: - - type - properties: - type: - type: string - description: The object type. - discriminator: - propertyName: type - mapping: - submit_tool_outputs: '#/components/schemas/SubmitToolOutputsAction' - description: An abstract representation of a required action for an assistant thread run to continue. - RetrievalToolCall: - type: object - required: - - type - - retrieval - properties: - type: - type: string - enum: - - retrieval - description: The object type, which is always 'retrieval'. - retrieval: - type: object - additionalProperties: - type: string - description: The key/value pairs produced by the retrieval tool. - allOf: - - $ref: '#/components/schemas/ToolCall' - description: |- - A tool call to a retrieval tool, issued by the model in evaluation of a configured retrieval tool, that represents - submitted output needed or already fulfilled by the tool for the model to continue. - RetrievalToolDefinition: - type: object - required: - - type - properties: - type: - type: string - enum: - - retrieval - description: The object type, which is always 'retrieval'. - allOf: - - $ref: '#/components/schemas/ToolDefinition' - description: The input definition information for a retrieval tool as used to configure an assistant. - RunError: - type: object - required: - - code - - message - properties: - code: - type: string - description: The status for the error. - message: - type: string - description: The human-readable text associated with the error. - description: The details of an error as encountered by an assistant thread run. - RunStatus: - type: string - enum: - - queued - - in_progress - - requires_action - - cancelling - - cancelled - - failed - - completed - - expired - description: Possible values for the status of an assistant thread run. - RunStep: - type: object - required: - - id - - object - - type - - assistant_id - - thread_id - - run_id - - status - - step_details - - last_error - - created_at - - expired_at - - completed_at - - cancelled_at - - failed_at - - metadata - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread.run.step - description: The object type, which is always 'thread.run.step'. - type: - allOf: - - $ref: '#/components/schemas/RunStepType' - description: The type of run step, which can be either message_creation or tool_calls. - assistant_id: - type: string - description: The ID of the assistant associated with the run step. - thread_id: - type: string - description: The ID of the thread that was run. - run_id: - type: string - description: The ID of the run that this run step is a part of. - status: - allOf: - - $ref: '#/components/schemas/RunStepStatus' - description: The status of this run step. - step_details: - allOf: - - $ref: '#/components/schemas/RunStepDetails' - description: The details for this run step. - last_error: - type: object - allOf: - - $ref: '#/components/schemas/RunStepError' - nullable: true - description: If applicable, information about the last error encountered by this run step. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - expired_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this item expired. - completed_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this completed. - cancelled_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this was cancelled. - failed_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this failed. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: Detailed information about a single step of an assistant thread run. - RunStepDetails: - type: object - required: - - type - properties: - type: - allOf: - - $ref: '#/components/schemas/RunStepType' - description: The object type. - discriminator: - propertyName: type - mapping: - message_creation: '#/components/schemas/RunStepMessageCreationDetails' - tool_calls: '#/components/schemas/RunStepToolCallDetails' - description: An abstract representation of the details for a run step. - RunStepError: - type: object - required: - - code - - message - properties: - code: - allOf: - - $ref: '#/components/schemas/RunStepErrorCode' - description: The error code for this error. - message: - type: string - description: The human-readable text associated with this error. - description: The error information associated with a failed run step. - RunStepErrorCode: - type: string - enum: - - server_error - - rate_limit_exceeded - description: Possible error code values attributable to a failed run step. - RunStepMessageCreationDetails: - type: object - required: - - type - - message_creation - properties: - type: - type: string - enum: - - message_creation - description: The object type, which is always 'message_creation'. - message_creation: - allOf: - - $ref: '#/components/schemas/RunStepMessageCreationReference' - description: Information about the message creation associated with this run step. - allOf: - - $ref: '#/components/schemas/RunStepDetails' - description: The detailed information associated with a message creation run step. - RunStepMessageCreationReference: - type: object - required: - - message_id - properties: - message_id: - type: string - description: The ID of the message created by this run step. - description: The details of a message created as a part of a run step. - RunStepStatus: - type: string - enum: - - in_progress - - cancelled - - failed - - completed - - expired - description: Possible values for the status of a run step. - RunStepToolCallDetails: - type: object - required: - - type - - tool_calls - properties: - type: - type: string - enum: - - tool_calls - description: The object type, which is always 'tool_calls'. - tool_calls: - type: array - items: - $ref: '#/components/schemas/ToolCall' - description: A list tool call details for this run step. - allOf: - - $ref: '#/components/schemas/RunStepDetails' - description: The detailed information associated with a run step calling tools. - RunStepType: - type: string - enum: - - message_creation - - tool_calls - description: The possible types of run steps. - ServiceApiVersions: - type: string - enum: - - 2023-02-15-preview - description: The known set of supported API versions. - SubmitToolOutputsAction: - type: object - required: - - type - - submit_tool_outputs - properties: - type: - type: string - enum: - - submit_tool_outputs - description: The object type, which is always 'submit_tool_outputs'. - submit_tool_outputs: - allOf: - - $ref: '#/components/schemas/SubmitToolOutputsDetails' - description: The details describing tools that should be called to submit tool outputs. - allOf: - - $ref: '#/components/schemas/RequiredAction' - description: The details for required tool calls that must be submitted for an assistant thread run to continue. - SubmitToolOutputsDetails: - type: object - required: - - tool_calls - properties: - tool_calls: - type: array - items: - $ref: '#/components/schemas/ToolCall' - description: The list of tool calls that must be resolved for the assistant thread run to continue. - description: The details describing tools that should be called to submit tool outputs. - ThreadDeletionStatus: - type: object - required: - - id - - deleted - - object - properties: - id: - type: string - description: The ID of the resource specified for deletion. - deleted: - type: boolean - description: A value indicating whether deletion was successful. - object: - type: string - enum: - - thread.deleted - description: The object type, which is always 'thread.deleted'. - description: The status of a thread deletion operation. - ThreadMessage: - type: object - required: - - id - - object - - created_at - - thread_id - - role - - content - - file_ids - - metadata - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread.message - description: The object type, which is always 'thread.message'. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - thread_id: - type: string - description: The ID of the thread that this message belongs to. - role: - allOf: - - $ref: '#/components/schemas/MessageRole' - description: The role associated with the assistant thread message. - content: - type: array - items: - $ref: '#/components/schemas/MessageContent' - description: The list of content items associated with the assistant thread message. - assistant_id: - type: string - description: If applicable, the ID of the assistant that authored this message. - run_id: - type: string - description: If applicable, the ID of the run associated with the authoring of this message. - file_ids: - type: array - items: - type: string - description: |- - A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can - access files. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: A single message within an assistant thread. - ThreadRun: - type: object - required: - - id - - object - - thread_id - - assistant_id - - status - - last_error - - model - - instructions - - tools - - file_ids - - created_at - - expires_at - - started_at - - completed_at - - cancelled_at - - failed_at - - metadata - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread.run - description: The object type, which is always 'thread.run'. - thread_id: - type: string - description: The ID of the thread associated with this run. - assistant_id: - type: string - description: The ID of the assistant associated with the thread this run was performed against. - status: - allOf: - - $ref: '#/components/schemas/RunStatus' - description: The status of the assistant thread run. - required_action: - type: object - allOf: - - $ref: '#/components/schemas/RequiredAction' - nullable: true - description: The details of the action required for the assistant thread run to continue. - last_error: - type: object - allOf: - - $ref: '#/components/schemas/RunError' - nullable: true - description: The last error, if any, encountered by this assistant thread run. - model: - type: string - description: The ID of the model to use. - instructions: - type: string - description: The overridden system instructions used for this assistant thread run. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The overridden enabled tools used for this assistant thread run. - default: [] - file_ids: - type: array - items: - type: string - description: A list of attached file IDs, ordered by creation date in ascending order. - default: [] - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - expires_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this item expires. - started_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this item was started. - completed_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this completed. - cancelled_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this was cancelled. - failed_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this failed. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: Data representing a single evaluation run of an assistant thread. - ToolCall: - type: object - required: - - type - - id - properties: - type: - type: string - description: The object type. - id: - type: string - description: The ID of the tool call. This ID must be referenced when you submit tool outputs. - discriminator: - propertyName: type - mapping: - code_interpreter: '#/components/schemas/CodeInterpreterToolCall' - retrieval: '#/components/schemas/RetrievalToolCall' - function: '#/components/schemas/FunctionToolCall' - description: |- - An abstract representation a tool call, issued by the model in evaluation of a configured tool definition, that must - be fulfilled and have its outputs submitted before the model can continue. - ToolDefinition: - type: object - required: - - type - properties: - type: - type: string - description: The object type. - discriminator: - propertyName: type - mapping: - code_interpreter: '#/components/schemas/CodeInterpreterToolDefinition' - retrieval: '#/components/schemas/RetrievalToolDefinition' - function: '#/components/schemas/FunctionToolDefinition' - description: An abstract representation of an input tool definition that an assistant can use. - ToolOutput: - type: object - properties: - tool_call_id: - type: string - description: The ID of the tool call being resolved, as provided in the tool calls of a required action from a run. - output: - type: string - description: The output from the tool to be submitted. - description: The data provided during a tool outputs submission to resolve pending tool calls and allow the model to continue. - securitySchemes: - ApiKeyAuth: - type: apiKey - in: header - name: api-key - OAuth2Auth: - type: oauth2 - flows: - implicit: - authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize - scopes: - https://cognitiveservices.azure.com/.default: '' -servers: - - url: '{endpoint}' - description: Azure OpenAI APIs for Assistants. - variables: - endpoint: - default: '' - description: An OpenAI endpoint supporting assistants functionality. diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2023-11-06-beta/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2023-11-06-beta/assistants_generated.yaml deleted file mode 100644 index ee485d79df7c..000000000000 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2023-11-06-beta/assistants_generated.yaml +++ /dev/null @@ -1,2388 +0,0 @@ -openapi: 3.0.0 -info: - title: Azure OpenAI - version: 2023-11-06-beta - description: Azure OpenAI APIs for Assistants. -tags: [] -paths: - /assistants: - post: - operationId: createAssistant - description: Creates a new assistant. - parameters: [] - responses: - '200': - description: The new assistant instance. - content: - application/json: - schema: - $ref: '#/components/schemas/Assistant' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantCreationOptions' - get: - operationId: listAssistants - description: Gets a list of assistants that were previously created. - parameters: - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - - name: before - in: query - required: false - description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - responses: - '200': - description: The requested list of assistants. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/Assistant' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /assistants/{assistantId}: - get: - operationId: getAssistant - description: Retrieves an existing assistant. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to retrieve. - schema: - type: string - responses: - '200': - description: The requested assistant instance. - content: - application/json: - schema: - $ref: '#/components/schemas/Assistant' - post: - operationId: modifyAssistant - description: Modifies an existing assistant. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to modify. - schema: - type: string - responses: - '200': - description: The updated assistant instance. - content: - application/json: - schema: - $ref: '#/components/schemas/Assistant' - requestBody: - description: The details of the modification to perform on the specified assistant. - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantModificationOptions' - delete: - operationId: deleteAssistant - description: Deletes an assistant. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to delete. - schema: - type: string - responses: - '200': - description: Status information about the requested deletion operation. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantDeletionStatus' - /assistants/{assistantId}/files: - post: - operationId: createAssistantFile - description: Attaches a previously uploaded file to an assistant for use by tools that can read files. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to attach the file to. - schema: - type: string - responses: - '200': - description: Information about the attached file. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantFile' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - file_id: - type: string - description: The ID of the previously uploaded file to attach. - required: - - file_id - get: - operationId: listAssistantFiles - description: Gets a list of files attached to a specific assistant, as used by tools that can read files. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant to retrieve the list of attached files for. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - - name: before - in: query - required: false - description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - responses: - '200': - description: The requested list of files attached to the specified assistant. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/AssistantFile' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /assistants/{assistantId}/files/{fileId}: - get: - operationId: getAssistantFile - description: Retrieves a file attached to an assistant. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant associated with the attached file. - schema: - type: string - - name: fileId - in: path - required: true - description: The ID of the file to retrieve. - schema: - type: string - responses: - '200': - description: A representation of the attached file. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantFile' - delete: - operationId: deleteAssistantFile - description: |- - Unlinks a previously attached file from an assistant, rendering it unavailable for use by tools that can read - files. - parameters: - - name: assistantId - in: path - required: true - description: The ID of the assistant from which the specified file should be unlinked. - schema: - type: string - - name: fileId - in: path - required: true - description: The ID of the file to unlink from the specified assistant. - schema: - type: string - responses: - '200': - description: Status information about the requested file association deletion. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantFileDeletionStatus' - /files: - get: - operationId: listFiles - description: Gets a list of previously uploaded files. - parameters: - - name: purpose - in: query - required: false - description: A value that, when provided, limits list results to files matching the corresponding purpose. - schema: - $ref: '#/components/schemas/FilePurpose' - responses: - '200': - description: The requested list of files. - content: - application/json: - schema: - $ref: '#/components/schemas/FileListResponse' - post: - operationId: createFile - description: Uploads a file for use by other operations. - parameters: [] - responses: - '200': - description: A representation of the uploaded file. - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAIFile' - requestBody: - required: true - content: - multipart/form-data: - schema: - type: object - properties: - file: - type: string - format: binary - purpose: - allOf: - - $ref: '#/components/schemas/FilePurpose' - description: The intended purpose of the file. - filename: - type: string - description: A filename to associate with the uploaded data. - required: - - file - - purpose - /files/{fileId}/{file_id}: - delete: - operationId: deleteFile - description: Delete a previously uploaded file. - parameters: - - name: fileId - in: path - required: true - description: The ID of the file to delete. - schema: - type: string - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - $ref: '#/components/schemas/FileDeletionStatus' - get: - operationId: retrieveFile - description: Returns information about a specific file. Does not retrieve file content. - parameters: - - name: fileId - in: path - required: true - description: The ID of the file to retrieve. - schema: - type: string - responses: - '200': - description: The request has succeeded. - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAIFile' - /threads: - post: - operationId: createThread - description: Creates a new thread. Threads contain messages and can be run by assistants. - parameters: [] - responses: - '200': - description: Information about the newly created thread. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantThread' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantThreadCreationOptions' - /threads/runs: - post: - operationId: createThreadAndRun - description: Creates a new assistant thread and immediately starts a run using that new thread. - parameters: [] - responses: - '200': - description: Information about the newly created thread. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/CreateAndRunThreadOptions' - /threads/{threadId}: - get: - operationId: getThread - description: Gets information about an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to retrieve information about. - schema: - type: string - responses: - '200': - description: Information about the requested thread. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantThread' - post: - operationId: modifyThread - description: Modifies an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to modify. - schema: - type: string - responses: - '200': - description: Information about the modified thread. - content: - application/json: - schema: - $ref: '#/components/schemas/AssistantThread' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - delete: - operationId: deleteThread - description: Deletes an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to delete. - schema: - type: string - responses: - '200': - description: Status information about the requested thread deletion operation. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadDeletionStatus' - /threads/{threadId}/messages: - post: - operationId: createMessage - description: Creates a new message on a specified thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to create the new message on. - schema: - type: string - responses: - '200': - description: A representation of the new message. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadMessage' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - role: - allOf: - - $ref: '#/components/schemas/MessageRole' - description: The role to associate with the new message. - content: - type: string - description: The textual content for the new message. - file_ids: - type: array - items: - type: string - description: A list of up to 10 file IDs to associate with the message, as used by tools like 'code_interpreter' or 'retrieval' that can read files. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - required: - - role - - content - get: - operationId: listMessages - description: Gets a list of messages that exist on a thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to list messages from. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - - name: before - in: query - required: false - description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - responses: - '200': - description: The requested list of messages. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/ThreadMessage' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /threads/{threadId}/messages/{messageId}: - get: - operationId: getMessage - description: Gets an existing message from an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to retrieve the specified message from. - schema: - type: string - - name: messageId - in: path - required: true - description: The ID of the message to retrieve from the specified thread. - schema: - type: string - responses: - '200': - description: A representation of the requested message. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadMessage' - post: - operationId: modifyMessage - description: Modifies an existing message on an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread containing the specified message to modify. - schema: - type: string - - name: messageId - in: path - required: true - description: The ID of the message to modify on the specified thread. - schema: - type: string - responses: - '200': - description: A representation of the modified message. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadMessage' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - /threads/{threadId}/messages/{messageId}/files: - get: - operationId: listMessageFiles - description: Gets a list of previously uploaded files associated with a message from a thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread containing the message to list files from. - schema: - type: string - - name: messageId - in: path - required: true - description: The ID of the message to list files from. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - - name: before - in: query - required: false - description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - responses: - '200': - description: The requested list of files associated with the specified message. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/MessageFile' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /threads/{threadId}/messages/{messageId}/files/{fileId}: - get: - operationId: getMessageFile - description: Gets information about a file attachment to a message within a thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread containing the message to get information from. - schema: - type: string - - name: messageId - in: path - required: true - description: The ID of the message to get information from. - schema: - type: string - - name: fileId - in: path - required: true - description: The ID of the file to get information about. - schema: - type: string - responses: - '200': - description: The requested file information. - content: - application/json: - schema: - $ref: '#/components/schemas/MessageFile' - /threads/{threadId}/runs: - post: - operationId: createRun - description: Creates a new run for an assistant thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to run. - schema: - type: string - responses: - '200': - description: Information about the new thread run. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - assistant_id: - type: string - description: The ID of the assistant that should run the thread. - model: - type: string - description: The overridden model name that the assistant should use to run the thread. - instructions: - type: string - description: The overridden system instructions that the assistant should use to run the thread. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The overridden list of enabled tools that the assistant should use to run the thread. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - required: - - assistant_id - get: - operationId: listRuns - description: Gets a list of runs for a specified thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to list runs from. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - - name: before - in: query - required: false - description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - responses: - '200': - description: The requested list of thread runs. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/ThreadRun' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /threads/{threadId}/runs/{runId}: - get: - operationId: getRun - description: Gets an existing run from an existing thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread to retrieve run information from. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the thread to retrieve information about. - schema: - type: string - responses: - '200': - description: The requested information about the specified thread run. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - post: - operationId: modifyRun - description: Modifies an existing thread run. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread associated with the specified run. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the run to modify. - schema: - type: string - responses: - '200': - description: Information about the modified run. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - /threads/{threadId}/runs/{runId}/cancel: - post: - operationId: cancelRun - description: Cancels a run of an in progress thread. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread being run. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the run to cancel. - schema: - type: string - responses: - '200': - description: Updated information about the cancelled run. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - /threads/{threadId}/runs/{runId}/steps: - get: - operationId: listRunSteps - description: Gets a list of run steps from a thread run. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread that was run. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the run to list steps from. - schema: - type: string - - name: limit - in: query - required: false - description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - schema: - type: integer - format: int32 - default: 20 - - name: order - in: query - required: false - description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. - schema: - $ref: '#/components/schemas/ListSortOrder' - default: desc - - name: after - in: query - required: false - description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. - schema: - type: string - - name: before - in: query - required: false - description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. - schema: - type: string - responses: - '200': - description: The requested list of run steps. - content: - application/json: - schema: - type: object - required: - - object - - data - - first_id - - last_id - - has_more - properties: - object: - type: string - enum: - - list - description: The object type, which is always list. - data: - type: array - items: - $ref: '#/components/schemas/RunStep' - description: The requested list of items. - first_id: - type: string - description: The first ID represented in this list. - last_id: - type: string - description: The last ID represented in this list. - has_more: - type: boolean - description: A value indicating whether there are additional values available not captured in this list. - description: The response data for a requested list of items. - /threads/{threadId}/runs/{runId}/steps/{stepId}: - get: - operationId: getRunStep - description: Gets a single run step from a thread run. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread that was run. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the specific run to retrieve the step from. - schema: - type: string - - name: stepId - in: path - required: true - description: The ID of the step to retrieve information about. - schema: - type: string - responses: - '200': - description: Information about the requested run step. - content: - application/json: - schema: - $ref: '#/components/schemas/RunStep' - /threads/{threadId}/runs/{runId}/submit_tool_outputs: - post: - operationId: submitToolOutputsToRun - description: Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'. - parameters: - - name: threadId - in: path - required: true - description: The ID of the thread that was run. - schema: - type: string - - name: runId - in: path - required: true - description: The ID of the run that requires tool outputs. - schema: - type: string - responses: - '200': - description: Updated information about the run. - content: - application/json: - schema: - $ref: '#/components/schemas/ThreadRun' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - tool_outputs: - type: array - items: - $ref: '#/components/schemas/ToolOutput' - description: The list of tool outputs requested by tool calls from the specified run. - required: - - tool_outputs -security: - - ApiKeyAuth: [] - - OAuth2Auth: - - https://cognitiveservices.azure.com/.default -components: - schemas: - Assistant: - type: object - required: - - id - - object - - created_at - - name - - description - - model - - instructions - - tools - - file_ids - - metadata - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - assistant - description: The object type, which is always assistant. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - name: - type: string - nullable: true - description: The name of the assistant. - description: - type: string - nullable: true - description: The description of the assistant. - model: - type: string - description: The ID of the model to use. - instructions: - type: string - nullable: true - description: The system instructions for the assistant to use. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The collection of tools enabled for the assistant. - default: [] - file_ids: - type: array - items: - type: string - description: A list of attached file IDs, ordered by creation date in ascending order. - default: [] - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: Represents an assistant that can call the model and use tools. - AssistantCreationOptions: - type: object - required: - - model - properties: - model: - type: string - description: The ID of the model to use. - name: - type: string - nullable: true - description: The name of the new assistant. - description: - type: string - nullable: true - description: The description of the new assistant. - instructions: - type: string - nullable: true - description: The system instructions for the new assistant to use. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The collection of tools to enable for the new assistant. - default: [] - file_ids: - type: array - items: - type: string - description: A list of previously uploaded file IDs to attach to the assistant. - default: [] - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: The request details to use when creating a new assistant. - AssistantDeletionStatus: - type: object - required: - - id - - deleted - - object - properties: - id: - type: string - description: The ID of the resource specified for deletion. - deleted: - type: boolean - description: A value indicating whether deletion was successful. - object: - type: string - enum: - - assistant.deleted - description: The object type, which is always 'assistant.deleted'. - description: The status of an assistant deletion operation. - AssistantFile: - type: object - required: - - id - - object - - created_at - - assistant_id - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - assistant.file - description: The object type, which is always 'assistant.file'. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - assistant_id: - type: string - description: The assistant ID that the file is attached to. - description: Information about a file attached to an assistant, as used by tools that can read files. - AssistantFileDeletionStatus: - type: object - required: - - id - - deleted - - object - properties: - id: - type: string - description: The ID of the resource specified for deletion. - deleted: - type: boolean - description: A value indicating whether deletion was successful. - object: - type: string - enum: - - assistant.file.deleted - description: The object type, which is always 'assistant.file.deleted'. - description: The status of an assistant file deletion operation. - AssistantModificationOptions: - type: object - properties: - model: - type: string - description: The ID of the model to use. - name: - type: string - nullable: true - description: The modified name for the assistant to use. - description: - type: string - nullable: true - description: The modified description for the assistant to use. - instructions: - type: string - nullable: true - description: The modified system instructions for the new assistant to use. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The modified collection of tools to enable for the assistant. - default: [] - file_ids: - type: array - items: - type: string - description: The modified list of previously uploaded fileIDs to attach to the assistant. - default: [] - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: The request details to use when modifying an existing assistant. - AssistantThread: - type: object - required: - - id - - object - - created_at - - metadata - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread - description: The object type, which is always 'thread'. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: Information about a single thread associated with an assistant. - AssistantThreadCreationOptions: - type: object - properties: - messages: - type: array - items: - $ref: '#/components/schemas/ThreadMessage' - description: The messages to associate with the new thread. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: The details used to create a new assistant thread. - CodeInterpreterImageOutput: - type: object - required: - - type - - image - properties: - type: - type: string - enum: - - image - description: The object type, which is always 'image'. - image: - allOf: - - $ref: '#/components/schemas/CodeInterpreterImageReference' - description: Referential information for the image associated with this output. - allOf: - - $ref: '#/components/schemas/CodeInterpreterToolCallOutput' - description: A representation of an image output emitted by a code interpreter tool in response to a tool call by the model. - CodeInterpreterImageReference: - type: object - required: - - file_id - properties: - file_id: - type: string - description: The ID of the file associated with this image. - description: An image reference emitted by a code interpreter tool in response to a tool call by the model. - CodeInterpreterLogOutput: - type: object - required: - - type - - logs - properties: - type: - type: string - enum: - - logs - description: The object type, which is always 'logs'. - logs: - type: string - description: The serialized log output emitted by the code interpreter. - allOf: - - $ref: '#/components/schemas/CodeInterpreterToolCallOutput' - description: A representation of a log output emitted by a code interpreter tool in response to a tool call by the model. - CodeInterpreterToolCall: - type: object - required: - - type - - code_interpreter - properties: - type: - type: string - enum: - - code_interpreter - description: The object type, which is always 'code_interpreter'. - code_interpreter: - allOf: - - $ref: '#/components/schemas/CodeInterpreterToolCallDetails' - description: The details of the tool call to the code interpreter tool. - allOf: - - $ref: '#/components/schemas/ToolCall' - description: |- - A tool call to a code interpreter tool, issued by the model in evaluation of a configured code interpreter tool, that - represents submitted output needed or already fulfilled by the tool for the model to continue. - CodeInterpreterToolCallDetails: - type: object - required: - - input - - outputs - properties: - input: - type: string - description: The input provided by the model to the code interpreter tool. - outputs: - type: array - items: - $ref: '#/components/schemas/CodeInterpreterToolCallOutput' - description: The outputs produced by the code interpreter tool back to the model in response to the tool call. - description: The detailed information about a code interpreter invocation by the model. - CodeInterpreterToolCallOutput: - type: object - required: - - type - properties: - type: - type: string - description: The object type. - discriminator: - propertyName: type - mapping: - logs: '#/components/schemas/CodeInterpreterLogOutput' - image: '#/components/schemas/CodeInterpreterImageOutput' - description: An abstract representation of an emitted output from a code interpreter tool. - CodeInterpreterToolDefinition: - type: object - required: - - type - properties: - type: - type: string - enum: - - code_interpreter - description: The object type, which is always 'code_interpreter'. - allOf: - - $ref: '#/components/schemas/ToolDefinition' - description: The input definition information for a code interpreter tool as used to configure an assistant. - CreateAndRunThreadOptions: - type: object - required: - - assistant_id - properties: - assistant_id: - type: string - description: The ID of the assistant for which the thread should be created. - thread: - allOf: - - $ref: '#/components/schemas/AssistantThreadCreationOptions' - description: The details used to create the new thread. - model: - type: string - description: The overridden model that the assistant should use to run the thread. - instructions: - type: string - description: The overridden system instructions the assistant should use to run the thread. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The overridden list of enabled tools the assistant should use to run the thread. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: The details used when creating and immediately running a new assistant thread. - FileDeletionStatus: - type: object - required: - - id - - deleted - - object - properties: - id: - type: string - description: The ID of the resource specified for deletion. - deleted: - type: boolean - description: A value indicating whether deletion was successful. - object: - type: string - enum: - - file - description: The object type, which is always 'file'. - description: A status response from a file deletion operation. - FileListResponse: - type: object - required: - - object - - data - properties: - object: - type: string - enum: - - list - description: The object type, which is always 'list'. - data: - type: array - items: - $ref: '#/components/schemas/OpenAIFile' - description: The files returned for the request. - description: The response data from a file list operation. - FilePurpose: - type: string - enum: - - fine-tune - - fine-tune-results - - assistants - - assistants_output - description: The possible values denoting the intended usage of a file. - FunctionDefinition: - type: object - required: - - name - - parameters - properties: - name: - type: string - description: The name of the function to be called. - description: - type: string - description: A description of what the function does, used by the model to choose when and how to call the function. - parameters: - description: The parameters the functions accepts, described as a JSON Schema object. - description: The input definition information for a function. - FunctionToolCall: - type: object - required: - - type - - function - properties: - type: - type: string - enum: - - function - description: The object type, which is always 'function'. - function: - allOf: - - $ref: '#/components/schemas/FunctionToolCallDetails' - description: The detailed information about the function called by the model. - allOf: - - $ref: '#/components/schemas/ToolCall' - description: |- - A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents - given function inputs and submitted function outputs needed or already fulfilled by the tool for the model to continue. - FunctionToolCallDetails: - type: object - required: - - name - - arguments - - output - properties: - name: - type: string - description: The name of the function. - arguments: - type: string - description: The arguments that the model requires are provided to the named function. - output: - type: string - nullable: true - description: The output of the function, only populated for function calls that have already have had their outputs submitted. - description: The detailed information about the function called by the model. - FunctionToolDefinition: - type: object - required: - - type - - function - properties: - type: - type: string - enum: - - function - description: The object type, which is always 'function'. - function: - allOf: - - $ref: '#/components/schemas/FunctionDefinition' - description: The definition of the concrete function that the function tool should call. - allOf: - - $ref: '#/components/schemas/ToolDefinition' - description: The input definition information for a function tool as used to configure an assistant. - ListSortOrder: - type: string - enum: - - asc - - desc - description: The available sorting options when requesting a list of response objects. - MessageContent: - type: object - required: - - type - properties: - type: - type: string - description: The object type. - discriminator: - propertyName: type - mapping: - text: '#/components/schemas/MessageTextContent' - image_file: '#/components/schemas/MessageImageFileContent' - description: An abstract representation of a single item of thread message content. - MessageFile: - type: object - required: - - id - - object - - created_at - - message_id - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread.message.file - description: The object type, which is always 'thread.message.file'. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - message_id: - type: string - description: The ID of the message that this file is attached to. - description: Information about a file attached to an assistant thread message. - MessageFileCitationTextAnnotation: - type: object - required: - - type - - file_citation - properties: - type: - type: string - enum: - - file_citation - description: The object type, which is always 'file_citation'. - file_citation: - allOf: - - $ref: '#/components/schemas/MessageTextFileCitationDetails' - description: |- - A citation within the message that points to a specific quote from a specific file. - Generated when the assistant uses the "retrieval" tool to search files. - allOf: - - $ref: '#/components/schemas/MessageTextAnnotation' - description: A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the 'retrieval' tool to search files. - MessageFilePathDetails: - type: object - required: - - file_id - properties: - file_id: - type: string - description: The ID of the specific file that the citation is from. - description: An encapsulation of an image file ID, as used by message image content. - MessageFilePathTextAnnotation: - type: object - required: - - type - - file_path - properties: - type: - type: string - enum: - - file_path - description: The object type, which is always 'file_path'. - file_path: - allOf: - - $ref: '#/components/schemas/MessageFilePathDetails' - description: A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file. - allOf: - - $ref: '#/components/schemas/MessageTextAnnotation' - description: A citation within the message that points to a file located at a specific path. - MessageImageFileContent: - type: object - required: - - type - - image_file - properties: - type: - type: string - enum: - - image_file - description: The object type, which is always 'image_file'. - image_file: - allOf: - - $ref: '#/components/schemas/MessageImageFileDetails' - description: The image file for this thread message content item. - allOf: - - $ref: '#/components/schemas/MessageContent' - description: A representation of image file content in a thread message. - MessageImageFileDetails: - type: object - required: - - file_id - properties: - file_id: - allOf: - - $ref: '#/components/schemas/MessageImageFileIdDetails' - description: The ID for the file associated with this image. - description: An image reference, as represented in thread message content. - MessageImageFileIdDetails: - type: object - required: - - file_id - properties: - file_id: - type: string - description: The ID of the specific image file. - description: An encapsulation of an image file ID, as used by message image content. - MessageRole: - type: string - enum: - - user - - assistant - description: The possible values for roles attributed to messages in a thread. - MessageTextAnnotation: - type: object - required: - - type - - text - - start_index - - end_index - properties: - type: - type: string - description: The object type. - text: - type: string - description: The textual content associated with this text annotation item. - start_index: - type: integer - format: int32 - description: The first text index associated with this text annotation. - end_index: - type: integer - format: int32 - description: The last text index associated with this text annotation. - discriminator: - propertyName: type - mapping: - file_citation: '#/components/schemas/MessageFileCitationTextAnnotation' - file_path: '#/components/schemas/MessageFilePathTextAnnotation' - description: An abstract representation of an annotation to text thread message content. - MessageTextContent: - type: object - required: - - type - - text - properties: - type: - type: string - enum: - - text - description: The object type, which is always 'text'. - text: - allOf: - - $ref: '#/components/schemas/MessageTextDetails' - description: The text and associated annotations for this thread message content item. - allOf: - - $ref: '#/components/schemas/MessageContent' - description: A representation of a textual item of thread message content. - MessageTextDetails: - type: object - required: - - value - - annotations - properties: - value: - type: string - description: The text data. - annotations: - type: array - items: - $ref: '#/components/schemas/MessageTextAnnotation' - description: A list of annotations associated with this text. - description: The text and associated annotations for a single item of assistant thread message content. - MessageTextFileCitationDetails: - type: object - required: - - file_id - - quote - properties: - file_id: - type: string - description: The ID of the file associated with this citation. - quote: - type: string - description: The specific quote cited in the associated file. - description: A representation of a file-based text citation, as used in a file-based annotation of text thread message content. - OpenAIFile: - type: object - required: - - object - - id - - bytes - - filename - - created_at - - purpose - properties: - object: - type: string - enum: - - file - description: The object type, which is always 'file'. - id: - type: string - description: The identifier, which can be referenced in API endpoints. - bytes: - type: integer - format: int32 - description: The size of the file, in bytes. - filename: - type: string - description: The name of the file. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - purpose: - allOf: - - $ref: '#/components/schemas/FilePurpose' - description: The intended purpose of a file. - description: Represents an assistant that can call the model and use tools. - RequiredAction: - type: object - required: - - type - properties: - type: - type: string - description: The object type. - discriminator: - propertyName: type - mapping: - submit_tool_outputs: '#/components/schemas/SubmitToolOutputsAction' - description: An abstract representation of a required action for an assistant thread run to continue. - RetrievalToolCall: - type: object - required: - - type - - retrieval - properties: - type: - type: string - enum: - - retrieval - description: The object type, which is always 'retrieval'. - retrieval: - type: object - additionalProperties: - type: string - description: The key/value pairs produced by the retrieval tool. - allOf: - - $ref: '#/components/schemas/ToolCall' - description: |- - A tool call to a retrieval tool, issued by the model in evaluation of a configured retrieval tool, that represents - submitted output needed or already fulfilled by the tool for the model to continue. - RetrievalToolDefinition: - type: object - required: - - type - properties: - type: - type: string - enum: - - retrieval - description: The object type, which is always 'retrieval'. - allOf: - - $ref: '#/components/schemas/ToolDefinition' - description: The input definition information for a retrieval tool as used to configure an assistant. - RunError: - type: object - required: - - code - - message - properties: - code: - type: string - description: The status for the error. - message: - type: string - description: The human-readable text associated with the error. - description: The details of an error as encountered by an assistant thread run. - RunStatus: - type: string - enum: - - queued - - in_progress - - requires_action - - cancelling - - cancelled - - failed - - completed - - expired - description: Possible values for the status of an assistant thread run. - RunStep: - type: object - required: - - id - - object - - type - - assistant_id - - thread_id - - run_id - - status - - step_details - - last_error - - created_at - - expired_at - - completed_at - - cancelled_at - - failed_at - - metadata - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread.run.step - description: The object type, which is always 'thread.run.step'. - type: - allOf: - - $ref: '#/components/schemas/RunStepType' - description: The type of run step, which can be either message_creation or tool_calls. - assistant_id: - type: string - description: The ID of the assistant associated with the run step. - thread_id: - type: string - description: The ID of the thread that was run. - run_id: - type: string - description: The ID of the run that this run step is a part of. - status: - allOf: - - $ref: '#/components/schemas/RunStepStatus' - description: The status of this run step. - step_details: - allOf: - - $ref: '#/components/schemas/RunStepDetails' - description: The details for this run step. - last_error: - type: object - allOf: - - $ref: '#/components/schemas/RunStepError' - nullable: true - description: If applicable, information about the last error encountered by this run step. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - expired_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this item expired. - completed_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this completed. - cancelled_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this was cancelled. - failed_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this failed. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: Detailed information about a single step of an assistant thread run. - RunStepDetails: - type: object - required: - - type - properties: - type: - allOf: - - $ref: '#/components/schemas/RunStepType' - description: The object type. - discriminator: - propertyName: type - mapping: - message_creation: '#/components/schemas/RunStepMessageCreationDetails' - tool_calls: '#/components/schemas/RunStepToolCallDetails' - description: An abstract representation of the details for a run step. - RunStepError: - type: object - required: - - code - - message - properties: - code: - allOf: - - $ref: '#/components/schemas/RunStepErrorCode' - description: The error code for this error. - message: - type: string - description: The human-readable text associated with this error. - description: The error information associated with a failed run step. - RunStepErrorCode: - type: string - enum: - - server_error - - rate_limit_exceeded - description: Possible error code values attributable to a failed run step. - RunStepMessageCreationDetails: - type: object - required: - - type - - message_creation - properties: - type: - type: string - enum: - - message_creation - description: The object type, which is always 'message_creation'. - message_creation: - allOf: - - $ref: '#/components/schemas/RunStepMessageCreationReference' - description: Information about the message creation associated with this run step. - allOf: - - $ref: '#/components/schemas/RunStepDetails' - description: The detailed information associated with a message creation run step. - RunStepMessageCreationReference: - type: object - required: - - message_id - properties: - message_id: - type: string - description: The ID of the message created by this run step. - description: The details of a message created as a part of a run step. - RunStepStatus: - type: string - enum: - - in_progress - - cancelled - - failed - - completed - - expired - description: Possible values for the status of a run step. - RunStepToolCallDetails: - type: object - required: - - type - - tool_calls - properties: - type: - type: string - enum: - - tool_calls - description: The object type, which is always 'tool_calls'. - tool_calls: - type: array - items: - $ref: '#/components/schemas/ToolCall' - description: A list tool call details for this run step. - allOf: - - $ref: '#/components/schemas/RunStepDetails' - description: The detailed information associated with a run step calling tools. - RunStepType: - type: string - enum: - - message_creation - - tool_calls - description: The possible types of run steps. - ServiceApiVersions: - type: string - enum: - - 2023-11-06-beta - description: The known set of supported API versions. - SubmitToolOutputsAction: - type: object - required: - - type - - submit_tool_outputs - properties: - type: - type: string - enum: - - submit_tool_outputs - description: The object type, which is always 'submit_tool_outputs'. - submit_tool_outputs: - allOf: - - $ref: '#/components/schemas/SubmitToolOutputsDetails' - description: The details describing tools that should be called to submit tool outputs. - allOf: - - $ref: '#/components/schemas/RequiredAction' - description: The details for required tool calls that must be submitted for an assistant thread run to continue. - SubmitToolOutputsDetails: - type: object - required: - - tool_calls - properties: - tool_calls: - type: array - items: - $ref: '#/components/schemas/ToolCall' - description: The list of tool calls that must be resolved for the assistant thread run to continue. - description: The details describing tools that should be called to submit tool outputs. - ThreadDeletionStatus: - type: object - required: - - id - - deleted - - object - properties: - id: - type: string - description: The ID of the resource specified for deletion. - deleted: - type: boolean - description: A value indicating whether deletion was successful. - object: - type: string - enum: - - thread.deleted - description: The object type, which is always 'thread.deleted'. - description: The status of a thread deletion operation. - ThreadMessage: - type: object - required: - - id - - object - - created_at - - thread_id - - role - - content - - file_ids - - metadata - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread.message - description: The object type, which is always 'thread.message'. - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - thread_id: - type: string - description: The ID of the thread that this message belongs to. - role: - allOf: - - $ref: '#/components/schemas/MessageRole' - description: The role associated with the assistant thread message. - content: - type: array - items: - $ref: '#/components/schemas/MessageContent' - description: The list of content items associated with the assistant thread message. - assistant_id: - type: string - description: If applicable, the ID of the assistant that authored this message. - run_id: - type: string - description: If applicable, the ID of the run associated with the authoring of this message. - file_ids: - type: array - items: - type: string - description: |- - A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can - access files. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: A single message within an assistant thread. - ThreadRun: - type: object - required: - - id - - object - - thread_id - - assistant_id - - status - - last_error - - model - - instructions - - tools - - file_ids - - created_at - - expires_at - - started_at - - completed_at - - cancelled_at - - failed_at - - metadata - properties: - id: - type: string - description: The identifier, which can be referenced in API endpoints. - object: - type: string - enum: - - thread.run - description: The object type, which is always 'thread.run'. - thread_id: - type: string - description: The ID of the thread associated with this run. - assistant_id: - type: string - description: The ID of the assistant associated with the thread this run was performed against. - status: - allOf: - - $ref: '#/components/schemas/RunStatus' - description: The status of the assistant thread run. - required_action: - type: object - allOf: - - $ref: '#/components/schemas/RequiredAction' - nullable: true - description: The details of the action required for the assistant thread run to continue. - last_error: - type: object - allOf: - - $ref: '#/components/schemas/RunError' - nullable: true - description: The last error, if any, encountered by this assistant thread run. - model: - type: string - description: The ID of the model to use. - instructions: - type: string - description: The overridden system instructions used for this assistant thread run. - tools: - type: array - items: - $ref: '#/components/schemas/ToolDefinition' - description: The overridden enabled tools used for this assistant thread run. - default: [] - file_ids: - type: array - items: - type: string - description: A list of attached file IDs, ordered by creation date in ascending order. - default: [] - created_at: - type: integer - format: unixtime - description: The Unix timestamp, in seconds, representing when this object was created. - expires_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this item expires. - started_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this item was started. - completed_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this completed. - cancelled_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this was cancelled. - failed_at: - type: string - format: date-time - nullable: true - description: The Unix timestamp, in seconds, representing when this failed. - metadata: - type: object - additionalProperties: - type: string - nullable: true - description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. - description: Data representing a single evaluation run of an assistant thread. - ToolCall: - type: object - required: - - type - - id - properties: - type: - type: string - description: The object type. - id: - type: string - description: The ID of the tool call. This ID must be referenced when you submit tool outputs. - discriminator: - propertyName: type - mapping: - code_interpreter: '#/components/schemas/CodeInterpreterToolCall' - retrieval: '#/components/schemas/RetrievalToolCall' - function: '#/components/schemas/FunctionToolCall' - description: |- - An abstract representation a tool call, issued by the model in evaluation of a configured tool definition, that must - be fulfilled and have its outputs submitted before the model can continue. - ToolDefinition: - type: object - required: - - type - properties: - type: - type: string - description: The object type. - discriminator: - propertyName: type - mapping: - code_interpreter: '#/components/schemas/CodeInterpreterToolDefinition' - retrieval: '#/components/schemas/RetrievalToolDefinition' - function: '#/components/schemas/FunctionToolDefinition' - description: An abstract representation of an input tool definition that an assistant can use. - ToolOutput: - type: object - properties: - tool_call_id: - type: string - description: The ID of the tool call being resolved, as provided in the tool calls of a required action from a run. - output: - type: string - description: The output from the tool to be submitted. - description: The data provided during a tool outputs submission to resolve pending tool calls and allow the model to continue. - securitySchemes: - ApiKeyAuth: - type: apiKey - in: header - name: api-key - OAuth2Auth: - type: oauth2 - flows: - implicit: - authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize - scopes: - https://cognitiveservices.azure.com/.default: '' -servers: - - url: '{endpoint}' - description: Azure OpenAI APIs for Assistants. - variables: - endpoint: - default: '' - description: An OpenAI endpoint supporting assistants functionality. diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml index 50ff2a97ab68..a60a83e089b4 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml @@ -18,7 +18,7 @@ paths: schema: $ref: '#/components/schemas/Assistant' requestBody: - description: Body parameter. + description: The request details to use when creating a new assistant. required: true content: application/json: @@ -125,7 +125,7 @@ paths: schema: $ref: '#/components/schemas/Assistant' requestBody: - description: Body parameter. + description: The request details to use when modifying an existing assistant. required: true content: application/json: @@ -264,7 +264,7 @@ paths: schema: $ref: '#/components/schemas/AssistantThread' requestBody: - description: Body parameter. + description: The details used to create a new assistant thread. required: true content: application/json: @@ -283,7 +283,7 @@ paths: schema: $ref: '#/components/schemas/ThreadRun' requestBody: - description: Body parameter. + description: The details used when creating and immediately running a new assistant thread. required: true content: application/json: @@ -325,7 +325,7 @@ paths: schema: $ref: '#/components/schemas/AssistantThread' requestBody: - description: Body parameter. + description: The details used to update an existing assistant thread. required: true content: application/json: @@ -366,6 +366,13 @@ paths: application/json: schema: $ref: '#/components/schemas/ThreadMessage' + requestBody: + description: A single message within an assistant thread, as provided during that thread's creation for its initial state. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadMessageOptions' get: operationId: listMessages description: Gets a list of messages that exist on a thread. @@ -516,7 +523,7 @@ paths: schema: $ref: '#/components/schemas/ThreadRun' requestBody: - description: The details for the run to create. + description: The details used when creating a new run of an assistant thread. required: true content: application/json: @@ -2510,6 +2517,32 @@ components: nullable: true description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. description: A single, existing message within an assistant thread. + ThreadMessageOptions: + type: object + required: + - role + - content + properties: + role: + allOf: + - $ref: '#/components/schemas/MessageRole' + 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 + description: |- + The textual content of the initial message. Currently, robust input including images and annotated text may only be provided via + a separate call to the create message API. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: A single message within an assistant thread, as provided during that thread's creation for its initial state. ThreadRun: type: object required: diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml index e7a6f9691f97..f763ef81895c 100644 --- a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-05-01-preview/assistants_generated.yaml @@ -18,7 +18,7 @@ paths: schema: $ref: '#/components/schemas/Assistant' requestBody: - description: Body parameter. + description: The request details to use when creating a new assistant. required: true content: application/json: @@ -125,7 +125,7 @@ paths: schema: $ref: '#/components/schemas/Assistant' requestBody: - description: Body parameter. + description: The request details to use when modifying an existing assistant. required: true content: application/json: @@ -264,7 +264,7 @@ paths: schema: $ref: '#/components/schemas/AssistantThread' requestBody: - description: Body parameter. + description: The details used to create a new assistant thread. required: true content: application/json: @@ -283,7 +283,7 @@ paths: schema: $ref: '#/components/schemas/ThreadRun' requestBody: - description: Body parameter. + description: The details used when creating and immediately running a new assistant thread. required: true content: application/json: @@ -325,7 +325,7 @@ paths: schema: $ref: '#/components/schemas/AssistantThread' requestBody: - description: Body parameter. + description: The details used to update an existing assistant thread. required: true content: application/json: @@ -529,7 +529,7 @@ paths: schema: $ref: '#/components/schemas/ThreadRun' requestBody: - description: The details for the run to create. + description: The details used when creating a new run of an assistant thread. required: true content: application/json: @@ -918,7 +918,7 @@ paths: schema: $ref: '#/components/schemas/VectorStore' requestBody: - description: Body parameter. + description: Request object for creating a vector store. required: true content: application/json: @@ -960,6 +960,7 @@ paths: schema: $ref: '#/components/schemas/VectorStore' requestBody: + description: Request object for updating a vector store. required: true content: application/json: diff --git a/specification/ai/data-plane/OpenAI.Assistants/readme.md b/specification/ai/data-plane/OpenAI.Assistants/readme.md new file mode 100644 index 000000000000..5733840ef282 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/readme.md @@ -0,0 +1,38 @@ +# AI OpenAI.Assistants SDK + +> see https://aka.ms/autorest + +Configuration for generating AzureOpenAI Inference SDK. + +The current release for the AzureOpenAI is `release_2024_05_01`. + +``` yaml +tag: release_2023_05_15 +add-credentials: true +openapi-type: data-plane +``` + +## Suppression + +``` yaml +directive: + - suppress: INVALID_TYPE + from: assistants_generated.json + reason: A bug in oav is preventing a x-nullable attribute on incomplete_details from being honored. +``` + +# Releases + +## OpenAI.Assistants 2024-02-15-preview (generated) +These settings apply only when `--tag=release_2024_02_15_preview_autogen` is specified on the command line. + +``` yaml $(tag) == 'release_2024_02_15_preview_autogen' +input-file: OpenApiV2/preview/2024-02-15-preview/assistants_generated.json +``` + +## OpenAI.Assistants 2024-05-01-preview (generated) +These settings apply only when `--tag=release_2024_05_01_preview_autogen` is specified on the command line. + +``` yaml $(tag) == 'release_2024_05_01_preview_autogen' +input-file: OpenApiV2/preview/2024-05-01-preview/assistants_generated.json +``` diff --git a/specification/apicenter/ApiCenter.Management/Service.tsp b/specification/apicenter/ApiCenter.Management/Service.tsp index 17ecb746ffa1..ca3d3bc50ed4 100644 --- a/specification/apicenter/ApiCenter.Management/Service.tsp +++ b/specification/apicenter/ApiCenter.Management/Service.tsp @@ -29,7 +29,13 @@ interface Services { @doc("Creates new or updates existing API.") createOrUpdate is Azure.ResourceManager.ArmResourceCreateOrReplaceSync; @doc("Updates existing service.") - update is ArmResourcePatchSync; + update is ArmCustomPatchSync< + Service, + Azure.ResourceManager.Foundations.ResourceUpdateModel< + Service, + ServiceProperties + > + >; @doc("Deletes specified service.") delete is ArmResourceDeleteSync; @doc("Returns a collection of services within the resource group.") diff --git a/specification/apicenter/ApiCenter.Management/tspconfig.yaml b/specification/apicenter/ApiCenter.Management/tspconfig.yaml index 955a20044884..70f9f5896ce9 100644 --- a/specification/apicenter/ApiCenter.Management/tspconfig.yaml +++ b/specification/apicenter/ApiCenter.Management/tspconfig.yaml @@ -4,6 +4,9 @@ options: "@azure-tools/typespec-autorest": emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/apicenter.json" examples-directory: "{project-root}/examples" use-read-only-status-schema: true diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-03-15-preview/apicenter.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-03-15-preview/apicenter.json index 99c8fd351591..1350ded5e5a8 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-03-15-preview/apicenter.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-03-15-preview/apicenter.json @@ -4817,6 +4817,7 @@ }, "properties": { "$ref": "#/definitions/ServiceUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/tspconfig.yaml b/specification/appcomplianceautomation/AppComplianceAutomation.Management/tspconfig.yaml index 77659b374742..ce20e26474dd 100644 --- a/specification/appcomplianceautomation/AppComplianceAutomation.Management/tspconfig.yaml +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/tspconfig.yaml @@ -11,6 +11,9 @@ options: use-read-only-status-schema: true emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/appcomplianceautomation.json" examples-directory: "{project-root}/examples" "@azure-tools/typespec-ts": diff --git a/specification/azurefleet/AzureFleet.Management/baseVirtualMachineProfile.tsp b/specification/azurefleet/AzureFleet.Management/baseVirtualMachineProfile.tsp new file mode 100644 index 000000000000..5fa1f2d6c591 --- /dev/null +++ b/specification/azurefleet/AzureFleet.Management/baseVirtualMachineProfile.tsp @@ -0,0 +1,2340 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@azure-tools/typespec-azure-core"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.Core; + +namespace Microsoft.AzureFleet; + +/** + * Describes the base virtual machine profile for fleet + */ +model BaseVirtualMachineProfile { + /** + * Specifies the operating system settings for the virtual machines in the scale + * set. + */ + osProfile?: VirtualMachineScaleSetOSProfile; + + /** + * Specifies the storage settings for the virtual machine disks. + */ + storageProfile?: VirtualMachineScaleSetStorageProfile; + + /** + * Specifies properties of the network interfaces of the virtual machines in the + * scale set. + */ + networkProfile?: VirtualMachineScaleSetNetworkProfile; + + /** + * Specifies the Security related profile settings for the virtual machines in the + * scale set. + */ + securityProfile?: SecurityProfile; + + /** + * Specifies the boot diagnostic settings state. + */ + diagnosticsProfile?: DiagnosticsProfile; + + /** + * Specifies a collection of settings for extensions installed on virtual machines + * in the scale set. + */ + extensionProfile?: VirtualMachineScaleSetExtensionProfile; + + /** + * Specifies that the image or disk that is being used was licensed on-premises. + *

Possible values for Windows Server operating system are:

+ * Windows_Client

Windows_Server

Possible values for Linux + * Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS + * (for SUSE)

For more information, see [Azure Hybrid Use Benefit for + * Windows + * Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing) + *

[Azure Hybrid Use Benefit for Linux + * Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux) + *

Minimum api-version: 2015-06-15 + */ + licenseType?: string; + + /** + * Specifies Scheduled Event related configurations. + */ + scheduledEventsProfile?: ScheduledEventsProfile; + + /** + * UserData for the virtual machines in the scale set, which must be base-64 + * encoded. Customer should not pass any secrets in here. Minimum api-version: + * 2021-03-01. + */ + userData?: string; + + /** + * Specifies the capacity reservation related details of a scale set. Minimum + * api-version: 2021-04-01. + */ + capacityReservation?: CapacityReservationProfile; + + /** + * Specifies the gallery applications that should be made available to the VM/VMSS + */ + applicationProfile?: ApplicationProfile; + + /** + * Specifies the hardware profile related details of a scale set. Minimum + * api-version: 2021-11-01. + */ + hardwareProfile?: VirtualMachineScaleSetHardwareProfile; + + /** + * Specifies the service artifact reference id used to set same image version for + * all virtual machines in the scale set when using 'latest' image version. + * Minimum api-version: 2022-11-01 + */ + serviceArtifactReference?: ServiceArtifactReference; + + /** + * Specifies the security posture to be used for all virtual machines in the scale + * set. Minimum api-version: 2023-03-01 + */ + securityPostureReference?: SecurityPostureReference; + + /** + * Specifies the time in which this VM profile for the Virtual Machine Scale Set + * was created. Minimum API version for this property is 2023-09-01. This value + * will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile + * with minimum api-version 2023-09-01. Examples: "2024-07-01T00:00:01.1234567+00:00" + */ + @visibility("read") + timeCreated?: utcDateTime; +} + +/** + * Describes a virtual machine scale set OS profile. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "" +model VirtualMachineScaleSetOSProfile { + /** + * Specifies the computer name prefix for all of the virtual machines in the scale + * set. Computer name prefixes must be 1 to 15 characters long. + */ + computerNamePrefix?: string; + + /** + * Specifies the name of the administrator account.

**Windows-only + * restriction:** Cannot end in "."

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

**Minimum-length (Linux):** 1 character

**Max-length + * (Linux):** 64 characters

**Max-length (Windows):** 20 characters + */ + adminUsername?: string; + + @doc(""" + Specifies the password of the administrator account.

**Minimum-length + (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters +

**Max-length (Windows):** 123 characters

**Max-length + (Linux):** 72 characters

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

**Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", + \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", + \"Password22\", \"iloveyou!\"

For resetting the password, see [How to + reset the Remote Desktop service or its login password in a Windows + VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp) +

For resetting root password, see [Manage users, SSH, and check or + repair disks on Azure Linux VMs using the VMAccess + Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) + """) + @visibility("create", "update") + @secret + adminPassword?: string; + + /** + * Specifies a base-64 encoded string of custom data. The base-64 encoded string + * is decoded to a binary array that is saved as a file on the Virtual Machine. + * The maximum length of the binary array is 65535 bytes. For using cloud-init for + * your VM, see [Using cloud-init to customize a Linux VM during + * creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init) + */ + @visibility("create", "update") + @secret + customData?: string; + + /** + * Specifies Windows operating system settings on the virtual machine. + */ + windowsConfiguration?: WindowsConfiguration; + + /** + * Specifies the Linux operating system settings on the virtual machine. For a + * list of supported Linux distributions, see [Linux on Azure-Endorsed + * Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros). + */ + linuxConfiguration?: LinuxConfiguration; + + /** + * Specifies set of certificates that should be installed onto the virtual + * machines in the scale set. To install certificates on a virtual machine it is + * recommended to use the [Azure Key Vault virtual machine extension for + * Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) + * or the [Azure Key Vault virtual machine extension for + * Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). + */ + #suppress "@azure-tools/typespec-azure-resource-manager/missing-x-ms-identifiers" "id exists inside sourceVault" + @OpenAPI.extension("x-ms-identifiers", ["sourceVault/id"]) + secrets?: VaultSecretGroup[]; + + /** + * Specifies whether extension operations should be allowed on the virtual machine + * scale set. This may only be set to False when no extensions are present on the + * virtual machine scale set. + */ + allowExtensionOperations?: boolean; + + /** + * Optional property which must either be set to True or omitted. + */ + requireGuestProvisionSignal?: boolean; +} + +/** + * Specifies Windows operating system settings on the virtual machine. + */ +model WindowsConfiguration { + /** + * Indicates whether virtual machine agent should be provisioned on the virtual + * machine. When this property is not specified in the request body, it is set to + * true by default. This will ensure that VM Agent is installed on the VM so that + * extensions can be added to the VM later. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "" + provisionVMAgent?: boolean; + + /** + * Indicates whether Automatic Updates is enabled for the Windows virtual machine. + * Default value is true. For virtual machine scale sets, this property can be + * updated and updates will take effect on OS reprovisioning. + */ + enableAutomaticUpdates?: boolean; + + /** + * Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". + * Possible values can be + * [TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) + * value from time zones returned by + * [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). + */ + timeZone?: string; + + /** + * Specifies additional base-64 encoded XML formatted information that can be + * included in the Unattend.xml file, which is used by Windows Setup. + */ + @OpenAPI.extension("x-ms-identifiers", []) + additionalUnattendContent?: AdditionalUnattendContent[]; + + /** + * [Preview Feature] Specifies settings related to VM Guest Patching on Windows. + */ + patchSettings?: PatchSettings; + + /** + * Specifies the Windows Remote Management listeners. This enables remote Windows + * PowerShell. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "" + winRM?: WinRMConfiguration; + + /** + * Indicates whether VMAgent Platform Updates is enabled for the Windows virtual + * machine. Default value is false. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "" + enableVMAgentPlatformUpdates?: boolean; +} + +/** + * Specifies additional XML formatted information that can be included in the + * Unattend.xml file, which is used by Windows Setup. Contents are defined by + * setting name, component name, and the pass in which the content is applied. + */ +model AdditionalUnattendContent { + /** + * The pass name. Currently, the only allowable value is OobeSystem. + */ + passName?: "OobeSystem"; + + /** + * The component name. Currently, the only allowable value is + * Microsoft-Windows-Shell-Setup. + */ + componentName?: "Microsoft-Windows-Shell-Setup"; + + /** + * Specifies the name of the setting to which the content applies. Possible values + * are: FirstLogonCommands and AutoLogon. + */ + settingName?: SettingNames; + + /** + * Specifies the XML formatted content that is added to the unattend.xml file for + * the specified path and component. The XML must be less than 4KB and must + * include the root element for the setting or feature that is being inserted. + */ + @visibility("create", "update") + @secret + content?: string; +} + +/** + * Specifies settings related to VM Guest Patching on Windows. + */ +model PatchSettings { + /** + * Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual + * machines associated to virtual machine scale set with OrchestrationMode as + * Flexible.

Possible values are:

**Manual** - You + * control the application of patches to a virtual machine. You do this by + * applying patches manually inside the VM. In this mode, automatic updates are + * disabled; the property WindowsConfiguration.enableAutomaticUpdates must be + * false

**AutomaticByOS** - The virtual machine will automatically be + * updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates + * must be true.

**AutomaticByPlatform** - the virtual machine will + * automatically updated by the platform. The properties provisionVMAgent and + * WindowsConfiguration.enableAutomaticUpdates must be true + */ + patchMode?: WindowsVMGuestPatchMode; + + /** + * Enables customers to patch their Azure VMs without requiring a reboot. For + * enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' + * must be set to 'AutomaticByPlatform'. + */ + enableHotpatching?: boolean; + + /** + * Specifies the mode of VM Guest patch assessment for the IaaS virtual + * machine.

Possible values are:

**ImageDefault** - You + * control the timing of patch assessments on a virtual machine.

+ * **AutomaticByPlatform** - The platform will trigger periodic patch assessments. + * The property provisionVMAgent must be true. + */ + assessmentMode?: WindowsPatchAssessmentMode; + + /** + * Specifies additional settings for patch mode AutomaticByPlatform in VM Guest + * Patching on Windows. + */ + automaticByPlatformSettings?: WindowsVMGuestPatchAutomaticByPlatformSettings; +} + +/** + * Specifies additional settings to be applied when patch mode AutomaticByPlatform + * is selected in Windows patch settings. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "" +model WindowsVMGuestPatchAutomaticByPlatformSettings { + /** + * Specifies the reboot setting for all AutomaticByPlatform patch installation + * operations. + */ + rebootSetting?: WindowsVMGuestPatchAutomaticByPlatformRebootSetting; + + /** + * Enables customer to schedule patching without accidental upgrades + */ + bypassPlatformSafetyChecksOnUserSchedule?: boolean; +} + +/** + * Describes Windows Remote Management configuration of the VM + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "" +model WinRMConfiguration { + /** + * The list of Windows Remote Management listeners + */ + @OpenAPI.extension("x-ms-identifiers", []) + listeners?: WinRMListener[]; +} + +/** + * Describes Protocol and thumbprint of Windows Remote Management listener + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "" +model WinRMListener { + /** + * Specifies the protocol of WinRM listener. Possible values are: **http,** + * **https.** + */ + protocol?: ProtocolTypes; + + /** + * This is the URL of a certificate that has been uploaded to Key Vault as a + * secret. For adding a secret to the Key Vault, see [Add a key or secret to the + * key + * vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). + * In this case, your certificate needs to be the Base64 encoding of the following + * JSON Object which is encoded in UTF-8:

{
+ * "data":"",
"dataType":"pfx",
+ * "password":""
}
To install certificates on a virtual + * machine it is recommended to use the [Azure Key Vault virtual machine extension + * for + * Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) + * or the [Azure Key Vault virtual machine extension for + * Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). + */ + certificateUrl?: string; +} + +/** + * Specifies the Linux operating system settings on the virtual machine. For a + * list of supported Linux distributions, see [Linux on Azure-Endorsed + * Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros). + */ +model LinuxConfiguration { + /** + * Specifies whether password authentication should be disabled. + */ + disablePasswordAuthentication?: boolean; + + /** + * Specifies the ssh key configuration for a Linux OS. + */ + ssh?: SshConfiguration; + + /** + * Indicates whether virtual machine agent should be provisioned on the virtual + * machine. When this property is not specified in the request body, default + * behavior is to set it to true. This will ensure that VM Agent is installed on + * the VM so that extensions can be added to the VM later. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "" + provisionVMAgent?: boolean; + + /** + * [Preview Feature] Specifies settings related to VM Guest Patching on Linux. + */ + patchSettings?: LinuxPatchSettings; + + /** + * Indicates whether VMAgent Platform Updates is enabled for the Linux virtual + * machine. Default value is false. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "" + enableVMAgentPlatformUpdates?: boolean; +} + +/** + * SSH configuration for Linux based VMs running on Azure + */ +model SshConfiguration { + /** + * The list of SSH public keys used to authenticate with linux based VMs. + */ + @OpenAPI.extension("x-ms-identifiers", ["path"]) + publicKeys?: SshPublicKey[]; +} + +/** + * Contains information about SSH certificate public key and the path on the Linux + * VM where the public key is placed. + */ +model SshPublicKey { + /** + * Specifies the full path on the created VM where ssh public key is stored. If + * the file already exists, the specified key is appended to the file. Example: + * /home/user/.ssh/authorized_keys + */ + path?: string; + + /** + * SSH public key certificate used to authenticate with the VM through ssh. The + * key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, + * see [Create SSH keys on Linux and Mac for Linux VMs in + * Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). + */ + keyData?: string; +} + +/** + * Specifies settings related to VM Guest Patching on Linux. + */ +model LinuxPatchSettings { + /** + * Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual + * machines associated to virtual machine scale set with OrchestrationMode as + * Flexible.

Possible values are:

**ImageDefault** - The + * virtual machine's default patching configuration is used.

+ * **AutomaticByPlatform** - The virtual machine will be automatically updated by + * the platform. The property provisionVMAgent must be true + */ + patchMode?: LinuxVMGuestPatchMode; + + /** + * Specifies the mode of VM Guest Patch Assessment for the IaaS virtual + * machine.

Possible values are:

**ImageDefault** - You + * control the timing of patch assessments on a virtual machine.

+ * **AutomaticByPlatform** - The platform will trigger periodic patch assessments. + * The property provisionVMAgent must be true. + */ + assessmentMode?: LinuxPatchAssessmentMode; + + /** + * Specifies additional settings for patch mode AutomaticByPlatform in VM Guest + * Patching on Linux. + */ + automaticByPlatformSettings?: LinuxVMGuestPatchAutomaticByPlatformSettings; +} + +/** + * Specifies additional settings to be applied when patch mode AutomaticByPlatform + * is selected in Linux patch settings. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "" +model LinuxVMGuestPatchAutomaticByPlatformSettings { + /** + * Specifies the reboot setting for all AutomaticByPlatform patch installation + * operations. + */ + rebootSetting?: LinuxVMGuestPatchAutomaticByPlatformRebootSetting; + + /** + * Enables customer to schedule patching without accidental upgrades + */ + bypassPlatformSafetyChecksOnUserSchedule?: boolean; +} + +/** + * Describes a set of certificates which are all in the same Key Vault. + */ +model VaultSecretGroup { + /** + * The relative URL of the Key Vault containing all of the certificates in + * VaultCertificates. + */ + sourceVault?: SubResource; + + /** + * The list of key vault references in SourceVault which contain certificates. + */ + @OpenAPI.extension("x-ms-identifiers", ["certificateUrl"]) + vaultCertificates?: VaultCertificate[]; +} + +/** + * Describes SubResource + */ +model SubResource { + /** + * Resource Id + */ + id?: armResourceIdentifier; +} + +/** + * Describes a single certificate reference in a Key Vault, and where the + * certificate should reside on the VM. + */ +model VaultCertificate { + /** + * This is the URL of a certificate that has been uploaded to Key Vault as a + * secret. For adding a secret to the Key Vault, see [Add a key or secret to the + * key + * vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). + * In this case, your certificate needs to be It is the Base64 encoding of the + * following JSON Object which is encoded in UTF-8:

{
+ * "data":"",
"dataType":"pfx",
+ * "password":""
}
To install certificates on a virtual + * machine it is recommended to use the [Azure Key Vault virtual machine extension + * for + * Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) + * or the [Azure Key Vault virtual machine extension for + * Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). + */ + certificateUrl?: string; + + /** + * For Windows VMs, specifies the certificate store on the Virtual Machine to + * which the certificate should be added. The specified certificate store is + * implicitly in the LocalMachine account. For Linux VMs, the certificate file is + * placed under the /var/lib/waagent directory, with the file name + * <UppercaseThumbprint>.crt for the X509 certificate file and + * <UppercaseThumbprint>.prv for private key. Both of these files are .pem + * formatted. + */ + certificateStore?: string; +} + +/** + * Describes a virtual machine scale set storage profile. + */ +model VirtualMachineScaleSetStorageProfile { + /** + * Specifies information about the image to use. You can specify information about + * platform images, marketplace images, or virtual machine images. This element is + * required when you want to use a platform image, marketplace image, or virtual + * machine image, but is not used in other creation operations. + */ + imageReference?: ImageReference; + + /** + * Specifies information about the operating system disk used by the virtual + * machines in the scale set. For more information about disks, see [About disks + * and VHDs for Azure virtual + * machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). + */ + osDisk?: VirtualMachineScaleSetOSDisk; + + /** + * Specifies the parameters that are used to add data disks to the virtual + * machines in the scale set. For more information about disks, see [About disks + * and VHDs for Azure virtual + * machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). + */ + @OpenAPI.extension("x-ms-identifiers", ["name", "lun"]) + dataDisks?: VirtualMachineScaleSetDataDisk[]; + + /** + * Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01 + */ + diskControllerType?: DiskControllerTypes; +} + +/** + * Specifies information about the image to use. You can specify information about + * platform images, marketplace images, or virtual machine images. This element is + * required when you want to use a platform image, marketplace image, or virtual + * machine image, but is not used in other creation operations. NOTE: Image + * reference publisher and offer can only be set when you create the scale set. + */ +model ImageReference is SubResource { + /** + * The image publisher. + */ + publisher?: string; + + /** + * Specifies the offer of the platform image or marketplace image used to create + * the virtual machine. + */ + offer?: string; + + /** + * The image SKU. + */ + sku?: string; + + /** + * Specifies the version of the platform image or marketplace image used to create + * the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. + * Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest + * version of an image available at deploy time. Even if you use 'latest', the VM + * image will not automatically update after deploy time even if a new version + * becomes available. Please do not use field 'version' for gallery image + * deployment, gallery image should always use 'id' field for deployment, to use 'latest' + * version of gallery image, just set + * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' + * in the 'id' field without version input. + */ + version?: string; + + /** + * Specifies in decimal numbers, the version of platform image or marketplace + * image used to create the virtual machine. This readonly field differs from 'version', + * only if the value specified in 'version' field is 'latest'. + */ + @visibility("read") + exactVersion?: string; + + /** + * Specified the shared gallery image unique id for vm deployment. This can be + * fetched from shared gallery image GET call. + */ + sharedGalleryImageId?: string; + + /** + * Specified the community gallery image unique id for vm deployment. This can be + * fetched from community gallery image GET call. + */ + communityGalleryImageId?: string; +} + +/** + * Describes a virtual machine scale set operating system disk. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "" +model VirtualMachineScaleSetOSDisk { + /** + * The disk name. + */ + name?: string; + + /** + * Specifies the caching requirements. Possible values are: **None,** + * **ReadOnly,** **ReadWrite.** The default values are: **None for Standard + * storage. ReadOnly for Premium storage.** + */ + caching?: CachingTypes; + + /** + * Specifies whether writeAccelerator should be enabled or disabled on the disk. + */ + writeAcceleratorEnabled?: boolean; + + /** + * Specifies how the virtual machines in the scale set should be created. The only + * allowed value is: **FromImage.** This value is used when you are using an image + * to create the virtual machine. If you are using a platform image, you also use + * the imageReference element described above. If you are using a marketplace + * image, you also use the plan element previously described. + */ + createOption: DiskCreateOptionTypes; + + /** + * Specifies the ephemeral disk Settings for the operating system disk used by the + * virtual machine scale set. + */ + diffDiskSettings?: DiffDiskSettings; + + /** + * Specifies the size of an empty data disk in gigabytes. This element can be used + * to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' + * is the number of bytes x 1024^3 for the disk and the value cannot + * be larger than 1023. + */ + diskSizeGB?: int32; + + /** + * This property allows you to specify the type of the OS that is included in the + * disk if creating a VM from user-image or a specialized VHD. Possible values + * are: **Windows,** **Linux.** + */ + osType?: OperatingSystemTypes; + + /** + * Specifies information about the unmanaged user image to base the scale set on. + */ + image?: VirtualHardDisk; + + /** + * Specifies the container urls that are used to store operating system disks for + * the scale set. + */ + vhdContainers?: string[]; + + /** + * The managed disk parameters. + */ + managedDisk?: VirtualMachineScaleSetManagedDiskParameters; + + /** + * Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion + * (This feature is available for VMSS with Flexible OrchestrationMode only). + *

Possible values:

**Delete** If this value is used, the OS + * disk is deleted when VMSS Flex VM is deleted.

**Detach** If this value + * is used, the OS disk is retained after VMSS Flex VM is deleted.

The + * default value is set to **Delete**. For an Ephemeral OS Disk, the default value + * is set to **Delete**. User cannot change the delete option for Ephemeral OS + * Disk. + */ + deleteOption?: DiskDeleteOptionTypes; +} + +/** + * Describes the parameters of ephemeral disk settings that can be specified for + * operating system disk. **Note:** The ephemeral disk settings can only be + * specified for managed disk. + */ +model DiffDiskSettings { + /** + * Specifies the ephemeral disk settings for operating system disk. + */ + option?: DiffDiskOptions; + + /** + * Specifies the ephemeral disk placement for operating system disk. Possible + * values are: **CacheDisk,** **ResourceDisk.** The defaulting behavior is: + * **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** + * is used. Refer to the VM size documentation for Windows VM at + * https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at + * https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM + * sizes exposes a cache disk. + */ + placement?: DiffDiskPlacement; +} + +/** + * Describes the uri of a disk. + */ +model VirtualHardDisk { + /** + * Specifies the virtual hard disk's uri. + */ + uri?: string; +} + +/** + * Describes the parameters of a ScaleSet managed disk. + */ +model VirtualMachineScaleSetManagedDiskParameters { + /** + * Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can + * only be used with data disks, it cannot be used with OS Disk. + */ + storageAccountType?: StorageAccountTypes; + + /** + * Specifies the customer managed disk encryption set resource id for the managed + * disk. + */ + diskEncryptionSet?: DiskEncryptionSetParameters; + + /** + * Specifies the security profile for the managed disk. + */ + securityProfile?: VMDiskSecurityProfile; +} + +/** + * Describes the parameter of customer managed disk encryption set resource id + * that can be specified for disk. **Note:** The disk encryption set resource id + * can only be specified for managed disk. Please refer + * https://aka.ms/mdssewithcmkoverview for more details. + */ +model DiskEncryptionSetParameters is SubResource; + +/** + * Specifies the security profile settings for the managed disk. **Note:** It can + * only be set for Confidential VMs. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "" +model VMDiskSecurityProfile { + /** + * Specifies the EncryptionType of the managed disk. It is set to + * DiskWithVMGuestState for encryption of the managed disk along with VMGuestState + * blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and + * NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. + * **Note:** It can be set for only Confidential VMs. + */ + securityEncryptionType?: SecurityEncryptionTypes; + + /** + * Specifies the customer managed disk encryption set resource id for the managed + * disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and + * VMGuest blob. + */ + diskEncryptionSet?: DiskEncryptionSetParameters; +} + +/** + * Describes a virtual machine scale set data disk. + */ +model VirtualMachineScaleSetDataDisk { + /** + * The disk name. + */ + name?: string; + + /** + * Specifies the logical unit number of the data disk. This value is used to + * identify data disks within the VM and therefore must be unique for each data + * disk attached to a VM. + */ + lun: int32; + + /** + * Specifies the caching requirements. Possible values are: **None,** + * **ReadOnly,** **ReadWrite.** The default values are: **None for Standard + * storage. ReadOnly for Premium storage.** + */ + caching?: CachingTypes; + + /** + * Specifies whether writeAccelerator should be enabled or disabled on the disk. + */ + writeAcceleratorEnabled?: boolean; + + /** + * The create option. + */ + createOption: DiskCreateOptionTypes; + + /** + * Specifies the size of an empty data disk in gigabytes. This element can be used + * to overwrite the size of the disk in a virtual machine image. The property + * diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be + * larger than 1023. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "" + diskSizeGB?: int32; + + /** + * The managed disk parameters. + */ + managedDisk?: VirtualMachineScaleSetManagedDiskParameters; + + /** + * Specifies the Read-Write IOPS for the managed disk. Should be used only when + * StorageAccountType is UltraSSD_LRS. If not specified, a default value would be + * assigned based on diskSizeGB. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "" + diskIOPSReadWrite?: int64; + + /** + * Specifies the bandwidth in MB per second for the managed disk. Should be used + * only when StorageAccountType is UltraSSD_LRS. If not specified, a default value + * would be assigned based on diskSizeGB. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "" + diskMBpsReadWrite?: int64; + + /** + * Specifies whether data disk should be deleted or detached upon VMSS Flex + * deletion (This feature is available for VMSS with Flexible OrchestrationMode + * only).

Possible values:

**Delete** If this value is used, the + * data disk is deleted when the VMSS Flex VM is deleted.

**Detach** If + * this value is used, the data disk is retained after VMSS Flex VM is + * deleted.

The default value is set to **Delete**. + */ + deleteOption?: DiskDeleteOptionTypes; +} + +/** + * Describes a virtual machine scale set network profile. + */ +model VirtualMachineScaleSetNetworkProfile { + /** + * A reference to a load balancer probe used to determine the health of an + * instance in the virtual machine scale set. The reference will be in the form: + * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. + */ + healthProbe?: ApiEntityReference; + + /** + * The list of network configurations. + */ + @OpenAPI.extension("x-ms-identifiers", []) + networkInterfaceConfigurations?: VirtualMachineScaleSetNetworkConfiguration[]; + + /** + * specifies the Microsoft.Network API version used when creating networking + * resources in the Network Interface Configurations for Virtual Machine Scale Set + * with orchestration mode 'Flexible' + */ + networkApiVersion?: NetworkApiVersion; +} + +/** + * The API entity reference. + */ +model ApiEntityReference { + /** + * The ARM resource id in the form of + * /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... + */ + id?: armResourceIdentifier; +} + +/** + * Describes a virtual machine scale set network profile's network configurations. + */ +model VirtualMachineScaleSetNetworkConfiguration { + /** + * The network configuration name. + */ + name: string; + + /** + * Describes a virtual machine scale set network profile's IP configuration. + */ + properties?: VirtualMachineScaleSetNetworkConfigurationProperties; +} + +/** + * Describes a virtual machine scale set network profile's IP configuration. + */ +model VirtualMachineScaleSetNetworkConfigurationProperties { + /** + * Specifies the primary network interface in case the virtual machine has more + * than 1 network interface. + */ + primary?: boolean; + + /** + * Specifies whether the network interface is accelerated networking-enabled. + */ + enableAcceleratedNetworking?: boolean; + + /** + * Specifies whether the network interface is disabled for tcp state tracking. + */ + disableTcpStateTracking?: boolean; + + /** + * Specifies whether the network interface is FPGA networking-enabled. + */ + enableFpga?: boolean; + + /** + * The network security group. + */ + networkSecurityGroup?: SubResource; + + /** + * The dns settings to be applied on the network interfaces. + */ + dnsSettings?: VirtualMachineScaleSetNetworkConfigurationDnsSettings; + + /** + * Specifies the IP configurations of the network interface. + */ + @OpenAPI.extension("x-ms-identifiers", ["name"]) + ipConfigurations: VirtualMachineScaleSetIPConfiguration[]; + + /** + * Whether IP forwarding enabled on this NIC. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "" + enableIPForwarding?: boolean; + + /** + * Specify what happens to the network interface when the VM is deleted + */ + deleteOption?: DeleteOptions; + + /** + * Specifies whether the Auxiliary mode is enabled for the Network Interface + * resource. + */ + auxiliaryMode?: NetworkInterfaceAuxiliaryMode; + + /** + * Specifies whether the Auxiliary sku is enabled for the Network Interface + * resource. + */ + auxiliarySku?: NetworkInterfaceAuxiliarySku; +} + +/** + * Describes a virtual machines scale sets network configuration's DNS settings. + */ +model VirtualMachineScaleSetNetworkConfigurationDnsSettings { + /** + * List of DNS servers IP addresses + */ + dnsServers?: string[]; +} + +/** + * Describes a virtual machine scale set network profile's IP configuration. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "" +model VirtualMachineScaleSetIPConfiguration { + /** + * The IP configuration name. + */ + name: string; + + /** + * Describes a virtual machine scale set network profile's IP configuration + * properties. + */ + properties?: VirtualMachineScaleSetIPConfigurationProperties; +} + +/** + * Describes a virtual machine scale set network profile's IP configuration + * properties. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "" +model VirtualMachineScaleSetIPConfigurationProperties { + /** + * Specifies the identifier of the subnet. + */ + subnet?: ApiEntityReference; + + /** + * Specifies the primary network interface in case the virtual machine has more + * than 1 network interface. + */ + primary?: boolean; + + /** + * The publicIPAddressConfiguration. + */ + publicIPAddressConfiguration?: VirtualMachineScaleSetPublicIPAddressConfiguration; + + /** + * Available from Api-Version 2017-03-30 onwards, it represents whether the + * specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible + * values are: 'IPv4' and 'IPv6'. + */ + privateIPAddressVersion?: IPVersion; + + /** + * Specifies an array of references to backend address pools of application + * gateways. A scale set can reference backend address pools of multiple + * application gateways. Multiple scale sets cannot use the same application + * gateway. + */ + applicationGatewayBackendAddressPools?: SubResource[]; + + /** + * Specifies an array of references to application security group. + */ + applicationSecurityGroups?: SubResource[]; + + /** + * Specifies an array of references to backend address pools of load balancers. A + * scale set can reference backend address pools of one public and one internal + * load balancer. Multiple scale sets cannot use the same basic sku load balancer. + */ + loadBalancerBackendAddressPools?: SubResource[]; + + /** + * Specifies an array of references to inbound Nat pools of the load balancers. A + * scale set can reference inbound nat pools of one public and one internal load + * balancer. Multiple scale sets cannot use the same basic sku load balancer. + */ + loadBalancerInboundNatPools?: SubResource[]; +} + +/** + * Describes a virtual machines scale set IP Configuration's PublicIPAddress + * configuration + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "" +model VirtualMachineScaleSetPublicIPAddressConfiguration { + /** + * The publicIP address configuration name. + */ + name: string; + + /** + * Describes a virtual machines scale set IP Configuration's PublicIPAddress + * configuration + */ + properties?: VirtualMachineScaleSetPublicIPAddressConfigurationProperties; + + /** + * Describes the public IP Sku. It can only be set with OrchestrationMode as + * Flexible. + */ + sku?: PublicIPAddressSku; +} + +/** + * Describes a virtual machines scale set IP Configuration's PublicIPAddress + * configuration + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "" +model VirtualMachineScaleSetPublicIPAddressConfigurationProperties { + /** + * The idle timeout of the public IP address. + */ + idleTimeoutInMinutes?: int32; + + /** + * The dns settings to be applied on the publicIP addresses . + */ + dnsSettings?: VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings; + + /** + * The list of IP tags associated with the public IP address. + */ + @OpenAPI.extension("x-ms-identifiers", []) + ipTags?: VirtualMachineScaleSetIpTag[]; + + /** + * The PublicIPPrefix from which to allocate publicIP addresses. + */ + publicIPPrefix?: SubResource; + + /** + * Available from Api-Version 2019-07-01 onwards, it represents whether the + * specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible + * values are: 'IPv4' and 'IPv6'. + */ + publicIPAddressVersion?: IPVersion; + + /** + * Specify what happens to the public IP when the VM is deleted + */ + deleteOption?: DeleteOptions; +} + +/** + * Describes a virtual machines scale sets network configuration's DNS settings. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "" +model VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings { + /** + * The Domain name label.The concatenation of the domain name label and vm index + * will be the domain name labels of the PublicIPAddress resources that will be + * created + */ + domainNameLabel: string; + + /** + * The Domain name label scope.The concatenation of the hashed domain name label + * that generated according to the policy from domain name label scope and vm + * index will be the domain name labels of the PublicIPAddress resources that will + * be created + */ + domainNameLabelScope?: DomainNameLabelScopeTypes; +} + +/** + * Contains the IP tag associated with the public IP address. + */ +model VirtualMachineScaleSetIpTag { + /** + * IP tag type. Example: FirstPartyUsage. + */ + ipTagType?: string; + + /** + * IP tag associated with the public IP. Example: SQL, Storage etc. + */ + tag?: string; +} + +/** + * Describes the public IP Sku. It can only be set with OrchestrationMode as + * Flexible. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "" +model PublicIPAddressSku { + /** + * Specify public IP sku name + */ + name?: PublicIPAddressSkuName; + + /** + * Specify public IP sku tier + */ + tier?: PublicIPAddressSkuTier; +} + +/** + * Specifies the Security profile settings for the virtual machine or virtual + * machine scale set. + */ +model SecurityProfile { + /** + * Specifies the security settings like secure boot and vTPM used while creating + * the virtual machine. Minimum api-version: 2020-12-01. + */ + uefiSettings?: UefiSettings; + + /** + * This property can be used by user in the request to enable or disable the Host + * Encryption for the virtual machine or virtual machine scale set. This will + * enable the encryption for all the disks including Resource/Temp disk at host + * itself. The default behavior is: The Encryption at host will be disabled unless + * this property is set to true for the resource. + */ + encryptionAtHost?: boolean; + + /** + * Specifies the SecurityType of the virtual machine. It has to be set to any + * specified value to enable UefiSettings. The default behavior is: UefiSettings + * will not be enabled unless this property is set. + */ + securityType?: SecurityTypes; + + /** + * Specifies the Managed Identity used by ADE to get access token for keyvault + * operations. + */ + encryptionIdentity?: EncryptionIdentity; + + /** + * Specifies ProxyAgent settings while creating the virtual machine. Minimum + * api-version: 2023-09-01. + */ + proxyAgentSettings?: ProxyAgentSettings; +} + +/** + * Specifies the security settings like secure boot and vTPM used while creating + * the virtual machine. Minimum api-version: 2020-12-01. + */ +model UefiSettings { + /** + * Specifies whether secure boot should be enabled on the virtual machine. Minimum + * api-version: 2020-12-01. + */ + secureBootEnabled?: boolean; + + /** + * Specifies whether vTPM should be enabled on the virtual machine. Minimum + * api-version: 2020-12-01. + */ + vTpmEnabled?: boolean; +} + +/** + * Specifies the Managed Identity used by ADE to get access token for keyvault + * operations. + */ +model EncryptionIdentity { + /** + * Specifies ARM Resource ID of one of the user identities associated with the VM. + */ + userAssignedIdentityResourceId?: armResourceIdentifier; +} + +/** + * Specifies ProxyAgent settings while creating the virtual machine. Minimum + * api-version: 2023-09-01. + */ +model ProxyAgentSettings { + /** + * Specifies whether ProxyAgent feature should be enabled on the virtual machine + * or virtual machine scale set. + */ + enabled?: boolean; + + /** + * Specifies the mode that ProxyAgent will execute on if the feature is enabled. + * ProxyAgent will start to audit or monitor but not enforce access control over + * requests to host endpoints in Audit mode, while in Enforce mode it will enforce + * access control. The default value is Enforce mode. + */ + mode?: Mode; + + /** + * Increase the value of this property allows user to reset the key used for + * securing communication channel between guest and host. + */ + keyIncarnationId?: int32; +} + +/** + * Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. + */ +model DiagnosticsProfile { + /** + * Boot Diagnostics is a debugging feature which allows you to view Console Output + * and Screenshot to diagnose VM status. **NOTE**: If storageUri is being + * specified then ensure that the storage account is in the same region and + * subscription as the VM. You can easily view the output of your console log. + * Azure also enables you to see a screenshot of the VM from the hypervisor. + */ + bootDiagnostics?: BootDiagnostics; +} + +/** + * Boot Diagnostics is a debugging feature which allows you to view Console Output + * and Screenshot to diagnose VM status. You can easily view the output of your + * console log. Azure also enables you to see a screenshot of the VM from the + * hypervisor. + */ +model BootDiagnostics { + /** + * Whether boot diagnostics should be enabled on the Virtual Machine. + */ + enabled?: boolean; + + /** + * Uri of the storage account to use for placing the console output and + * screenshot. If storageUri is not specified while enabling boot diagnostics, + * managed storage will be used. + */ + storageUri?: string; +} + +/** + * Describes a virtual machine scale set extension profile. + */ +model VirtualMachineScaleSetExtensionProfile { + /** + * The virtual machine scale set child extension resources. + */ + extensions?: VirtualMachineScaleSetExtension[]; + + /** + * Specifies the time alloted for all extensions to start. The time duration + * should be between 15 minutes and 120 minutes (inclusive) and should be + * specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). + * Minimum api-version: 2020-06-01. + */ + extensionsTimeBudget?: string; +} + +/** + * Describes a Virtual Machine Scale Set Extension. + */ +model VirtualMachineScaleSetExtension is SubResourceReadOnly { + /** + * The name of the extension. + */ + name?: string; + + /** + * Resource type + */ + @visibility("read") + type?: string; + + /** + * Describes the properties of a Virtual Machine Scale Set Extension. + */ + properties?: VirtualMachineScaleSetExtensionProperties; +} + +/** + * Describes the properties of a Virtual Machine Scale Set Extension. + */ +model VirtualMachineScaleSetExtensionProperties { + /** + * If a value is provided and is different from the previous value, the extension + * handler will be forced to update even if the extension configuration has not + * changed. + */ + forceUpdateTag?: string; + + /** + * The name of the extension handler publisher. + */ + publisher?: string; + + /** + * Specifies the type of the extension; an example is "CustomScriptExtension". + */ + type?: string; + + /** + * Specifies the version of the script handler. + */ + typeHandlerVersion?: string; + + /** + * Indicates whether the extension should use a newer minor version if one is + * available at deployment time. Once deployed, however, the extension will not + * upgrade minor versions unless redeployed, even with this property set to true. + */ + autoUpgradeMinorVersion?: boolean; + + /** + * Indicates whether the extension should be automatically upgraded by the + * platform if there is a newer version of the extension available. + */ + enableAutomaticUpgrade?: boolean; + + /** + * Json formatted public settings for the extension. + */ + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Converted legacy object to typespec https://github.com/Azure/azure-rest-api-specs/blob/d715112415eb08572ee96cc4bd77217aa44dedf1/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L5002C1-L5009C11" + settings?: Record; + + /** + * The extension can contain either protectedSettings or + * protectedSettingsFromKeyVault or no protected settings at all. + */ + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Converted legacy object to typespec https://github.com/Azure/azure-rest-api-specs/blob/d715112415eb08572ee96cc4bd77217aa44dedf1/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L5002C1-L5009C11" + @visibility("create", "update") + @OpenAPI.extension("x-ms-secret", true) + protectedSettings?: Record; + + /** + * The provisioning state, which only appears in the response. + */ + @visibility("read") + provisioningState?: string; + + /** + * Collection of extension names after which this extension needs to be + * provisioned. + */ + provisionAfterExtensions?: string[]; + + /** + * Indicates whether failures stemming from the extension will be suppressed + * (Operational failures such as not connecting to the VM will not be suppressed + * regardless of this value). The default is false. + */ + suppressFailures?: boolean; + + /** + * The extensions protected settings that are passed by reference, and consumed + * from key vault + */ + protectedSettingsFromKeyVault?: KeyVaultSecretReference; +} + +/** + * Describes a reference to Key Vault Secret + */ +model KeyVaultSecretReference { + /** + * The URL referencing a secret in a Key Vault. + */ + secretUrl: string; + + /** + * The relative URL of the Key Vault containing the secret. + */ + sourceVault: SubResource; +} + +/** + * Describes a Readonly subresource. + */ +model SubResourceReadOnly { + /** + * Resource Id + */ + @visibility("read") + id?: armResourceIdentifier; +} + +/** + * Specifies Scheduled Event related configurations. + */ +model ScheduledEventsProfile { + /** + * Specifies Terminate Scheduled Event related configurations. + */ + terminateNotificationProfile?: TerminateNotificationProfile; + + /** + * Specifies OS Image Scheduled Event related configurations. + */ + osImageNotificationProfile?: OSImageNotificationProfile; +} + +/** + * Specifies Terminate Scheduled Event related configurations. + */ +model TerminateNotificationProfile { + /** + * Configurable length of time a Virtual Machine being deleted will have to + * potentially approve the Terminate Scheduled Event before the event is auto + * approved (timed out). The configuration must be specified in ISO 8601 format, + * the default value is 5 minutes (PT5M) + */ + notBeforeTimeout?: string; + + /** + * Specifies whether the Terminate Scheduled event is enabled or disabled. + */ + enable?: boolean; +} + +/** + * Specifies OS Image Scheduled Event related configurations. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "" +model OSImageNotificationProfile { + /** + * Length of time a Virtual Machine being reimaged or having its OS upgraded will + * have to potentially approve the OS Image Scheduled Event before the event is + * auto approved (timed out). The configuration is specified in ISO 8601 format, + * and the value must not exceed 15 minutes (PT15M) + */ + notBeforeTimeout?: string; + + /** + * Specifies whether the OS Image Scheduled event is enabled or disabled. + */ + enable?: boolean; +} + +/** + * The parameters of a capacity reservation Profile. + */ +model CapacityReservationProfile { + /** + * Specifies the capacity reservation group resource id that should be used for + * allocating the virtual machine or scaleset vm instances provided enough + * capacity has been reserved. Please refer to https://aka.ms/CapacityReservation + * for more details. + */ + capacityReservationGroup?: SubResource; +} + +/** + * Contains the list of gallery applications that should be made available to the + * VM/VMSS + */ +model ApplicationProfile { + /** + * Specifies the gallery applications that should be made available to the VM/VMSS + */ + @OpenAPI.extension("x-ms-identifiers", ["packageReferenceId"]) + galleryApplications?: VMGalleryApplication[]; +} + +/** + * Specifies the required information to reference a compute gallery application + * version + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "" +model VMGalleryApplication { + /** + * Optional, Specifies a passthrough value for more generic context. + */ + tags?: string; + + /** + * Optional, Specifies the order in which the packages have to be installed + */ + order?: int32; + + /** + * Specifies the GalleryApplicationVersion resource id on the form of + * /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} + */ + packageReferenceId: armResourceIdentifier; + + /** + * Optional, Specifies the uri to an azure blob that will replace the default + * configuration for the package if provided + */ + configurationReference?: string; + + /** + * Optional, If true, any failure for any operation in the VmApplication will fail + * the deployment + */ + treatFailureAsDeploymentFailure?: boolean; + + /** + * If set to true, when a new Gallery Application version is available in PIR/SIG, + * it will be automatically updated for the VM/VMSS + */ + enableAutomaticUpgrade?: boolean; +} + +/** + * Specifies the hardware settings for the virtual machine scale set. + */ +model VirtualMachineScaleSetHardwareProfile { + /** + * Specifies the properties for customizing the size of the virtual machine. + * Minimum api-version: 2021-11-01. Please follow the instructions in [VM + * Customization](https://aka.ms/vmcustomization) for more details. + */ + vmSizeProperties?: VMSizeProperties; +} + +/** + * Specifies VM Size Property settings on the virtual machine. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "" +model VMSizeProperties { + /** + * Specifies the number of vCPUs available for the VM. When this property is not + * specified in the request body the default behavior is to set it to the value of + * vCPUs available for that VM size exposed in api response of [List all available + * virtual machine sizes in a + * region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list). + */ + vCPUsAvailable?: int32; + + /** + * Specifies the vCPU to physical core ratio. When this property is not specified + * in the request body the default behavior is set to the value of vCPUsPerCore + * for the VM Size exposed in api response of [List all available virtual machine + * sizes in a + * region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list). + * **Setting this property to 1 also means that hyper-threading is disabled.** + */ + vCPUsPerCore?: int32; +} + +/** + * Specifies the service artifact reference id used to set same image version for + * all virtual machines in the scale set when using 'latest' image version. + * Minimum api-version: 2022-11-01 + */ +model ServiceArtifactReference { + /** + * The service artifact reference id in the form of + * /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} + */ + id?: armResourceIdentifier; +} + +/** + * Specifies the security posture to be used for all virtual machines in the scale + * set. Minimum api-version: 2023-03-01 + */ +model SecurityPostureReference { + /** + * The security posture reference id in the form of + * /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest + */ + id?: string; + + /** + * List of virtual machine extension names to exclude when applying the security + * posture. + */ + excludeExtensions?: string[]; + + /** + * Whether the security posture can be overridden by the user. + */ + isOverridable?: boolean; +} + +/** + * Specifies the name of the setting to which the content applies. Possible values + * are: FirstLogonCommands and AutoLogon. + */ +union SettingNames { + string, + + /** + * AutoLogon setting + */ + AutoLogon: "AutoLogon", + + /** + * FirstLogonCommands setting + */ + FirstLogonCommands: "FirstLogonCommands", +} + +/** + * Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual + * machines associated to virtual machine scale set with OrchestrationMode as + * Flexible. + */ +union WindowsVMGuestPatchMode { + string, + + /** + * You control the application of patches to a virtual machine. + * You do this by applying patches manually inside the VM. In this mode, + * automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates + * must be false + */ + Manual: "Manual", + + /** + * The virtual machine will automatically be updated by the OS. + * The property WindowsConfiguration.enableAutomaticUpdates must be true. + */ + AutomaticByOS: "AutomaticByOS", + + /** + * The virtual machine will automatically updated by the platform. The properties + * provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true. + */ + AutomaticByPlatform: "AutomaticByPlatform", +} + +/** + * Specifies the mode of VM Guest patch assessment for the IaaS virtual machine. + */ +union WindowsPatchAssessmentMode { + string, + + /** + * You control the timing of patch assessments on a virtual machine. + */ + ImageDefault: "ImageDefault", + + /** + * The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. + */ + AutomaticByPlatform: "AutomaticByPlatform", +} + +/** + * Specifies the reboot setting for all AutomaticByPlatform patch installation operations. + */ +union WindowsVMGuestPatchAutomaticByPlatformRebootSetting { + string, + + /** + * Unknown Reboot setting + */ + Unknown: "Unknown", + + /** + * IfRequired Reboot setting + */ + IfRequired: "IfRequired", + + /** + * Never Reboot setting + */ + Never: "Never", + + /** + * Always Reboot setting + */ + Always: "Always", +} + +/** + * Specifies the protocol of WinRM listener. Possible values are: **http,** + * **https.** + */ +union ProtocolTypes { + string, + + /** + * Http protocol + */ + Http: "Http", + + /** + * Https protocol + */ + Https: "Https", +} + +/** + * Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual + * machines associated to virtual machine scale set with OrchestrationMode as + * Flexible. + */ +union LinuxVMGuestPatchMode { + string, + + /** + * The virtual machine's default patching configuration is used. + */ + ImageDefault: "ImageDefault", + + /** + * The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true. + */ + AutomaticByPlatform: "AutomaticByPlatform", +} + +/** + * Specifies the mode of VM Guest Patch Assessment for the IaaS virtual + * machine.

Possible values are:

**ImageDefault** - You + * control the timing of patch assessments on a virtual machine.

+ * **AutomaticByPlatform** - The platform will trigger periodic patch assessments. + * The property provisionVMAgent must be true. + */ +union LinuxPatchAssessmentMode { + string, + + /** + * You control the timing of patch assessments on a virtual machine. + */ + ImageDefault: "ImageDefault", + + /** + * The platform will trigger periodic patch assessments.The property provisionVMAgent must be true. + */ + AutomaticByPlatform: "AutomaticByPlatform", +} + +/** + * Specifies the reboot setting for all AutomaticByPlatform patch installation + * operations. + */ +union LinuxVMGuestPatchAutomaticByPlatformRebootSetting { + string, + + /** + * Unknown Reboot setting + */ + Unknown: "Unknown", + + /** + * IfRequired Reboot setting + */ + IfRequired: "IfRequired", + + /** + * Never Reboot setting + */ + Never: "Never", + + /** + * Always Reboot setting + */ + Always: "Always", +} + +/** + * Specifies the caching requirements. + */ +union CachingTypes { + string, + + /** + * 'None' is default for Standard Storage + */ + None: "None", + + /** + * 'ReadOnly' is default for Premium Storage + */ + ReadOnly: "ReadOnly", + + /** + * 'ReadWrite' is default for OS Disk + */ + ReadWrite: "ReadWrite", +} + +/** + * This property allows you to specify the type of the OS that is included in the + * disk if creating a VM from user-image or a specialized VHD. Possible values + * are: **Windows,** **Linux.** + */ +union OperatingSystemTypes { + string, + + /** + * Windows OS type + */ + Windows: "Windows", + + /** + * Linux OS type + */ + Linux: "Linux", +} + +/** + * Specifies how the virtual machine should be created. + */ +union DiskCreateOptionTypes { + string, + + /** + * This value is used when you are using an image to create the virtual machine. + * If you are using a platform image, you also use the imageReference element + * described above. If you are using a marketplace image, you also use the + * plan element previously described. + */ + FromImage: "FromImage", + + /** + * This value is used when creating an empty data disk. + */ + Empty: "Empty", + + /** + * This value is used when you are using a specialized disk to create the virtual machine. + */ + Attach: "Attach", + + /** + * This value is used to create a data disk from a snapshot or another disk. + */ + Copy: "Copy", + + /** + * This value is used to create a data disk from a disk restore point. + */ + Restore: "Restore", +} + +/** + * Specifies the behavior of the managed disk when the VM gets deleted, for + * example whether the managed disk is deleted or detached. Supported values are: + * **Delete.** If this value is used, the managed disk is deleted when VM gets + * deleted. **Detach.** If this value is used, the managed disk is retained after + * VM gets deleted. Minimum api-version: 2021-03-01. + */ +union DiskDeleteOptionTypes { + string, + + /** + * If this value is used, the managed disk is deleted when VM gets deleted. + */ + Delete: "Delete", + + /** + * If this value is used, the managed disk is retained after VM gets deleted. + */ + Detach: "Detach", +} + +/** + * Specifies the ephemeral disk option for operating system disk. + */ +union DiffDiskOptions { + string, + + /** + * Local Option. + */ + Local: "Local", +} + +/** + * Specifies the ephemeral disk placement for operating system disk. This property + * can be used by user in the request to choose the location i.e, cache disk or + * resource disk space for Ephemeral OS disk provisioning. For more information on + * Ephemeral OS disk size requirements, please refer Ephemeral OS disk size + * requirements for Windows VM at + * https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements + * and Linux VM at + * https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements + * Minimum api-version for NvmeDisk: 2024-03-01. + */ +union DiffDiskPlacement { + string, + + /** + * CacheDisk option. + */ + CacheDisk: "CacheDisk", + + /** + * Resource Disk option. + */ + ResourceDisk: "ResourceDisk", + + /** + * NvmeDisk option. + */ + NvmeDisk: "NvmeDisk", +} + +/** + * Specifies the storage account type for the managed disk. Managed OS disk + * storage account type can only be set when you create the scale set. NOTE: + * UltraSSD_LRS can only be used with data disks. It cannot be used with OS Disk. + * Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS + * uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD + * zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant + * storage. For more information regarding disks supported for Windows Virtual + * Machines, refer to + * https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for + * Linux Virtual Machines, refer to + * https://docs.microsoft.com/azure/virtual-machines/linux/disks-types + */ +union StorageAccountTypes { + string, + + /** + * Standard_LRS option. + */ + Standard_LRS: "Standard_LRS", + + /** + * Premium_LRS option. + */ + Premium_LRS: "Premium_LRS", + + /** + * StandardSSD_LRS option. + */ + StandardSSD_LRS: "StandardSSD_LRS", + + /** + * UltraSSD_LRS option. + */ + UltraSSD_LRS: "UltraSSD_LRS", + + /** + * Premium_ZRS option. + */ + Premium_ZRS: "Premium_ZRS", + + /** + * StandardSSD_ZRS option. + */ + StandardSSD_ZRS: "StandardSSD_ZRS", + + /** + * PremiumV2_LRS option. + */ + PremiumV2_LRS: "PremiumV2_LRS", +} + +/** + * Specifies the EncryptionType of the managed disk. + * **Note:** It can be set for only Confidential VMs. + */ +union SecurityEncryptionTypes { + string, + + /** + * EncryptionType of the managed disk is set to VMGuestStateOnly for encryption + * of just the VMGuestState blob. + */ + VMGuestStateOnly: "VMGuestStateOnly", + + /** + * EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption + * of the managed disk along with VMGuestState blob. + */ + DiskWithVMGuestState: "DiskWithVMGuestState", + + /** + * EncryptionType of the managed disk is set to NonPersistedTPM for not persisting + * firmware state in the VMGuestState blob. + */ + NonPersistedTPM: "NonPersistedTPM", +} + +/** + * specifies the Microsoft.Network API version used when creating networking + * resources in the Network Interface Configurations for Virtual Machine Scale Set + * with orchestration mode 'Flexible' + */ +union NetworkApiVersion { + string, + + /** + * Initial version supported. Later versions are supported as well. + */ + `2020-11-01`: "2020-11-01", +} + +/** + * Specify what happens to the network interface when the VM is deleted + */ +union DeleteOptions { + string, + + /** + * Delete Option + */ + Delete: "Delete", + + /** + * Detach Option + */ + Detach: "Detach", +} + +/** + * Specifies whether the Auxiliary mode is enabled for the Network Interface + * resource. + */ +union NetworkInterfaceAuxiliaryMode { + string, + + /** + * None Mode + */ + None: "None", + + /** + * AcceleratedConnections Mode + */ + AcceleratedConnections: "AcceleratedConnections", + + /** + * Floating Mode + */ + Floating: "Floating", +} + +/** + * Specifies whether the Auxiliary sku is enabled for the Network Interface + * resource. + */ +union NetworkInterfaceAuxiliarySku { + string, + + /** + * no sku + */ + None: "None", + + /** + * A1 sku + */ + A1: "A1", + + /** + * A2 sku + */ + A2: "A2", + + /** + * A4 sku + */ + A4: "A4", + + /** + * A8 sku + */ + A8: "A8", +} + +/** + * Available from Api-Version 2017-03-30 onwards, it represents whether the + * specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible + * values are: 'IPv4' and 'IPv6'. + */ +union IPVersion { + string, + + /** + * IPv4 version + */ + IPv4: "IPv4", + + /** + * IPv6 version + */ + IPv6: "IPv6", +} + +/** + * The Domain name label scope.The concatenation of the hashed domain name label + * that generated according to the policy from domain name label scope and vm + * index will be the domain name labels of the PublicIPAddress resources that will + * be created + */ +union DomainNameLabelScopeTypes { + string, + + /** + * TenantReuse type + */ + TenantReuse: "TenantReuse", + + /** + * SubscriptionReuse type + */ + SubscriptionReuse: "SubscriptionReuse", + + /** + * ResourceGroupReuse type + */ + ResourceGroupReuse: "ResourceGroupReuse", + + /** + * NoReuse type + */ + NoReuse: "NoReuse", +} + +/** + * Specify public IP sku name. + */ +union PublicIPAddressSkuName { + string, + + /** + * Basic sku name + */ + Basic: "Basic", + + /** + * Standard sku name + */ + Standard: "Standard", +} + +/** + * Specify public IP sku tier + */ +union PublicIPAddressSkuTier { + string, + + /** + * Regional sku tier + */ + Regional: "Regional", + + /** + * Global sku tier + */ + Global: "Global", +} + +/** + * Specifies the SecurityType of the virtual machine. It has to be set to any + * specified value to enable UefiSettings. The default behavior is: UefiSettings + * will not be enabled unless this property is set. + */ +union SecurityTypes { + string, + + /** + * TrustedLaunch security type + */ + TrustedLaunch: "TrustedLaunch", + + /** + * ConfidentialVM security type + */ + ConfidentialVM: "ConfidentialVM", +} + +/** + * Specifies the mode that ProxyAgent will execute on if the feature is enabled. + * ProxyAgent will start to audit or monitor but not enforce access control over + * requests to host endpoints in Audit mode, while in Enforce mode it will enforce + * access control. The default value is Enforce mode. + */ +union Mode { + string, + + /** + * Audit Mode + */ + Audit: "Audit", + + /** + * Enforce Mode + */ + Enforce: "Enforce", +} + +/** + * The level code. + */ +union StatusLevelTypes { + string, + + /** + * Info level + */ + Info: "Info", + + /** + * Warning level + */ + Warning: "Warning", + + /** + * Error Level + */ + Error: "Error", +} + +/** + * Specifies the disk controller type configured for the VM and + * VirtualMachineScaleSet. This property is only supported for virtual machines + * whose operating system disk and VM sku supports Generation 2 + * (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), please + * check the HyperVGenerations capability returned as part of VM sku capabilities + * in the response of Microsoft.Compute SKUs api for the region contains V2 + * (https://docs.microsoft.com/rest/api/compute/resourceskus/list). For more + * information about Disk Controller Types supported please refer to + * https://aka.ms/azure-diskcontrollertypes. + */ +union DiskControllerTypes { + string, + + /** + * SCSI disk type + */ + SCSI: "SCSI", + + /** + * NVMe disk type + */ + NVMe: "NVMe", +} diff --git a/specification/azurefleet/AzureFleet.Management/common.tsp b/specification/azurefleet/AzureFleet.Management/common.tsp index d8bc97b05ebb..42650bba1b2b 100644 --- a/specification/azurefleet/AzureFleet.Management/common.tsp +++ b/specification/azurefleet/AzureFleet.Management/common.tsp @@ -1,19 +1,44 @@ import "@typespec/http"; import "@typespec/rest"; import "@typespec/versioning"; -import "@azure-tools/typespec-autorest"; import "@azure-tools/typespec-azure-core"; import "@azure-tools/typespec-azure-resource-manager"; using TypeSpec.Http; using TypeSpec.Rest; using TypeSpec.Versioning; -using Autorest; using Azure.ResourceManager; using OpenAPI; namespace Microsoft.AzureFleet; @doc("ApiError for Fleet") -@useRef("../../../../../compute/resource-manager/Microsoft.Compute/common-types/v1/common.json#/definitions/ApiError") -model ApiError {} +model ApiError is ApiErrorBase { + @extension("x-ms-identifiers", ["message", "target"]) + @doc("The API error details") + details?: Array; + + @doc("The API inner error") + innererror?: InnerError; +} + +@doc("API error base.") +model ApiErrorBase { + @doc("The error code.") + code?: string; + + @doc("The target of the particular error.") + target?: string; + + @doc("The error message.") + message?: string; +} + +@doc("Inner error details.") +model InnerError { + @doc("The exception type.") + exceptionType?: string; + + @doc("The internal error message or exception dump.") + errorDetail?: string; +} diff --git a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_CreateOrUpdate_MaximumSet.json b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_CreateOrUpdate_MaximumSet.json index 58e8fcb80aed..a6ecbf71369b 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_CreateOrUpdate_MaximumSet.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_CreateOrUpdate_MaximumSet.json @@ -87,7 +87,7 @@ "secrets": [ { "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -108,7 +108,7 @@ "version": "nhzyxfc", "sharedGalleryImageId": "mkfpnxoxmkyrwpab", "communityGalleryImageId": "ujhxcd", - "id": "eouuvblwiuykzebjh" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" }, "osDisk": { "name": "qzchzeaaxupl", @@ -130,12 +130,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -152,12 +152,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -170,7 +170,7 @@ }, "networkProfile": { "healthProbe": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -181,7 +181,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -193,7 +193,7 @@ "name": "et", "properties": { "subnet": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -211,7 +211,7 @@ } ], "publicIPPrefix": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -224,22 +224,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -262,7 +262,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "ymhqsov" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -296,7 +296,7 @@ "protectedSettingsFromKeyVault": { "secretUrl": "qmjoynsytvnjzutetnkog", "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } } } @@ -318,7 +318,7 @@ "userData": "jhlyuc", "capacityReservation": { "capacityReservationGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -326,7 +326,7 @@ { "tags": "bevijlsuchspoihzlfjczuqttaqz", "order": 4, - "packageReferenceId": "aabkcborasmyowocjceldewmkci", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "configurationReference": "auikpeahpgodbqdih", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true @@ -340,61 +340,14 @@ } }, "serviceArtifactReference": { - "id": "qqqxnjehbgcepcfldzifjkwlzusn" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { - "id": "zwtxjdjwedxmhpcoii", + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "eleagpulycjgvscuulb", - "publisher": "rwaucnzfffywlsaoqltkmsynni", - "type": "rgnq", - "typeHandlerVersion": "hyyj", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "instanceView": { - "name": "xxnjefzqotctmujsqpmyleaie", - "type": "cycepellfcdujniys", - "typeHandlerVersion": "jefntwzzgxsbzncchhefqiqbs", - "substatuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ], - "statuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "qmjoynsytvnjzutetnkog", - "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" - } - }, - "provisionAfterExtensions": [ - "aysdon" - ] - }, - "location": "jzecxhirbtegqxpyk", - "tags": { - "key4849": "hqnzzgyumfzflmyjxklwslb" - } - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true } }, "computeApiVersion": "2023-07-01" @@ -411,6 +364,13 @@ "userAssignedIdentities": { "identityUrl": {} } + }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" } } }, @@ -494,7 +454,7 @@ "secrets": [ { "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -516,7 +476,7 @@ "exactVersion": "hfph", "sharedGalleryImageId": "mkfpnxoxmkyrwpab", "communityGalleryImageId": "ujhxcd", - "id": "eouuvblwiuykzebjh" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" }, "osDisk": { "name": "qzchzeaaxupl", @@ -538,12 +498,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -560,12 +520,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -578,7 +538,7 @@ }, "networkProfile": { "healthProbe": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -589,7 +549,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -601,7 +561,7 @@ "name": "et", "properties": { "subnet": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -619,7 +579,7 @@ } ], "publicIPPrefix": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -632,22 +592,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -670,7 +630,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "ymhqsov" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -697,8 +657,7 @@ "autoUpgradeMinorVersion": true, "enableAutomaticUpgrade": true, "settings": {}, - "protectedSettings": {}, - "provisioningState": "kauilerjryyvizdqoazz", + "provisioningState": "Succeeded", "provisionAfterExtensions": [ "babgtjyllusylxsnfvepitrkmkcx" ], @@ -706,11 +665,11 @@ "protectedSettingsFromKeyVault": { "secretUrl": "qmjoynsytvnjzutetnkog", "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } } }, - "id": "qx" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" } ], "extensionsTimeBudget": "srvemetinivyy" @@ -729,7 +688,7 @@ "userData": "jhlyuc", "capacityReservation": { "capacityReservationGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -737,8 +696,7 @@ { "tags": "bevijlsuchspoihzlfjczuqttaqz", "order": 4, - "packageReferenceId": "aabkcborasmyowocjceldewmkci", - "configurationReference": "auikpeahpgodbqdih", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true } @@ -751,76 +709,34 @@ } }, "serviceArtifactReference": { - "id": "qqqxnjehbgcepcfldzifjkwlzusn" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { - "id": "zwtxjdjwedxmhpcoii", + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "eleagpulycjgvscuulb", - "publisher": "rwaucnzfffywlsaoqltkmsynni", - "type": "rgnq", - "typeHandlerVersion": "hyyj", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "provisioningState": "rmhlppcusvaiepeqafd", - "instanceView": { - "name": "xxnjefzqotctmujsqpmyleaie", - "type": "cycepellfcdujniys", - "typeHandlerVersion": "jefntwzzgxsbzncchhefqiqbs", - "substatuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ], - "statuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "qmjoynsytvnjzutetnkog", - "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" - } - }, - "provisionAfterExtensions": [ - "aysdon" - ] - }, - "location": "jzecxhirbtegqxpyk", - "id": "vlgmhpmsbktwfzbioynslximoohfc", - "name": "qchtvtoulax", - "type": "shqqxyvbipxzaxjbsesymzgrfybww", - "tags": { - "key4849": "hqnzzgyumfzflmyjxklwslb" - } - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true }, "timeCreated": "2024-01-28T09:08:15.995Z" }, "computeApiVersion": "2023-07-01" }, - "provisioningState": "Succeeded" + "provisioningState": "Succeeded", + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" }, "zones": [ "zone1", "zone2" ], + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, "tags": {}, "location": "westus", "identity": { @@ -929,7 +845,7 @@ "secrets": [ { "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -951,7 +867,7 @@ "exactVersion": "hfph", "sharedGalleryImageId": "mkfpnxoxmkyrwpab", "communityGalleryImageId": "ujhxcd", - "id": "eouuvblwiuykzebjh" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" }, "osDisk": { "name": "qzchzeaaxupl", @@ -973,12 +889,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -995,12 +911,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -1013,7 +929,7 @@ }, "networkProfile": { "healthProbe": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -1024,7 +940,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -1036,7 +952,7 @@ "name": "et", "properties": { "subnet": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -1054,7 +970,7 @@ } ], "publicIPPrefix": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -1067,22 +983,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -1105,7 +1021,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "ymhqsov" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -1132,8 +1048,7 @@ "autoUpgradeMinorVersion": true, "enableAutomaticUpgrade": true, "settings": {}, - "protectedSettings": {}, - "provisioningState": "kauilerjryyvizdqoazz", + "provisioningState": "Succeeded", "provisionAfterExtensions": [ "babgtjyllusylxsnfvepitrkmkcx" ], @@ -1141,11 +1056,11 @@ "protectedSettingsFromKeyVault": { "secretUrl": "qmjoynsytvnjzutetnkog", "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } } }, - "id": "qx" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" } ], "extensionsTimeBudget": "srvemetinivyy" @@ -1164,7 +1079,7 @@ "userData": "jhlyuc", "capacityReservation": { "capacityReservationGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -1172,8 +1087,7 @@ { "tags": "bevijlsuchspoihzlfjczuqttaqz", "order": 4, - "packageReferenceId": "aabkcborasmyowocjceldewmkci", - "configurationReference": "auikpeahpgodbqdih", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true } @@ -1186,71 +1100,22 @@ } }, "serviceArtifactReference": { - "id": "qqqxnjehbgcepcfldzifjkwlzusn" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { - "id": "zwtxjdjwedxmhpcoii", + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "eleagpulycjgvscuulb", - "publisher": "rwaucnzfffywlsaoqltkmsynni", - "type": "rgnq", - "typeHandlerVersion": "hyyj", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "provisioningState": "rmhlppcusvaiepeqafd", - "instanceView": { - "name": "xxnjefzqotctmujsqpmyleaie", - "type": "cycepellfcdujniys", - "typeHandlerVersion": "jefntwzzgxsbzncchhefqiqbs", - "substatuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ], - "statuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "qmjoynsytvnjzutetnkog", - "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" - } - }, - "provisionAfterExtensions": [ - "aysdon" - ] - }, - "location": "jzecxhirbtegqxpyk", - "id": "vlgmhpmsbktwfzbioynslximoohfc", - "name": "qchtvtoulax", - "type": "shqqxyvbipxzaxjbsesymzgrfybww", - "tags": { - "key4849": "hqnzzgyumfzflmyjxklwslb" - } - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true }, "timeCreated": "2024-01-28T09:08:15.995Z" }, "computeApiVersion": "2023-07-01" }, - "provisioningState": "Succeeded" + "provisioningState": "Succeeded", + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" }, "zones": [ "zone1", @@ -1258,6 +1123,13 @@ ], "tags": {}, "location": "westus", + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, "identity": { "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c", "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c", diff --git a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Get_MaximumSet.json b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Get_MaximumSet.json index b080f05cdc68..a52280192c0a 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Get_MaximumSet.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Get_MaximumSet.json @@ -87,7 +87,7 @@ "secrets": [ { "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -109,7 +109,7 @@ "exactVersion": "hfph", "sharedGalleryImageId": "mkfpnxoxmkyrwpab", "communityGalleryImageId": "ujhxcd", - "id": "eouuvblwiuykzebjh" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" }, "osDisk": { "name": "qzchzeaaxupl", @@ -131,12 +131,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -153,12 +153,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -171,7 +171,7 @@ }, "networkProfile": { "healthProbe": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -182,7 +182,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -194,7 +194,7 @@ "name": "et", "properties": { "subnet": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -212,7 +212,7 @@ } ], "publicIPPrefix": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -225,22 +225,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -263,7 +263,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "ymhqsov" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -290,8 +290,7 @@ "autoUpgradeMinorVersion": true, "enableAutomaticUpgrade": true, "settings": {}, - "protectedSettings": {}, - "provisioningState": "kauilerjryyvizdqoazz", + "provisioningState": "Succeeded", "provisionAfterExtensions": [ "babgtjyllusylxsnfvepitrkmkcx" ], @@ -299,11 +298,11 @@ "protectedSettingsFromKeyVault": { "secretUrl": "qmjoynsytvnjzutetnkog", "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } } }, - "id": "qx" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" } ], "extensionsTimeBudget": "srvemetinivyy" @@ -322,7 +321,7 @@ "userData": "jhlyuc", "capacityReservation": { "capacityReservationGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -330,8 +329,7 @@ { "tags": "bevijlsuchspoihzlfjczuqttaqz", "order": 4, - "packageReferenceId": "aabkcborasmyowocjceldewmkci", - "configurationReference": "auikpeahpgodbqdih", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true } @@ -344,71 +342,22 @@ } }, "serviceArtifactReference": { - "id": "qqqxnjehbgcepcfldzifjkwlzusn" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { - "id": "zwtxjdjwedxmhpcoii", + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "eleagpulycjgvscuulb", - "publisher": "rwaucnzfffywlsaoqltkmsynni", - "type": "rgnq", - "typeHandlerVersion": "hyyj", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "provisioningState": "rmhlppcusvaiepeqafd", - "instanceView": { - "name": "xxnjefzqotctmujsqpmyleaie", - "type": "cycepellfcdujniys", - "typeHandlerVersion": "jefntwzzgxsbzncchhefqiqbs", - "substatuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ], - "statuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "qmjoynsytvnjzutetnkog", - "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" - } - }, - "provisionAfterExtensions": [ - "aysdon" - ] - }, - "location": "jzecxhirbtegqxpyk", - "id": "vlgmhpmsbktwfzbioynslximoohfc", - "name": "qchtvtoulax", - "type": "shqqxyvbipxzaxjbsesymzgrfybww", - "tags": { - "key4849": "hqnzzgyumfzflmyjxklwslb" - } - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true }, "timeCreated": "2024-01-28T09:08:15.995Z" }, "computeApiVersion": "2023-07-01" }, - "provisioningState": "Succeeded" + "provisioningState": "Succeeded", + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" }, "zones": [ "zone1", @@ -416,6 +365,13 @@ ], "tags": {}, "location": "westus", + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, "identity": { "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c", "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c", diff --git a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_ListByResourceGroup_MaximumSet.json b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_ListByResourceGroup_MaximumSet.json index 1ddb67117d37..873082abde6e 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_ListByResourceGroup_MaximumSet.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_ListByResourceGroup_MaximumSet.json @@ -89,7 +89,7 @@ "secrets": [ { "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -111,7 +111,7 @@ "exactVersion": "hfph", "sharedGalleryImageId": "mkfpnxoxmkyrwpab", "communityGalleryImageId": "ujhxcd", - "id": "eouuvblwiuykzebjh" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" }, "osDisk": { "name": "qzchzeaaxupl", @@ -133,12 +133,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -155,12 +155,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -173,7 +173,7 @@ }, "networkProfile": { "healthProbe": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -184,7 +184,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -196,7 +196,7 @@ "name": "et", "properties": { "subnet": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -214,7 +214,7 @@ } ], "publicIPPrefix": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -227,22 +227,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -265,7 +265,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "ymhqsov" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -292,8 +292,7 @@ "autoUpgradeMinorVersion": true, "enableAutomaticUpgrade": true, "settings": {}, - "protectedSettings": {}, - "provisioningState": "kauilerjryyvizdqoazz", + "provisioningState": "Succeeded", "provisionAfterExtensions": [ "babgtjyllusylxsnfvepitrkmkcx" ], @@ -301,11 +300,11 @@ "protectedSettingsFromKeyVault": { "secretUrl": "qmjoynsytvnjzutetnkog", "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } } }, - "id": "qx" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" } ], "extensionsTimeBudget": "srvemetinivyy" @@ -324,7 +323,7 @@ "userData": "nwrklspknozvftyi", "capacityReservation": { "capacityReservationGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -332,8 +331,7 @@ { "tags": "bevijlsuchspoihzlfjczuqttaqz", "order": 4, - "packageReferenceId": "aabkcborasmyowocjceldewmkci", - "configurationReference": "auikpeahpgodbqdih", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true } @@ -346,70 +344,21 @@ } }, "serviceArtifactReference": { - "id": "qqqxnjehbgcepcfldzifjkwlzusn" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { - "id": "zwtxjdjwedxmhpcoii", + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "eleagpulycjgvscuulb", - "publisher": "rwaucnzfffywlsaoqltkmsynni", - "type": "rgnq", - "typeHandlerVersion": "hyyj", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "provisioningState": "rmhlppcusvaiepeqafd", - "instanceView": { - "name": "xxnjefzqotctmujsqpmyleaie", - "type": "cycepellfcdujniys", - "typeHandlerVersion": "jefntwzzgxsbzncchhefqiqbs", - "substatuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ], - "statuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "qmjoynsytvnjzutetnkog", - "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" - } - }, - "provisionAfterExtensions": [ - "aysdon" - ] - }, - "location": "jzecxhirbtegqxpyk", - "id": "vlgmhpmsbktwfzbioynslximoohfc", - "name": "qchtvtoulax", - "type": "shqqxyvbipxzaxjbsesymzgrfybww", - "tags": { - "key4849": "hqnzzgyumfzflmyjxklwslb" - } - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true }, "timeCreated": "2024-01-28T09:08:15.992Z" }, "computeApiVersion": "2023-07-01" - } + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" }, "zones": [ "zone1", @@ -417,6 +366,13 @@ ], "tags": {}, "location": "westus", + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, "identity": { "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c", "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c", diff --git a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_ListBySubscription_MaximumSet.json b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_ListBySubscription_MaximumSet.json index 55fea7dae063..56f0a254dfcb 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_ListBySubscription_MaximumSet.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_ListBySubscription_MaximumSet.json @@ -88,7 +88,7 @@ "secrets": [ { "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -110,7 +110,7 @@ "exactVersion": "hfph", "sharedGalleryImageId": "mkfpnxoxmkyrwpab", "communityGalleryImageId": "ujhxcd", - "id": "eouuvblwiuykzebjh" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" }, "osDisk": { "name": "qzchzeaaxupl", @@ -132,12 +132,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -154,12 +154,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -172,7 +172,7 @@ }, "networkProfile": { "healthProbe": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -183,7 +183,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -195,7 +195,7 @@ "name": "et", "properties": { "subnet": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -213,7 +213,7 @@ } ], "publicIPPrefix": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -226,22 +226,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -264,7 +264,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "ymhqsov" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -291,8 +291,7 @@ "autoUpgradeMinorVersion": true, "enableAutomaticUpgrade": true, "settings": {}, - "protectedSettings": {}, - "provisioningState": "kauilerjryyvizdqoazz", + "provisioningState": "Succeeded", "provisionAfterExtensions": [ "babgtjyllusylxsnfvepitrkmkcx" ], @@ -300,11 +299,11 @@ "protectedSettingsFromKeyVault": { "secretUrl": "qmjoynsytvnjzutetnkog", "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } } }, - "id": "qx" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" } ], "extensionsTimeBudget": "srvemetinivyy" @@ -323,7 +322,7 @@ "userData": "nwrklspknozvftyi", "capacityReservation": { "capacityReservationGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -331,8 +330,7 @@ { "tags": "bevijlsuchspoihzlfjczuqttaqz", "order": 4, - "packageReferenceId": "aabkcborasmyowocjceldewmkci", - "configurationReference": "auikpeahpgodbqdih", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true } @@ -345,75 +343,33 @@ } }, "serviceArtifactReference": { - "id": "qqqxnjehbgcepcfldzifjkwlzusn" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { - "id": "zwtxjdjwedxmhpcoii", + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "eleagpulycjgvscuulb", - "publisher": "rwaucnzfffywlsaoqltkmsynni", - "type": "rgnq", - "typeHandlerVersion": "hyyj", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "provisioningState": "rmhlppcusvaiepeqafd", - "instanceView": { - "name": "xxnjefzqotctmujsqpmyleaie", - "type": "cycepellfcdujniys", - "typeHandlerVersion": "jefntwzzgxsbzncchhefqiqbs", - "substatuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ], - "statuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "qmjoynsytvnjzutetnkog", - "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" - } - }, - "provisionAfterExtensions": [ - "aysdon" - ] - }, - "location": "jzecxhirbtegqxpyk", - "id": "vlgmhpmsbktwfzbioynslximoohfc", - "name": "qchtvtoulax", - "type": "shqqxyvbipxzaxjbsesymzgrfybww", - "tags": { - "key4849": "hqnzzgyumfzflmyjxklwslb" - } - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true }, "timeCreated": "2024-01-28T09:08:15.992Z" }, "computeApiVersion": "2023-07-01" - } + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" }, "zones": [ "zone1", "zone2" ], + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, "tags": {}, "location": "westus", "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", diff --git a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Update_MaximumSet.json b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Update_MaximumSet.json index 43cbb9db43e1..a1e029f4c91b 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Update_MaximumSet.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Update_MaximumSet.json @@ -88,7 +88,7 @@ "secrets": [ { "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -109,7 +109,7 @@ "version": "nhzyxfc", "sharedGalleryImageId": "mkfpnxoxmkyrwpab", "communityGalleryImageId": "ujhxcd", - "id": "eouuvblwiuykzebjh" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" }, "osDisk": { "name": "qzchzeaaxupl", @@ -131,12 +131,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -153,12 +153,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -171,7 +171,7 @@ }, "networkProfile": { "healthProbe": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -182,7 +182,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -194,7 +194,7 @@ "name": "et", "properties": { "subnet": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -212,7 +212,7 @@ } ], "publicIPPrefix": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -225,22 +225,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -263,7 +263,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "ymhqsov" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -297,7 +297,7 @@ "protectedSettingsFromKeyVault": { "secretUrl": "qmjoynsytvnjzutetnkog", "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } } } @@ -319,7 +319,7 @@ "userData": "jgdmsclzzknsevdsh", "capacityReservation": { "capacityReservationGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -327,7 +327,7 @@ { "tags": "bevijlsuchspoihzlfjczuqttaqz", "order": 4, - "packageReferenceId": "aabkcborasmyowocjceldewmkci", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "configurationReference": "auikpeahpgodbqdih", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true @@ -341,59 +341,14 @@ } }, "serviceArtifactReference": { - "id": "qqqxnjehbgcepcfldzifjkwlzusn" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { - "id": "zwtxjdjwedxmhpcoii", + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "eleagpulycjgvscuulb", - "publisher": "rwaucnzfffywlsaoqltkmsynni", - "type": "rgnq", - "typeHandlerVersion": "hyyj", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "instanceView": { - "name": "xxnjefzqotctmujsqpmyleaie", - "type": "cycepellfcdujniys", - "typeHandlerVersion": "jefntwzzgxsbzncchhefqiqbs", - "substatuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ], - "statuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "qmjoynsytvnjzutetnkog", - "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" - } - }, - "provisionAfterExtensions": [ - "aysdon" - ] - }, - "location": "jzecxhirbtegqxpyk", - "tags": {} - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true } }, "computeApiVersion": "2023-07-01" @@ -492,7 +447,7 @@ "secrets": [ { "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -513,7 +468,7 @@ "version": "nhzyxfc", "sharedGalleryImageId": "mkfpnxoxmkyrwpab", "communityGalleryImageId": "ujhxcd", - "id": "eouuvblwiuykzebjh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}", "exactVersion": "hfph" }, "osDisk": { @@ -536,12 +491,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -558,12 +513,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -576,7 +531,7 @@ }, "networkProfile": { "healthProbe": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -587,7 +542,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -599,7 +554,7 @@ "name": "et", "properties": { "subnet": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -617,7 +572,7 @@ } ], "publicIPPrefix": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -630,22 +585,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -668,7 +623,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "ymhqsov" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -693,8 +648,6 @@ "typeHandlerVersion": "vqrkrrankheuqbcopc", "autoUpgradeMinorVersion": true, "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, "provisionAfterExtensions": [ "babgtjyllusylxsnfvepitrkmkcx" ], @@ -702,13 +655,13 @@ "protectedSettingsFromKeyVault": { "secretUrl": "qmjoynsytvnjzutetnkog", "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } }, - "provisioningState": "kauilerjryyvizdqoazz" + "provisioningState": "Succeeded" }, "type": "rhmnomookzqyld", - "id": "qx" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" } ], "extensionsTimeBudget": "srvemetinivyy" @@ -727,7 +680,7 @@ "userData": "jgdmsclzzknsevdsh", "capacityReservation": { "capacityReservationGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -735,8 +688,7 @@ { "tags": "bevijlsuchspoihzlfjczuqttaqz", "order": 4, - "packageReferenceId": "aabkcborasmyowocjceldewmkci", - "configurationReference": "auikpeahpgodbqdih", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true } @@ -749,69 +701,22 @@ } }, "serviceArtifactReference": { - "id": "qqqxnjehbgcepcfldzifjkwlzusn" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { - "id": "zwtxjdjwedxmhpcoii", + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "eleagpulycjgvscuulb", - "publisher": "rwaucnzfffywlsaoqltkmsynni", - "type": "rgnq", - "typeHandlerVersion": "hyyj", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "instanceView": { - "name": "xxnjefzqotctmujsqpmyleaie", - "type": "cycepellfcdujniys", - "typeHandlerVersion": "jefntwzzgxsbzncchhefqiqbs", - "substatuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ], - "statuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "qmjoynsytvnjzutetnkog", - "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" - } - }, - "provisionAfterExtensions": [ - "aysdon" - ], - "provisioningState": "rmhlppcusvaiepeqafd" - }, - "location": "jzecxhirbtegqxpyk", - "tags": {}, - "id": "vlgmhpmsbktwfzbioynslximoohfc", - "name": "qchtvtoulax", - "type": "shqqxyvbipxzaxjbsesymzgrfybww" - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true }, "timeCreated": "2024-01-28T09:08:15.992Z" }, "computeApiVersion": "2023-07-01" }, - "provisioningState": "Succeeded" + "provisioningState": "Succeeded", + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" }, "zones": [ "zone1", diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_CreateOrUpdate.json b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_CreateOrUpdate.json index f90d8d57e529..0aee59f3b1e0 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_CreateOrUpdate.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_CreateOrUpdate.json @@ -89,7 +89,7 @@ "secrets": [ { "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -110,7 +110,7 @@ "version": "wvpcqefgtmqdgltiuz", "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", "communityGalleryImageId": "vlqe", - "id": "aiunknwgksu" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" }, "osDisk": { "name": "wfttw", @@ -132,12 +132,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -154,12 +154,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -172,7 +172,7 @@ }, "networkProfile": { "healthProbe": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -183,7 +183,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -195,7 +195,7 @@ "name": "oezqhkidfhyywlfzwuotilrpbqnjg", "properties": { "subnet": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -213,7 +213,7 @@ } ], "publicIPPrefix": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -226,22 +226,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -264,7 +264,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "qoersmt" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -298,7 +298,7 @@ "protectedSettingsFromKeyVault": { "secretUrl": "vyhzfkqsqanacgzjthpjoe", "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } } } @@ -320,7 +320,7 @@ "userData": "s", "capacityReservation": { "capacityReservationGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -328,7 +328,7 @@ { "tags": "eyrqjbib", "order": 5, - "packageReferenceId": "lfxqiadouhmbovcd", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "configurationReference": "ulztmiavpojpbpbddgnuuiimxcpau", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true @@ -342,61 +342,14 @@ } }, "serviceArtifactReference": { - "id": "qlkeeyskyr" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { - "id": "mubredelfbshboaxrsxiajihahaa", + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "oriasdwawveilgusfrn", - "publisher": "rxoajzb", - "type": "vhrtgbaqdkbrrqxsdiiaqxksmqukl", - "typeHandlerVersion": "bvzbiibps", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "instanceView": { - "name": "ip", - "type": "woadxvobquacooaujyg", - "typeHandlerVersion": "ftkkqxdqiofgsusvxekdcpua", - "substatuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ], - "statuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "vyhzfkqsqanacgzjthpjoe", - "sourceVault": { - "id": "groxwd" - } - }, - "provisionAfterExtensions": [ - "lwsfavklrgzuwmyxscskt" - ] - }, - "location": "wrqxhbqaebwkzmcdmngyqmhogc", - "tags": { - "key7356": "apuftleiygpnemfzryiop" - } - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true } }, "computeApiVersion": "2023-07-01", @@ -416,7 +369,14 @@ "tags": { "key3518": "luvrnuvsgdpbuofdskkcoqhfh" }, - "location": "westus" + "location": "westus", + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + } } }, "responses": { @@ -502,7 +462,7 @@ "secrets": [ { "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -524,7 +484,7 @@ "exactVersion": "zjbntmiskjexlr", "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", "communityGalleryImageId": "vlqe", - "id": "aiunknwgksu" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" }, "osDisk": { "name": "wfttw", @@ -546,12 +506,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -568,12 +528,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -586,7 +546,7 @@ }, "networkProfile": { "healthProbe": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -597,7 +557,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -609,7 +569,7 @@ "name": "oezqhkidfhyywlfzwuotilrpbqnjg", "properties": { "subnet": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -627,7 +587,7 @@ } ], "publicIPPrefix": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -640,22 +600,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -678,7 +638,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "qoersmt" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -705,8 +665,7 @@ "autoUpgradeMinorVersion": true, "enableAutomaticUpgrade": true, "settings": {}, - "protectedSettings": {}, - "provisioningState": "jquzzuhvarugybjwdooovfrgqtpe", + "provisioningState": "Succeeded", "provisionAfterExtensions": [ "nftzosroolbcwmpupujzqwqe" ], @@ -714,11 +673,11 @@ "protectedSettingsFromKeyVault": { "secretUrl": "vyhzfkqsqanacgzjthpjoe", "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } } }, - "id": "fmheufuaqonfvirwrpd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" } ], "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" @@ -737,7 +696,7 @@ "userData": "s", "capacityReservation": { "capacityReservationGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -745,8 +704,7 @@ { "tags": "eyrqjbib", "order": 5, - "packageReferenceId": "lfxqiadouhmbovcd", - "configurationReference": "ulztmiavpojpbpbddgnuuiimxcpau", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true } @@ -759,71 +717,22 @@ } }, "serviceArtifactReference": { - "id": "qlkeeyskyr" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { - "id": "mubredelfbshboaxrsxiajihahaa", + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "oriasdwawveilgusfrn", - "publisher": "rxoajzb", - "type": "vhrtgbaqdkbrrqxsdiiaqxksmqukl", - "typeHandlerVersion": "bvzbiibps", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "provisioningState": "tzbaituagn", - "instanceView": { - "name": "ip", - "type": "woadxvobquacooaujyg", - "typeHandlerVersion": "ftkkqxdqiofgsusvxekdcpua", - "substatuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ], - "statuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "vyhzfkqsqanacgzjthpjoe", - "sourceVault": { - "id": "groxwd" - } - }, - "provisionAfterExtensions": [ - "lwsfavklrgzuwmyxscskt" - ] - }, - "location": "wrqxhbqaebwkzmcdmngyqmhogc", - "id": "ovmtxndtfwvcxnw", - "name": "zudiuxzkgqhxaam", - "type": "lpnynhnniohtotmkznxku", - "tags": { - "key7356": "apuftleiygpnemfzryiop" - } - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true }, "timeCreated": "2024-04-29T21:51:44.043Z" }, "computeApiVersion": "2023-07-01", "platformFaultDomainCount": 1 - } + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" }, "zones": [ "zone1", @@ -840,6 +749,13 @@ } } }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, "tags": { "key3518": "luvrnuvsgdpbuofdskkcoqhfh" }, @@ -942,7 +858,7 @@ "secrets": [ { "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -964,7 +880,7 @@ "exactVersion": "zjbntmiskjexlr", "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", "communityGalleryImageId": "vlqe", - "id": "aiunknwgksu" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" }, "osDisk": { "name": "wfttw", @@ -986,12 +902,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -1008,12 +924,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -1026,7 +942,7 @@ }, "networkProfile": { "healthProbe": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -1037,7 +953,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -1049,7 +965,7 @@ "name": "oezqhkidfhyywlfzwuotilrpbqnjg", "properties": { "subnet": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -1067,7 +983,7 @@ } ], "publicIPPrefix": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -1080,22 +996,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -1118,7 +1034,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "qoersmt" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -1145,8 +1061,7 @@ "autoUpgradeMinorVersion": true, "enableAutomaticUpgrade": true, "settings": {}, - "protectedSettings": {}, - "provisioningState": "jquzzuhvarugybjwdooovfrgqtpe", + "provisioningState": "Succeeded", "provisionAfterExtensions": [ "nftzosroolbcwmpupujzqwqe" ], @@ -1154,11 +1069,11 @@ "protectedSettingsFromKeyVault": { "secretUrl": "vyhzfkqsqanacgzjthpjoe", "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } } }, - "id": "fmheufuaqonfvirwrpd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" } ], "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" @@ -1177,7 +1092,7 @@ "userData": "s", "capacityReservation": { "capacityReservationGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -1185,8 +1100,7 @@ { "tags": "eyrqjbib", "order": 5, - "packageReferenceId": "lfxqiadouhmbovcd", - "configurationReference": "ulztmiavpojpbpbddgnuuiimxcpau", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true } @@ -1199,71 +1113,22 @@ } }, "serviceArtifactReference": { - "id": "qlkeeyskyr" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { - "id": "mubredelfbshboaxrsxiajihahaa", + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "oriasdwawveilgusfrn", - "publisher": "rxoajzb", - "type": "vhrtgbaqdkbrrqxsdiiaqxksmqukl", - "typeHandlerVersion": "bvzbiibps", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "provisioningState": "tzbaituagn", - "instanceView": { - "name": "ip", - "type": "woadxvobquacooaujyg", - "typeHandlerVersion": "ftkkqxdqiofgsusvxekdcpua", - "substatuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ], - "statuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "vyhzfkqsqanacgzjthpjoe", - "sourceVault": { - "id": "groxwd" - } - }, - "provisionAfterExtensions": [ - "lwsfavklrgzuwmyxscskt" - ] - }, - "location": "wrqxhbqaebwkzmcdmngyqmhogc", - "id": "ovmtxndtfwvcxnw", - "name": "zudiuxzkgqhxaam", - "type": "lpnynhnniohtotmkznxku", - "tags": { - "key7356": "apuftleiygpnemfzryiop" - } - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true }, "timeCreated": "2024-04-29T21:51:44.043Z" }, "computeApiVersion": "2023-07-01", "platformFaultDomainCount": 1 - } + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" }, "zones": [ "zone1", @@ -1283,6 +1148,13 @@ "tags": { "key3518": "luvrnuvsgdpbuofdskkcoqhfh" }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, "location": "westus", "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", "name": "testFleet", diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_CreateOrUpdate_MinimumSet.json b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_CreateOrUpdate_MinimumSet.json new file mode 100644 index 000000000000..8d9bd1338335 --- /dev/null +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_CreateOrUpdate_MinimumSet.json @@ -0,0 +1,299 @@ +{ + "title": "Fleets_CreateOrUpdate_MinimumSet", + "operationId": "Fleets_CreateOrUpdate", + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", + "resourceGroupName": "rgazurefleet", + "fleetName": "testFleet", + "resource": { + "properties": { + "spotPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_D2s_v3" + }, + { + "name": "Standard_D4s_v3" + }, + { + "name": "Standard_E2s_v3" + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "storageProfile": { + "imageReference": { + "publisher": "canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts-gen2", + "version": "latest" + }, + "osDisk": { + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + } + }, + "osProfile": { + "computerNamePrefix": "prefix", + "adminUsername": "azureuser", + "adminPassword": "TestPassword$0", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "primary": true, + "enableAcceleratedNetworking": false, + "ipConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true + } + } + ], + "networkApiVersion": "2022-07-01" + } + }, + "computeApiVersion": "2023-09-01", + "platformFaultDomainCount": 1 + } + }, + "tags": { + "key": "fleets-test" + }, + "location": "eastus2euap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Creating", + "spotPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_D2s_v3" + }, + { + "name": "Standard_D4s_v3" + }, + { + "name": "Standard_E2s_v3" + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "storageProfile": { + "imageReference": { + "publisher": "canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts-gen2", + "version": "latest" + }, + "osDisk": { + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + } + }, + "osProfile": { + "computerNamePrefix": "prefix", + "adminUsername": "azureuser", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "primary": true, + "enableAcceleratedNetworking": false, + "ipConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true + } + } + ], + "networkApiVersion": "2022-07-01" + } + }, + "computeApiVersion": "2023-09-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "tags": { + "key": "fleets-test" + }, + "location": "eastus2euap", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Creating", + "spotPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_D2s_v3" + }, + { + "name": "Standard_D4s_v3" + }, + { + "name": "Standard_E2s_v3" + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "storageProfile": { + "imageReference": { + "publisher": "canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts-gen2", + "version": "latest" + }, + "osDisk": { + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + } + }, + "osProfile": { + "computerNamePrefix": "prefix", + "adminUsername": "azureuser", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "primary": true, + "enableAcceleratedNetworking": false, + "ipConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true + } + } + ], + "networkApiVersion": "2022-07-01" + } + }, + "computeApiVersion": "2023-09-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "tags": { + "key": "fleets-test" + }, + "location": "eastus2euap", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets" + } + } + } +} diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_Get.json b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_Get.json index 94a05d95228b..aad43edb4459 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_Get.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_Get.json @@ -36,7 +36,6 @@ "osProfile": { "computerNamePrefix": "o", "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", - "customData": "xjjib", "windowsConfiguration": { "provisionVMAgent": true, "enableAutomaticUpdates": true, @@ -45,8 +44,7 @@ { "passName": "OobeSystem", "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "AutoLogon", - "content": "bubmqbxjkj" + "settingName": "AutoLogon" } ], "patchSettings": { @@ -92,7 +90,7 @@ "secrets": [ { "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -114,7 +112,7 @@ "exactVersion": "zjbntmiskjexlr", "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", "communityGalleryImageId": "vlqe", - "id": "aiunknwgksu" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" }, "osDisk": { "name": "wfttw", @@ -136,12 +134,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -158,12 +156,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -176,7 +174,7 @@ }, "networkProfile": { "healthProbe": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -187,7 +185,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -199,7 +197,7 @@ "name": "oezqhkidfhyywlfzwuotilrpbqnjg", "properties": { "subnet": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -217,7 +215,7 @@ } ], "publicIPPrefix": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -230,22 +228,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -268,7 +266,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "qoersmt" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -295,8 +293,7 @@ "autoUpgradeMinorVersion": true, "enableAutomaticUpgrade": true, "settings": {}, - "protectedSettings": {}, - "provisioningState": "jquzzuhvarugybjwdooovfrgqtpe", + "provisioningState": "Succeeded", "provisionAfterExtensions": [ "nftzosroolbcwmpupujzqwqe" ], @@ -304,21 +301,16 @@ "protectedSettingsFromKeyVault": { "secretUrl": "vyhzfkqsqanacgzjthpjoe", "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } } }, - "id": "fmheufuaqonfvirwrpd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" } ], "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" }, "licenseType": "v", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 2 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "iljppmmw", @@ -332,7 +324,7 @@ "userData": "s", "capacityReservation": { "capacityReservationGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -340,8 +332,7 @@ { "tags": "eyrqjbib", "order": 5, - "packageReferenceId": "lfxqiadouhmbovcd", - "configurationReference": "ulztmiavpojpbpbddgnuuiimxcpau", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true } @@ -354,71 +345,22 @@ } }, "serviceArtifactReference": { - "id": "qlkeeyskyr" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { "id": "mubredelfbshboaxrsxiajihahaa", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "oriasdwawveilgusfrn", - "publisher": "rxoajzb", - "type": "vhrtgbaqdkbrrqxsdiiaqxksmqukl", - "typeHandlerVersion": "bvzbiibps", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "provisioningState": "tzbaituagn", - "instanceView": { - "name": "ip", - "type": "woadxvobquacooaujyg", - "typeHandlerVersion": "ftkkqxdqiofgsusvxekdcpua", - "substatuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ], - "statuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "vyhzfkqsqanacgzjthpjoe", - "sourceVault": { - "id": "groxwd" - } - }, - "provisionAfterExtensions": [ - "lwsfavklrgzuwmyxscskt" - ] - }, - "location": "wrqxhbqaebwkzmcdmngyqmhogc", - "id": "ovmtxndtfwvcxnw", - "name": "zudiuxzkgqhxaam", - "type": "lpnynhnniohtotmkznxku", - "tags": { - "key7356": "apuftleiygpnemfzryiop" - } - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true }, "timeCreated": "2024-04-29T21:51:44.043Z" }, "computeApiVersion": "2023-07-01", "platformFaultDomainCount": 1 - } + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" }, "zones": [ "zone1", @@ -438,6 +380,13 @@ "tags": { "key3518": "luvrnuvsgdpbuofdskkcoqhfh" }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, "location": "westus", "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", "name": "testFleet", diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_ListByResourceGroup.json b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_ListByResourceGroup.json index ad7bc37f6910..e94357690c84 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_ListByResourceGroup.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_ListByResourceGroup.json @@ -37,7 +37,6 @@ "osProfile": { "computerNamePrefix": "o", "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", - "customData": "xjjib", "windowsConfiguration": { "provisionVMAgent": true, "enableAutomaticUpdates": true, @@ -46,8 +45,7 @@ { "passName": "OobeSystem", "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "AutoLogon", - "content": "bubmqbxjkj" + "settingName": "AutoLogon" } ], "patchSettings": { @@ -93,7 +91,7 @@ "secrets": [ { "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -115,7 +113,7 @@ "exactVersion": "zjbntmiskjexlr", "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", "communityGalleryImageId": "vlqe", - "id": "aiunknwgksu" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" }, "osDisk": { "name": "wfttw", @@ -137,12 +135,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -159,12 +157,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -177,7 +175,7 @@ }, "networkProfile": { "healthProbe": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -188,7 +186,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -200,7 +198,7 @@ "name": "oezqhkidfhyywlfzwuotilrpbqnjg", "properties": { "subnet": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -218,7 +216,7 @@ } ], "publicIPPrefix": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -231,22 +229,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -269,7 +267,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "qoersmt" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -296,8 +294,7 @@ "autoUpgradeMinorVersion": true, "enableAutomaticUpgrade": true, "settings": {}, - "protectedSettings": {}, - "provisioningState": "jquzzuhvarugybjwdooovfrgqtpe", + "provisioningState": "Succeeded", "provisionAfterExtensions": [ "nftzosroolbcwmpupujzqwqe" ], @@ -305,11 +302,11 @@ "protectedSettingsFromKeyVault": { "secretUrl": "vyhzfkqsqanacgzjthpjoe", "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } } }, - "id": "fmheufuaqonfvirwrpd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" } ], "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" @@ -328,7 +325,7 @@ "userData": "s", "capacityReservation": { "capacityReservationGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -336,8 +333,7 @@ { "tags": "eyrqjbib", "order": 5, - "packageReferenceId": "lfxqiadouhmbovcd", - "configurationReference": "ulztmiavpojpbpbddgnuuiimxcpau", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true } @@ -350,71 +346,22 @@ } }, "serviceArtifactReference": { - "id": "qlkeeyskyr" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { "id": "mubredelfbshboaxrsxiajihahaa", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "oriasdwawveilgusfrn", - "publisher": "rxoajzb", - "type": "vhrtgbaqdkbrrqxsdiiaqxksmqukl", - "typeHandlerVersion": "bvzbiibps", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "provisioningState": "tzbaituagn", - "instanceView": { - "name": "ip", - "type": "woadxvobquacooaujyg", - "typeHandlerVersion": "ftkkqxdqiofgsusvxekdcpua", - "substatuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ], - "statuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "vyhzfkqsqanacgzjthpjoe", - "sourceVault": { - "id": "groxwd" - } - }, - "provisionAfterExtensions": [ - "lwsfavklrgzuwmyxscskt" - ] - }, - "location": "wrqxhbqaebwkzmcdmngyqmhogc", - "id": "ovmtxndtfwvcxnw", - "name": "zudiuxzkgqhxaam", - "type": "lpnynhnniohtotmkznxku", - "tags": { - "key7356": "apuftleiygpnemfzryiop" - } - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true }, "timeCreated": "2024-04-29T21:51:44.043Z" }, "computeApiVersion": "2023-07-01", "platformFaultDomainCount": 1 - } + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" }, "zones": [ "zone1", @@ -431,6 +378,13 @@ } } }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, "tags": { "key3518": "luvrnuvsgdpbuofdskkcoqhfh" }, diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_ListBySubscription.json b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_ListBySubscription.json index 0c9de85a88ba..a708351de4b3 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_ListBySubscription.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_ListBySubscription.json @@ -36,7 +36,6 @@ "osProfile": { "computerNamePrefix": "o", "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", - "customData": "xjjib", "windowsConfiguration": { "provisionVMAgent": true, "enableAutomaticUpdates": true, @@ -45,8 +44,7 @@ { "passName": "OobeSystem", "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "AutoLogon", - "content": "bubmqbxjkj" + "settingName": "AutoLogon" } ], "patchSettings": { @@ -92,7 +90,7 @@ "secrets": [ { "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -114,7 +112,7 @@ "exactVersion": "zjbntmiskjexlr", "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", "communityGalleryImageId": "vlqe", - "id": "aiunknwgksu" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" }, "osDisk": { "name": "wfttw", @@ -136,12 +134,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -158,12 +156,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -176,7 +174,7 @@ }, "networkProfile": { "healthProbe": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -187,7 +185,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -199,7 +197,7 @@ "name": "oezqhkidfhyywlfzwuotilrpbqnjg", "properties": { "subnet": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -217,7 +215,7 @@ } ], "publicIPPrefix": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -230,22 +228,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -268,7 +266,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "qoersmt" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -295,8 +293,7 @@ "autoUpgradeMinorVersion": true, "enableAutomaticUpgrade": true, "settings": {}, - "protectedSettings": {}, - "provisioningState": "jquzzuhvarugybjwdooovfrgqtpe", + "provisioningState": "Succeeded", "provisionAfterExtensions": [ "nftzosroolbcwmpupujzqwqe" ], @@ -304,11 +301,11 @@ "protectedSettingsFromKeyVault": { "secretUrl": "vyhzfkqsqanacgzjthpjoe", "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } } }, - "id": "fmheufuaqonfvirwrpd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" } ], "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" @@ -327,7 +324,7 @@ "userData": "s", "capacityReservation": { "capacityReservationGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -335,8 +332,7 @@ { "tags": "eyrqjbib", "order": 5, - "packageReferenceId": "lfxqiadouhmbovcd", - "configurationReference": "ulztmiavpojpbpbddgnuuiimxcpau", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true } @@ -349,71 +345,22 @@ } }, "serviceArtifactReference": { - "id": "qlkeeyskyr" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { "id": "mubredelfbshboaxrsxiajihahaa", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "oriasdwawveilgusfrn", - "publisher": "rxoajzb", - "type": "vhrtgbaqdkbrrqxsdiiaqxksmqukl", - "typeHandlerVersion": "bvzbiibps", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "provisioningState": "tzbaituagn", - "instanceView": { - "name": "ip", - "type": "woadxvobquacooaujyg", - "typeHandlerVersion": "ftkkqxdqiofgsusvxekdcpua", - "substatuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ], - "statuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "vyhzfkqsqanacgzjthpjoe", - "sourceVault": { - "id": "groxwd" - } - }, - "provisionAfterExtensions": [ - "lwsfavklrgzuwmyxscskt" - ] - }, - "location": "wrqxhbqaebwkzmcdmngyqmhogc", - "id": "ovmtxndtfwvcxnw", - "name": "zudiuxzkgqhxaam", - "type": "lpnynhnniohtotmkznxku", - "tags": { - "key7356": "apuftleiygpnemfzryiop" - } - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true }, "timeCreated": "2024-04-29T21:51:44.043Z" }, "computeApiVersion": "2023-07-01", "platformFaultDomainCount": 1 - } + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" }, "zones": [ "zone1", @@ -430,6 +377,13 @@ } } }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, "tags": { "key3518": "luvrnuvsgdpbuofdskkcoqhfh" }, diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_ListVirtualMachineScaleSets.json b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_ListVirtualMachineScaleSets.json index 628c68be9aed..90fbbfd5c47f 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_ListVirtualMachineScaleSets.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_ListVirtualMachineScaleSets.json @@ -25,8 +25,8 @@ } ], "innererror": { - "exceptiontype": "sfaomfpoaptnbxchrfskm", - "errordetail": "ihjwbwykq" + "exceptionType": "sfaomfpoaptnbxchrfskm", + "errorDetail": "ihjwbwykq" }, "code": "OverconstrainedAllocationRequest", "target": "nhaj", diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_Update.json b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_Update.json index 621ccf96f741..c987029fbeb5 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_Update.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_Update.json @@ -94,7 +94,7 @@ "secrets": [ { "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -115,7 +115,7 @@ "version": "wvpcqefgtmqdgltiuz", "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", "communityGalleryImageId": "vlqe", - "id": "aiunknwgksu" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" }, "osDisk": { "name": "wfttw", @@ -137,12 +137,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -159,12 +159,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -177,7 +177,7 @@ }, "networkProfile": { "healthProbe": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -188,7 +188,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -200,7 +200,7 @@ "name": "oezqhkidfhyywlfzwuotilrpbqnjg", "properties": { "subnet": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -218,7 +218,7 @@ } ], "publicIPPrefix": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -231,22 +231,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -269,7 +269,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "qoersmt" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -303,7 +303,7 @@ "protectedSettingsFromKeyVault": { "secretUrl": "vyhzfkqsqanacgzjthpjoe", "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } } } @@ -325,7 +325,7 @@ "userData": "s", "capacityReservation": { "capacityReservationGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -333,7 +333,7 @@ { "tags": "eyrqjbib", "order": 5, - "packageReferenceId": "lfxqiadouhmbovcd", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "configurationReference": "ulztmiavpojpbpbddgnuuiimxcpau", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true @@ -347,59 +347,14 @@ } }, "serviceArtifactReference": { - "id": "qlkeeyskyr" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { - "id": "mubredelfbshboaxrsxiajihahaa", + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "oriasdwawveilgusfrn", - "publisher": "rxoajzb", - "type": "vhrtgbaqdkbrrqxsdiiaqxksmqukl", - "typeHandlerVersion": "bvzbiibps", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "instanceView": { - "name": "ip", - "type": "woadxvobquacooaujyg", - "typeHandlerVersion": "ftkkqxdqiofgsusvxekdcpua", - "substatuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ], - "statuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "vyhzfkqsqanacgzjthpjoe", - "sourceVault": { - "id": "groxwd" - } - }, - "provisionAfterExtensions": [ - "lwsfavklrgzuwmyxscskt" - ] - }, - "location": "wrqxhbqaebwkzmcdmngyqmhogc", - "tags": {} - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true } }, "computeApiVersion": "2023-07-01", @@ -497,7 +452,7 @@ "secrets": [ { "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -518,7 +473,7 @@ "version": "wvpcqefgtmqdgltiuz", "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", "communityGalleryImageId": "vlqe", - "id": "aiunknwgksu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}", "exactVersion": "zjbntmiskjexlr" }, "osDisk": { @@ -541,12 +496,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -563,12 +518,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -581,7 +536,7 @@ }, "networkProfile": { "healthProbe": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -592,7 +547,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -604,7 +559,7 @@ "name": "oezqhkidfhyywlfzwuotilrpbqnjg", "properties": { "subnet": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -622,7 +577,7 @@ } ], "publicIPPrefix": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -635,22 +590,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -673,7 +628,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "qoersmt" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -698,8 +653,6 @@ "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", "autoUpgradeMinorVersion": true, "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, "provisionAfterExtensions": [ "nftzosroolbcwmpupujzqwqe" ], @@ -707,13 +660,14 @@ "protectedSettingsFromKeyVault": { "secretUrl": "vyhzfkqsqanacgzjthpjoe", "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } }, - "provisioningState": "jquzzuhvarugybjwdooovfrgqtpe" + "settings": {}, + "provisioningState": "Succeeded" }, "type": "cmeam", - "id": "fmheufuaqonfvirwrpd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" } ], "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" @@ -732,7 +686,7 @@ "userData": "s", "capacityReservation": { "capacityReservationGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -740,8 +694,7 @@ { "tags": "eyrqjbib", "order": 5, - "packageReferenceId": "lfxqiadouhmbovcd", - "configurationReference": "ulztmiavpojpbpbddgnuuiimxcpau", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true } @@ -754,70 +707,23 @@ } }, "serviceArtifactReference": { - "id": "qlkeeyskyr" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { - "id": "mubredelfbshboaxrsxiajihahaa", + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "oriasdwawveilgusfrn", - "publisher": "rxoajzb", - "type": "vhrtgbaqdkbrrqxsdiiaqxksmqukl", - "typeHandlerVersion": "bvzbiibps", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "instanceView": { - "name": "ip", - "type": "woadxvobquacooaujyg", - "typeHandlerVersion": "ftkkqxdqiofgsusvxekdcpua", - "substatuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ], - "statuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "vyhzfkqsqanacgzjthpjoe", - "sourceVault": { - "id": "groxwd" - } - }, - "provisionAfterExtensions": [ - "lwsfavklrgzuwmyxscskt" - ], - "provisioningState": "tzbaituagn" - }, - "location": "wrqxhbqaebwkzmcdmngyqmhogc", - "tags": {}, - "id": "ovmtxndtfwvcxnw", - "name": "zudiuxzkgqhxaam", - "type": "lpnynhnniohtotmkznxku" - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true }, "timeCreated": "2024-04-29T21:51:44.043Z" }, "computeApiVersion": "2023-07-01", "platformFaultDomainCount": 1 }, - "provisioningState": "Creating" + "provisioningState": "Creating", + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" }, "zones": [ "zone1", diff --git a/specification/azurefleet/AzureFleet.Management/fleet.tsp b/specification/azurefleet/AzureFleet.Management/fleet.tsp index f1c124a7cac3..ee8abc852867 100644 --- a/specification/azurefleet/AzureFleet.Management/fleet.tsp +++ b/specification/azurefleet/AzureFleet.Management/fleet.tsp @@ -1,14 +1,12 @@ import "@typespec/http"; import "@typespec/rest"; import "@typespec/versioning"; -import "@azure-tools/typespec-autorest"; import "@azure-tools/typespec-azure-core"; import "@azure-tools/typespec-azure-resource-manager"; using TypeSpec.Http; using TypeSpec.Rest; using TypeSpec.Versioning; -using Autorest; using Azure.ResourceManager; using OpenAPI; @@ -88,6 +86,14 @@ model FleetProperties { @doc("Compute Profile to use for running user's workloads.") computeProfile: ComputeProfile; + + @doc("Specifies the time at which the Compute Fleet is created.") + @visibility("read") + timeCreated?: utcDateTime; + + @doc("Specifies the ID which uniquely identifies a Compute Fleet.") + @visibility("read") + uniqueId?: string; } @doc("Compute Profile to use for running user's workloads.") @@ -114,10 +120,6 @@ model ComputeProfile { platformFaultDomainCount?: int32; } -@doc("BaseVirtualMachineProfile") -@useRef("../../../../../compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineScaleSet.json#/definitions/VirtualMachineScaleSetVMProfile") -model BaseVirtualMachineProfile {} - @doc("Specifications about a VM Size. This will also contain the corresponding rank and weight in future.") model VmSizeProfile { @doc("The Sku name (e.g. 'Standard_DS1_v2')") @@ -218,6 +220,7 @@ interface Fleets { Fleet, LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; + @parameterVisibility update is ArmCustomPatchAsync; delete is ArmResourceDeleteWithoutOkAsync; listByResourceGroup is ArmResourceListByParent; @@ -227,12 +230,6 @@ interface Fleets { @armResourceList(VirtualMachineScaleSet) @get @doc("List VirtualMachineScaleSet resources by Fleet") - @extension( - "x-ms-pageable", - { - nextLinkName: "nextLink", - } - ) listVirtualMachineScaleSets( ...ApiVersionParameter, ...SubscriptionIdParameter, diff --git a/specification/azurefleet/AzureFleet.Management/main.tsp b/specification/azurefleet/AzureFleet.Management/main.tsp index 17ef95fcf8e7..a29951f7985a 100644 --- a/specification/azurefleet/AzureFleet.Management/main.tsp +++ b/specification/azurefleet/AzureFleet.Management/main.tsp @@ -5,6 +5,7 @@ import "@azure-tools/typespec-azure-core"; import "@azure-tools/typespec-azure-resource-manager"; import "./common.tsp"; import "./fleet.tsp"; +import "./baseVirtualMachineProfile.tsp"; import "./virtualMachineScaleSet.tsp"; using TypeSpec.Http; @@ -22,11 +23,13 @@ namespace Microsoft.AzureFleet; /** Api versions */ enum Versions { @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(Azure.Core.Versions.v1_0_Preview_2) @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) @doc("Private Preview Api version") v2023_11_01_preview: "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.v5) @doc("Public Preview Api version") v2024_05_01_preview: "2024-05-01-preview", diff --git a/specification/azurefleet/AzureFleet.Management/tspconfig.yaml b/specification/azurefleet/AzureFleet.Management/tspconfig.yaml index 05aeccd4f73e..3ef181c18fa3 100644 --- a/specification/azurefleet/AzureFleet.Management/tspconfig.yaml +++ b/specification/azurefleet/AzureFleet.Management/tspconfig.yaml @@ -13,6 +13,9 @@ options: use-read-only-status-schema: true emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/azurefleet.json" examples-directory: "examples" "@azure-tools/typespec-csharp": diff --git a/specification/azurefleet/AzureFleet.Management/virtualMachineScaleSet.tsp b/specification/azurefleet/AzureFleet.Management/virtualMachineScaleSet.tsp index 63d3fd5f8011..62da7ad7eb78 100644 --- a/specification/azurefleet/AzureFleet.Management/virtualMachineScaleSet.tsp +++ b/specification/azurefleet/AzureFleet.Management/virtualMachineScaleSet.tsp @@ -9,6 +9,7 @@ using TypeSpec.Rest; using TypeSpec.Versioning; using TypeSpec.OpenAPI; using Azure.ResourceManager; +using Azure.Core; namespace Microsoft.AzureFleet; @@ -49,12 +50,13 @@ model VirtualMachineScaleSet { } @doc("The response of a VirtualMachineScaleSet list operation.") +@pagedResult model VirtualMachineScaleSetListResult { @doc("The VirtualMachineScaleSet items on this page") + @items value: Array; - #suppress "@azure-tools/typespec-azure-core/no-format" "NextLink is of uri format and need to be defined." @doc("The link to the next page of items") - @format("uri") - nextLink?: string; + @nextLink + nextLink?: url; } diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/azurefleet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/azurefleet.json index 3a7a0582b6b8..37ca8c777804 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/azurefleet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/azurefleet.json @@ -486,57 +486,261 @@ } }, "definitions": { - "Azure.ResourceManager.CommonTypes.ManagedServiceIdentityType": { + "AdditionalUnattendContent": { + "type": "object", + "description": "Specifies additional XML formatted information that can be included in the\nUnattend.xml file, which is used by Windows Setup. Contents are defined by\nsetting name, component name, and the pass in which the content is applied.", + "properties": { + "passName": { + "type": "string", + "description": "The pass name. Currently, the only allowable value is OobeSystem.", + "enum": [ + "OobeSystem" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "componentName": { + "type": "string", + "description": "The component name. Currently, the only allowable value is\nMicrosoft-Windows-Shell-Setup.", + "enum": [ + "Microsoft-Windows-Shell-Setup" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "settingName": { + "$ref": "#/definitions/SettingNames", + "description": "Specifies the name of the setting to which the content applies. Possible values\nare: FirstLogonCommands and AutoLogon." + }, + "content": { + "type": "string", + "format": "password", + "description": "Specifies the XML formatted content that is added to the unattend.xml file for\nthe specified path and component. The XML must be less than 4KB and must\ninclude the root element for the setting or feature that is being inserted.", + "x-ms-mutability": [ + "update", + "create" + ], + "x-ms-secret": true + } + } + }, + "ApiEntityReference": { + "type": "object", + "description": "The API entity reference.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM resource id in the form of\n/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." + } + } + }, + "ApiError": { + "type": "object", + "description": "ApiError for Fleet", + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + }, + "details": { + "type": "array", + "description": "The API error details", + "items": { + "$ref": "#/definitions/ApiErrorBase" + }, + "x-ms-identifiers": [ + "message", + "target" + ] + }, + "innererror": { + "$ref": "#/definitions/InnerError", + "description": "The API inner error" + } + } + }, + "ApiErrorBase": { + "type": "object", + "description": "API error base.", + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + } + } + }, + "ApplicationProfile": { + "type": "object", + "description": "Contains the list of gallery applications that should be made available to the\nVM/VMSS", + "properties": { + "galleryApplications": { + "type": "array", + "description": "Specifies the gallery applications that should be made available to the VM/VMSS", + "items": { + "$ref": "#/definitions/VMGalleryApplication" + }, + "x-ms-identifiers": [ + "packageReferenceId" + ] + } + } + }, + "BasePriorityProfile": { + "type": "object", + "description": "Contains common properties that are applicable to both Spot and Regular.", + "properties": { + "capacity": { + "type": "integer", + "format": "int32", + "description": "Total capacity to achieve. It is currently in terms of number of VMs.", + "minimum": 0 + }, + "minCapacity": { + "type": "integer", + "format": "int32", + "description": "Minimum capacity to achieve which cannot be updated. If we will not be able to \"guarantee\" minimum capacity, we will reject the request in the sync path itself.", + "minimum": 0 + } + } + }, + "BaseVirtualMachineProfile": { + "type": "object", + "description": "Describes the base virtual machine profile for fleet", + "properties": { + "osProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetOSProfile", + "description": "Specifies the operating system settings for the virtual machines in the scale\nset." + }, + "storageProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "networkProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile", + "description": "Specifies properties of the network interfaces of the virtual machines in the\nscale set." + }, + "securityProfile": { + "$ref": "#/definitions/SecurityProfile", + "description": "Specifies the Security related profile settings for the virtual machines in the\nscale set." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/DiagnosticsProfile", + "description": "Specifies the boot diagnostic settings state." + }, + "extensionProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile", + "description": "Specifies a collection of settings for extensions installed on virtual machines\nin the scale set." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises.\n

Possible values for Windows Server operating system are:

\nWindows_Client

Windows_Server

Possible values for Linux\nServer operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS\n(for SUSE)

For more information, see [Azure Hybrid Use Benefit for\nWindows\nServer](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)\n

[Azure Hybrid Use Benefit for Linux\nServer](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)\n

Minimum api-version: 2015-06-15" + }, + "scheduledEventsProfile": { + "$ref": "#/definitions/ScheduledEventsProfile", + "description": "Specifies Scheduled Event related configurations." + }, + "userData": { + "type": "string", + "description": "UserData for the virtual machines in the scale set, which must be base-64\nencoded. Customer should not pass any secrets in here. Minimum api-version:\n2021-03-01." + }, + "capacityReservation": { + "$ref": "#/definitions/CapacityReservationProfile", + "description": "Specifies the capacity reservation related details of a scale set. Minimum\napi-version: 2021-04-01." + }, + "applicationProfile": { + "$ref": "#/definitions/ApplicationProfile", + "description": "Specifies the gallery applications that should be made available to the VM/VMSS" + }, + "hardwareProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetHardwareProfile", + "description": "Specifies the hardware profile related details of a scale set. Minimum\napi-version: 2021-11-01." + }, + "serviceArtifactReference": { + "$ref": "#/definitions/ServiceArtifactReference", + "description": "Specifies the service artifact reference id used to set same image version for\nall virtual machines in the scale set when using 'latest' image version.\nMinimum api-version: 2022-11-01" + }, + "securityPostureReference": { + "$ref": "#/definitions/SecurityPostureReference", + "description": "Specifies the security posture to be used for all virtual machines in the scale\nset. Minimum api-version: 2023-03-01" + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "Specifies the time in which this VM profile for the Virtual Machine Scale Set\nwas created. Minimum API version for this property is 2023-09-01. This value\nwill be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile\nwith minimum api-version 2023-09-01. Examples: \"2024-07-01T00:00:01.1234567+00:00\"", + "readOnly": true + } + } + }, + "BootDiagnostics": { + "type": "object", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output\nand Screenshot to diagnose VM status. You can easily view the output of your\nconsole log. Azure also enables you to see a screenshot of the VM from the\nhypervisor.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether boot diagnostics should be enabled on the Virtual Machine." + }, + "storageUri": { + "type": "string", + "description": "Uri of the storage account to use for placing the console output and\nscreenshot. If storageUri is not specified while enabling boot diagnostics,\nmanaged storage will be used." + } + } + }, + "CachingTypes": { "type": "string", - "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).", + "description": "Specifies the caching requirements.", "enum": [ "None", - "SystemAssigned", - "UserAssigned", - "SystemAssigned,UserAssigned" + "ReadOnly", + "ReadWrite" ], "x-ms-enum": { - "name": "ManagedServiceIdentityType", + "name": "CachingTypes", "modelAsString": true, "values": [ { "name": "None", "value": "None", - "description": "No managed identity." - }, - { - "name": "SystemAssigned", - "value": "SystemAssigned", - "description": "System assigned managed identity." + "description": "'None' is default for Standard Storage" }, { - "name": "UserAssigned", - "value": "UserAssigned", - "description": "User assigned managed identity." + "name": "ReadOnly", + "value": "ReadOnly", + "description": "'ReadOnly' is default for Premium Storage" }, { - "name": "SystemAndUserAssigned", - "value": "SystemAssigned,UserAssigned", - "description": "System and user assigned managed identity." + "name": "ReadWrite", + "value": "ReadWrite", + "description": "'ReadWrite' is default for OS Disk" } ] } }, - "BasePriorityProfile": { + "CapacityReservationProfile": { "type": "object", - "description": "Contains common properties that are applicable to both Spot and Regular.", + "description": "The parameters of a capacity reservation Profile.", "properties": { - "capacity": { - "type": "integer", - "format": "int32", - "description": "Total capacity to achieve. It is currently in terms of number of VMs.", - "minimum": 0 - }, - "minCapacity": { - "type": "integer", - "format": "int32", - "description": "Minimum capacity to achieve which cannot be updated. If we will not be able to \"guarantee\" minimum capacity, we will reject the request in the sync path itself.", - "minimum": 0 + "capacityReservationGroup": { + "$ref": "#/definitions/SubResource", + "description": "Specifies the capacity reservation group resource id that should be used for\nallocating the virtual machine or scaleset vm instances provided enough\ncapacity has been reserved. Please refer to https://aka.ms/CapacityReservation\nfor more details." } } }, @@ -545,7 +749,7 @@ "description": "Compute Profile to use for running user's workloads.", "properties": { "baseVirtualMachineProfile": { - "$ref": "../../../../../compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineScaleSet.json#/definitions/VirtualMachineScaleSetVMProfile", + "$ref": "#/definitions/BaseVirtualMachineProfile", "description": "Base Virtual Machine Profile Properties to be specified according to \"specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/{computeApiVersion}/virtualMachineScaleSet.json#/definitions/VirtualMachineScaleSetVMProfile\"" }, "computeApiVersion": { @@ -557,17 +761,247 @@ "baseVirtualMachineProfile" ] }, - "ComputeProfileUpdate": { + "DeleteOptions": { + "type": "string", + "description": "Specify what happens to the network interface when the VM is deleted", + "enum": [ + "Delete", + "Detach" + ], + "x-ms-enum": { + "name": "DeleteOptions", + "modelAsString": true, + "values": [ + { + "name": "Delete", + "value": "Delete", + "description": "Delete Option" + }, + { + "name": "Detach", + "value": "Detach", + "description": "Detach Option" + } + ] + } + }, + "DiagnosticsProfile": { "type": "object", - "description": "Compute Profile to use for running user's workloads.", + "description": "Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.", "properties": { - "baseVirtualMachineProfile": { - "$ref": "../../../../../compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineScaleSet.json#/definitions/VirtualMachineScaleSetVMProfile", - "description": "Base Virtual Machine Profile Properties to be specified according to \"specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/{computeApiVersion}/virtualMachineScaleSet.json#/definitions/VirtualMachineScaleSetVMProfile\"" + "bootDiagnostics": { + "$ref": "#/definitions/BootDiagnostics", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output\nand Screenshot to diagnose VM status. **NOTE**: If storageUri is being\nspecified then ensure that the storage account is in the same region and\nsubscription as the VM. You can easily view the output of your console log.\nAzure also enables you to see a screenshot of the VM from the hypervisor." + } + } + }, + "DiffDiskOptions": { + "type": "string", + "description": "Specifies the ephemeral disk option for operating system disk.", + "enum": [ + "Local" + ], + "x-ms-enum": { + "name": "DiffDiskOptions", + "modelAsString": true, + "values": [ + { + "name": "Local", + "value": "Local", + "description": "Local Option." + } + ] + } + }, + "DiffDiskPlacement": { + "type": "string", + "description": "Specifies the ephemeral disk placement for operating system disk. This property\ncan be used by user in the request to choose the location i.e, cache disk or\nresource disk space for Ephemeral OS disk provisioning. For more information on\nEphemeral OS disk size requirements, please refer Ephemeral OS disk size\nrequirements for Windows VM at\nhttps://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements\nand Linux VM at\nhttps://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements\nMinimum api-version for NvmeDisk: 2024-03-01.", + "enum": [ + "CacheDisk", + "ResourceDisk", + "NvmeDisk" + ], + "x-ms-enum": { + "name": "DiffDiskPlacement", + "modelAsString": true, + "values": [ + { + "name": "CacheDisk", + "value": "CacheDisk", + "description": "CacheDisk option." + }, + { + "name": "ResourceDisk", + "value": "ResourceDisk", + "description": "Resource Disk option." + }, + { + "name": "NvmeDisk", + "value": "NvmeDisk", + "description": "NvmeDisk option." + } + ] + } + }, + "DiffDiskSettings": { + "type": "object", + "description": "Describes the parameters of ephemeral disk settings that can be specified for\noperating system disk. **Note:** The ephemeral disk settings can only be\nspecified for managed disk.", + "properties": { + "option": { + "$ref": "#/definitions/DiffDiskOptions", + "description": "Specifies the ephemeral disk settings for operating system disk." }, - "computeApiVersion": { + "placement": { + "$ref": "#/definitions/DiffDiskPlacement", + "description": "Specifies the ephemeral disk placement for operating system disk. Possible\nvalues are: **CacheDisk,** **ResourceDisk.** The defaulting behavior is:\n**CacheDisk** if one is configured for the VM size otherwise **ResourceDisk**\nis used. Refer to the VM size documentation for Windows VM at\nhttps://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at\nhttps://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM\nsizes exposes a cache disk." + } + } + }, + "DiskControllerTypes": { + "type": "string", + "description": "Specifies the disk controller type configured for the VM and\nVirtualMachineScaleSet. This property is only supported for virtual machines\nwhose operating system disk and VM sku supports Generation 2\n(https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), please\ncheck the HyperVGenerations capability returned as part of VM sku capabilities\nin the response of Microsoft.Compute SKUs api for the region contains V2\n(https://docs.microsoft.com/rest/api/compute/resourceskus/list). For more\ninformation about Disk Controller Types supported please refer to\nhttps://aka.ms/azure-diskcontrollertypes.", + "enum": [ + "SCSI", + "NVMe" + ], + "x-ms-enum": { + "name": "DiskControllerTypes", + "modelAsString": true, + "values": [ + { + "name": "SCSI", + "value": "SCSI", + "description": "SCSI disk type" + }, + { + "name": "NVMe", + "value": "NVMe", + "description": "NVMe disk type" + } + ] + } + }, + "DiskCreateOptionTypes": { + "type": "string", + "description": "Specifies how the virtual machine should be created.", + "enum": [ + "FromImage", + "Empty", + "Attach", + "Copy", + "Restore" + ], + "x-ms-enum": { + "name": "DiskCreateOptionTypes", + "modelAsString": true, + "values": [ + { + "name": "FromImage", + "value": "FromImage", + "description": "This value is used when you are using an image to create the virtual machine.\nIf you are using a platform image, you also use the imageReference element\ndescribed above. If you are using a marketplace image, you also use the\nplan element previously described." + }, + { + "name": "Empty", + "value": "Empty", + "description": "This value is used when creating an empty data disk." + }, + { + "name": "Attach", + "value": "Attach", + "description": "This value is used when you are using a specialized disk to create the virtual machine." + }, + { + "name": "Copy", + "value": "Copy", + "description": "This value is used to create a data disk from a snapshot or another disk." + }, + { + "name": "Restore", + "value": "Restore", + "description": "This value is used to create a data disk from a disk restore point." + } + ] + } + }, + "DiskDeleteOptionTypes": { + "type": "string", + "description": "Specifies the behavior of the managed disk when the VM gets deleted, for\nexample whether the managed disk is deleted or detached. Supported values are:\n**Delete.** If this value is used, the managed disk is deleted when VM gets\ndeleted. **Detach.** If this value is used, the managed disk is retained after\nVM gets deleted. Minimum api-version: 2021-03-01.", + "enum": [ + "Delete", + "Detach" + ], + "x-ms-enum": { + "name": "DiskDeleteOptionTypes", + "modelAsString": true, + "values": [ + { + "name": "Delete", + "value": "Delete", + "description": "If this value is used, the managed disk is deleted when VM gets deleted." + }, + { + "name": "Detach", + "value": "Detach", + "description": "If this value is used, the managed disk is retained after VM gets deleted." + } + ] + } + }, + "DiskEncryptionSetParameters": { + "type": "object", + "description": "Describes the parameter of customer managed disk encryption set resource id\nthat can be specified for disk. **Note:** The disk encryption set resource id\ncan only be specified for managed disk. Please refer\nhttps://aka.ms/mdssewithcmkoverview for more details.", + "properties": { + "id": { "type": "string", - "description": "Specifies the Microsoft.Compute API version to use when creating underlying Virtual Machine scale sets and Virtual Machines.\nThe default value will be the latest supported computeApiVersion by Compute Fleet." + "format": "arm-id", + "description": "Resource Id" + } + } + }, + "DomainNameLabelScopeTypes": { + "type": "string", + "description": "The Domain name label scope.The concatenation of the hashed domain name label\nthat generated according to the policy from domain name label scope and vm\nindex will be the domain name labels of the PublicIPAddress resources that will\nbe created", + "enum": [ + "TenantReuse", + "SubscriptionReuse", + "ResourceGroupReuse", + "NoReuse" + ], + "x-ms-enum": { + "name": "DomainNameLabelScopeTypes", + "modelAsString": true, + "values": [ + { + "name": "TenantReuse", + "value": "TenantReuse", + "description": "TenantReuse type" + }, + { + "name": "SubscriptionReuse", + "value": "SubscriptionReuse", + "description": "SubscriptionReuse type" + }, + { + "name": "ResourceGroupReuse", + "value": "ResourceGroupReuse", + "description": "ResourceGroupReuse type" + }, + { + "name": "NoReuse", + "value": "NoReuse", + "description": "NoReuse type" + } + ] + } + }, + "EncryptionIdentity": { + "type": "object", + "description": "Specifies the Managed Identity used by ADE to get access token for keyvault\noperations.", + "properties": { + "userAssignedIdentityResourceId": { + "type": "string", + "format": "arm-id", + "description": "Specifies ARM Resource ID of one of the user identities associated with the VM." } } }, @@ -675,6 +1109,17 @@ "computeProfile": { "$ref": "#/definitions/ComputeProfile", "description": "Compute Profile to use for running user's workloads." + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "Specifies the time at which the Compute Fleet is created.", + "readOnly": true + }, + "uniqueId": { + "type": "string", + "description": "Specifies the ID which uniquely identifies a Compute Fleet.", + "readOnly": true } }, "required": [ @@ -682,35 +1127,9 @@ "computeProfile" ] }, - "FleetPropertiesUpdate": { + "FleetUpdate": { "type": "object", - "description": "Details of the Compute Fleet.", - "properties": { - "spotPriorityProfile": { - "$ref": "#/definitions/SpotPriorityProfile", - "description": "Configuration Options for Spot instances in Compute Fleet." - }, - "regularPriorityProfile": { - "$ref": "#/definitions/RegularPriorityProfile", - "description": "Configuration Options for Regular instances in Compute Fleet." - }, - "vmSizesProfile": { - "type": "array", - "description": "List of VM sizes supported for Compute Fleet", - "items": { - "$ref": "#/definitions/VmSizeProfile" - }, - "x-ms-identifiers": [] - }, - "computeProfile": { - "$ref": "#/definitions/ComputeProfileUpdate", - "description": "Compute Profile to use for running user's workloads." - } - } - }, - "FleetUpdate": { - "type": "object", - "description": "Fleet Update Model", + "description": "Fleet Update Model", "properties": { "tags": { "type": "object", @@ -728,29 +1147,470 @@ "description": "Updatable resource plan" }, "properties": { - "$ref": "#/definitions/FleetPropertiesUpdate", + "$ref": "#/definitions/FleetProperties", "description": "RP-specific updatable properties" } } }, + "IPVersion": { + "type": "string", + "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the\nspecific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible\nvalues are: 'IPv4' and 'IPv6'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true, + "values": [ + { + "name": "IPv4", + "value": "IPv4", + "description": "IPv4 version" + }, + { + "name": "IPv6", + "value": "IPv6", + "description": "IPv6 version" + } + ] + } + }, + "ImageReference": { + "type": "object", + "description": "Specifies information about the image to use. You can specify information about\nplatform images, marketplace images, or virtual machine images. This element is\nrequired when you want to use a platform image, marketplace image, or virtual\nmachine image, but is not used in other creation operations. NOTE: Image\nreference publisher and offer can only be set when you create the scale set.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "Resource Id" + }, + "publisher": { + "type": "string", + "description": "The image publisher." + }, + "offer": { + "type": "string", + "description": "Specifies the offer of the platform image or marketplace image used to create\nthe virtual machine." + }, + "sku": { + "type": "string", + "description": "The image SKU." + }, + "version": { + "type": "string", + "description": "Specifies the version of the platform image or marketplace image used to create\nthe virtual machine. The allowed formats are Major.Minor.Build or 'latest'.\nMajor, Minor, and Build are decimal numbers. Specify 'latest' to use the latest\nversion of an image available at deploy time. Even if you use 'latest', the VM\nimage will not automatically update after deploy time even if a new version\nbecomes available. Please do not use field 'version' for gallery image\ndeployment, gallery image should always use 'id' field for deployment, to use 'latest'\nversion of gallery image, just set\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}'\nin the 'id' field without version input." + }, + "exactVersion": { + "type": "string", + "description": "Specifies in decimal numbers, the version of platform image or marketplace\nimage used to create the virtual machine. This readonly field differs from 'version',\nonly if the value specified in 'version' field is 'latest'.", + "readOnly": true + }, + "sharedGalleryImageId": { + "type": "string", + "description": "Specified the shared gallery image unique id for vm deployment. This can be\nfetched from shared gallery image GET call." + }, + "communityGalleryImageId": { + "type": "string", + "description": "Specified the community gallery image unique id for vm deployment. This can be\nfetched from community gallery image GET call." + } + } + }, + "InnerError": { + "type": "object", + "description": "Inner error details.", + "properties": { + "exceptionType": { + "type": "string", + "description": "The exception type." + }, + "errorDetail": { + "type": "string", + "description": "The internal error message or exception dump." + } + } + }, + "KeyVaultSecretReference": { + "type": "object", + "description": "Describes a reference to Key Vault Secret", + "properties": { + "secretUrl": { + "type": "string", + "description": "The URL referencing a secret in a Key Vault." + }, + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing the secret." + } + }, + "required": [ + "secretUrl", + "sourceVault" + ] + }, + "LinuxConfiguration": { + "type": "object", + "description": "Specifies the Linux operating system settings on the virtual machine. For a\nlist of supported Linux distributions, see [Linux on Azure-Endorsed\nDistributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros).", + "properties": { + "disablePasswordAuthentication": { + "type": "boolean", + "description": "Specifies whether password authentication should be disabled." + }, + "ssh": { + "$ref": "#/definitions/SshConfiguration", + "description": "Specifies the ssh key configuration for a Linux OS." + }, + "provisionVMAgent": { + "type": "boolean", + "description": "Indicates whether virtual machine agent should be provisioned on the virtual\nmachine. When this property is not specified in the request body, default\nbehavior is to set it to true. This will ensure that VM Agent is installed on\nthe VM so that extensions can be added to the VM later." + }, + "patchSettings": { + "$ref": "#/definitions/LinuxPatchSettings", + "description": "[Preview Feature] Specifies settings related to VM Guest Patching on Linux." + }, + "enableVMAgentPlatformUpdates": { + "type": "boolean", + "description": "Indicates whether VMAgent Platform Updates is enabled for the Linux virtual\nmachine. Default value is false." + } + } + }, + "LinuxPatchAssessmentMode": { + "type": "string", + "description": "Specifies the mode of VM Guest Patch Assessment for the IaaS virtual\nmachine.

Possible values are:

**ImageDefault** - You\ncontrol the timing of patch assessments on a virtual machine.

\n**AutomaticByPlatform** - The platform will trigger periodic patch assessments.\nThe property provisionVMAgent must be true.", + "enum": [ + "ImageDefault", + "AutomaticByPlatform" + ], + "x-ms-enum": { + "name": "LinuxPatchAssessmentMode", + "modelAsString": true, + "values": [ + { + "name": "ImageDefault", + "value": "ImageDefault", + "description": "You control the timing of patch assessments on a virtual machine." + }, + { + "name": "AutomaticByPlatform", + "value": "AutomaticByPlatform", + "description": "The platform will trigger periodic patch assessments.The property provisionVMAgent must be true." + } + ] + } + }, + "LinuxPatchSettings": { + "type": "object", + "description": "Specifies settings related to VM Guest Patching on Linux.", + "properties": { + "patchMode": { + "$ref": "#/definitions/LinuxVMGuestPatchMode", + "description": "Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual\nmachines associated to virtual machine scale set with OrchestrationMode as\nFlexible.

Possible values are:

**ImageDefault** - The\nvirtual machine's default patching configuration is used.

\n**AutomaticByPlatform** - The virtual machine will be automatically updated by\nthe platform. The property provisionVMAgent must be true" + }, + "assessmentMode": { + "$ref": "#/definitions/LinuxPatchAssessmentMode", + "description": "Specifies the mode of VM Guest Patch Assessment for the IaaS virtual\nmachine.

Possible values are:

**ImageDefault** - You\ncontrol the timing of patch assessments on a virtual machine.

\n**AutomaticByPlatform** - The platform will trigger periodic patch assessments.\nThe property provisionVMAgent must be true." + }, + "automaticByPlatformSettings": { + "$ref": "#/definitions/LinuxVMGuestPatchAutomaticByPlatformSettings", + "description": "Specifies additional settings for patch mode AutomaticByPlatform in VM Guest\nPatching on Linux." + } + } + }, + "LinuxVMGuestPatchAutomaticByPlatformRebootSetting": { + "type": "string", + "description": "Specifies the reboot setting for all AutomaticByPlatform patch installation\noperations.", + "enum": [ + "Unknown", + "IfRequired", + "Never", + "Always" + ], + "x-ms-enum": { + "name": "LinuxVMGuestPatchAutomaticByPlatformRebootSetting", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Reboot setting" + }, + { + "name": "IfRequired", + "value": "IfRequired", + "description": "IfRequired Reboot setting" + }, + { + "name": "Never", + "value": "Never", + "description": "Never Reboot setting" + }, + { + "name": "Always", + "value": "Always", + "description": "Always Reboot setting" + } + ] + } + }, + "LinuxVMGuestPatchAutomaticByPlatformSettings": { + "type": "object", + "description": "Specifies additional settings to be applied when patch mode AutomaticByPlatform\nis selected in Linux patch settings.", + "properties": { + "rebootSetting": { + "$ref": "#/definitions/LinuxVMGuestPatchAutomaticByPlatformRebootSetting", + "description": "Specifies the reboot setting for all AutomaticByPlatform patch installation\noperations." + }, + "bypassPlatformSafetyChecksOnUserSchedule": { + "type": "boolean", + "description": "Enables customer to schedule patching without accidental upgrades" + } + } + }, + "LinuxVMGuestPatchMode": { + "type": "string", + "description": "Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual\nmachines associated to virtual machine scale set with OrchestrationMode as\nFlexible.", + "enum": [ + "ImageDefault", + "AutomaticByPlatform" + ], + "x-ms-enum": { + "name": "LinuxVMGuestPatchMode", + "modelAsString": true, + "values": [ + { + "name": "ImageDefault", + "value": "ImageDefault", + "description": "The virtual machine's default patching configuration is used." + }, + { + "name": "AutomaticByPlatform", + "value": "AutomaticByPlatform", + "description": "The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true." + } + ] + } + }, "ManagedServiceIdentityUpdate": { "type": "object", "description": "The template for adding optional properties.", "properties": { "type": { - "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.ManagedServiceIdentityType", + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentityType", "description": "The type of managed identity assigned to this resource." }, "userAssignedIdentities": { "type": "object", "description": "The identities assigned to this resource by the user.", - "x-nullable": true, "additionalProperties": { - "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/UserAssignedIdentity" + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/UserAssignedIdentity" + } + ], + "type": "object", + "x-nullable": true + } + } + } + }, + "Mode": { + "type": "string", + "description": "Specifies the mode that ProxyAgent will execute on if the feature is enabled.\nProxyAgent will start to audit or monitor but not enforce access control over\nrequests to host endpoints in Audit mode, while in Enforce mode it will enforce\naccess control. The default value is Enforce mode.", + "enum": [ + "Audit", + "Enforce" + ], + "x-ms-enum": { + "name": "Mode", + "modelAsString": true, + "values": [ + { + "name": "Audit", + "value": "Audit", + "description": "Audit Mode" + }, + { + "name": "Enforce", + "value": "Enforce", + "description": "Enforce Mode" + } + ] + } + }, + "NetworkApiVersion": { + "type": "string", + "description": "specifies the Microsoft.Network API version used when creating networking\nresources in the Network Interface Configurations for Virtual Machine Scale Set\nwith orchestration mode 'Flexible'", + "enum": [ + "2020-11-01" + ], + "x-ms-enum": { + "name": "NetworkApiVersion", + "modelAsString": true, + "values": [ + { + "name": "2020-11-01", + "value": "2020-11-01", + "description": "Initial version supported. Later versions are supported as well." + } + ] + } + }, + "NetworkInterfaceAuxiliaryMode": { + "type": "string", + "description": "Specifies whether the Auxiliary mode is enabled for the Network Interface\nresource.", + "enum": [ + "None", + "AcceleratedConnections", + "Floating" + ], + "x-ms-enum": { + "name": "NetworkInterfaceAuxiliaryMode", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "None Mode" + }, + { + "name": "AcceleratedConnections", + "value": "AcceleratedConnections", + "description": "AcceleratedConnections Mode" + }, + { + "name": "Floating", + "value": "Floating", + "description": "Floating Mode" + } + ] + } + }, + "NetworkInterfaceAuxiliarySku": { + "type": "string", + "description": "Specifies whether the Auxiliary sku is enabled for the Network Interface\nresource.", + "enum": [ + "None", + "A1", + "A2", + "A4", + "A8" + ], + "x-ms-enum": { + "name": "NetworkInterfaceAuxiliarySku", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "no sku" + }, + { + "name": "A1", + "value": "A1", + "description": "A1 sku" + }, + { + "name": "A2", + "value": "A2", + "description": "A2 sku" + }, + { + "name": "A4", + "value": "A4", + "description": "A4 sku" + }, + { + "name": "A8", + "value": "A8", + "description": "A8 sku" + } + ] + } + }, + "OSImageNotificationProfile": { + "type": "object", + "description": "Specifies OS Image Scheduled Event related configurations.", + "properties": { + "notBeforeTimeout": { + "type": "string", + "description": "Length of time a Virtual Machine being reimaged or having its OS upgraded will\nhave to potentially approve the OS Image Scheduled Event before the event is\nauto approved (timed out). The configuration is specified in ISO 8601 format,\nand the value must not exceed 15 minutes (PT15M)" + }, + "enable": { + "type": "boolean", + "description": "Specifies whether the OS Image Scheduled event is enabled or disabled." + } + } + }, + "OperatingSystemTypes": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the\ndisk if creating a VM from user-image or a specialized VHD. Possible values\nare: **Windows,** **Linux.**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": true, + "values": [ + { + "name": "Windows", + "value": "Windows", + "description": "Windows OS type" + }, + { + "name": "Linux", + "value": "Linux", + "description": "Linux OS type" } + ] + } + }, + "PatchSettings": { + "type": "object", + "description": "Specifies settings related to VM Guest Patching on Windows.", + "properties": { + "patchMode": { + "$ref": "#/definitions/WindowsVMGuestPatchMode", + "description": "Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual\nmachines associated to virtual machine scale set with OrchestrationMode as\nFlexible.

Possible values are:

**Manual** - You\ncontrol the application of patches to a virtual machine. You do this by\napplying patches manually inside the VM. In this mode, automatic updates are\ndisabled; the property WindowsConfiguration.enableAutomaticUpdates must be\nfalse

**AutomaticByOS** - The virtual machine will automatically be\nupdated by the OS. The property WindowsConfiguration.enableAutomaticUpdates\nmust be true.

**AutomaticByPlatform** - the virtual machine will\nautomatically updated by the platform. The properties provisionVMAgent and\nWindowsConfiguration.enableAutomaticUpdates must be true" + }, + "enableHotpatching": { + "type": "boolean", + "description": "Enables customers to patch their Azure VMs without requiring a reboot. For\nenableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode'\nmust be set to 'AutomaticByPlatform'." + }, + "assessmentMode": { + "$ref": "#/definitions/WindowsPatchAssessmentMode", + "description": "Specifies the mode of VM Guest patch assessment for the IaaS virtual\nmachine.

Possible values are:

**ImageDefault** - You\ncontrol the timing of patch assessments on a virtual machine.

\n**AutomaticByPlatform** - The platform will trigger periodic patch assessments.\nThe property provisionVMAgent must be true." + }, + "automaticByPlatformSettings": { + "$ref": "#/definitions/WindowsVMGuestPatchAutomaticByPlatformSettings", + "description": "Specifies additional settings for patch mode AutomaticByPlatform in VM Guest\nPatching on Windows." } } }, + "ProtocolTypes": { + "type": "string", + "description": "Specifies the protocol of WinRM listener. Possible values are: **http,**\n**https.**", + "enum": [ + "Http", + "Https" + ], + "x-ms-enum": { + "name": "ProtocolTypes", + "modelAsString": true, + "values": [ + { + "name": "Http", + "value": "Http", + "description": "Http protocol" + }, + { + "name": "Https", + "value": "Https", + "description": "Https protocol" + } + ] + } + }, "ProvisioningState": { "type": "string", "description": "The status of the current operation.", @@ -806,13 +1666,94 @@ }, "readOnly": true }, - "RegularPriorityAllocationStrategy": { - "type": "string", - "description": "Regular VM Allocation strategy types for Compute Fleet", - "enum": [ - "LowestPrice" - ], - "x-ms-enum": { + "ProxyAgentSettings": { + "type": "object", + "description": "Specifies ProxyAgent settings while creating the virtual machine. Minimum\napi-version: 2023-09-01.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Specifies whether ProxyAgent feature should be enabled on the virtual machine\nor virtual machine scale set." + }, + "mode": { + "$ref": "#/definitions/Mode", + "description": "Specifies the mode that ProxyAgent will execute on if the feature is enabled.\nProxyAgent will start to audit or monitor but not enforce access control over\nrequests to host endpoints in Audit mode, while in Enforce mode it will enforce\naccess control. The default value is Enforce mode." + }, + "keyIncarnationId": { + "type": "integer", + "format": "int32", + "description": "Increase the value of this property allows user to reset the key used for\nsecuring communication channel between guest and host." + } + } + }, + "PublicIPAddressSku": { + "type": "object", + "description": "Describes the public IP Sku. It can only be set with OrchestrationMode as\nFlexible.", + "properties": { + "name": { + "$ref": "#/definitions/PublicIPAddressSkuName", + "description": "Specify public IP sku name" + }, + "tier": { + "$ref": "#/definitions/PublicIPAddressSkuTier", + "description": "Specify public IP sku tier" + } + } + }, + "PublicIPAddressSkuName": { + "type": "string", + "description": "Specify public IP sku name.", + "enum": [ + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "PublicIPAddressSkuName", + "modelAsString": true, + "values": [ + { + "name": "Basic", + "value": "Basic", + "description": "Basic sku name" + }, + { + "name": "Standard", + "value": "Standard", + "description": "Standard sku name" + } + ] + } + }, + "PublicIPAddressSkuTier": { + "type": "string", + "description": "Specify public IP sku tier", + "enum": [ + "Regional", + "Global" + ], + "x-ms-enum": { + "name": "PublicIPAddressSkuTier", + "modelAsString": true, + "values": [ + { + "name": "Regional", + "value": "Regional", + "description": "Regional sku tier" + }, + { + "name": "Global", + "value": "Global", + "description": "Global sku tier" + } + ] + } + }, + "RegularPriorityAllocationStrategy": { + "type": "string", + "description": "Regular VM Allocation strategy types for Compute Fleet", + "enum": [ + "LowestPrice" + ], + "x-ms-enum": { "name": "RegularPriorityAllocationStrategy", "modelAsString": true, "values": [ @@ -872,6 +1813,156 @@ } } }, + "ScheduledEventsProfile": { + "type": "object", + "description": "Specifies Scheduled Event related configurations.", + "properties": { + "terminateNotificationProfile": { + "$ref": "#/definitions/TerminateNotificationProfile", + "description": "Specifies Terminate Scheduled Event related configurations." + }, + "osImageNotificationProfile": { + "$ref": "#/definitions/OSImageNotificationProfile", + "description": "Specifies OS Image Scheduled Event related configurations." + } + } + }, + "SecurityEncryptionTypes": { + "type": "string", + "description": "Specifies the EncryptionType of the managed disk.\n**Note:** It can be set for only Confidential VMs.", + "enum": [ + "VMGuestStateOnly", + "DiskWithVMGuestState", + "NonPersistedTPM" + ], + "x-ms-enum": { + "name": "SecurityEncryptionTypes", + "modelAsString": true, + "values": [ + { + "name": "VMGuestStateOnly", + "value": "VMGuestStateOnly", + "description": "EncryptionType of the managed disk is set to VMGuestStateOnly for encryption\nof just the VMGuestState blob." + }, + { + "name": "DiskWithVMGuestState", + "value": "DiskWithVMGuestState", + "description": "EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption\nof the managed disk along with VMGuestState blob." + }, + { + "name": "NonPersistedTPM", + "value": "NonPersistedTPM", + "description": "EncryptionType of the managed disk is set to NonPersistedTPM for not persisting\nfirmware state in the VMGuestState blob." + } + ] + } + }, + "SecurityPostureReference": { + "type": "object", + "description": "Specifies the security posture to be used for all virtual machines in the scale\nset. Minimum api-version: 2023-03-01", + "properties": { + "id": { + "type": "string", + "description": "The security posture reference id in the form of\n/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest" + }, + "excludeExtensions": { + "type": "array", + "description": "List of virtual machine extension names to exclude when applying the security\nposture.", + "items": { + "type": "string" + } + }, + "isOverridable": { + "type": "boolean", + "description": "Whether the security posture can be overridden by the user." + } + } + }, + "SecurityProfile": { + "type": "object", + "description": "Specifies the Security profile settings for the virtual machine or virtual\nmachine scale set.", + "properties": { + "uefiSettings": { + "$ref": "#/definitions/UefiSettings", + "description": "Specifies the security settings like secure boot and vTPM used while creating\nthe virtual machine. Minimum api-version: 2020-12-01." + }, + "encryptionAtHost": { + "type": "boolean", + "description": "This property can be used by user in the request to enable or disable the Host\nEncryption for the virtual machine or virtual machine scale set. This will\nenable the encryption for all the disks including Resource/Temp disk at host\nitself. The default behavior is: The Encryption at host will be disabled unless\nthis property is set to true for the resource." + }, + "securityType": { + "$ref": "#/definitions/SecurityTypes", + "description": "Specifies the SecurityType of the virtual machine. It has to be set to any\nspecified value to enable UefiSettings. The default behavior is: UefiSettings\nwill not be enabled unless this property is set." + }, + "encryptionIdentity": { + "$ref": "#/definitions/EncryptionIdentity", + "description": "Specifies the Managed Identity used by ADE to get access token for keyvault\noperations." + }, + "proxyAgentSettings": { + "$ref": "#/definitions/ProxyAgentSettings", + "description": "Specifies ProxyAgent settings while creating the virtual machine. Minimum\napi-version: 2023-09-01." + } + } + }, + "SecurityTypes": { + "type": "string", + "description": "Specifies the SecurityType of the virtual machine. It has to be set to any\nspecified value to enable UefiSettings. The default behavior is: UefiSettings\nwill not be enabled unless this property is set.", + "enum": [ + "TrustedLaunch", + "ConfidentialVM" + ], + "x-ms-enum": { + "name": "SecurityTypes", + "modelAsString": true, + "values": [ + { + "name": "TrustedLaunch", + "value": "TrustedLaunch", + "description": "TrustedLaunch security type" + }, + { + "name": "ConfidentialVM", + "value": "ConfidentialVM", + "description": "ConfidentialVM security type" + } + ] + } + }, + "ServiceArtifactReference": { + "type": "object", + "description": "Specifies the service artifact reference id used to set same image version for\nall virtual machines in the scale set when using 'latest' image version.\nMinimum api-version: 2022-11-01", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The service artifact reference id in the form of\n/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}" + } + } + }, + "SettingNames": { + "type": "string", + "description": "Specifies the name of the setting to which the content applies. Possible values\nare: FirstLogonCommands and AutoLogon.", + "enum": [ + "AutoLogon", + "FirstLogonCommands" + ], + "x-ms-enum": { + "name": "SettingNames", + "modelAsString": true, + "values": [ + { + "name": "AutoLogon", + "value": "AutoLogon", + "description": "AutoLogon setting" + }, + { + "name": "FirstLogonCommands", + "value": "FirstLogonCommands", + "description": "FirstLogonCommands setting" + } + ] + } + }, "SpotAllocationStrategy": { "type": "string", "description": "Spot allocation strategy types for Compute Fleet", @@ -933,70 +2024,1114 @@ } } }, - "VirtualMachineScaleSet": { + "SshConfiguration": { "type": "object", - "description": "An AzureFleet's virtualMachineScaleSet", + "description": "SSH configuration for Linux based VMs running on Azure", "properties": { - "name": { + "publicKeys": { + "type": "array", + "description": "The list of SSH public keys used to authenticate with linux based VMs.", + "items": { + "$ref": "#/definitions/SshPublicKey" + }, + "x-ms-identifiers": [ + "path" + ] + } + } + }, + "SshPublicKey": { + "type": "object", + "description": "Contains information about SSH certificate public key and the path on the Linux\nVM where the public key is placed.", + "properties": { + "path": { "type": "string", - "description": "The name of the virtualMachineScaleSet", - "readOnly": true + "description": "Specifies the full path on the created VM where ssh public key is stored. If\nthe file already exists, the specified key is appended to the file. Example:\n/home/user/.ssh/authorized_keys" }, + "keyData": { + "type": "string", + "description": "SSH public key certificate used to authenticate with the VM through ssh. The\nkey needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys,\nsee [Create SSH keys on Linux and Mac for Linux VMs in\nAzure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed)." + } + } + }, + "StatusLevelTypes": { + "type": "string", + "description": "The level code.", + "enum": [ + "Info", + "Warning", + "Error" + ], + "x-ms-enum": { + "name": "StatusLevelTypes", + "modelAsString": true, + "values": [ + { + "name": "Info", + "value": "Info", + "description": "Info level" + }, + { + "name": "Warning", + "value": "Warning", + "description": "Warning level" + }, + { + "name": "Error", + "value": "Error", + "description": "Error Level" + } + ] + } + }, + "StorageAccountTypes": { + "type": "string", + "description": "Specifies the storage account type for the managed disk. Managed OS disk\nstorage account type can only be set when you create the scale set. NOTE:\nUltraSSD_LRS can only be used with data disks. It cannot be used with OS Disk.\nStandard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS\nuses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD\nzone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant\nstorage. For more information regarding disks supported for Windows Virtual\nMachines, refer to\nhttps://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for\nLinux Virtual Machines, refer to\nhttps://docs.microsoft.com/azure/virtual-machines/linux/disks-types", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "UltraSSD_LRS", + "Premium_ZRS", + "StandardSSD_ZRS", + "PremiumV2_LRS" + ], + "x-ms-enum": { + "name": "StorageAccountTypes", + "modelAsString": true, + "values": [ + { + "name": "Standard_LRS", + "value": "Standard_LRS", + "description": "Standard_LRS option." + }, + { + "name": "Premium_LRS", + "value": "Premium_LRS", + "description": "Premium_LRS option." + }, + { + "name": "StandardSSD_LRS", + "value": "StandardSSD_LRS", + "description": "StandardSSD_LRS option." + }, + { + "name": "UltraSSD_LRS", + "value": "UltraSSD_LRS", + "description": "UltraSSD_LRS option." + }, + { + "name": "Premium_ZRS", + "value": "Premium_ZRS", + "description": "Premium_ZRS option." + }, + { + "name": "StandardSSD_ZRS", + "value": "StandardSSD_ZRS", + "description": "StandardSSD_ZRS option." + }, + { + "name": "PremiumV2_LRS", + "value": "PremiumV2_LRS", + "description": "PremiumV2_LRS option." + } + ] + } + }, + "SubResource": { + "type": "object", + "description": "Describes SubResource", + "properties": { "id": { "type": "string", - "description": "The compute RP resource id of the virtualMachineScaleSet \n\"subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}\"", - "readOnly": true - }, - "type": { + "format": "arm-id", + "description": "Resource Id" + } + } + }, + "SubResourceReadOnly": { + "type": "object", + "description": "Describes a Readonly subresource.", + "properties": { + "id": { "type": "string", - "description": "Type of the virtualMachineScaleSet", + "format": "arm-id", + "description": "Resource Id", "readOnly": true + } + } + }, + "TerminateNotificationProfile": { + "type": "object", + "description": "Specifies Terminate Scheduled Event related configurations.", + "properties": { + "notBeforeTimeout": { + "type": "string", + "description": "Configurable length of time a Virtual Machine being deleted will have to\npotentially approve the Terminate Scheduled Event before the event is auto\napproved (timed out). The configuration must be specified in ISO 8601 format,\nthe default value is 5 minutes (PT5M)" }, - "provisioningState": { - "$ref": "#/definitions/ProvisioningState", - "description": "This represents the Provisioning State of the VMSS in response to the last operation that was performed on it by Azure Fleet resource.", - "readOnly": true + "enable": { + "type": "boolean", + "description": "Specifies whether the Terminate Scheduled event is enabled or disabled." } - }, - "required": [ - "name", - "id", - "provisioningState" - ] + } }, - "VirtualMachineScaleSetListResult": { + "UefiSettings": { "type": "object", - "description": "The response of a VirtualMachineScaleSet list operation.", + "description": "Specifies the security settings like secure boot and vTPM used while creating\nthe virtual machine. Minimum api-version: 2020-12-01.", "properties": { - "value": { - "type": "array", - "description": "The VirtualMachineScaleSet items on this page", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSet" - } + "secureBootEnabled": { + "type": "boolean", + "description": "Specifies whether secure boot should be enabled on the virtual machine. Minimum\napi-version: 2020-12-01." }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" + "vTpmEnabled": { + "type": "boolean", + "description": "Specifies whether vTPM should be enabled on the virtual machine. Minimum\napi-version: 2020-12-01." } - }, - "required": [ - "value" - ] + } }, - "VmSizeProfile": { + "VMDiskSecurityProfile": { "type": "object", - "description": "Specifications about a VM Size. This will also contain the corresponding rank and weight in future.", + "description": "Specifies the security profile settings for the managed disk. **Note:** It can\nonly be set for Confidential VMs.", "properties": { - "name": { + "securityEncryptionType": { + "$ref": "#/definitions/SecurityEncryptionTypes", + "description": "Specifies the EncryptionType of the managed disk. It is set to\nDiskWithVMGuestState for encryption of the managed disk along with VMGuestState\nblob, VMGuestStateOnly for encryption of just the VMGuestState blob, and\nNonPersistedTPM for not persisting firmware state in the VMGuestState blob..\n**Note:** It can be set for only Confidential VMs." + }, + "diskEncryptionSet": { + "$ref": "#/definitions/DiskEncryptionSetParameters", + "description": "Specifies the customer managed disk encryption set resource id for the managed\ndisk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and\nVMGuest blob." + } + } + }, + "VMGalleryApplication": { + "type": "object", + "description": "Specifies the required information to reference a compute gallery application\nversion", + "properties": { + "tags": { "type": "string", - "description": "The Sku name (e.g. 'Standard_DS1_v2')" + "description": "Optional, Specifies a passthrough value for more generic context." + }, + "order": { + "type": "integer", + "format": "int32", + "description": "Optional, Specifies the order in which the packages have to be installed" + }, + "packageReferenceId": { + "type": "string", + "format": "arm-id", + "description": "Specifies the GalleryApplicationVersion resource id on the form of\n/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version}" + }, + "configurationReference": { + "type": "string", + "description": "Optional, Specifies the uri to an azure blob that will replace the default\nconfiguration for the package if provided" + }, + "treatFailureAsDeploymentFailure": { + "type": "boolean", + "description": "Optional, If true, any failure for any operation in the VmApplication will fail\nthe deployment" + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "If set to true, when a new Gallery Application version is available in PIR/SIG,\nit will be automatically updated for the VM/VMSS" } }, "required": [ - "name" + "packageReferenceId" ] + }, + "VMSizeProperties": { + "type": "object", + "description": "Specifies VM Size Property settings on the virtual machine.", + "properties": { + "vCPUsAvailable": { + "type": "integer", + "format": "int32", + "description": "Specifies the number of vCPUs available for the VM. When this property is not\nspecified in the request body the default behavior is to set it to the value of\nvCPUs available for that VM size exposed in api response of [List all available\nvirtual machine sizes in a\nregion](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list)." + }, + "vCPUsPerCore": { + "type": "integer", + "format": "int32", + "description": "Specifies the vCPU to physical core ratio. When this property is not specified\nin the request body the default behavior is set to the value of vCPUsPerCore\nfor the VM Size exposed in api response of [List all available virtual machine\nsizes in a\nregion](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list).\n**Setting this property to 1 also means that hyper-threading is disabled.**" + } + } + }, + "VaultCertificate": { + "type": "object", + "description": "Describes a single certificate reference in a Key Vault, and where the\ncertificate should reside on the VM.", + "properties": { + "certificateUrl": { + "type": "string", + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a\nsecret. For adding a secret to the Key Vault, see [Add a key or secret to the\nkey\nvault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add).\nIn this case, your certificate needs to be It is the Base64 encoding of the\nfollowing JSON Object which is encoded in UTF-8:

{
\n\"data\":\"\",
\"dataType\":\"pfx\",
\n\"password\":\"\"
}
To install certificates on a virtual\nmachine it is recommended to use the [Azure Key Vault virtual machine extension\nfor\nLinux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux)\nor the [Azure Key Vault virtual machine extension for\nWindows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)." + }, + "certificateStore": { + "type": "string", + "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to\nwhich the certificate should be added. The specified certificate store is\nimplicitly in the LocalMachine account. For Linux VMs, the certificate file is\nplaced under the /var/lib/waagent directory, with the file name\n<UppercaseThumbprint>.crt for the X509 certificate file and\n<UppercaseThumbprint>.prv for private key. Both of these files are .pem\nformatted." + } + } + }, + "VaultSecretGroup": { + "type": "object", + "description": "Describes a set of certificates which are all in the same Key Vault.", + "properties": { + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing all of the certificates in\nVaultCertificates." + }, + "vaultCertificates": { + "type": "array", + "description": "The list of key vault references in SourceVault which contain certificates.", + "items": { + "$ref": "#/definitions/VaultCertificate" + }, + "x-ms-identifiers": [ + "certificateUrl" + ] + } + } + }, + "VirtualHardDisk": { + "type": "object", + "description": "Describes the uri of a disk.", + "properties": { + "uri": { + "type": "string", + "description": "Specifies the virtual hard disk's uri." + } + } + }, + "VirtualMachineScaleSet": { + "type": "object", + "description": "An AzureFleet's virtualMachineScaleSet", + "properties": { + "name": { + "type": "string", + "description": "The name of the virtualMachineScaleSet", + "readOnly": true + }, + "id": { + "type": "string", + "description": "The compute RP resource id of the virtualMachineScaleSet \n\"subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}\"", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Type of the virtualMachineScaleSet", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "This represents the Provisioning State of the VMSS in response to the last operation that was performed on it by Azure Fleet resource.", + "readOnly": true + } + }, + "required": [ + "name", + "id", + "provisioningState" + ] + }, + "VirtualMachineScaleSetDataDisk": { + "type": "object", + "description": "Describes a virtual machine scale set data disk.", + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "lun": { + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to\nidentify data disks within the VM and therefore must be unique for each data\ndisk attached to a VM." + }, + "caching": { + "$ref": "#/definitions/CachingTypes", + "description": "Specifies the caching requirements. Possible values are: **None,**\n**ReadOnly,** **ReadWrite.** The default values are: **None for Standard\nstorage. ReadOnly for Premium storage.**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "createOption": { + "$ref": "#/definitions/DiskCreateOptionTypes", + "description": "The create option." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used\nto overwrite the size of the disk in a virtual machine image. The property\ndiskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be\nlarger than 1023." + }, + "managedDisk": { + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters", + "description": "The managed disk parameters." + }, + "diskIOPSReadWrite": { + "type": "integer", + "format": "int64", + "description": "Specifies the Read-Write IOPS for the managed disk. Should be used only when\nStorageAccountType is UltraSSD_LRS. If not specified, a default value would be\nassigned based on diskSizeGB." + }, + "diskMBpsReadWrite": { + "type": "integer", + "format": "int64", + "description": "Specifies the bandwidth in MB per second for the managed disk. Should be used\nonly when StorageAccountType is UltraSSD_LRS. If not specified, a default value\nwould be assigned based on diskSizeGB." + }, + "deleteOption": { + "$ref": "#/definitions/DiskDeleteOptionTypes", + "description": "Specifies whether data disk should be deleted or detached upon VMSS Flex\ndeletion (This feature is available for VMSS with Flexible OrchestrationMode\nonly).

Possible values:

**Delete** If this value is used, the\ndata disk is deleted when the VMSS Flex VM is deleted.

**Detach** If\nthis value is used, the data disk is retained after VMSS Flex VM is\ndeleted.

The default value is set to **Delete**." + } + }, + "required": [ + "lun", + "createOption" + ] + }, + "VirtualMachineScaleSetExtension": { + "type": "object", + "description": "Describes a Virtual Machine Scale Set Extension.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "Resource Id", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of the extension." + }, + "type": { + "type": "string", + "description": "Resource type", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties", + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + } + } + }, + "VirtualMachineScaleSetExtensionProfile": { + "type": "object", + "description": "Describes a virtual machine scale set extension profile.", + "properties": { + "extensions": { + "type": "array", + "description": "The virtual machine scale set child extension resources.", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + }, + "extensionsTimeBudget": { + "type": "string", + "description": "Specifies the time alloted for all extensions to start. The time duration\nshould be between 15 minutes and 120 minutes (inclusive) and should be\nspecified in ISO 8601 format. The default value is 90 minutes (PT1H30M).\nMinimum api-version: 2020-06-01." + } + } + }, + "VirtualMachineScaleSetExtensionProperties": { + "type": "object", + "description": "Describes the properties of a Virtual Machine Scale Set Extension.", + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "If a value is provided and is different from the previous value, the extension\nhandler will be forced to update even if the extension configuration has not\nchanged." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is\navailable at deployment time. Once deployed, however, the extension will not\nupgrade minor versions unless redeployed, even with this property set to true." + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "Indicates whether the extension should be automatically upgraded by the\nplatform if there is a newer version of the extension available." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension.", + "additionalProperties": {} + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or\nprotectedSettingsFromKeyVault or no protected settings at all.", + "additionalProperties": {}, + "x-ms-mutability": [ + "update", + "create" + ], + "x-ms-secret": true + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state, which only appears in the response.", + "readOnly": true + }, + "provisionAfterExtensions": { + "type": "array", + "description": "Collection of extension names after which this extension needs to be\nprovisioned.", + "items": { + "type": "string" + } + }, + "suppressFailures": { + "type": "boolean", + "description": "Indicates whether failures stemming from the extension will be suppressed\n(Operational failures such as not connecting to the VM will not be suppressed\nregardless of this value). The default is false." + }, + "protectedSettingsFromKeyVault": { + "$ref": "#/definitions/KeyVaultSecretReference", + "description": "The extensions protected settings that are passed by reference, and consumed\nfrom key vault" + } + } + }, + "VirtualMachineScaleSetHardwareProfile": { + "type": "object", + "description": "Specifies the hardware settings for the virtual machine scale set.", + "properties": { + "vmSizeProperties": { + "$ref": "#/definitions/VMSizeProperties", + "description": "Specifies the properties for customizing the size of the virtual machine.\nMinimum api-version: 2021-11-01. Please follow the instructions in [VM\nCustomization](https://aka.ms/vmcustomization) for more details." + } + } + }, + "VirtualMachineScaleSetIPConfiguration": { + "type": "object", + "description": "Describes a virtual machine scale set network profile's IP configuration.", + "properties": { + "name": { + "type": "string", + "description": "The IP configuration name." + }, + "properties": { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfigurationProperties", + "description": "Describes a virtual machine scale set network profile's IP configuration\nproperties." + } + }, + "required": [ + "name" + ] + }, + "VirtualMachineScaleSetIPConfigurationProperties": { + "type": "object", + "description": "Describes a virtual machine scale set network profile's IP configuration\nproperties.", + "properties": { + "subnet": { + "$ref": "#/definitions/ApiEntityReference", + "description": "Specifies the identifier of the subnet." + }, + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more\nthan 1 network interface." + }, + "publicIPAddressConfiguration": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration", + "description": "The publicIPAddressConfiguration." + }, + "privateIPAddressVersion": { + "$ref": "#/definitions/IPVersion", + "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the\nspecific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible\nvalues are: 'IPv4' and 'IPv6'." + }, + "applicationGatewayBackendAddressPools": { + "type": "array", + "description": "Specifies an array of references to backend address pools of application\ngateways. A scale set can reference backend address pools of multiple\napplication gateways. Multiple scale sets cannot use the same application\ngateway.", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + "applicationSecurityGroups": { + "type": "array", + "description": "Specifies an array of references to application security group.", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + "loadBalancerBackendAddressPools": { + "type": "array", + "description": "Specifies an array of references to backend address pools of load balancers. A\nscale set can reference backend address pools of one public and one internal\nload balancer. Multiple scale sets cannot use the same basic sku load balancer.", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + "loadBalancerInboundNatPools": { + "type": "array", + "description": "Specifies an array of references to inbound Nat pools of the load balancers. A\nscale set can reference inbound nat pools of one public and one internal load\nbalancer. Multiple scale sets cannot use the same basic sku load balancer.", + "items": { + "$ref": "#/definitions/SubResource" + } + } + } + }, + "VirtualMachineScaleSetIpTag": { + "type": "object", + "description": "Contains the IP tag associated with the public IP address.", + "properties": { + "ipTagType": { + "type": "string", + "description": "IP tag type. Example: FirstPartyUsage." + }, + "tag": { + "type": "string", + "description": "IP tag associated with the public IP. Example: SQL, Storage etc." + } + } + }, + "VirtualMachineScaleSetListResult": { + "type": "object", + "description": "The response of a VirtualMachineScaleSet list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VirtualMachineScaleSet items on this page", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VirtualMachineScaleSetManagedDiskParameters": { + "type": "object", + "description": "Describes the parameters of a ScaleSet managed disk.", + "properties": { + "storageAccountType": { + "$ref": "#/definitions/StorageAccountTypes", + "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can\nonly be used with data disks, it cannot be used with OS Disk." + }, + "diskEncryptionSet": { + "$ref": "#/definitions/DiskEncryptionSetParameters", + "description": "Specifies the customer managed disk encryption set resource id for the managed\ndisk." + }, + "securityProfile": { + "$ref": "#/definitions/VMDiskSecurityProfile", + "description": "Specifies the security profile for the managed disk." + } + } + }, + "VirtualMachineScaleSetNetworkConfiguration": { + "type": "object", + "description": "Describes a virtual machine scale set network profile's network configurations.", + "properties": { + "name": { + "type": "string", + "description": "The network configuration name." + }, + "properties": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationProperties", + "description": "Describes a virtual machine scale set network profile's IP configuration." + } + }, + "required": [ + "name" + ] + }, + "VirtualMachineScaleSetNetworkConfigurationDnsSettings": { + "type": "object", + "description": "Describes a virtual machines scale sets network configuration's DNS settings.", + "properties": { + "dnsServers": { + "type": "array", + "description": "List of DNS servers IP addresses", + "items": { + "type": "string" + } + } + } + }, + "VirtualMachineScaleSetNetworkConfigurationProperties": { + "type": "object", + "description": "Describes a virtual machine scale set network profile's IP configuration.", + "properties": { + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more\nthan 1 network interface." + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "description": "Specifies whether the network interface is accelerated networking-enabled." + }, + "disableTcpStateTracking": { + "type": "boolean", + "description": "Specifies whether the network interface is disabled for tcp state tracking." + }, + "enableFpga": { + "type": "boolean", + "description": "Specifies whether the network interface is FPGA networking-enabled." + }, + "networkSecurityGroup": { + "$ref": "#/definitions/SubResource", + "description": "The network security group." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings", + "description": "The dns settings to be applied on the network interfaces." + }, + "ipConfigurations": { + "type": "array", + "description": "Specifies the IP configurations of the network interface.", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "enableIPForwarding": { + "type": "boolean", + "description": "Whether IP forwarding enabled on this NIC." + }, + "deleteOption": { + "$ref": "#/definitions/DeleteOptions", + "description": "Specify what happens to the network interface when the VM is deleted" + }, + "auxiliaryMode": { + "$ref": "#/definitions/NetworkInterfaceAuxiliaryMode", + "description": "Specifies whether the Auxiliary mode is enabled for the Network Interface\nresource." + }, + "auxiliarySku": { + "$ref": "#/definitions/NetworkInterfaceAuxiliarySku", + "description": "Specifies whether the Auxiliary sku is enabled for the Network Interface\nresource." + } + }, + "required": [ + "ipConfigurations" + ] + }, + "VirtualMachineScaleSetNetworkProfile": { + "type": "object", + "description": "Describes a virtual machine scale set network profile.", + "properties": { + "healthProbe": { + "$ref": "#/definitions/ApiEntityReference", + "description": "A reference to a load balancer probe used to determine the health of an\ninstance in the virtual machine scale set. The reference will be in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'." + }, + "networkInterfaceConfigurations": { + "type": "array", + "description": "The list of network configurations.", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" + }, + "x-ms-identifiers": [] + }, + "networkApiVersion": { + "$ref": "#/definitions/NetworkApiVersion", + "description": "specifies the Microsoft.Network API version used when creating networking\nresources in the Network Interface Configurations for Virtual Machine Scale Set\nwith orchestration mode 'Flexible'" + } + } + }, + "VirtualMachineScaleSetOSDisk": { + "type": "object", + "description": "Describes a virtual machine scale set operating system disk.", + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "caching": { + "$ref": "#/definitions/CachingTypes", + "description": "Specifies the caching requirements. Possible values are: **None,**\n**ReadOnly,** **ReadWrite.** The default values are: **None for Standard\nstorage. ReadOnly for Premium storage.**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "createOption": { + "$ref": "#/definitions/DiskCreateOptionTypes", + "description": "Specifies how the virtual machines in the scale set should be created. The only\nallowed value is: **FromImage.** This value is used when you are using an image\nto create the virtual machine. If you are using a platform image, you also use\nthe imageReference element described above. If you are using a marketplace\nimage, you also use the plan element previously described." + }, + "diffDiskSettings": { + "$ref": "#/definitions/DiffDiskSettings", + "description": "Specifies the ephemeral disk Settings for the operating system disk used by the\nvirtual machine scale set." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used\nto overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB'\nis the number of bytes x 1024^3 for the disk and the value cannot\nbe larger than 1023." + }, + "osType": { + "$ref": "#/definitions/OperatingSystemTypes", + "description": "This property allows you to specify the type of the OS that is included in the\ndisk if creating a VM from user-image or a specialized VHD. Possible values\nare: **Windows,** **Linux.**" + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "Specifies information about the unmanaged user image to base the scale set on." + }, + "vhdContainers": { + "type": "array", + "description": "Specifies the container urls that are used to store operating system disks for\nthe scale set.", + "items": { + "type": "string" + } + }, + "managedDisk": { + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters", + "description": "The managed disk parameters." + }, + "deleteOption": { + "$ref": "#/definitions/DiskDeleteOptionTypes", + "description": "Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion\n(This feature is available for VMSS with Flexible OrchestrationMode only).\n

Possible values:

**Delete** If this value is used, the OS\ndisk is deleted when VMSS Flex VM is deleted.

**Detach** If this value\nis used, the OS disk is retained after VMSS Flex VM is deleted.

The\ndefault value is set to **Delete**. For an Ephemeral OS Disk, the default value\nis set to **Delete**. User cannot change the delete option for Ephemeral OS\nDisk." + } + }, + "required": [ + "createOption" + ] + }, + "VirtualMachineScaleSetOSProfile": { + "type": "object", + "description": "Describes a virtual machine scale set OS profile.", + "properties": { + "computerNamePrefix": { + "type": "string", + "description": "Specifies the computer name prefix for all of the virtual machines in the scale\nset. Computer name prefixes must be 1 to 15 characters long." + }, + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

**Windows-only\nrestriction:** Cannot end in \".\"

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

**Minimum-length (Linux):** 1 character

**Max-length\n(Linux):** 64 characters

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

**Minimum-length\n(Windows):** 8 characters

**Minimum-length (Linux):** 6 characters\n

**Max-length (Windows):** 123 characters

**Max-length\n(Linux):** 72 characters

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

**Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\",\n\"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\",\n\"Password22\", \"iloveyou!\"

For resetting the password, see [How to\nreset the Remote Desktop service or its login password in a Windows\nVM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)\n

For resetting root password, see [Manage users, SSH, and check or\nrepair disks on Azure Linux VMs using the VMAccess\nExtension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection)", + "x-ms-mutability": [ + "update", + "create" + ], + "x-ms-secret": true + }, + "customData": { + "type": "string", + "format": "password", + "description": "Specifies a base-64 encoded string of custom data. The base-64 encoded string\nis decoded to a binary array that is saved as a file on the Virtual Machine.\nThe maximum length of the binary array is 65535 bytes. For using cloud-init for\nyour VM, see [Using cloud-init to customize a Linux VM during\ncreation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init)", + "x-ms-mutability": [ + "update", + "create" + ], + "x-ms-secret": true + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "linuxConfiguration": { + "$ref": "#/definitions/LinuxConfiguration", + "description": "Specifies the Linux operating system settings on the virtual machine. For a\nlist of supported Linux distributions, see [Linux on Azure-Endorsed\nDistributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros)." + }, + "secrets": { + "type": "array", + "description": "Specifies set of certificates that should be installed onto the virtual\nmachines in the scale set. To install certificates on a virtual machine it is\nrecommended to use the [Azure Key Vault virtual machine extension for\nLinux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux)\nor the [Azure Key Vault virtual machine extension for\nWindows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows).", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + }, + "x-ms-identifiers": [ + "sourceVault/id" + ] + }, + "allowExtensionOperations": { + "type": "boolean", + "description": "Specifies whether extension operations should be allowed on the virtual machine\nscale set. This may only be set to False when no extensions are present on the\nvirtual machine scale set." + }, + "requireGuestProvisionSignal": { + "type": "boolean", + "description": "Optional property which must either be set to True or omitted." + } + } + }, + "VirtualMachineScaleSetPublicIPAddressConfiguration": { + "type": "object", + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress\nconfiguration", + "properties": { + "name": { + "type": "string", + "description": "The publicIP address configuration name." + }, + "properties": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationProperties", + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress\nconfiguration" + }, + "sku": { + "$ref": "#/definitions/PublicIPAddressSku", + "description": "Describes the public IP Sku. It can only be set with OrchestrationMode as\nFlexible." + } + }, + "required": [ + "name" + ] + }, + "VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings": { + "type": "object", + "description": "Describes a virtual machines scale sets network configuration's DNS settings.", + "properties": { + "domainNameLabel": { + "type": "string", + "description": "The Domain name label.The concatenation of the domain name label and vm index\nwill be the domain name labels of the PublicIPAddress resources that will be\ncreated" + }, + "domainNameLabelScope": { + "$ref": "#/definitions/DomainNameLabelScopeTypes", + "description": "The Domain name label scope.The concatenation of the hashed domain name label\nthat generated according to the policy from domain name label scope and vm\nindex will be the domain name labels of the PublicIPAddress resources that will\nbe created" + } + }, + "required": [ + "domainNameLabel" + ] + }, + "VirtualMachineScaleSetPublicIPAddressConfigurationProperties": { + "type": "object", + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress\nconfiguration", + "properties": { + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The idle timeout of the public IP address." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings", + "description": "The dns settings to be applied on the publicIP addresses ." + }, + "ipTags": { + "type": "array", + "description": "The list of IP tags associated with the public IP address.", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIpTag" + }, + "x-ms-identifiers": [] + }, + "publicIPPrefix": { + "$ref": "#/definitions/SubResource", + "description": "The PublicIPPrefix from which to allocate publicIP addresses." + }, + "publicIPAddressVersion": { + "$ref": "#/definitions/IPVersion", + "description": "Available from Api-Version 2019-07-01 onwards, it represents whether the\nspecific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible\nvalues are: 'IPv4' and 'IPv6'." + }, + "deleteOption": { + "$ref": "#/definitions/DeleteOptions", + "description": "Specify what happens to the public IP when the VM is deleted" + } + } + }, + "VirtualMachineScaleSetStorageProfile": { + "type": "object", + "description": "Describes a virtual machine scale set storage profile.", + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "Specifies information about the image to use. You can specify information about\nplatform images, marketplace images, or virtual machine images. This element is\nrequired when you want to use a platform image, marketplace image, or virtual\nmachine image, but is not used in other creation operations." + }, + "osDisk": { + "$ref": "#/definitions/VirtualMachineScaleSetOSDisk", + "description": "Specifies information about the operating system disk used by the virtual\nmachines in the scale set. For more information about disks, see [About disks\nand VHDs for Azure virtual\nmachines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)." + }, + "dataDisks": { + "type": "array", + "description": "Specifies the parameters that are used to add data disks to the virtual\nmachines in the scale set. For more information about disks, see [About disks\nand VHDs for Azure virtual\nmachines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview).", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" + }, + "x-ms-identifiers": [ + "name", + "lun" + ] + }, + "diskControllerType": { + "$ref": "#/definitions/DiskControllerTypes", + "description": "Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01" + } + } + }, + "VmSizeProfile": { + "type": "object", + "description": "Specifications about a VM Size. This will also contain the corresponding rank and weight in future.", + "properties": { + "name": { + "type": "string", + "description": "The Sku name (e.g. 'Standard_DS1_v2')" + } + }, + "required": [ + "name" + ] + }, + "WinRMConfiguration": { + "type": "object", + "description": "Describes Windows Remote Management configuration of the VM", + "properties": { + "listeners": { + "type": "array", + "description": "The list of Windows Remote Management listeners", + "items": { + "$ref": "#/definitions/WinRMListener" + }, + "x-ms-identifiers": [] + } + } + }, + "WinRMListener": { + "type": "object", + "description": "Describes Protocol and thumbprint of Windows Remote Management listener", + "properties": { + "protocol": { + "$ref": "#/definitions/ProtocolTypes", + "description": "Specifies the protocol of WinRM listener. Possible values are: **http,**\n**https.**" + }, + "certificateUrl": { + "type": "string", + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a\nsecret. For adding a secret to the Key Vault, see [Add a key or secret to the\nkey\nvault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add).\nIn this case, your certificate needs to be the Base64 encoding of the following\nJSON Object which is encoded in UTF-8:

{
\n\"data\":\"\",
\"dataType\":\"pfx\",
\n\"password\":\"\"
}
To install certificates on a virtual\nmachine it is recommended to use the [Azure Key Vault virtual machine extension\nfor\nLinux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux)\nor the [Azure Key Vault virtual machine extension for\nWindows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)." + } + } + }, + "WindowsConfiguration": { + "type": "object", + "description": "Specifies Windows operating system settings on the virtual machine.", + "properties": { + "provisionVMAgent": { + "type": "boolean", + "description": "Indicates whether virtual machine agent should be provisioned on the virtual\nmachine. When this property is not specified in the request body, it is set to\ntrue by default. This will ensure that VM Agent is installed on the VM so that\nextensions can be added to the VM later." + }, + "enableAutomaticUpdates": { + "type": "boolean", + "description": "Indicates whether Automatic Updates is enabled for the Windows virtual machine.\nDefault value is true. For virtual machine scale sets, this property can be\nupdated and updates will take effect on OS reprovisioning." + }, + "timeZone": { + "type": "string", + "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\".\nPossible values can be\n[TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id)\nvalue from time zones returned by\n[TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones)." + }, + "additionalUnattendContent": { + "type": "array", + "description": "Specifies additional base-64 encoded XML formatted information that can be\nincluded in the Unattend.xml file, which is used by Windows Setup.", + "items": { + "$ref": "#/definitions/AdditionalUnattendContent" + }, + "x-ms-identifiers": [] + }, + "patchSettings": { + "$ref": "#/definitions/PatchSettings", + "description": "[Preview Feature] Specifies settings related to VM Guest Patching on Windows." + }, + "winRM": { + "$ref": "#/definitions/WinRMConfiguration", + "description": "Specifies the Windows Remote Management listeners. This enables remote Windows\nPowerShell." + }, + "enableVMAgentPlatformUpdates": { + "type": "boolean", + "description": "Indicates whether VMAgent Platform Updates is enabled for the Windows virtual\nmachine. Default value is false." + } + } + }, + "WindowsPatchAssessmentMode": { + "type": "string", + "description": "Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.", + "enum": [ + "ImageDefault", + "AutomaticByPlatform" + ], + "x-ms-enum": { + "name": "WindowsPatchAssessmentMode", + "modelAsString": true, + "values": [ + { + "name": "ImageDefault", + "value": "ImageDefault", + "description": "You control the timing of patch assessments on a virtual machine." + }, + { + "name": "AutomaticByPlatform", + "value": "AutomaticByPlatform", + "description": "The platform will trigger periodic patch assessments. The property provisionVMAgent must be true." + } + ] + } + }, + "WindowsVMGuestPatchAutomaticByPlatformRebootSetting": { + "type": "string", + "description": "Specifies the reboot setting for all AutomaticByPlatform patch installation operations.", + "enum": [ + "Unknown", + "IfRequired", + "Never", + "Always" + ], + "x-ms-enum": { + "name": "WindowsVMGuestPatchAutomaticByPlatformRebootSetting", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Reboot setting" + }, + { + "name": "IfRequired", + "value": "IfRequired", + "description": "IfRequired Reboot setting" + }, + { + "name": "Never", + "value": "Never", + "description": "Never Reboot setting" + }, + { + "name": "Always", + "value": "Always", + "description": "Always Reboot setting" + } + ] + } + }, + "WindowsVMGuestPatchAutomaticByPlatformSettings": { + "type": "object", + "description": "Specifies additional settings to be applied when patch mode AutomaticByPlatform\nis selected in Windows patch settings.", + "properties": { + "rebootSetting": { + "$ref": "#/definitions/WindowsVMGuestPatchAutomaticByPlatformRebootSetting", + "description": "Specifies the reboot setting for all AutomaticByPlatform patch installation\noperations." + }, + "bypassPlatformSafetyChecksOnUserSchedule": { + "type": "boolean", + "description": "Enables customer to schedule patching without accidental upgrades" + } + } + }, + "WindowsVMGuestPatchMode": { + "type": "string", + "description": "Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual\nmachines associated to virtual machine scale set with OrchestrationMode as\nFlexible.", + "enum": [ + "Manual", + "AutomaticByOS", + "AutomaticByPlatform" + ], + "x-ms-enum": { + "name": "WindowsVMGuestPatchMode", + "modelAsString": true, + "values": [ + { + "name": "Manual", + "value": "Manual", + "description": "You control the application of patches to a virtual machine.\nYou do this by applying patches manually inside the VM. In this mode,\nautomatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates\nmust be false" + }, + { + "name": "AutomaticByOS", + "value": "AutomaticByOS", + "description": "The virtual machine will automatically be updated by the OS.\nThe property WindowsConfiguration.enableAutomaticUpdates must be true." + }, + { + "name": "AutomaticByPlatform", + "value": "AutomaticByPlatform", + "description": "The virtual machine will automatically updated by the platform. The properties\nprovisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true." + } + ] + } } }, "parameters": {} diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_CreateOrUpdate_MaximumSet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_CreateOrUpdate_MaximumSet.json index 58e8fcb80aed..a6ecbf71369b 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_CreateOrUpdate_MaximumSet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_CreateOrUpdate_MaximumSet.json @@ -87,7 +87,7 @@ "secrets": [ { "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -108,7 +108,7 @@ "version": "nhzyxfc", "sharedGalleryImageId": "mkfpnxoxmkyrwpab", "communityGalleryImageId": "ujhxcd", - "id": "eouuvblwiuykzebjh" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" }, "osDisk": { "name": "qzchzeaaxupl", @@ -130,12 +130,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -152,12 +152,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -170,7 +170,7 @@ }, "networkProfile": { "healthProbe": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -181,7 +181,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -193,7 +193,7 @@ "name": "et", "properties": { "subnet": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -211,7 +211,7 @@ } ], "publicIPPrefix": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -224,22 +224,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -262,7 +262,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "ymhqsov" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -296,7 +296,7 @@ "protectedSettingsFromKeyVault": { "secretUrl": "qmjoynsytvnjzutetnkog", "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } } } @@ -318,7 +318,7 @@ "userData": "jhlyuc", "capacityReservation": { "capacityReservationGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -326,7 +326,7 @@ { "tags": "bevijlsuchspoihzlfjczuqttaqz", "order": 4, - "packageReferenceId": "aabkcborasmyowocjceldewmkci", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "configurationReference": "auikpeahpgodbqdih", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true @@ -340,61 +340,14 @@ } }, "serviceArtifactReference": { - "id": "qqqxnjehbgcepcfldzifjkwlzusn" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { - "id": "zwtxjdjwedxmhpcoii", + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "eleagpulycjgvscuulb", - "publisher": "rwaucnzfffywlsaoqltkmsynni", - "type": "rgnq", - "typeHandlerVersion": "hyyj", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "instanceView": { - "name": "xxnjefzqotctmujsqpmyleaie", - "type": "cycepellfcdujniys", - "typeHandlerVersion": "jefntwzzgxsbzncchhefqiqbs", - "substatuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ], - "statuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "qmjoynsytvnjzutetnkog", - "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" - } - }, - "provisionAfterExtensions": [ - "aysdon" - ] - }, - "location": "jzecxhirbtegqxpyk", - "tags": { - "key4849": "hqnzzgyumfzflmyjxklwslb" - } - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true } }, "computeApiVersion": "2023-07-01" @@ -411,6 +364,13 @@ "userAssignedIdentities": { "identityUrl": {} } + }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" } } }, @@ -494,7 +454,7 @@ "secrets": [ { "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -516,7 +476,7 @@ "exactVersion": "hfph", "sharedGalleryImageId": "mkfpnxoxmkyrwpab", "communityGalleryImageId": "ujhxcd", - "id": "eouuvblwiuykzebjh" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" }, "osDisk": { "name": "qzchzeaaxupl", @@ -538,12 +498,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -560,12 +520,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -578,7 +538,7 @@ }, "networkProfile": { "healthProbe": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -589,7 +549,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -601,7 +561,7 @@ "name": "et", "properties": { "subnet": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -619,7 +579,7 @@ } ], "publicIPPrefix": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -632,22 +592,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -670,7 +630,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "ymhqsov" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -697,8 +657,7 @@ "autoUpgradeMinorVersion": true, "enableAutomaticUpgrade": true, "settings": {}, - "protectedSettings": {}, - "provisioningState": "kauilerjryyvizdqoazz", + "provisioningState": "Succeeded", "provisionAfterExtensions": [ "babgtjyllusylxsnfvepitrkmkcx" ], @@ -706,11 +665,11 @@ "protectedSettingsFromKeyVault": { "secretUrl": "qmjoynsytvnjzutetnkog", "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } } }, - "id": "qx" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" } ], "extensionsTimeBudget": "srvemetinivyy" @@ -729,7 +688,7 @@ "userData": "jhlyuc", "capacityReservation": { "capacityReservationGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -737,8 +696,7 @@ { "tags": "bevijlsuchspoihzlfjczuqttaqz", "order": 4, - "packageReferenceId": "aabkcborasmyowocjceldewmkci", - "configurationReference": "auikpeahpgodbqdih", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true } @@ -751,76 +709,34 @@ } }, "serviceArtifactReference": { - "id": "qqqxnjehbgcepcfldzifjkwlzusn" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { - "id": "zwtxjdjwedxmhpcoii", + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "eleagpulycjgvscuulb", - "publisher": "rwaucnzfffywlsaoqltkmsynni", - "type": "rgnq", - "typeHandlerVersion": "hyyj", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "provisioningState": "rmhlppcusvaiepeqafd", - "instanceView": { - "name": "xxnjefzqotctmujsqpmyleaie", - "type": "cycepellfcdujniys", - "typeHandlerVersion": "jefntwzzgxsbzncchhefqiqbs", - "substatuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ], - "statuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "qmjoynsytvnjzutetnkog", - "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" - } - }, - "provisionAfterExtensions": [ - "aysdon" - ] - }, - "location": "jzecxhirbtegqxpyk", - "id": "vlgmhpmsbktwfzbioynslximoohfc", - "name": "qchtvtoulax", - "type": "shqqxyvbipxzaxjbsesymzgrfybww", - "tags": { - "key4849": "hqnzzgyumfzflmyjxklwslb" - } - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true }, "timeCreated": "2024-01-28T09:08:15.995Z" }, "computeApiVersion": "2023-07-01" }, - "provisioningState": "Succeeded" + "provisioningState": "Succeeded", + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" }, "zones": [ "zone1", "zone2" ], + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, "tags": {}, "location": "westus", "identity": { @@ -929,7 +845,7 @@ "secrets": [ { "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -951,7 +867,7 @@ "exactVersion": "hfph", "sharedGalleryImageId": "mkfpnxoxmkyrwpab", "communityGalleryImageId": "ujhxcd", - "id": "eouuvblwiuykzebjh" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" }, "osDisk": { "name": "qzchzeaaxupl", @@ -973,12 +889,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -995,12 +911,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -1013,7 +929,7 @@ }, "networkProfile": { "healthProbe": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -1024,7 +940,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -1036,7 +952,7 @@ "name": "et", "properties": { "subnet": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -1054,7 +970,7 @@ } ], "publicIPPrefix": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -1067,22 +983,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -1105,7 +1021,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "ymhqsov" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -1132,8 +1048,7 @@ "autoUpgradeMinorVersion": true, "enableAutomaticUpgrade": true, "settings": {}, - "protectedSettings": {}, - "provisioningState": "kauilerjryyvizdqoazz", + "provisioningState": "Succeeded", "provisionAfterExtensions": [ "babgtjyllusylxsnfvepitrkmkcx" ], @@ -1141,11 +1056,11 @@ "protectedSettingsFromKeyVault": { "secretUrl": "qmjoynsytvnjzutetnkog", "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } } }, - "id": "qx" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" } ], "extensionsTimeBudget": "srvemetinivyy" @@ -1164,7 +1079,7 @@ "userData": "jhlyuc", "capacityReservation": { "capacityReservationGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -1172,8 +1087,7 @@ { "tags": "bevijlsuchspoihzlfjczuqttaqz", "order": 4, - "packageReferenceId": "aabkcborasmyowocjceldewmkci", - "configurationReference": "auikpeahpgodbqdih", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true } @@ -1186,71 +1100,22 @@ } }, "serviceArtifactReference": { - "id": "qqqxnjehbgcepcfldzifjkwlzusn" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { - "id": "zwtxjdjwedxmhpcoii", + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "eleagpulycjgvscuulb", - "publisher": "rwaucnzfffywlsaoqltkmsynni", - "type": "rgnq", - "typeHandlerVersion": "hyyj", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "provisioningState": "rmhlppcusvaiepeqafd", - "instanceView": { - "name": "xxnjefzqotctmujsqpmyleaie", - "type": "cycepellfcdujniys", - "typeHandlerVersion": "jefntwzzgxsbzncchhefqiqbs", - "substatuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ], - "statuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "qmjoynsytvnjzutetnkog", - "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" - } - }, - "provisionAfterExtensions": [ - "aysdon" - ] - }, - "location": "jzecxhirbtegqxpyk", - "id": "vlgmhpmsbktwfzbioynslximoohfc", - "name": "qchtvtoulax", - "type": "shqqxyvbipxzaxjbsesymzgrfybww", - "tags": { - "key4849": "hqnzzgyumfzflmyjxklwslb" - } - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true }, "timeCreated": "2024-01-28T09:08:15.995Z" }, "computeApiVersion": "2023-07-01" }, - "provisioningState": "Succeeded" + "provisioningState": "Succeeded", + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" }, "zones": [ "zone1", @@ -1258,6 +1123,13 @@ ], "tags": {}, "location": "westus", + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, "identity": { "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c", "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c", diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Get_MaximumSet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Get_MaximumSet.json index b080f05cdc68..a52280192c0a 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Get_MaximumSet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Get_MaximumSet.json @@ -87,7 +87,7 @@ "secrets": [ { "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -109,7 +109,7 @@ "exactVersion": "hfph", "sharedGalleryImageId": "mkfpnxoxmkyrwpab", "communityGalleryImageId": "ujhxcd", - "id": "eouuvblwiuykzebjh" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" }, "osDisk": { "name": "qzchzeaaxupl", @@ -131,12 +131,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -153,12 +153,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -171,7 +171,7 @@ }, "networkProfile": { "healthProbe": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -182,7 +182,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -194,7 +194,7 @@ "name": "et", "properties": { "subnet": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -212,7 +212,7 @@ } ], "publicIPPrefix": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -225,22 +225,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -263,7 +263,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "ymhqsov" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -290,8 +290,7 @@ "autoUpgradeMinorVersion": true, "enableAutomaticUpgrade": true, "settings": {}, - "protectedSettings": {}, - "provisioningState": "kauilerjryyvizdqoazz", + "provisioningState": "Succeeded", "provisionAfterExtensions": [ "babgtjyllusylxsnfvepitrkmkcx" ], @@ -299,11 +298,11 @@ "protectedSettingsFromKeyVault": { "secretUrl": "qmjoynsytvnjzutetnkog", "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } } }, - "id": "qx" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" } ], "extensionsTimeBudget": "srvemetinivyy" @@ -322,7 +321,7 @@ "userData": "jhlyuc", "capacityReservation": { "capacityReservationGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -330,8 +329,7 @@ { "tags": "bevijlsuchspoihzlfjczuqttaqz", "order": 4, - "packageReferenceId": "aabkcborasmyowocjceldewmkci", - "configurationReference": "auikpeahpgodbqdih", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true } @@ -344,71 +342,22 @@ } }, "serviceArtifactReference": { - "id": "qqqxnjehbgcepcfldzifjkwlzusn" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { - "id": "zwtxjdjwedxmhpcoii", + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "eleagpulycjgvscuulb", - "publisher": "rwaucnzfffywlsaoqltkmsynni", - "type": "rgnq", - "typeHandlerVersion": "hyyj", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "provisioningState": "rmhlppcusvaiepeqafd", - "instanceView": { - "name": "xxnjefzqotctmujsqpmyleaie", - "type": "cycepellfcdujniys", - "typeHandlerVersion": "jefntwzzgxsbzncchhefqiqbs", - "substatuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ], - "statuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "qmjoynsytvnjzutetnkog", - "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" - } - }, - "provisionAfterExtensions": [ - "aysdon" - ] - }, - "location": "jzecxhirbtegqxpyk", - "id": "vlgmhpmsbktwfzbioynslximoohfc", - "name": "qchtvtoulax", - "type": "shqqxyvbipxzaxjbsesymzgrfybww", - "tags": { - "key4849": "hqnzzgyumfzflmyjxklwslb" - } - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true }, "timeCreated": "2024-01-28T09:08:15.995Z" }, "computeApiVersion": "2023-07-01" }, - "provisioningState": "Succeeded" + "provisioningState": "Succeeded", + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" }, "zones": [ "zone1", @@ -416,6 +365,13 @@ ], "tags": {}, "location": "westus", + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, "identity": { "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c", "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c", diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_ListByResourceGroup_MaximumSet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_ListByResourceGroup_MaximumSet.json index 1ddb67117d37..873082abde6e 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_ListByResourceGroup_MaximumSet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_ListByResourceGroup_MaximumSet.json @@ -89,7 +89,7 @@ "secrets": [ { "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -111,7 +111,7 @@ "exactVersion": "hfph", "sharedGalleryImageId": "mkfpnxoxmkyrwpab", "communityGalleryImageId": "ujhxcd", - "id": "eouuvblwiuykzebjh" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" }, "osDisk": { "name": "qzchzeaaxupl", @@ -133,12 +133,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -155,12 +155,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -173,7 +173,7 @@ }, "networkProfile": { "healthProbe": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -184,7 +184,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -196,7 +196,7 @@ "name": "et", "properties": { "subnet": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -214,7 +214,7 @@ } ], "publicIPPrefix": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -227,22 +227,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -265,7 +265,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "ymhqsov" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -292,8 +292,7 @@ "autoUpgradeMinorVersion": true, "enableAutomaticUpgrade": true, "settings": {}, - "protectedSettings": {}, - "provisioningState": "kauilerjryyvizdqoazz", + "provisioningState": "Succeeded", "provisionAfterExtensions": [ "babgtjyllusylxsnfvepitrkmkcx" ], @@ -301,11 +300,11 @@ "protectedSettingsFromKeyVault": { "secretUrl": "qmjoynsytvnjzutetnkog", "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } } }, - "id": "qx" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" } ], "extensionsTimeBudget": "srvemetinivyy" @@ -324,7 +323,7 @@ "userData": "nwrklspknozvftyi", "capacityReservation": { "capacityReservationGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -332,8 +331,7 @@ { "tags": "bevijlsuchspoihzlfjczuqttaqz", "order": 4, - "packageReferenceId": "aabkcborasmyowocjceldewmkci", - "configurationReference": "auikpeahpgodbqdih", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true } @@ -346,70 +344,21 @@ } }, "serviceArtifactReference": { - "id": "qqqxnjehbgcepcfldzifjkwlzusn" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { - "id": "zwtxjdjwedxmhpcoii", + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "eleagpulycjgvscuulb", - "publisher": "rwaucnzfffywlsaoqltkmsynni", - "type": "rgnq", - "typeHandlerVersion": "hyyj", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "provisioningState": "rmhlppcusvaiepeqafd", - "instanceView": { - "name": "xxnjefzqotctmujsqpmyleaie", - "type": "cycepellfcdujniys", - "typeHandlerVersion": "jefntwzzgxsbzncchhefqiqbs", - "substatuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ], - "statuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "qmjoynsytvnjzutetnkog", - "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" - } - }, - "provisionAfterExtensions": [ - "aysdon" - ] - }, - "location": "jzecxhirbtegqxpyk", - "id": "vlgmhpmsbktwfzbioynslximoohfc", - "name": "qchtvtoulax", - "type": "shqqxyvbipxzaxjbsesymzgrfybww", - "tags": { - "key4849": "hqnzzgyumfzflmyjxklwslb" - } - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true }, "timeCreated": "2024-01-28T09:08:15.992Z" }, "computeApiVersion": "2023-07-01" - } + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" }, "zones": [ "zone1", @@ -417,6 +366,13 @@ ], "tags": {}, "location": "westus", + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, "identity": { "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c", "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c", diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_ListBySubscription_MaximumSet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_ListBySubscription_MaximumSet.json index 55fea7dae063..56f0a254dfcb 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_ListBySubscription_MaximumSet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_ListBySubscription_MaximumSet.json @@ -88,7 +88,7 @@ "secrets": [ { "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -110,7 +110,7 @@ "exactVersion": "hfph", "sharedGalleryImageId": "mkfpnxoxmkyrwpab", "communityGalleryImageId": "ujhxcd", - "id": "eouuvblwiuykzebjh" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" }, "osDisk": { "name": "qzchzeaaxupl", @@ -132,12 +132,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -154,12 +154,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -172,7 +172,7 @@ }, "networkProfile": { "healthProbe": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -183,7 +183,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -195,7 +195,7 @@ "name": "et", "properties": { "subnet": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -213,7 +213,7 @@ } ], "publicIPPrefix": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -226,22 +226,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -264,7 +264,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "ymhqsov" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -291,8 +291,7 @@ "autoUpgradeMinorVersion": true, "enableAutomaticUpgrade": true, "settings": {}, - "protectedSettings": {}, - "provisioningState": "kauilerjryyvizdqoazz", + "provisioningState": "Succeeded", "provisionAfterExtensions": [ "babgtjyllusylxsnfvepitrkmkcx" ], @@ -300,11 +299,11 @@ "protectedSettingsFromKeyVault": { "secretUrl": "qmjoynsytvnjzutetnkog", "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } } }, - "id": "qx" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" } ], "extensionsTimeBudget": "srvemetinivyy" @@ -323,7 +322,7 @@ "userData": "nwrklspknozvftyi", "capacityReservation": { "capacityReservationGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -331,8 +330,7 @@ { "tags": "bevijlsuchspoihzlfjczuqttaqz", "order": 4, - "packageReferenceId": "aabkcborasmyowocjceldewmkci", - "configurationReference": "auikpeahpgodbqdih", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true } @@ -345,75 +343,33 @@ } }, "serviceArtifactReference": { - "id": "qqqxnjehbgcepcfldzifjkwlzusn" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { - "id": "zwtxjdjwedxmhpcoii", + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "eleagpulycjgvscuulb", - "publisher": "rwaucnzfffywlsaoqltkmsynni", - "type": "rgnq", - "typeHandlerVersion": "hyyj", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "provisioningState": "rmhlppcusvaiepeqafd", - "instanceView": { - "name": "xxnjefzqotctmujsqpmyleaie", - "type": "cycepellfcdujniys", - "typeHandlerVersion": "jefntwzzgxsbzncchhefqiqbs", - "substatuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ], - "statuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "qmjoynsytvnjzutetnkog", - "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" - } - }, - "provisionAfterExtensions": [ - "aysdon" - ] - }, - "location": "jzecxhirbtegqxpyk", - "id": "vlgmhpmsbktwfzbioynslximoohfc", - "name": "qchtvtoulax", - "type": "shqqxyvbipxzaxjbsesymzgrfybww", - "tags": { - "key4849": "hqnzzgyumfzflmyjxklwslb" - } - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true }, "timeCreated": "2024-01-28T09:08:15.992Z" }, "computeApiVersion": "2023-07-01" - } + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" }, "zones": [ "zone1", "zone2" ], + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, "tags": {}, "location": "westus", "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Update_MaximumSet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Update_MaximumSet.json index 43cbb9db43e1..a1e029f4c91b 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Update_MaximumSet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Update_MaximumSet.json @@ -88,7 +88,7 @@ "secrets": [ { "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -109,7 +109,7 @@ "version": "nhzyxfc", "sharedGalleryImageId": "mkfpnxoxmkyrwpab", "communityGalleryImageId": "ujhxcd", - "id": "eouuvblwiuykzebjh" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" }, "osDisk": { "name": "qzchzeaaxupl", @@ -131,12 +131,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -153,12 +153,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -171,7 +171,7 @@ }, "networkProfile": { "healthProbe": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -182,7 +182,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -194,7 +194,7 @@ "name": "et", "properties": { "subnet": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -212,7 +212,7 @@ } ], "publicIPPrefix": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -225,22 +225,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -263,7 +263,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "ymhqsov" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -297,7 +297,7 @@ "protectedSettingsFromKeyVault": { "secretUrl": "qmjoynsytvnjzutetnkog", "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } } } @@ -319,7 +319,7 @@ "userData": "jgdmsclzzknsevdsh", "capacityReservation": { "capacityReservationGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -327,7 +327,7 @@ { "tags": "bevijlsuchspoihzlfjczuqttaqz", "order": 4, - "packageReferenceId": "aabkcborasmyowocjceldewmkci", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "configurationReference": "auikpeahpgodbqdih", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true @@ -341,59 +341,14 @@ } }, "serviceArtifactReference": { - "id": "qqqxnjehbgcepcfldzifjkwlzusn" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { - "id": "zwtxjdjwedxmhpcoii", + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "eleagpulycjgvscuulb", - "publisher": "rwaucnzfffywlsaoqltkmsynni", - "type": "rgnq", - "typeHandlerVersion": "hyyj", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "instanceView": { - "name": "xxnjefzqotctmujsqpmyleaie", - "type": "cycepellfcdujniys", - "typeHandlerVersion": "jefntwzzgxsbzncchhefqiqbs", - "substatuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ], - "statuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "qmjoynsytvnjzutetnkog", - "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" - } - }, - "provisionAfterExtensions": [ - "aysdon" - ] - }, - "location": "jzecxhirbtegqxpyk", - "tags": {} - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true } }, "computeApiVersion": "2023-07-01" @@ -492,7 +447,7 @@ "secrets": [ { "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -513,7 +468,7 @@ "version": "nhzyxfc", "sharedGalleryImageId": "mkfpnxoxmkyrwpab", "communityGalleryImageId": "ujhxcd", - "id": "eouuvblwiuykzebjh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}", "exactVersion": "hfph" }, "osDisk": { @@ -536,12 +491,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -558,12 +513,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "hinhonboozgfbrfwyy" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -576,7 +531,7 @@ }, "networkProfile": { "healthProbe": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -587,7 +542,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -599,7 +554,7 @@ "name": "et", "properties": { "subnet": { - "id": "puulsdoecyaooqmhz" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -617,7 +572,7 @@ } ], "publicIPPrefix": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -630,22 +585,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -668,7 +623,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "ymhqsov" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -693,8 +648,6 @@ "typeHandlerVersion": "vqrkrrankheuqbcopc", "autoUpgradeMinorVersion": true, "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, "provisionAfterExtensions": [ "babgtjyllusylxsnfvepitrkmkcx" ], @@ -702,13 +655,13 @@ "protectedSettingsFromKeyVault": { "secretUrl": "qmjoynsytvnjzutetnkog", "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } }, - "provisioningState": "kauilerjryyvizdqoazz" + "provisioningState": "Succeeded" }, "type": "rhmnomookzqyld", - "id": "qx" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" } ], "extensionsTimeBudget": "srvemetinivyy" @@ -727,7 +680,7 @@ "userData": "jgdmsclzzknsevdsh", "capacityReservation": { "capacityReservationGroup": { - "id": "ihxrocoahkxxjrbmbhmaahzi" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -735,8 +688,7 @@ { "tags": "bevijlsuchspoihzlfjczuqttaqz", "order": 4, - "packageReferenceId": "aabkcborasmyowocjceldewmkci", - "configurationReference": "auikpeahpgodbqdih", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true } @@ -749,69 +701,22 @@ } }, "serviceArtifactReference": { - "id": "qqqxnjehbgcepcfldzifjkwlzusn" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { - "id": "zwtxjdjwedxmhpcoii", + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "eleagpulycjgvscuulb", - "publisher": "rwaucnzfffywlsaoqltkmsynni", - "type": "rgnq", - "typeHandlerVersion": "hyyj", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "instanceView": { - "name": "xxnjefzqotctmujsqpmyleaie", - "type": "cycepellfcdujniys", - "typeHandlerVersion": "jefntwzzgxsbzncchhefqiqbs", - "substatuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ], - "statuses": [ - { - "code": "cbzjpwcbfodkqjnd", - "level": "Info", - "displayStatus": "oxhrtqv", - "message": "uldcsnhprfe", - "time": "2024-01-28T09:08:15.992Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "qmjoynsytvnjzutetnkog", - "sourceVault": { - "id": "ihxrocoahkxxjrbmbhmaahzi" - } - }, - "provisionAfterExtensions": [ - "aysdon" - ], - "provisioningState": "rmhlppcusvaiepeqafd" - }, - "location": "jzecxhirbtegqxpyk", - "tags": {}, - "id": "vlgmhpmsbktwfzbioynslximoohfc", - "name": "qchtvtoulax", - "type": "shqqxyvbipxzaxjbsesymzgrfybww" - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true }, "timeCreated": "2024-01-28T09:08:15.992Z" }, "computeApiVersion": "2023-07-01" }, - "provisioningState": "Succeeded" + "provisioningState": "Succeeded", + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" }, "zones": [ "zone1", diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/azurefleet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/azurefleet.json index fe99e2db4dc9..9057878868d3 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/azurefleet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/azurefleet.json @@ -273,6 +273,9 @@ "x-ms-examples": { "Fleets_CreateOrUpdate": { "$ref": "./examples/Fleets_CreateOrUpdate.json" + }, + "Fleets_CreateOrUpdate_MinimumSet": { + "$ref": "./examples/Fleets_CreateOrUpdate_MinimumSet.json" } }, "x-ms-long-running-operation-options": { @@ -465,57 +468,261 @@ } }, "definitions": { - "Azure.ResourceManager.CommonTypes.ManagedServiceIdentityType": { + "AdditionalUnattendContent": { + "type": "object", + "description": "Specifies additional XML formatted information that can be included in the\nUnattend.xml file, which is used by Windows Setup. Contents are defined by\nsetting name, component name, and the pass in which the content is applied.", + "properties": { + "passName": { + "type": "string", + "description": "The pass name. Currently, the only allowable value is OobeSystem.", + "enum": [ + "OobeSystem" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "componentName": { + "type": "string", + "description": "The component name. Currently, the only allowable value is\nMicrosoft-Windows-Shell-Setup.", + "enum": [ + "Microsoft-Windows-Shell-Setup" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "settingName": { + "$ref": "#/definitions/SettingNames", + "description": "Specifies the name of the setting to which the content applies. Possible values\nare: FirstLogonCommands and AutoLogon." + }, + "content": { + "type": "string", + "format": "password", + "description": "Specifies the XML formatted content that is added to the unattend.xml file for\nthe specified path and component. The XML must be less than 4KB and must\ninclude the root element for the setting or feature that is being inserted.", + "x-ms-mutability": [ + "update", + "create" + ], + "x-ms-secret": true + } + } + }, + "ApiEntityReference": { + "type": "object", + "description": "The API entity reference.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM resource id in the form of\n/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." + } + } + }, + "ApiError": { + "type": "object", + "description": "ApiError for Fleet", + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + }, + "details": { + "type": "array", + "description": "The API error details", + "items": { + "$ref": "#/definitions/ApiErrorBase" + }, + "x-ms-identifiers": [ + "message", + "target" + ] + }, + "innererror": { + "$ref": "#/definitions/InnerError", + "description": "The API inner error" + } + } + }, + "ApiErrorBase": { + "type": "object", + "description": "API error base.", + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + } + } + }, + "ApplicationProfile": { + "type": "object", + "description": "Contains the list of gallery applications that should be made available to the\nVM/VMSS", + "properties": { + "galleryApplications": { + "type": "array", + "description": "Specifies the gallery applications that should be made available to the VM/VMSS", + "items": { + "$ref": "#/definitions/VMGalleryApplication" + }, + "x-ms-identifiers": [ + "packageReferenceId" + ] + } + } + }, + "BasePriorityProfile": { + "type": "object", + "description": "Contains common properties that are applicable to both Spot and Regular.", + "properties": { + "capacity": { + "type": "integer", + "format": "int32", + "description": "Total capacity to achieve. It is currently in terms of number of VMs.", + "minimum": 0 + }, + "minCapacity": { + "type": "integer", + "format": "int32", + "description": "Minimum capacity to achieve which cannot be updated. If we will not be able to \"guarantee\" minimum capacity, we will reject the request in the sync path itself.", + "minimum": 0 + } + } + }, + "BaseVirtualMachineProfile": { + "type": "object", + "description": "Describes the base virtual machine profile for fleet", + "properties": { + "osProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetOSProfile", + "description": "Specifies the operating system settings for the virtual machines in the scale\nset." + }, + "storageProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "networkProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile", + "description": "Specifies properties of the network interfaces of the virtual machines in the\nscale set." + }, + "securityProfile": { + "$ref": "#/definitions/SecurityProfile", + "description": "Specifies the Security related profile settings for the virtual machines in the\nscale set." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/DiagnosticsProfile", + "description": "Specifies the boot diagnostic settings state." + }, + "extensionProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile", + "description": "Specifies a collection of settings for extensions installed on virtual machines\nin the scale set." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises.\n

Possible values for Windows Server operating system are:

\nWindows_Client

Windows_Server

Possible values for Linux\nServer operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS\n(for SUSE)

For more information, see [Azure Hybrid Use Benefit for\nWindows\nServer](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)\n

[Azure Hybrid Use Benefit for Linux\nServer](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)\n

Minimum api-version: 2015-06-15" + }, + "scheduledEventsProfile": { + "$ref": "#/definitions/ScheduledEventsProfile", + "description": "Specifies Scheduled Event related configurations." + }, + "userData": { + "type": "string", + "description": "UserData for the virtual machines in the scale set, which must be base-64\nencoded. Customer should not pass any secrets in here. Minimum api-version:\n2021-03-01." + }, + "capacityReservation": { + "$ref": "#/definitions/CapacityReservationProfile", + "description": "Specifies the capacity reservation related details of a scale set. Minimum\napi-version: 2021-04-01." + }, + "applicationProfile": { + "$ref": "#/definitions/ApplicationProfile", + "description": "Specifies the gallery applications that should be made available to the VM/VMSS" + }, + "hardwareProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetHardwareProfile", + "description": "Specifies the hardware profile related details of a scale set. Minimum\napi-version: 2021-11-01." + }, + "serviceArtifactReference": { + "$ref": "#/definitions/ServiceArtifactReference", + "description": "Specifies the service artifact reference id used to set same image version for\nall virtual machines in the scale set when using 'latest' image version.\nMinimum api-version: 2022-11-01" + }, + "securityPostureReference": { + "$ref": "#/definitions/SecurityPostureReference", + "description": "Specifies the security posture to be used for all virtual machines in the scale\nset. Minimum api-version: 2023-03-01" + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "Specifies the time in which this VM profile for the Virtual Machine Scale Set\nwas created. Minimum API version for this property is 2023-09-01. This value\nwill be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile\nwith minimum api-version 2023-09-01. Examples: \"2024-07-01T00:00:01.1234567+00:00\"", + "readOnly": true + } + } + }, + "BootDiagnostics": { + "type": "object", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output\nand Screenshot to diagnose VM status. You can easily view the output of your\nconsole log. Azure also enables you to see a screenshot of the VM from the\nhypervisor.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether boot diagnostics should be enabled on the Virtual Machine." + }, + "storageUri": { + "type": "string", + "description": "Uri of the storage account to use for placing the console output and\nscreenshot. If storageUri is not specified while enabling boot diagnostics,\nmanaged storage will be used." + } + } + }, + "CachingTypes": { "type": "string", - "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).", + "description": "Specifies the caching requirements.", "enum": [ "None", - "SystemAssigned", - "UserAssigned", - "SystemAssigned,UserAssigned" + "ReadOnly", + "ReadWrite" ], "x-ms-enum": { - "name": "ManagedServiceIdentityType", + "name": "CachingTypes", "modelAsString": true, "values": [ { "name": "None", "value": "None", - "description": "No managed identity." - }, - { - "name": "SystemAssigned", - "value": "SystemAssigned", - "description": "System assigned managed identity." + "description": "'None' is default for Standard Storage" }, { - "name": "UserAssigned", - "value": "UserAssigned", - "description": "User assigned managed identity." + "name": "ReadOnly", + "value": "ReadOnly", + "description": "'ReadOnly' is default for Premium Storage" }, { - "name": "SystemAndUserAssigned", - "value": "SystemAssigned,UserAssigned", - "description": "System and user assigned managed identity." + "name": "ReadWrite", + "value": "ReadWrite", + "description": "'ReadWrite' is default for OS Disk" } ] } }, - "BasePriorityProfile": { + "CapacityReservationProfile": { "type": "object", - "description": "Contains common properties that are applicable to both Spot and Regular.", + "description": "The parameters of a capacity reservation Profile.", "properties": { - "capacity": { - "type": "integer", - "format": "int32", - "description": "Total capacity to achieve. It is currently in terms of number of VMs.", - "minimum": 0 - }, - "minCapacity": { - "type": "integer", - "format": "int32", - "description": "Minimum capacity to achieve which cannot be updated. If we will not be able to \"guarantee\" minimum capacity, we will reject the request in the sync path itself.", - "minimum": 0 + "capacityReservationGroup": { + "$ref": "#/definitions/SubResource", + "description": "Specifies the capacity reservation group resource id that should be used for\nallocating the virtual machine or scaleset vm instances provided enough\ncapacity has been reserved. Please refer to https://aka.ms/CapacityReservation\nfor more details." } } }, @@ -524,7 +731,7 @@ "description": "Compute Profile to use for running user's workloads.", "properties": { "baseVirtualMachineProfile": { - "$ref": "../../../../../compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineScaleSet.json#/definitions/VirtualMachineScaleSetVMProfile", + "$ref": "#/definitions/BaseVirtualMachineProfile", "description": "Base Virtual Machine Profile Properties to be specified according to \"specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/{computeApiVersion}/virtualMachineScaleSet.json#/definitions/VirtualMachineScaleSetVMProfile\"" }, "computeApiVersion": { @@ -541,22 +748,247 @@ "baseVirtualMachineProfile" ] }, - "ComputeProfileUpdate": { + "DeleteOptions": { + "type": "string", + "description": "Specify what happens to the network interface when the VM is deleted", + "enum": [ + "Delete", + "Detach" + ], + "x-ms-enum": { + "name": "DeleteOptions", + "modelAsString": true, + "values": [ + { + "name": "Delete", + "value": "Delete", + "description": "Delete Option" + }, + { + "name": "Detach", + "value": "Detach", + "description": "Detach Option" + } + ] + } + }, + "DiagnosticsProfile": { "type": "object", - "description": "Compute Profile to use for running user's workloads.", + "description": "Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.", "properties": { - "baseVirtualMachineProfile": { - "$ref": "../../../../../compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineScaleSet.json#/definitions/VirtualMachineScaleSetVMProfile", - "description": "Base Virtual Machine Profile Properties to be specified according to \"specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/{computeApiVersion}/virtualMachineScaleSet.json#/definitions/VirtualMachineScaleSetVMProfile\"" + "bootDiagnostics": { + "$ref": "#/definitions/BootDiagnostics", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output\nand Screenshot to diagnose VM status. **NOTE**: If storageUri is being\nspecified then ensure that the storage account is in the same region and\nsubscription as the VM. You can easily view the output of your console log.\nAzure also enables you to see a screenshot of the VM from the hypervisor." + } + } + }, + "DiffDiskOptions": { + "type": "string", + "description": "Specifies the ephemeral disk option for operating system disk.", + "enum": [ + "Local" + ], + "x-ms-enum": { + "name": "DiffDiskOptions", + "modelAsString": true, + "values": [ + { + "name": "Local", + "value": "Local", + "description": "Local Option." + } + ] + } + }, + "DiffDiskPlacement": { + "type": "string", + "description": "Specifies the ephemeral disk placement for operating system disk. This property\ncan be used by user in the request to choose the location i.e, cache disk or\nresource disk space for Ephemeral OS disk provisioning. For more information on\nEphemeral OS disk size requirements, please refer Ephemeral OS disk size\nrequirements for Windows VM at\nhttps://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements\nand Linux VM at\nhttps://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements\nMinimum api-version for NvmeDisk: 2024-03-01.", + "enum": [ + "CacheDisk", + "ResourceDisk", + "NvmeDisk" + ], + "x-ms-enum": { + "name": "DiffDiskPlacement", + "modelAsString": true, + "values": [ + { + "name": "CacheDisk", + "value": "CacheDisk", + "description": "CacheDisk option." + }, + { + "name": "ResourceDisk", + "value": "ResourceDisk", + "description": "Resource Disk option." + }, + { + "name": "NvmeDisk", + "value": "NvmeDisk", + "description": "NvmeDisk option." + } + ] + } + }, + "DiffDiskSettings": { + "type": "object", + "description": "Describes the parameters of ephemeral disk settings that can be specified for\noperating system disk. **Note:** The ephemeral disk settings can only be\nspecified for managed disk.", + "properties": { + "option": { + "$ref": "#/definitions/DiffDiskOptions", + "description": "Specifies the ephemeral disk settings for operating system disk." }, - "computeApiVersion": { + "placement": { + "$ref": "#/definitions/DiffDiskPlacement", + "description": "Specifies the ephemeral disk placement for operating system disk. Possible\nvalues are: **CacheDisk,** **ResourceDisk.** The defaulting behavior is:\n**CacheDisk** if one is configured for the VM size otherwise **ResourceDisk**\nis used. Refer to the VM size documentation for Windows VM at\nhttps://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at\nhttps://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM\nsizes exposes a cache disk." + } + } + }, + "DiskControllerTypes": { + "type": "string", + "description": "Specifies the disk controller type configured for the VM and\nVirtualMachineScaleSet. This property is only supported for virtual machines\nwhose operating system disk and VM sku supports Generation 2\n(https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), please\ncheck the HyperVGenerations capability returned as part of VM sku capabilities\nin the response of Microsoft.Compute SKUs api for the region contains V2\n(https://docs.microsoft.com/rest/api/compute/resourceskus/list). For more\ninformation about Disk Controller Types supported please refer to\nhttps://aka.ms/azure-diskcontrollertypes.", + "enum": [ + "SCSI", + "NVMe" + ], + "x-ms-enum": { + "name": "DiskControllerTypes", + "modelAsString": true, + "values": [ + { + "name": "SCSI", + "value": "SCSI", + "description": "SCSI disk type" + }, + { + "name": "NVMe", + "value": "NVMe", + "description": "NVMe disk type" + } + ] + } + }, + "DiskCreateOptionTypes": { + "type": "string", + "description": "Specifies how the virtual machine should be created.", + "enum": [ + "FromImage", + "Empty", + "Attach", + "Copy", + "Restore" + ], + "x-ms-enum": { + "name": "DiskCreateOptionTypes", + "modelAsString": true, + "values": [ + { + "name": "FromImage", + "value": "FromImage", + "description": "This value is used when you are using an image to create the virtual machine.\nIf you are using a platform image, you also use the imageReference element\ndescribed above. If you are using a marketplace image, you also use the\nplan element previously described." + }, + { + "name": "Empty", + "value": "Empty", + "description": "This value is used when creating an empty data disk." + }, + { + "name": "Attach", + "value": "Attach", + "description": "This value is used when you are using a specialized disk to create the virtual machine." + }, + { + "name": "Copy", + "value": "Copy", + "description": "This value is used to create a data disk from a snapshot or another disk." + }, + { + "name": "Restore", + "value": "Restore", + "description": "This value is used to create a data disk from a disk restore point." + } + ] + } + }, + "DiskDeleteOptionTypes": { + "type": "string", + "description": "Specifies the behavior of the managed disk when the VM gets deleted, for\nexample whether the managed disk is deleted or detached. Supported values are:\n**Delete.** If this value is used, the managed disk is deleted when VM gets\ndeleted. **Detach.** If this value is used, the managed disk is retained after\nVM gets deleted. Minimum api-version: 2021-03-01.", + "enum": [ + "Delete", + "Detach" + ], + "x-ms-enum": { + "name": "DiskDeleteOptionTypes", + "modelAsString": true, + "values": [ + { + "name": "Delete", + "value": "Delete", + "description": "If this value is used, the managed disk is deleted when VM gets deleted." + }, + { + "name": "Detach", + "value": "Detach", + "description": "If this value is used, the managed disk is retained after VM gets deleted." + } + ] + } + }, + "DiskEncryptionSetParameters": { + "type": "object", + "description": "Describes the parameter of customer managed disk encryption set resource id\nthat can be specified for disk. **Note:** The disk encryption set resource id\ncan only be specified for managed disk. Please refer\nhttps://aka.ms/mdssewithcmkoverview for more details.", + "properties": { + "id": { "type": "string", - "description": "Specifies the Microsoft.Compute API version to use when creating underlying Virtual Machine scale sets and Virtual Machines.\nThe default value will be the latest supported computeApiVersion by Compute Fleet." - }, - "platformFaultDomainCount": { - "type": "integer", - "format": "int32", - "description": "Specifies the number of fault domains to use when creating the underlying VMSS.\nA fault domain is a logical group of hardware within an Azure datacenter.\nVMs in the same fault domain share a common power source and network switch.\nIf not specified, defaults to 1, which represents \"Max Spreading\" (using as many fault domains as possible).\nThis property cannot be updated." + "format": "arm-id", + "description": "Resource Id" + } + } + }, + "DomainNameLabelScopeTypes": { + "type": "string", + "description": "The Domain name label scope.The concatenation of the hashed domain name label\nthat generated according to the policy from domain name label scope and vm\nindex will be the domain name labels of the PublicIPAddress resources that will\nbe created", + "enum": [ + "TenantReuse", + "SubscriptionReuse", + "ResourceGroupReuse", + "NoReuse" + ], + "x-ms-enum": { + "name": "DomainNameLabelScopeTypes", + "modelAsString": true, + "values": [ + { + "name": "TenantReuse", + "value": "TenantReuse", + "description": "TenantReuse type" + }, + { + "name": "SubscriptionReuse", + "value": "SubscriptionReuse", + "description": "SubscriptionReuse type" + }, + { + "name": "ResourceGroupReuse", + "value": "ResourceGroupReuse", + "description": "ResourceGroupReuse type" + }, + { + "name": "NoReuse", + "value": "NoReuse", + "description": "NoReuse type" + } + ] + } + }, + "EncryptionIdentity": { + "type": "object", + "description": "Specifies the Managed Identity used by ADE to get access token for keyvault\noperations.", + "properties": { + "userAssignedIdentityResourceId": { + "type": "string", + "format": "arm-id", + "description": "Specifies ARM Resource ID of one of the user identities associated with the VM." } } }, @@ -664,38 +1096,23 @@ "computeProfile": { "$ref": "#/definitions/ComputeProfile", "description": "Compute Profile to use for running user's workloads." - } - }, - "required": [ - "vmSizesProfile", - "computeProfile" - ] - }, - "FleetPropertiesUpdate": { - "type": "object", - "description": "Details of the Compute Fleet.", - "properties": { - "spotPriorityProfile": { - "$ref": "#/definitions/SpotPriorityProfile", - "description": "Configuration Options for Spot instances in Compute Fleet." - }, - "regularPriorityProfile": { - "$ref": "#/definitions/RegularPriorityProfile", - "description": "Configuration Options for Regular instances in Compute Fleet." }, - "vmSizesProfile": { - "type": "array", - "description": "List of VM sizes supported for Compute Fleet", - "items": { - "$ref": "#/definitions/VmSizeProfile" - }, - "x-ms-identifiers": [] + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "Specifies the time at which the Compute Fleet is created.", + "readOnly": true }, - "computeProfile": { - "$ref": "#/definitions/ComputeProfileUpdate", - "description": "Compute Profile to use for running user's workloads." + "uniqueId": { + "type": "string", + "description": "Specifies the ID which uniquely identifies a Compute Fleet.", + "readOnly": true } - } + }, + "required": [ + "vmSizesProfile", + "computeProfile" + ] }, "FleetUpdate": { "type": "object", @@ -717,278 +1134,1824 @@ "description": "Updatable resource plan" }, "properties": { - "$ref": "#/definitions/FleetPropertiesUpdate", + "$ref": "#/definitions/FleetProperties", "description": "RP-specific updatable properties" } } }, - "ManagedServiceIdentityUpdate": { + "IPVersion": { + "type": "string", + "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the\nspecific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible\nvalues are: 'IPv4' and 'IPv6'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true, + "values": [ + { + "name": "IPv4", + "value": "IPv4", + "description": "IPv4 version" + }, + { + "name": "IPv6", + "value": "IPv6", + "description": "IPv6 version" + } + ] + } + }, + "ImageReference": { "type": "object", - "description": "The template for adding optional properties.", + "description": "Specifies information about the image to use. You can specify information about\nplatform images, marketplace images, or virtual machine images. This element is\nrequired when you want to use a platform image, marketplace image, or virtual\nmachine image, but is not used in other creation operations. NOTE: Image\nreference publisher and offer can only be set when you create the scale set.", "properties": { - "type": { - "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.ManagedServiceIdentityType", - "description": "The type of managed identity assigned to this resource." + "id": { + "type": "string", + "format": "arm-id", + "description": "Resource Id" }, - "userAssignedIdentities": { - "type": "object", - "description": "The identities assigned to this resource by the user.", - "x-nullable": true, - "additionalProperties": { - "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/UserAssignedIdentity" - } + "publisher": { + "type": "string", + "description": "The image publisher." + }, + "offer": { + "type": "string", + "description": "Specifies the offer of the platform image or marketplace image used to create\nthe virtual machine." + }, + "sku": { + "type": "string", + "description": "The image SKU." + }, + "version": { + "type": "string", + "description": "Specifies the version of the platform image or marketplace image used to create\nthe virtual machine. The allowed formats are Major.Minor.Build or 'latest'.\nMajor, Minor, and Build are decimal numbers. Specify 'latest' to use the latest\nversion of an image available at deploy time. Even if you use 'latest', the VM\nimage will not automatically update after deploy time even if a new version\nbecomes available. Please do not use field 'version' for gallery image\ndeployment, gallery image should always use 'id' field for deployment, to use 'latest'\nversion of gallery image, just set\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}'\nin the 'id' field without version input." + }, + "exactVersion": { + "type": "string", + "description": "Specifies in decimal numbers, the version of platform image or marketplace\nimage used to create the virtual machine. This readonly field differs from 'version',\nonly if the value specified in 'version' field is 'latest'.", + "readOnly": true + }, + "sharedGalleryImageId": { + "type": "string", + "description": "Specified the shared gallery image unique id for vm deployment. This can be\nfetched from shared gallery image GET call." + }, + "communityGalleryImageId": { + "type": "string", + "description": "Specified the community gallery image unique id for vm deployment. This can be\nfetched from community gallery image GET call." } } }, - "ProvisioningState": { + "InnerError": { + "type": "object", + "description": "Inner error details.", + "properties": { + "exceptionType": { + "type": "string", + "description": "The exception type." + }, + "errorDetail": { + "type": "string", + "description": "The internal error message or exception dump." + } + } + }, + "KeyVaultSecretReference": { + "type": "object", + "description": "Describes a reference to Key Vault Secret", + "properties": { + "secretUrl": { + "type": "string", + "description": "The URL referencing a secret in a Key Vault." + }, + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing the secret." + } + }, + "required": [ + "secretUrl", + "sourceVault" + ] + }, + "LinuxConfiguration": { + "type": "object", + "description": "Specifies the Linux operating system settings on the virtual machine. For a\nlist of supported Linux distributions, see [Linux on Azure-Endorsed\nDistributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros).", + "properties": { + "disablePasswordAuthentication": { + "type": "boolean", + "description": "Specifies whether password authentication should be disabled." + }, + "ssh": { + "$ref": "#/definitions/SshConfiguration", + "description": "Specifies the ssh key configuration for a Linux OS." + }, + "provisionVMAgent": { + "type": "boolean", + "description": "Indicates whether virtual machine agent should be provisioned on the virtual\nmachine. When this property is not specified in the request body, default\nbehavior is to set it to true. This will ensure that VM Agent is installed on\nthe VM so that extensions can be added to the VM later." + }, + "patchSettings": { + "$ref": "#/definitions/LinuxPatchSettings", + "description": "[Preview Feature] Specifies settings related to VM Guest Patching on Linux." + }, + "enableVMAgentPlatformUpdates": { + "type": "boolean", + "description": "Indicates whether VMAgent Platform Updates is enabled for the Linux virtual\nmachine. Default value is false." + } + } + }, + "LinuxPatchAssessmentMode": { "type": "string", - "description": "The status of the current operation.", + "description": "Specifies the mode of VM Guest Patch Assessment for the IaaS virtual\nmachine.

Possible values are:

**ImageDefault** - You\ncontrol the timing of patch assessments on a virtual machine.

\n**AutomaticByPlatform** - The platform will trigger periodic patch assessments.\nThe property provisionVMAgent must be true.", "enum": [ - "Succeeded", - "Failed", - "Canceled", - "Creating", - "Updating", - "Deleting", - "Migrating" + "ImageDefault", + "AutomaticByPlatform" ], "x-ms-enum": { - "name": "ProvisioningState", + "name": "LinuxPatchAssessmentMode", "modelAsString": true, "values": [ { - "name": "Succeeded", - "value": "Succeeded", - "description": "Resource has been created." - }, - { - "name": "Failed", - "value": "Failed", - "description": "Resource creation failed." + "name": "ImageDefault", + "value": "ImageDefault", + "description": "You control the timing of patch assessments on a virtual machine." }, { - "name": "Canceled", - "value": "Canceled", - "description": "Resource creation was canceled." - }, + "name": "AutomaticByPlatform", + "value": "AutomaticByPlatform", + "description": "The platform will trigger periodic patch assessments.The property provisionVMAgent must be true." + } + ] + } + }, + "LinuxPatchSettings": { + "type": "object", + "description": "Specifies settings related to VM Guest Patching on Linux.", + "properties": { + "patchMode": { + "$ref": "#/definitions/LinuxVMGuestPatchMode", + "description": "Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual\nmachines associated to virtual machine scale set with OrchestrationMode as\nFlexible.

Possible values are:

**ImageDefault** - The\nvirtual machine's default patching configuration is used.

\n**AutomaticByPlatform** - The virtual machine will be automatically updated by\nthe platform. The property provisionVMAgent must be true" + }, + "assessmentMode": { + "$ref": "#/definitions/LinuxPatchAssessmentMode", + "description": "Specifies the mode of VM Guest Patch Assessment for the IaaS virtual\nmachine.

Possible values are:

**ImageDefault** - You\ncontrol the timing of patch assessments on a virtual machine.

\n**AutomaticByPlatform** - The platform will trigger periodic patch assessments.\nThe property provisionVMAgent must be true." + }, + "automaticByPlatformSettings": { + "$ref": "#/definitions/LinuxVMGuestPatchAutomaticByPlatformSettings", + "description": "Specifies additional settings for patch mode AutomaticByPlatform in VM Guest\nPatching on Linux." + } + } + }, + "LinuxVMGuestPatchAutomaticByPlatformRebootSetting": { + "type": "string", + "description": "Specifies the reboot setting for all AutomaticByPlatform patch installation\noperations.", + "enum": [ + "Unknown", + "IfRequired", + "Never", + "Always" + ], + "x-ms-enum": { + "name": "LinuxVMGuestPatchAutomaticByPlatformRebootSetting", + "modelAsString": true, + "values": [ { - "name": "Creating", - "value": "Creating", - "description": "Initial creation in progress." + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Reboot setting" }, { - "name": "Updating", - "value": "Updating", - "description": "Update in progress." + "name": "IfRequired", + "value": "IfRequired", + "description": "IfRequired Reboot setting" }, { - "name": "Deleting", - "value": "Deleting", - "description": "Deletion in progress." + "name": "Never", + "value": "Never", + "description": "Never Reboot setting" }, { - "name": "Migrating", - "value": "Migrating", - "description": "Resource is being migrated from one subscription or resource group to another." + "name": "Always", + "value": "Always", + "description": "Always Reboot setting" } ] - }, - "readOnly": true + } }, - "RegularPriorityAllocationStrategy": { + "LinuxVMGuestPatchAutomaticByPlatformSettings": { + "type": "object", + "description": "Specifies additional settings to be applied when patch mode AutomaticByPlatform\nis selected in Linux patch settings.", + "properties": { + "rebootSetting": { + "$ref": "#/definitions/LinuxVMGuestPatchAutomaticByPlatformRebootSetting", + "description": "Specifies the reboot setting for all AutomaticByPlatform patch installation\noperations." + }, + "bypassPlatformSafetyChecksOnUserSchedule": { + "type": "boolean", + "description": "Enables customer to schedule patching without accidental upgrades" + } + } + }, + "LinuxVMGuestPatchMode": { "type": "string", - "description": "Regular VM Allocation strategy types for Compute Fleet", + "description": "Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual\nmachines associated to virtual machine scale set with OrchestrationMode as\nFlexible.", "enum": [ - "LowestPrice", - "Prioritized" + "ImageDefault", + "AutomaticByPlatform" ], "x-ms-enum": { - "name": "RegularPriorityAllocationStrategy", + "name": "LinuxVMGuestPatchMode", "modelAsString": true, "values": [ { - "name": "LowestPrice", - "value": "LowestPrice", - "description": "Default. VM sizes distribution will be determined to optimize for price." + "name": "ImageDefault", + "value": "ImageDefault", + "description": "The virtual machine's default patching configuration is used." }, { - "name": "Prioritized", - "value": "Prioritized", - "description": "VM sizes distribution will be determined to optimize for the 'priority' as specified for each vm size." + "name": "AutomaticByPlatform", + "value": "AutomaticByPlatform", + "description": "The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true." } ] } }, - "RegularPriorityProfile": { - "type": "object", - "description": "Configuration Options for Regular instances in Compute Fleet.", - "properties": { - "capacity": { - "type": "integer", - "format": "int32", - "description": "Total capacity to achieve. It is currently in terms of number of VMs.", - "minimum": 0 - }, - "minCapacity": { - "type": "integer", - "format": "int32", - "description": "Minimum capacity to achieve which cannot be updated. If we will not be able to \"guarantee\" minimum capacity, we will reject the request in the sync path itself.", - "minimum": 0 - }, - "allocationStrategy": { - "$ref": "#/definitions/RegularPriorityAllocationStrategy", - "description": "Allocation strategy to follow when determining the VM sizes distribution for Regular VMs." - } - } - }, - "ResourcePlanUpdate": { + "ManagedServiceIdentityUpdate": { "type": "object", "description": "The template for adding optional properties.", "properties": { - "name": { - "type": "string", - "description": "A user defined name of the 3rd Party Artifact that is being procured." - }, - "publisher": { - "type": "string", - "description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic" - }, - "product": { - "type": "string", - "description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding." - }, - "promotionCode": { - "type": "string", - "description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact." + "type": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentityType", + "description": "The type of managed identity assigned to this resource." }, - "version": { - "type": "string", - "description": "The version of the desired product/artifact." + "userAssignedIdentities": { + "type": "object", + "description": "The identities assigned to this resource by the user.", + "additionalProperties": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/UserAssignedIdentity" + } + ], + "type": "object", + "x-nullable": true + } } } }, - "SpotAllocationStrategy": { + "Mode": { "type": "string", - "description": "Spot allocation strategy types for Compute Fleet", + "description": "Specifies the mode that ProxyAgent will execute on if the feature is enabled.\nProxyAgent will start to audit or monitor but not enforce access control over\nrequests to host endpoints in Audit mode, while in Enforce mode it will enforce\naccess control. The default value is Enforce mode.", "enum": [ - "PriceCapacityOptimized", - "LowestPrice", - "CapacityOptimized" + "Audit", + "Enforce" ], "x-ms-enum": { - "name": "SpotAllocationStrategy", + "name": "Mode", "modelAsString": true, "values": [ { - "name": "PriceCapacityOptimized", - "value": "PriceCapacityOptimized", - "description": "Default. VM sizes distribution will be determined to optimize for both price and capacity." + "name": "Audit", + "value": "Audit", + "description": "Audit Mode" }, { - "name": "LowestPrice", - "value": "LowestPrice", - "description": "VM sizes distribution will be determined to optimize for price. Note: Capacity will still be considered here but will be given much less weight." - }, + "name": "Enforce", + "value": "Enforce", + "description": "Enforce Mode" + } + ] + } + }, + "NetworkApiVersion": { + "type": "string", + "description": "specifies the Microsoft.Network API version used when creating networking\nresources in the Network Interface Configurations for Virtual Machine Scale Set\nwith orchestration mode 'Flexible'", + "enum": [ + "2020-11-01" + ], + "x-ms-enum": { + "name": "NetworkApiVersion", + "modelAsString": true, + "values": [ { - "name": "CapacityOptimized", - "value": "CapacityOptimized", - "description": "VM sizes distribution will be determined to optimize for capacity." + "name": "2020-11-01", + "value": "2020-11-01", + "description": "Initial version supported. Later versions are supported as well." } ] } }, - "SpotPriorityProfile": { - "type": "object", - "description": "Configuration Options for Spot instances in Compute Fleet.", - "properties": { - "capacity": { - "type": "integer", + "NetworkInterfaceAuxiliaryMode": { + "type": "string", + "description": "Specifies whether the Auxiliary mode is enabled for the Network Interface\nresource.", + "enum": [ + "None", + "AcceleratedConnections", + "Floating" + ], + "x-ms-enum": { + "name": "NetworkInterfaceAuxiliaryMode", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "None Mode" + }, + { + "name": "AcceleratedConnections", + "value": "AcceleratedConnections", + "description": "AcceleratedConnections Mode" + }, + { + "name": "Floating", + "value": "Floating", + "description": "Floating Mode" + } + ] + } + }, + "NetworkInterfaceAuxiliarySku": { + "type": "string", + "description": "Specifies whether the Auxiliary sku is enabled for the Network Interface\nresource.", + "enum": [ + "None", + "A1", + "A2", + "A4", + "A8" + ], + "x-ms-enum": { + "name": "NetworkInterfaceAuxiliarySku", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "no sku" + }, + { + "name": "A1", + "value": "A1", + "description": "A1 sku" + }, + { + "name": "A2", + "value": "A2", + "description": "A2 sku" + }, + { + "name": "A4", + "value": "A4", + "description": "A4 sku" + }, + { + "name": "A8", + "value": "A8", + "description": "A8 sku" + } + ] + } + }, + "OSImageNotificationProfile": { + "type": "object", + "description": "Specifies OS Image Scheduled Event related configurations.", + "properties": { + "notBeforeTimeout": { + "type": "string", + "description": "Length of time a Virtual Machine being reimaged or having its OS upgraded will\nhave to potentially approve the OS Image Scheduled Event before the event is\nauto approved (timed out). The configuration is specified in ISO 8601 format,\nand the value must not exceed 15 minutes (PT15M)" + }, + "enable": { + "type": "boolean", + "description": "Specifies whether the OS Image Scheduled event is enabled or disabled." + } + } + }, + "OperatingSystemTypes": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the\ndisk if creating a VM from user-image or a specialized VHD. Possible values\nare: **Windows,** **Linux.**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": true, + "values": [ + { + "name": "Windows", + "value": "Windows", + "description": "Windows OS type" + }, + { + "name": "Linux", + "value": "Linux", + "description": "Linux OS type" + } + ] + } + }, + "PatchSettings": { + "type": "object", + "description": "Specifies settings related to VM Guest Patching on Windows.", + "properties": { + "patchMode": { + "$ref": "#/definitions/WindowsVMGuestPatchMode", + "description": "Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual\nmachines associated to virtual machine scale set with OrchestrationMode as\nFlexible.

Possible values are:

**Manual** - You\ncontrol the application of patches to a virtual machine. You do this by\napplying patches manually inside the VM. In this mode, automatic updates are\ndisabled; the property WindowsConfiguration.enableAutomaticUpdates must be\nfalse

**AutomaticByOS** - The virtual machine will automatically be\nupdated by the OS. The property WindowsConfiguration.enableAutomaticUpdates\nmust be true.

**AutomaticByPlatform** - the virtual machine will\nautomatically updated by the platform. The properties provisionVMAgent and\nWindowsConfiguration.enableAutomaticUpdates must be true" + }, + "enableHotpatching": { + "type": "boolean", + "description": "Enables customers to patch their Azure VMs without requiring a reboot. For\nenableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode'\nmust be set to 'AutomaticByPlatform'." + }, + "assessmentMode": { + "$ref": "#/definitions/WindowsPatchAssessmentMode", + "description": "Specifies the mode of VM Guest patch assessment for the IaaS virtual\nmachine.

Possible values are:

**ImageDefault** - You\ncontrol the timing of patch assessments on a virtual machine.

\n**AutomaticByPlatform** - The platform will trigger periodic patch assessments.\nThe property provisionVMAgent must be true." + }, + "automaticByPlatformSettings": { + "$ref": "#/definitions/WindowsVMGuestPatchAutomaticByPlatformSettings", + "description": "Specifies additional settings for patch mode AutomaticByPlatform in VM Guest\nPatching on Windows." + } + } + }, + "ProtocolTypes": { + "type": "string", + "description": "Specifies the protocol of WinRM listener. Possible values are: **http,**\n**https.**", + "enum": [ + "Http", + "Https" + ], + "x-ms-enum": { + "name": "ProtocolTypes", + "modelAsString": true, + "values": [ + { + "name": "Http", + "value": "Http", + "description": "Http protocol" + }, + { + "name": "Https", + "value": "Https", + "description": "Https protocol" + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The status of the current operation.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Updating", + "Deleting", + "Migrating" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Creating", + "value": "Creating", + "description": "Initial creation in progress." + }, + { + "name": "Updating", + "value": "Updating", + "description": "Update in progress." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Deletion in progress." + }, + { + "name": "Migrating", + "value": "Migrating", + "description": "Resource is being migrated from one subscription or resource group to another." + } + ] + }, + "readOnly": true + }, + "ProxyAgentSettings": { + "type": "object", + "description": "Specifies ProxyAgent settings while creating the virtual machine. Minimum\napi-version: 2023-09-01.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Specifies whether ProxyAgent feature should be enabled on the virtual machine\nor virtual machine scale set." + }, + "mode": { + "$ref": "#/definitions/Mode", + "description": "Specifies the mode that ProxyAgent will execute on if the feature is enabled.\nProxyAgent will start to audit or monitor but not enforce access control over\nrequests to host endpoints in Audit mode, while in Enforce mode it will enforce\naccess control. The default value is Enforce mode." + }, + "keyIncarnationId": { + "type": "integer", + "format": "int32", + "description": "Increase the value of this property allows user to reset the key used for\nsecuring communication channel between guest and host." + } + } + }, + "PublicIPAddressSku": { + "type": "object", + "description": "Describes the public IP Sku. It can only be set with OrchestrationMode as\nFlexible.", + "properties": { + "name": { + "$ref": "#/definitions/PublicIPAddressSkuName", + "description": "Specify public IP sku name" + }, + "tier": { + "$ref": "#/definitions/PublicIPAddressSkuTier", + "description": "Specify public IP sku tier" + } + } + }, + "PublicIPAddressSkuName": { + "type": "string", + "description": "Specify public IP sku name.", + "enum": [ + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "PublicIPAddressSkuName", + "modelAsString": true, + "values": [ + { + "name": "Basic", + "value": "Basic", + "description": "Basic sku name" + }, + { + "name": "Standard", + "value": "Standard", + "description": "Standard sku name" + } + ] + } + }, + "PublicIPAddressSkuTier": { + "type": "string", + "description": "Specify public IP sku tier", + "enum": [ + "Regional", + "Global" + ], + "x-ms-enum": { + "name": "PublicIPAddressSkuTier", + "modelAsString": true, + "values": [ + { + "name": "Regional", + "value": "Regional", + "description": "Regional sku tier" + }, + { + "name": "Global", + "value": "Global", + "description": "Global sku tier" + } + ] + } + }, + "RegularPriorityAllocationStrategy": { + "type": "string", + "description": "Regular VM Allocation strategy types for Compute Fleet", + "enum": [ + "LowestPrice", + "Prioritized" + ], + "x-ms-enum": { + "name": "RegularPriorityAllocationStrategy", + "modelAsString": true, + "values": [ + { + "name": "LowestPrice", + "value": "LowestPrice", + "description": "Default. VM sizes distribution will be determined to optimize for price." + }, + { + "name": "Prioritized", + "value": "Prioritized", + "description": "VM sizes distribution will be determined to optimize for the 'priority' as specified for each vm size." + } + ] + } + }, + "RegularPriorityProfile": { + "type": "object", + "description": "Configuration Options for Regular instances in Compute Fleet.", + "properties": { + "capacity": { + "type": "integer", "format": "int32", "description": "Total capacity to achieve. It is currently in terms of number of VMs.", "minimum": 0 }, - "minCapacity": { - "type": "integer", - "format": "int32", - "description": "Minimum capacity to achieve which cannot be updated. If we will not be able to \"guarantee\" minimum capacity, we will reject the request in the sync path itself.", - "minimum": 0 + "minCapacity": { + "type": "integer", + "format": "int32", + "description": "Minimum capacity to achieve which cannot be updated. If we will not be able to \"guarantee\" minimum capacity, we will reject the request in the sync path itself.", + "minimum": 0 + }, + "allocationStrategy": { + "$ref": "#/definitions/RegularPriorityAllocationStrategy", + "description": "Allocation strategy to follow when determining the VM sizes distribution for Regular VMs." + } + } + }, + "ResourcePlanUpdate": { + "type": "object", + "description": "The template for adding optional properties.", + "properties": { + "name": { + "type": "string", + "description": "A user defined name of the 3rd Party Artifact that is being procured." + }, + "publisher": { + "type": "string", + "description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic" + }, + "product": { + "type": "string", + "description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding." + }, + "promotionCode": { + "type": "string", + "description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact." + }, + "version": { + "type": "string", + "description": "The version of the desired product/artifact." + } + } + }, + "ScheduledEventsProfile": { + "type": "object", + "description": "Specifies Scheduled Event related configurations.", + "properties": { + "terminateNotificationProfile": { + "$ref": "#/definitions/TerminateNotificationProfile", + "description": "Specifies Terminate Scheduled Event related configurations." + }, + "osImageNotificationProfile": { + "$ref": "#/definitions/OSImageNotificationProfile", + "description": "Specifies OS Image Scheduled Event related configurations." + } + } + }, + "SecurityEncryptionTypes": { + "type": "string", + "description": "Specifies the EncryptionType of the managed disk.\n**Note:** It can be set for only Confidential VMs.", + "enum": [ + "VMGuestStateOnly", + "DiskWithVMGuestState", + "NonPersistedTPM" + ], + "x-ms-enum": { + "name": "SecurityEncryptionTypes", + "modelAsString": true, + "values": [ + { + "name": "VMGuestStateOnly", + "value": "VMGuestStateOnly", + "description": "EncryptionType of the managed disk is set to VMGuestStateOnly for encryption\nof just the VMGuestState blob." + }, + { + "name": "DiskWithVMGuestState", + "value": "DiskWithVMGuestState", + "description": "EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption\nof the managed disk along with VMGuestState blob." + }, + { + "name": "NonPersistedTPM", + "value": "NonPersistedTPM", + "description": "EncryptionType of the managed disk is set to NonPersistedTPM for not persisting\nfirmware state in the VMGuestState blob." + } + ] + } + }, + "SecurityPostureReference": { + "type": "object", + "description": "Specifies the security posture to be used for all virtual machines in the scale\nset. Minimum api-version: 2023-03-01", + "properties": { + "id": { + "type": "string", + "description": "The security posture reference id in the form of\n/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest" + }, + "excludeExtensions": { + "type": "array", + "description": "List of virtual machine extension names to exclude when applying the security\nposture.", + "items": { + "type": "string" + } + }, + "isOverridable": { + "type": "boolean", + "description": "Whether the security posture can be overridden by the user." + } + } + }, + "SecurityProfile": { + "type": "object", + "description": "Specifies the Security profile settings for the virtual machine or virtual\nmachine scale set.", + "properties": { + "uefiSettings": { + "$ref": "#/definitions/UefiSettings", + "description": "Specifies the security settings like secure boot and vTPM used while creating\nthe virtual machine. Minimum api-version: 2020-12-01." + }, + "encryptionAtHost": { + "type": "boolean", + "description": "This property can be used by user in the request to enable or disable the Host\nEncryption for the virtual machine or virtual machine scale set. This will\nenable the encryption for all the disks including Resource/Temp disk at host\nitself. The default behavior is: The Encryption at host will be disabled unless\nthis property is set to true for the resource." + }, + "securityType": { + "$ref": "#/definitions/SecurityTypes", + "description": "Specifies the SecurityType of the virtual machine. It has to be set to any\nspecified value to enable UefiSettings. The default behavior is: UefiSettings\nwill not be enabled unless this property is set." + }, + "encryptionIdentity": { + "$ref": "#/definitions/EncryptionIdentity", + "description": "Specifies the Managed Identity used by ADE to get access token for keyvault\noperations." + }, + "proxyAgentSettings": { + "$ref": "#/definitions/ProxyAgentSettings", + "description": "Specifies ProxyAgent settings while creating the virtual machine. Minimum\napi-version: 2023-09-01." + } + } + }, + "SecurityTypes": { + "type": "string", + "description": "Specifies the SecurityType of the virtual machine. It has to be set to any\nspecified value to enable UefiSettings. The default behavior is: UefiSettings\nwill not be enabled unless this property is set.", + "enum": [ + "TrustedLaunch", + "ConfidentialVM" + ], + "x-ms-enum": { + "name": "SecurityTypes", + "modelAsString": true, + "values": [ + { + "name": "TrustedLaunch", + "value": "TrustedLaunch", + "description": "TrustedLaunch security type" + }, + { + "name": "ConfidentialVM", + "value": "ConfidentialVM", + "description": "ConfidentialVM security type" + } + ] + } + }, + "ServiceArtifactReference": { + "type": "object", + "description": "Specifies the service artifact reference id used to set same image version for\nall virtual machines in the scale set when using 'latest' image version.\nMinimum api-version: 2022-11-01", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The service artifact reference id in the form of\n/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}" + } + } + }, + "SettingNames": { + "type": "string", + "description": "Specifies the name of the setting to which the content applies. Possible values\nare: FirstLogonCommands and AutoLogon.", + "enum": [ + "AutoLogon", + "FirstLogonCommands" + ], + "x-ms-enum": { + "name": "SettingNames", + "modelAsString": true, + "values": [ + { + "name": "AutoLogon", + "value": "AutoLogon", + "description": "AutoLogon setting" + }, + { + "name": "FirstLogonCommands", + "value": "FirstLogonCommands", + "description": "FirstLogonCommands setting" + } + ] + } + }, + "SpotAllocationStrategy": { + "type": "string", + "description": "Spot allocation strategy types for Compute Fleet", + "enum": [ + "PriceCapacityOptimized", + "LowestPrice", + "CapacityOptimized" + ], + "x-ms-enum": { + "name": "SpotAllocationStrategy", + "modelAsString": true, + "values": [ + { + "name": "PriceCapacityOptimized", + "value": "PriceCapacityOptimized", + "description": "Default. VM sizes distribution will be determined to optimize for both price and capacity." + }, + { + "name": "LowestPrice", + "value": "LowestPrice", + "description": "VM sizes distribution will be determined to optimize for price. Note: Capacity will still be considered here but will be given much less weight." + }, + { + "name": "CapacityOptimized", + "value": "CapacityOptimized", + "description": "VM sizes distribution will be determined to optimize for capacity." + } + ] + } + }, + "SpotPriorityProfile": { + "type": "object", + "description": "Configuration Options for Spot instances in Compute Fleet.", + "properties": { + "capacity": { + "type": "integer", + "format": "int32", + "description": "Total capacity to achieve. It is currently in terms of number of VMs.", + "minimum": 0 + }, + "minCapacity": { + "type": "integer", + "format": "int32", + "description": "Minimum capacity to achieve which cannot be updated. If we will not be able to \"guarantee\" minimum capacity, we will reject the request in the sync path itself.", + "minimum": 0 + }, + "maxPricePerVM": { + "type": "number", + "format": "float", + "description": "Price per hour of each Spot VM will never exceed this." + }, + "evictionPolicy": { + "$ref": "#/definitions/EvictionPolicy", + "description": "Eviction Policy to follow when evicting Spot VMs." + }, + "allocationStrategy": { + "$ref": "#/definitions/SpotAllocationStrategy", + "description": "Allocation strategy to follow when determining the VM sizes distribution for Spot VMs." + }, + "maintain": { + "type": "boolean", + "description": "Flag to enable/disable continuous goal seeking for the desired capacity and restoration of evicted Spot VMs.\nIf maintain is enabled, AzureFleetRP will use all VM sizes in vmSizesProfile to create new VMs (if VMs are evicted deleted)\nor update existing VMs with new VM sizes (if VMs are evicted deallocated or failed to allocate due to capacity constraint) in order to achieve the desired capacity.\nMaintain is enabled by default." + } + } + }, + "SshConfiguration": { + "type": "object", + "description": "SSH configuration for Linux based VMs running on Azure", + "properties": { + "publicKeys": { + "type": "array", + "description": "The list of SSH public keys used to authenticate with linux based VMs.", + "items": { + "$ref": "#/definitions/SshPublicKey" + }, + "x-ms-identifiers": [ + "path" + ] + } + } + }, + "SshPublicKey": { + "type": "object", + "description": "Contains information about SSH certificate public key and the path on the Linux\nVM where the public key is placed.", + "properties": { + "path": { + "type": "string", + "description": "Specifies the full path on the created VM where ssh public key is stored. If\nthe file already exists, the specified key is appended to the file. Example:\n/home/user/.ssh/authorized_keys" + }, + "keyData": { + "type": "string", + "description": "SSH public key certificate used to authenticate with the VM through ssh. The\nkey needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys,\nsee [Create SSH keys on Linux and Mac for Linux VMs in\nAzure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed)." + } + } + }, + "StatusLevelTypes": { + "type": "string", + "description": "The level code.", + "enum": [ + "Info", + "Warning", + "Error" + ], + "x-ms-enum": { + "name": "StatusLevelTypes", + "modelAsString": true, + "values": [ + { + "name": "Info", + "value": "Info", + "description": "Info level" + }, + { + "name": "Warning", + "value": "Warning", + "description": "Warning level" + }, + { + "name": "Error", + "value": "Error", + "description": "Error Level" + } + ] + } + }, + "StorageAccountTypes": { + "type": "string", + "description": "Specifies the storage account type for the managed disk. Managed OS disk\nstorage account type can only be set when you create the scale set. NOTE:\nUltraSSD_LRS can only be used with data disks. It cannot be used with OS Disk.\nStandard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS\nuses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD\nzone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant\nstorage. For more information regarding disks supported for Windows Virtual\nMachines, refer to\nhttps://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for\nLinux Virtual Machines, refer to\nhttps://docs.microsoft.com/azure/virtual-machines/linux/disks-types", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "UltraSSD_LRS", + "Premium_ZRS", + "StandardSSD_ZRS", + "PremiumV2_LRS" + ], + "x-ms-enum": { + "name": "StorageAccountTypes", + "modelAsString": true, + "values": [ + { + "name": "Standard_LRS", + "value": "Standard_LRS", + "description": "Standard_LRS option." + }, + { + "name": "Premium_LRS", + "value": "Premium_LRS", + "description": "Premium_LRS option." + }, + { + "name": "StandardSSD_LRS", + "value": "StandardSSD_LRS", + "description": "StandardSSD_LRS option." + }, + { + "name": "UltraSSD_LRS", + "value": "UltraSSD_LRS", + "description": "UltraSSD_LRS option." + }, + { + "name": "Premium_ZRS", + "value": "Premium_ZRS", + "description": "Premium_ZRS option." + }, + { + "name": "StandardSSD_ZRS", + "value": "StandardSSD_ZRS", + "description": "StandardSSD_ZRS option." + }, + { + "name": "PremiumV2_LRS", + "value": "PremiumV2_LRS", + "description": "PremiumV2_LRS option." + } + ] + } + }, + "SubResource": { + "type": "object", + "description": "Describes SubResource", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "Resource Id" + } + } + }, + "SubResourceReadOnly": { + "type": "object", + "description": "Describes a Readonly subresource.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "Resource Id", + "readOnly": true + } + } + }, + "TerminateNotificationProfile": { + "type": "object", + "description": "Specifies Terminate Scheduled Event related configurations.", + "properties": { + "notBeforeTimeout": { + "type": "string", + "description": "Configurable length of time a Virtual Machine being deleted will have to\npotentially approve the Terminate Scheduled Event before the event is auto\napproved (timed out). The configuration must be specified in ISO 8601 format,\nthe default value is 5 minutes (PT5M)" + }, + "enable": { + "type": "boolean", + "description": "Specifies whether the Terminate Scheduled event is enabled or disabled." + } + } + }, + "UefiSettings": { + "type": "object", + "description": "Specifies the security settings like secure boot and vTPM used while creating\nthe virtual machine. Minimum api-version: 2020-12-01.", + "properties": { + "secureBootEnabled": { + "type": "boolean", + "description": "Specifies whether secure boot should be enabled on the virtual machine. Minimum\napi-version: 2020-12-01." + }, + "vTpmEnabled": { + "type": "boolean", + "description": "Specifies whether vTPM should be enabled on the virtual machine. Minimum\napi-version: 2020-12-01." + } + } + }, + "VMDiskSecurityProfile": { + "type": "object", + "description": "Specifies the security profile settings for the managed disk. **Note:** It can\nonly be set for Confidential VMs.", + "properties": { + "securityEncryptionType": { + "$ref": "#/definitions/SecurityEncryptionTypes", + "description": "Specifies the EncryptionType of the managed disk. It is set to\nDiskWithVMGuestState for encryption of the managed disk along with VMGuestState\nblob, VMGuestStateOnly for encryption of just the VMGuestState blob, and\nNonPersistedTPM for not persisting firmware state in the VMGuestState blob..\n**Note:** It can be set for only Confidential VMs." + }, + "diskEncryptionSet": { + "$ref": "#/definitions/DiskEncryptionSetParameters", + "description": "Specifies the customer managed disk encryption set resource id for the managed\ndisk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and\nVMGuest blob." + } + } + }, + "VMGalleryApplication": { + "type": "object", + "description": "Specifies the required information to reference a compute gallery application\nversion", + "properties": { + "tags": { + "type": "string", + "description": "Optional, Specifies a passthrough value for more generic context." + }, + "order": { + "type": "integer", + "format": "int32", + "description": "Optional, Specifies the order in which the packages have to be installed" + }, + "packageReferenceId": { + "type": "string", + "format": "arm-id", + "description": "Specifies the GalleryApplicationVersion resource id on the form of\n/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version}" + }, + "configurationReference": { + "type": "string", + "description": "Optional, Specifies the uri to an azure blob that will replace the default\nconfiguration for the package if provided" + }, + "treatFailureAsDeploymentFailure": { + "type": "boolean", + "description": "Optional, If true, any failure for any operation in the VmApplication will fail\nthe deployment" + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "If set to true, when a new Gallery Application version is available in PIR/SIG,\nit will be automatically updated for the VM/VMSS" + } + }, + "required": [ + "packageReferenceId" + ] + }, + "VMSizeProperties": { + "type": "object", + "description": "Specifies VM Size Property settings on the virtual machine.", + "properties": { + "vCPUsAvailable": { + "type": "integer", + "format": "int32", + "description": "Specifies the number of vCPUs available for the VM. When this property is not\nspecified in the request body the default behavior is to set it to the value of\nvCPUs available for that VM size exposed in api response of [List all available\nvirtual machine sizes in a\nregion](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list)." + }, + "vCPUsPerCore": { + "type": "integer", + "format": "int32", + "description": "Specifies the vCPU to physical core ratio. When this property is not specified\nin the request body the default behavior is set to the value of vCPUsPerCore\nfor the VM Size exposed in api response of [List all available virtual machine\nsizes in a\nregion](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list).\n**Setting this property to 1 also means that hyper-threading is disabled.**" + } + } + }, + "VaultCertificate": { + "type": "object", + "description": "Describes a single certificate reference in a Key Vault, and where the\ncertificate should reside on the VM.", + "properties": { + "certificateUrl": { + "type": "string", + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a\nsecret. For adding a secret to the Key Vault, see [Add a key or secret to the\nkey\nvault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add).\nIn this case, your certificate needs to be It is the Base64 encoding of the\nfollowing JSON Object which is encoded in UTF-8:

{
\n\"data\":\"\",
\"dataType\":\"pfx\",
\n\"password\":\"\"
}
To install certificates on a virtual\nmachine it is recommended to use the [Azure Key Vault virtual machine extension\nfor\nLinux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux)\nor the [Azure Key Vault virtual machine extension for\nWindows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)." + }, + "certificateStore": { + "type": "string", + "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to\nwhich the certificate should be added. The specified certificate store is\nimplicitly in the LocalMachine account. For Linux VMs, the certificate file is\nplaced under the /var/lib/waagent directory, with the file name\n<UppercaseThumbprint>.crt for the X509 certificate file and\n<UppercaseThumbprint>.prv for private key. Both of these files are .pem\nformatted." + } + } + }, + "VaultSecretGroup": { + "type": "object", + "description": "Describes a set of certificates which are all in the same Key Vault.", + "properties": { + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing all of the certificates in\nVaultCertificates." + }, + "vaultCertificates": { + "type": "array", + "description": "The list of key vault references in SourceVault which contain certificates.", + "items": { + "$ref": "#/definitions/VaultCertificate" + }, + "x-ms-identifiers": [ + "certificateUrl" + ] + } + } + }, + "VirtualHardDisk": { + "type": "object", + "description": "Describes the uri of a disk.", + "properties": { + "uri": { + "type": "string", + "description": "Specifies the virtual hard disk's uri." + } + } + }, + "VirtualMachineScaleSet": { + "type": "object", + "description": "An AzureFleet's virtualMachineScaleSet", + "properties": { + "name": { + "type": "string", + "description": "The name of the virtualMachineScaleSet", + "readOnly": true + }, + "id": { + "type": "string", + "description": "The compute RP resource id of the virtualMachineScaleSet \n\"subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}\"", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Type of the virtualMachineScaleSet", + "readOnly": true + }, + "operationStatus": { + "$ref": "#/definitions/ProvisioningState", + "description": "This represents the operationStatus of the VMSS in response to the last operation that was performed on it by Azure Fleet resource.", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/ApiError", + "description": "Error Information when `operationStatus` is `Failed`", + "readOnly": true + } + }, + "required": [ + "name", + "id", + "operationStatus" + ] + }, + "VirtualMachineScaleSetDataDisk": { + "type": "object", + "description": "Describes a virtual machine scale set data disk.", + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "lun": { + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to\nidentify data disks within the VM and therefore must be unique for each data\ndisk attached to a VM." + }, + "caching": { + "$ref": "#/definitions/CachingTypes", + "description": "Specifies the caching requirements. Possible values are: **None,**\n**ReadOnly,** **ReadWrite.** The default values are: **None for Standard\nstorage. ReadOnly for Premium storage.**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "createOption": { + "$ref": "#/definitions/DiskCreateOptionTypes", + "description": "The create option." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used\nto overwrite the size of the disk in a virtual machine image. The property\ndiskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be\nlarger than 1023." + }, + "managedDisk": { + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters", + "description": "The managed disk parameters." + }, + "diskIOPSReadWrite": { + "type": "integer", + "format": "int64", + "description": "Specifies the Read-Write IOPS for the managed disk. Should be used only when\nStorageAccountType is UltraSSD_LRS. If not specified, a default value would be\nassigned based on diskSizeGB." + }, + "diskMBpsReadWrite": { + "type": "integer", + "format": "int64", + "description": "Specifies the bandwidth in MB per second for the managed disk. Should be used\nonly when StorageAccountType is UltraSSD_LRS. If not specified, a default value\nwould be assigned based on diskSizeGB." + }, + "deleteOption": { + "$ref": "#/definitions/DiskDeleteOptionTypes", + "description": "Specifies whether data disk should be deleted or detached upon VMSS Flex\ndeletion (This feature is available for VMSS with Flexible OrchestrationMode\nonly).

Possible values:

**Delete** If this value is used, the\ndata disk is deleted when the VMSS Flex VM is deleted.

**Detach** If\nthis value is used, the data disk is retained after VMSS Flex VM is\ndeleted.

The default value is set to **Delete**." + } + }, + "required": [ + "lun", + "createOption" + ] + }, + "VirtualMachineScaleSetExtension": { + "type": "object", + "description": "Describes a Virtual Machine Scale Set Extension.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "Resource Id", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of the extension." + }, + "type": { + "type": "string", + "description": "Resource type", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties", + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + } + } + }, + "VirtualMachineScaleSetExtensionProfile": { + "type": "object", + "description": "Describes a virtual machine scale set extension profile.", + "properties": { + "extensions": { + "type": "array", + "description": "The virtual machine scale set child extension resources.", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + }, + "extensionsTimeBudget": { + "type": "string", + "description": "Specifies the time alloted for all extensions to start. The time duration\nshould be between 15 minutes and 120 minutes (inclusive) and should be\nspecified in ISO 8601 format. The default value is 90 minutes (PT1H30M).\nMinimum api-version: 2020-06-01." + } + } + }, + "VirtualMachineScaleSetExtensionProperties": { + "type": "object", + "description": "Describes the properties of a Virtual Machine Scale Set Extension.", + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "If a value is provided and is different from the previous value, the extension\nhandler will be forced to update even if the extension configuration has not\nchanged." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is\navailable at deployment time. Once deployed, however, the extension will not\nupgrade minor versions unless redeployed, even with this property set to true." + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "Indicates whether the extension should be automatically upgraded by the\nplatform if there is a newer version of the extension available." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension.", + "additionalProperties": {} + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or\nprotectedSettingsFromKeyVault or no protected settings at all.", + "additionalProperties": {}, + "x-ms-mutability": [ + "update", + "create" + ], + "x-ms-secret": true + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state, which only appears in the response.", + "readOnly": true + }, + "provisionAfterExtensions": { + "type": "array", + "description": "Collection of extension names after which this extension needs to be\nprovisioned.", + "items": { + "type": "string" + } + }, + "suppressFailures": { + "type": "boolean", + "description": "Indicates whether failures stemming from the extension will be suppressed\n(Operational failures such as not connecting to the VM will not be suppressed\nregardless of this value). The default is false." + }, + "protectedSettingsFromKeyVault": { + "$ref": "#/definitions/KeyVaultSecretReference", + "description": "The extensions protected settings that are passed by reference, and consumed\nfrom key vault" + } + } + }, + "VirtualMachineScaleSetHardwareProfile": { + "type": "object", + "description": "Specifies the hardware settings for the virtual machine scale set.", + "properties": { + "vmSizeProperties": { + "$ref": "#/definitions/VMSizeProperties", + "description": "Specifies the properties for customizing the size of the virtual machine.\nMinimum api-version: 2021-11-01. Please follow the instructions in [VM\nCustomization](https://aka.ms/vmcustomization) for more details." + } + } + }, + "VirtualMachineScaleSetIPConfiguration": { + "type": "object", + "description": "Describes a virtual machine scale set network profile's IP configuration.", + "properties": { + "name": { + "type": "string", + "description": "The IP configuration name." + }, + "properties": { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfigurationProperties", + "description": "Describes a virtual machine scale set network profile's IP configuration\nproperties." + } + }, + "required": [ + "name" + ] + }, + "VirtualMachineScaleSetIPConfigurationProperties": { + "type": "object", + "description": "Describes a virtual machine scale set network profile's IP configuration\nproperties.", + "properties": { + "subnet": { + "$ref": "#/definitions/ApiEntityReference", + "description": "Specifies the identifier of the subnet." + }, + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more\nthan 1 network interface." + }, + "publicIPAddressConfiguration": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration", + "description": "The publicIPAddressConfiguration." + }, + "privateIPAddressVersion": { + "$ref": "#/definitions/IPVersion", + "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the\nspecific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible\nvalues are: 'IPv4' and 'IPv6'." + }, + "applicationGatewayBackendAddressPools": { + "type": "array", + "description": "Specifies an array of references to backend address pools of application\ngateways. A scale set can reference backend address pools of multiple\napplication gateways. Multiple scale sets cannot use the same application\ngateway.", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + "applicationSecurityGroups": { + "type": "array", + "description": "Specifies an array of references to application security group.", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + "loadBalancerBackendAddressPools": { + "type": "array", + "description": "Specifies an array of references to backend address pools of load balancers. A\nscale set can reference backend address pools of one public and one internal\nload balancer. Multiple scale sets cannot use the same basic sku load balancer.", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + "loadBalancerInboundNatPools": { + "type": "array", + "description": "Specifies an array of references to inbound Nat pools of the load balancers. A\nscale set can reference inbound nat pools of one public and one internal load\nbalancer. Multiple scale sets cannot use the same basic sku load balancer.", + "items": { + "$ref": "#/definitions/SubResource" + } + } + } + }, + "VirtualMachineScaleSetIpTag": { + "type": "object", + "description": "Contains the IP tag associated with the public IP address.", + "properties": { + "ipTagType": { + "type": "string", + "description": "IP tag type. Example: FirstPartyUsage." + }, + "tag": { + "type": "string", + "description": "IP tag associated with the public IP. Example: SQL, Storage etc." + } + } + }, + "VirtualMachineScaleSetListResult": { + "type": "object", + "description": "The response of a VirtualMachineScaleSet list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VirtualMachineScaleSet items on this page", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VirtualMachineScaleSetManagedDiskParameters": { + "type": "object", + "description": "Describes the parameters of a ScaleSet managed disk.", + "properties": { + "storageAccountType": { + "$ref": "#/definitions/StorageAccountTypes", + "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can\nonly be used with data disks, it cannot be used with OS Disk." + }, + "diskEncryptionSet": { + "$ref": "#/definitions/DiskEncryptionSetParameters", + "description": "Specifies the customer managed disk encryption set resource id for the managed\ndisk." + }, + "securityProfile": { + "$ref": "#/definitions/VMDiskSecurityProfile", + "description": "Specifies the security profile for the managed disk." + } + } + }, + "VirtualMachineScaleSetNetworkConfiguration": { + "type": "object", + "description": "Describes a virtual machine scale set network profile's network configurations.", + "properties": { + "name": { + "type": "string", + "description": "The network configuration name." + }, + "properties": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationProperties", + "description": "Describes a virtual machine scale set network profile's IP configuration." + } + }, + "required": [ + "name" + ] + }, + "VirtualMachineScaleSetNetworkConfigurationDnsSettings": { + "type": "object", + "description": "Describes a virtual machines scale sets network configuration's DNS settings.", + "properties": { + "dnsServers": { + "type": "array", + "description": "List of DNS servers IP addresses", + "items": { + "type": "string" + } + } + } + }, + "VirtualMachineScaleSetNetworkConfigurationProperties": { + "type": "object", + "description": "Describes a virtual machine scale set network profile's IP configuration.", + "properties": { + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more\nthan 1 network interface." }, - "maxPricePerVM": { - "type": "number", - "format": "float", - "description": "Price per hour of each Spot VM will never exceed this." + "enableAcceleratedNetworking": { + "type": "boolean", + "description": "Specifies whether the network interface is accelerated networking-enabled." }, - "evictionPolicy": { - "$ref": "#/definitions/EvictionPolicy", - "description": "Eviction Policy to follow when evicting Spot VMs." + "disableTcpStateTracking": { + "type": "boolean", + "description": "Specifies whether the network interface is disabled for tcp state tracking." }, - "allocationStrategy": { - "$ref": "#/definitions/SpotAllocationStrategy", - "description": "Allocation strategy to follow when determining the VM sizes distribution for Spot VMs." + "enableFpga": { + "type": "boolean", + "description": "Specifies whether the network interface is FPGA networking-enabled." }, - "maintain": { + "networkSecurityGroup": { + "$ref": "#/definitions/SubResource", + "description": "The network security group." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings", + "description": "The dns settings to be applied on the network interfaces." + }, + "ipConfigurations": { + "type": "array", + "description": "Specifies the IP configurations of the network interface.", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "enableIPForwarding": { "type": "boolean", - "description": "Flag to enable/disable continuous goal seeking for the desired capacity and restoration of evicted Spot VMs.\nIf maintain is enabled, AzureFleetRP will use all VM sizes in vmSizesProfile to create new VMs (if VMs are evicted deleted)\nor update existing VMs with new VM sizes (if VMs are evicted deallocated or failed to allocate due to capacity constraint) in order to achieve the desired capacity.\nMaintain is enabled by default." + "description": "Whether IP forwarding enabled on this NIC." + }, + "deleteOption": { + "$ref": "#/definitions/DeleteOptions", + "description": "Specify what happens to the network interface when the VM is deleted" + }, + "auxiliaryMode": { + "$ref": "#/definitions/NetworkInterfaceAuxiliaryMode", + "description": "Specifies whether the Auxiliary mode is enabled for the Network Interface\nresource." + }, + "auxiliarySku": { + "$ref": "#/definitions/NetworkInterfaceAuxiliarySku", + "description": "Specifies whether the Auxiliary sku is enabled for the Network Interface\nresource." + } + }, + "required": [ + "ipConfigurations" + ] + }, + "VirtualMachineScaleSetNetworkProfile": { + "type": "object", + "description": "Describes a virtual machine scale set network profile.", + "properties": { + "healthProbe": { + "$ref": "#/definitions/ApiEntityReference", + "description": "A reference to a load balancer probe used to determine the health of an\ninstance in the virtual machine scale set. The reference will be in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'." + }, + "networkInterfaceConfigurations": { + "type": "array", + "description": "The list of network configurations.", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" + }, + "x-ms-identifiers": [] + }, + "networkApiVersion": { + "$ref": "#/definitions/NetworkApiVersion", + "description": "specifies the Microsoft.Network API version used when creating networking\nresources in the Network Interface Configurations for Virtual Machine Scale Set\nwith orchestration mode 'Flexible'" } } }, - "VirtualMachineScaleSet": { + "VirtualMachineScaleSetOSDisk": { "type": "object", - "description": "An AzureFleet's virtualMachineScaleSet", + "description": "Describes a virtual machine scale set operating system disk.", "properties": { "name": { "type": "string", - "description": "The name of the virtualMachineScaleSet", - "readOnly": true + "description": "The disk name." }, - "id": { - "type": "string", - "description": "The compute RP resource id of the virtualMachineScaleSet \n\"subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}\"", - "readOnly": true + "caching": { + "$ref": "#/definitions/CachingTypes", + "description": "Specifies the caching requirements. Possible values are: **None,**\n**ReadOnly,** **ReadWrite.** The default values are: **None for Standard\nstorage. ReadOnly for Premium storage.**" }, - "type": { - "type": "string", - "description": "Type of the virtualMachineScaleSet", - "readOnly": true + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." }, - "operationStatus": { - "$ref": "#/definitions/ProvisioningState", - "description": "This represents the operationStatus of the VMSS in response to the last operation that was performed on it by Azure Fleet resource.", - "readOnly": true + "createOption": { + "$ref": "#/definitions/DiskCreateOptionTypes", + "description": "Specifies how the virtual machines in the scale set should be created. The only\nallowed value is: **FromImage.** This value is used when you are using an image\nto create the virtual machine. If you are using a platform image, you also use\nthe imageReference element described above. If you are using a marketplace\nimage, you also use the plan element previously described." }, - "error": { - "$ref": "../../../../../compute/resource-manager/Microsoft.Compute/common-types/v1/common.json#/definitions/ApiError", - "description": "Error Information when `operationStatus` is `Failed`", - "readOnly": true + "diffDiskSettings": { + "$ref": "#/definitions/DiffDiskSettings", + "description": "Specifies the ephemeral disk Settings for the operating system disk used by the\nvirtual machine scale set." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used\nto overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB'\nis the number of bytes x 1024^3 for the disk and the value cannot\nbe larger than 1023." + }, + "osType": { + "$ref": "#/definitions/OperatingSystemTypes", + "description": "This property allows you to specify the type of the OS that is included in the\ndisk if creating a VM from user-image or a specialized VHD. Possible values\nare: **Windows,** **Linux.**" + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "Specifies information about the unmanaged user image to base the scale set on." + }, + "vhdContainers": { + "type": "array", + "description": "Specifies the container urls that are used to store operating system disks for\nthe scale set.", + "items": { + "type": "string" + } + }, + "managedDisk": { + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters", + "description": "The managed disk parameters." + }, + "deleteOption": { + "$ref": "#/definitions/DiskDeleteOptionTypes", + "description": "Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion\n(This feature is available for VMSS with Flexible OrchestrationMode only).\n

Possible values:

**Delete** If this value is used, the OS\ndisk is deleted when VMSS Flex VM is deleted.

**Detach** If this value\nis used, the OS disk is retained after VMSS Flex VM is deleted.

The\ndefault value is set to **Delete**. For an Ephemeral OS Disk, the default value\nis set to **Delete**. User cannot change the delete option for Ephemeral OS\nDisk." } }, "required": [ - "name", - "id", - "operationStatus" + "createOption" ] }, - "VirtualMachineScaleSetListResult": { + "VirtualMachineScaleSetOSProfile": { "type": "object", - "description": "The response of a VirtualMachineScaleSet list operation.", + "description": "Describes a virtual machine scale set OS profile.", "properties": { - "value": { + "computerNamePrefix": { + "type": "string", + "description": "Specifies the computer name prefix for all of the virtual machines in the scale\nset. Computer name prefixes must be 1 to 15 characters long." + }, + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

**Windows-only\nrestriction:** Cannot end in \".\"

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

**Minimum-length (Linux):** 1 character

**Max-length\n(Linux):** 64 characters

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

**Minimum-length\n(Windows):** 8 characters

**Minimum-length (Linux):** 6 characters\n

**Max-length (Windows):** 123 characters

**Max-length\n(Linux):** 72 characters

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

**Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\",\n\"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\",\n\"Password22\", \"iloveyou!\"

For resetting the password, see [How to\nreset the Remote Desktop service or its login password in a Windows\nVM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)\n

For resetting root password, see [Manage users, SSH, and check or\nrepair disks on Azure Linux VMs using the VMAccess\nExtension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection)", + "x-ms-mutability": [ + "update", + "create" + ], + "x-ms-secret": true + }, + "customData": { + "type": "string", + "format": "password", + "description": "Specifies a base-64 encoded string of custom data. The base-64 encoded string\nis decoded to a binary array that is saved as a file on the Virtual Machine.\nThe maximum length of the binary array is 65535 bytes. For using cloud-init for\nyour VM, see [Using cloud-init to customize a Linux VM during\ncreation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init)", + "x-ms-mutability": [ + "update", + "create" + ], + "x-ms-secret": true + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "linuxConfiguration": { + "$ref": "#/definitions/LinuxConfiguration", + "description": "Specifies the Linux operating system settings on the virtual machine. For a\nlist of supported Linux distributions, see [Linux on Azure-Endorsed\nDistributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros)." + }, + "secrets": { "type": "array", - "description": "The VirtualMachineScaleSet items on this page", + "description": "Specifies set of certificates that should be installed onto the virtual\nmachines in the scale set. To install certificates on a virtual machine it is\nrecommended to use the [Azure Key Vault virtual machine extension for\nLinux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux)\nor the [Azure Key Vault virtual machine extension for\nWindows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows).", "items": { - "$ref": "#/definitions/VirtualMachineScaleSet" - } + "$ref": "#/definitions/VaultSecretGroup" + }, + "x-ms-identifiers": [ + "sourceVault/id" + ] }, - "nextLink": { + "allowExtensionOperations": { + "type": "boolean", + "description": "Specifies whether extension operations should be allowed on the virtual machine\nscale set. This may only be set to False when no extensions are present on the\nvirtual machine scale set." + }, + "requireGuestProvisionSignal": { + "type": "boolean", + "description": "Optional property which must either be set to True or omitted." + } + } + }, + "VirtualMachineScaleSetPublicIPAddressConfiguration": { + "type": "object", + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress\nconfiguration", + "properties": { + "name": { "type": "string", - "format": "uri", - "description": "The link to the next page of items" + "description": "The publicIP address configuration name." + }, + "properties": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationProperties", + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress\nconfiguration" + }, + "sku": { + "$ref": "#/definitions/PublicIPAddressSku", + "description": "Describes the public IP Sku. It can only be set with OrchestrationMode as\nFlexible." } }, "required": [ - "value" + "name" + ] + }, + "VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings": { + "type": "object", + "description": "Describes a virtual machines scale sets network configuration's DNS settings.", + "properties": { + "domainNameLabel": { + "type": "string", + "description": "The Domain name label.The concatenation of the domain name label and vm index\nwill be the domain name labels of the PublicIPAddress resources that will be\ncreated" + }, + "domainNameLabelScope": { + "$ref": "#/definitions/DomainNameLabelScopeTypes", + "description": "The Domain name label scope.The concatenation of the hashed domain name label\nthat generated according to the policy from domain name label scope and vm\nindex will be the domain name labels of the PublicIPAddress resources that will\nbe created" + } + }, + "required": [ + "domainNameLabel" ] }, + "VirtualMachineScaleSetPublicIPAddressConfigurationProperties": { + "type": "object", + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress\nconfiguration", + "properties": { + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The idle timeout of the public IP address." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings", + "description": "The dns settings to be applied on the publicIP addresses ." + }, + "ipTags": { + "type": "array", + "description": "The list of IP tags associated with the public IP address.", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIpTag" + }, + "x-ms-identifiers": [] + }, + "publicIPPrefix": { + "$ref": "#/definitions/SubResource", + "description": "The PublicIPPrefix from which to allocate publicIP addresses." + }, + "publicIPAddressVersion": { + "$ref": "#/definitions/IPVersion", + "description": "Available from Api-Version 2019-07-01 onwards, it represents whether the\nspecific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible\nvalues are: 'IPv4' and 'IPv6'." + }, + "deleteOption": { + "$ref": "#/definitions/DeleteOptions", + "description": "Specify what happens to the public IP when the VM is deleted" + } + } + }, + "VirtualMachineScaleSetStorageProfile": { + "type": "object", + "description": "Describes a virtual machine scale set storage profile.", + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "Specifies information about the image to use. You can specify information about\nplatform images, marketplace images, or virtual machine images. This element is\nrequired when you want to use a platform image, marketplace image, or virtual\nmachine image, but is not used in other creation operations." + }, + "osDisk": { + "$ref": "#/definitions/VirtualMachineScaleSetOSDisk", + "description": "Specifies information about the operating system disk used by the virtual\nmachines in the scale set. For more information about disks, see [About disks\nand VHDs for Azure virtual\nmachines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)." + }, + "dataDisks": { + "type": "array", + "description": "Specifies the parameters that are used to add data disks to the virtual\nmachines in the scale set. For more information about disks, see [About disks\nand VHDs for Azure virtual\nmachines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview).", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" + }, + "x-ms-identifiers": [ + "name", + "lun" + ] + }, + "diskControllerType": { + "$ref": "#/definitions/DiskControllerTypes", + "description": "Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01" + } + } + }, "VmSizeProfile": { "type": "object", "description": "Specifications about a VM Size. This will also contain the corresponding rank and weight in future.", @@ -1008,6 +2971,176 @@ "required": [ "name" ] + }, + "WinRMConfiguration": { + "type": "object", + "description": "Describes Windows Remote Management configuration of the VM", + "properties": { + "listeners": { + "type": "array", + "description": "The list of Windows Remote Management listeners", + "items": { + "$ref": "#/definitions/WinRMListener" + }, + "x-ms-identifiers": [] + } + } + }, + "WinRMListener": { + "type": "object", + "description": "Describes Protocol and thumbprint of Windows Remote Management listener", + "properties": { + "protocol": { + "$ref": "#/definitions/ProtocolTypes", + "description": "Specifies the protocol of WinRM listener. Possible values are: **http,**\n**https.**" + }, + "certificateUrl": { + "type": "string", + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a\nsecret. For adding a secret to the Key Vault, see [Add a key or secret to the\nkey\nvault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add).\nIn this case, your certificate needs to be the Base64 encoding of the following\nJSON Object which is encoded in UTF-8:

{
\n\"data\":\"\",
\"dataType\":\"pfx\",
\n\"password\":\"\"
}
To install certificates on a virtual\nmachine it is recommended to use the [Azure Key Vault virtual machine extension\nfor\nLinux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux)\nor the [Azure Key Vault virtual machine extension for\nWindows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)." + } + } + }, + "WindowsConfiguration": { + "type": "object", + "description": "Specifies Windows operating system settings on the virtual machine.", + "properties": { + "provisionVMAgent": { + "type": "boolean", + "description": "Indicates whether virtual machine agent should be provisioned on the virtual\nmachine. When this property is not specified in the request body, it is set to\ntrue by default. This will ensure that VM Agent is installed on the VM so that\nextensions can be added to the VM later." + }, + "enableAutomaticUpdates": { + "type": "boolean", + "description": "Indicates whether Automatic Updates is enabled for the Windows virtual machine.\nDefault value is true. For virtual machine scale sets, this property can be\nupdated and updates will take effect on OS reprovisioning." + }, + "timeZone": { + "type": "string", + "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\".\nPossible values can be\n[TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id)\nvalue from time zones returned by\n[TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones)." + }, + "additionalUnattendContent": { + "type": "array", + "description": "Specifies additional base-64 encoded XML formatted information that can be\nincluded in the Unattend.xml file, which is used by Windows Setup.", + "items": { + "$ref": "#/definitions/AdditionalUnattendContent" + }, + "x-ms-identifiers": [] + }, + "patchSettings": { + "$ref": "#/definitions/PatchSettings", + "description": "[Preview Feature] Specifies settings related to VM Guest Patching on Windows." + }, + "winRM": { + "$ref": "#/definitions/WinRMConfiguration", + "description": "Specifies the Windows Remote Management listeners. This enables remote Windows\nPowerShell." + }, + "enableVMAgentPlatformUpdates": { + "type": "boolean", + "description": "Indicates whether VMAgent Platform Updates is enabled for the Windows virtual\nmachine. Default value is false." + } + } + }, + "WindowsPatchAssessmentMode": { + "type": "string", + "description": "Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.", + "enum": [ + "ImageDefault", + "AutomaticByPlatform" + ], + "x-ms-enum": { + "name": "WindowsPatchAssessmentMode", + "modelAsString": true, + "values": [ + { + "name": "ImageDefault", + "value": "ImageDefault", + "description": "You control the timing of patch assessments on a virtual machine." + }, + { + "name": "AutomaticByPlatform", + "value": "AutomaticByPlatform", + "description": "The platform will trigger periodic patch assessments. The property provisionVMAgent must be true." + } + ] + } + }, + "WindowsVMGuestPatchAutomaticByPlatformRebootSetting": { + "type": "string", + "description": "Specifies the reboot setting for all AutomaticByPlatform patch installation operations.", + "enum": [ + "Unknown", + "IfRequired", + "Never", + "Always" + ], + "x-ms-enum": { + "name": "WindowsVMGuestPatchAutomaticByPlatformRebootSetting", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Reboot setting" + }, + { + "name": "IfRequired", + "value": "IfRequired", + "description": "IfRequired Reboot setting" + }, + { + "name": "Never", + "value": "Never", + "description": "Never Reboot setting" + }, + { + "name": "Always", + "value": "Always", + "description": "Always Reboot setting" + } + ] + } + }, + "WindowsVMGuestPatchAutomaticByPlatformSettings": { + "type": "object", + "description": "Specifies additional settings to be applied when patch mode AutomaticByPlatform\nis selected in Windows patch settings.", + "properties": { + "rebootSetting": { + "$ref": "#/definitions/WindowsVMGuestPatchAutomaticByPlatformRebootSetting", + "description": "Specifies the reboot setting for all AutomaticByPlatform patch installation\noperations." + }, + "bypassPlatformSafetyChecksOnUserSchedule": { + "type": "boolean", + "description": "Enables customer to schedule patching without accidental upgrades" + } + } + }, + "WindowsVMGuestPatchMode": { + "type": "string", + "description": "Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual\nmachines associated to virtual machine scale set with OrchestrationMode as\nFlexible.", + "enum": [ + "Manual", + "AutomaticByOS", + "AutomaticByPlatform" + ], + "x-ms-enum": { + "name": "WindowsVMGuestPatchMode", + "modelAsString": true, + "values": [ + { + "name": "Manual", + "value": "Manual", + "description": "You control the application of patches to a virtual machine.\nYou do this by applying patches manually inside the VM. In this mode,\nautomatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates\nmust be false" + }, + { + "name": "AutomaticByOS", + "value": "AutomaticByOS", + "description": "The virtual machine will automatically be updated by the OS.\nThe property WindowsConfiguration.enableAutomaticUpdates must be true." + }, + { + "name": "AutomaticByPlatform", + "value": "AutomaticByPlatform", + "description": "The virtual machine will automatically updated by the platform. The properties\nprovisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true." + } + ] + } } }, "parameters": {} diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_CreateOrUpdate.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_CreateOrUpdate.json index f90d8d57e529..0aee59f3b1e0 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_CreateOrUpdate.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_CreateOrUpdate.json @@ -89,7 +89,7 @@ "secrets": [ { "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -110,7 +110,7 @@ "version": "wvpcqefgtmqdgltiuz", "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", "communityGalleryImageId": "vlqe", - "id": "aiunknwgksu" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" }, "osDisk": { "name": "wfttw", @@ -132,12 +132,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -154,12 +154,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -172,7 +172,7 @@ }, "networkProfile": { "healthProbe": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -183,7 +183,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -195,7 +195,7 @@ "name": "oezqhkidfhyywlfzwuotilrpbqnjg", "properties": { "subnet": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -213,7 +213,7 @@ } ], "publicIPPrefix": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -226,22 +226,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -264,7 +264,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "qoersmt" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -298,7 +298,7 @@ "protectedSettingsFromKeyVault": { "secretUrl": "vyhzfkqsqanacgzjthpjoe", "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } } } @@ -320,7 +320,7 @@ "userData": "s", "capacityReservation": { "capacityReservationGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -328,7 +328,7 @@ { "tags": "eyrqjbib", "order": 5, - "packageReferenceId": "lfxqiadouhmbovcd", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "configurationReference": "ulztmiavpojpbpbddgnuuiimxcpau", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true @@ -342,61 +342,14 @@ } }, "serviceArtifactReference": { - "id": "qlkeeyskyr" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { - "id": "mubredelfbshboaxrsxiajihahaa", + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "oriasdwawveilgusfrn", - "publisher": "rxoajzb", - "type": "vhrtgbaqdkbrrqxsdiiaqxksmqukl", - "typeHandlerVersion": "bvzbiibps", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "instanceView": { - "name": "ip", - "type": "woadxvobquacooaujyg", - "typeHandlerVersion": "ftkkqxdqiofgsusvxekdcpua", - "substatuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ], - "statuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "vyhzfkqsqanacgzjthpjoe", - "sourceVault": { - "id": "groxwd" - } - }, - "provisionAfterExtensions": [ - "lwsfavklrgzuwmyxscskt" - ] - }, - "location": "wrqxhbqaebwkzmcdmngyqmhogc", - "tags": { - "key7356": "apuftleiygpnemfzryiop" - } - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true } }, "computeApiVersion": "2023-07-01", @@ -416,7 +369,14 @@ "tags": { "key3518": "luvrnuvsgdpbuofdskkcoqhfh" }, - "location": "westus" + "location": "westus", + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + } } }, "responses": { @@ -502,7 +462,7 @@ "secrets": [ { "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -524,7 +484,7 @@ "exactVersion": "zjbntmiskjexlr", "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", "communityGalleryImageId": "vlqe", - "id": "aiunknwgksu" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" }, "osDisk": { "name": "wfttw", @@ -546,12 +506,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -568,12 +528,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -586,7 +546,7 @@ }, "networkProfile": { "healthProbe": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -597,7 +557,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -609,7 +569,7 @@ "name": "oezqhkidfhyywlfzwuotilrpbqnjg", "properties": { "subnet": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -627,7 +587,7 @@ } ], "publicIPPrefix": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -640,22 +600,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -678,7 +638,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "qoersmt" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -705,8 +665,7 @@ "autoUpgradeMinorVersion": true, "enableAutomaticUpgrade": true, "settings": {}, - "protectedSettings": {}, - "provisioningState": "jquzzuhvarugybjwdooovfrgqtpe", + "provisioningState": "Succeeded", "provisionAfterExtensions": [ "nftzosroolbcwmpupujzqwqe" ], @@ -714,11 +673,11 @@ "protectedSettingsFromKeyVault": { "secretUrl": "vyhzfkqsqanacgzjthpjoe", "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } } }, - "id": "fmheufuaqonfvirwrpd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" } ], "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" @@ -737,7 +696,7 @@ "userData": "s", "capacityReservation": { "capacityReservationGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -745,8 +704,7 @@ { "tags": "eyrqjbib", "order": 5, - "packageReferenceId": "lfxqiadouhmbovcd", - "configurationReference": "ulztmiavpojpbpbddgnuuiimxcpau", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true } @@ -759,71 +717,22 @@ } }, "serviceArtifactReference": { - "id": "qlkeeyskyr" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { - "id": "mubredelfbshboaxrsxiajihahaa", + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "oriasdwawveilgusfrn", - "publisher": "rxoajzb", - "type": "vhrtgbaqdkbrrqxsdiiaqxksmqukl", - "typeHandlerVersion": "bvzbiibps", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "provisioningState": "tzbaituagn", - "instanceView": { - "name": "ip", - "type": "woadxvobquacooaujyg", - "typeHandlerVersion": "ftkkqxdqiofgsusvxekdcpua", - "substatuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ], - "statuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "vyhzfkqsqanacgzjthpjoe", - "sourceVault": { - "id": "groxwd" - } - }, - "provisionAfterExtensions": [ - "lwsfavklrgzuwmyxscskt" - ] - }, - "location": "wrqxhbqaebwkzmcdmngyqmhogc", - "id": "ovmtxndtfwvcxnw", - "name": "zudiuxzkgqhxaam", - "type": "lpnynhnniohtotmkznxku", - "tags": { - "key7356": "apuftleiygpnemfzryiop" - } - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true }, "timeCreated": "2024-04-29T21:51:44.043Z" }, "computeApiVersion": "2023-07-01", "platformFaultDomainCount": 1 - } + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" }, "zones": [ "zone1", @@ -840,6 +749,13 @@ } } }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, "tags": { "key3518": "luvrnuvsgdpbuofdskkcoqhfh" }, @@ -942,7 +858,7 @@ "secrets": [ { "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -964,7 +880,7 @@ "exactVersion": "zjbntmiskjexlr", "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", "communityGalleryImageId": "vlqe", - "id": "aiunknwgksu" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" }, "osDisk": { "name": "wfttw", @@ -986,12 +902,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -1008,12 +924,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -1026,7 +942,7 @@ }, "networkProfile": { "healthProbe": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -1037,7 +953,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -1049,7 +965,7 @@ "name": "oezqhkidfhyywlfzwuotilrpbqnjg", "properties": { "subnet": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -1067,7 +983,7 @@ } ], "publicIPPrefix": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -1080,22 +996,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -1118,7 +1034,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "qoersmt" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -1145,8 +1061,7 @@ "autoUpgradeMinorVersion": true, "enableAutomaticUpgrade": true, "settings": {}, - "protectedSettings": {}, - "provisioningState": "jquzzuhvarugybjwdooovfrgqtpe", + "provisioningState": "Succeeded", "provisionAfterExtensions": [ "nftzosroolbcwmpupujzqwqe" ], @@ -1154,11 +1069,11 @@ "protectedSettingsFromKeyVault": { "secretUrl": "vyhzfkqsqanacgzjthpjoe", "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } } }, - "id": "fmheufuaqonfvirwrpd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" } ], "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" @@ -1177,7 +1092,7 @@ "userData": "s", "capacityReservation": { "capacityReservationGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -1185,8 +1100,7 @@ { "tags": "eyrqjbib", "order": 5, - "packageReferenceId": "lfxqiadouhmbovcd", - "configurationReference": "ulztmiavpojpbpbddgnuuiimxcpau", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true } @@ -1199,71 +1113,22 @@ } }, "serviceArtifactReference": { - "id": "qlkeeyskyr" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { - "id": "mubredelfbshboaxrsxiajihahaa", + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "oriasdwawveilgusfrn", - "publisher": "rxoajzb", - "type": "vhrtgbaqdkbrrqxsdiiaqxksmqukl", - "typeHandlerVersion": "bvzbiibps", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "provisioningState": "tzbaituagn", - "instanceView": { - "name": "ip", - "type": "woadxvobquacooaujyg", - "typeHandlerVersion": "ftkkqxdqiofgsusvxekdcpua", - "substatuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ], - "statuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "vyhzfkqsqanacgzjthpjoe", - "sourceVault": { - "id": "groxwd" - } - }, - "provisionAfterExtensions": [ - "lwsfavklrgzuwmyxscskt" - ] - }, - "location": "wrqxhbqaebwkzmcdmngyqmhogc", - "id": "ovmtxndtfwvcxnw", - "name": "zudiuxzkgqhxaam", - "type": "lpnynhnniohtotmkznxku", - "tags": { - "key7356": "apuftleiygpnemfzryiop" - } - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true }, "timeCreated": "2024-04-29T21:51:44.043Z" }, "computeApiVersion": "2023-07-01", "platformFaultDomainCount": 1 - } + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" }, "zones": [ "zone1", @@ -1283,6 +1148,13 @@ "tags": { "key3518": "luvrnuvsgdpbuofdskkcoqhfh" }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, "location": "westus", "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", "name": "testFleet", diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_CreateOrUpdate_MinimumSet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_CreateOrUpdate_MinimumSet.json new file mode 100644 index 000000000000..8d9bd1338335 --- /dev/null +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_CreateOrUpdate_MinimumSet.json @@ -0,0 +1,299 @@ +{ + "title": "Fleets_CreateOrUpdate_MinimumSet", + "operationId": "Fleets_CreateOrUpdate", + "parameters": { + "api-version": "2024-05-01-preview", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", + "resourceGroupName": "rgazurefleet", + "fleetName": "testFleet", + "resource": { + "properties": { + "spotPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_D2s_v3" + }, + { + "name": "Standard_D4s_v3" + }, + { + "name": "Standard_E2s_v3" + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "storageProfile": { + "imageReference": { + "publisher": "canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts-gen2", + "version": "latest" + }, + "osDisk": { + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + } + }, + "osProfile": { + "computerNamePrefix": "prefix", + "adminUsername": "azureuser", + "adminPassword": "TestPassword$0", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "primary": true, + "enableAcceleratedNetworking": false, + "ipConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true + } + } + ], + "networkApiVersion": "2022-07-01" + } + }, + "computeApiVersion": "2023-09-01", + "platformFaultDomainCount": 1 + } + }, + "tags": { + "key": "fleets-test" + }, + "location": "eastus2euap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Creating", + "spotPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_D2s_v3" + }, + { + "name": "Standard_D4s_v3" + }, + { + "name": "Standard_E2s_v3" + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "storageProfile": { + "imageReference": { + "publisher": "canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts-gen2", + "version": "latest" + }, + "osDisk": { + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + } + }, + "osProfile": { + "computerNamePrefix": "prefix", + "adminUsername": "azureuser", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "primary": true, + "enableAcceleratedNetworking": false, + "ipConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true + } + } + ], + "networkApiVersion": "2022-07-01" + } + }, + "computeApiVersion": "2023-09-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "tags": { + "key": "fleets-test" + }, + "location": "eastus2euap", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Creating", + "spotPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_D2s_v3" + }, + { + "name": "Standard_D4s_v3" + }, + { + "name": "Standard_E2s_v3" + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "storageProfile": { + "imageReference": { + "publisher": "canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts-gen2", + "version": "latest" + }, + "osDisk": { + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + } + }, + "osProfile": { + "computerNamePrefix": "prefix", + "adminUsername": "azureuser", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "primary": true, + "enableAcceleratedNetworking": false, + "ipConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true + } + } + ], + "networkApiVersion": "2022-07-01" + } + }, + "computeApiVersion": "2023-09-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "tags": { + "key": "fleets-test" + }, + "location": "eastus2euap", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets" + } + } + } +} diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_Get.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_Get.json index 94a05d95228b..aad43edb4459 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_Get.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_Get.json @@ -36,7 +36,6 @@ "osProfile": { "computerNamePrefix": "o", "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", - "customData": "xjjib", "windowsConfiguration": { "provisionVMAgent": true, "enableAutomaticUpdates": true, @@ -45,8 +44,7 @@ { "passName": "OobeSystem", "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "AutoLogon", - "content": "bubmqbxjkj" + "settingName": "AutoLogon" } ], "patchSettings": { @@ -92,7 +90,7 @@ "secrets": [ { "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -114,7 +112,7 @@ "exactVersion": "zjbntmiskjexlr", "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", "communityGalleryImageId": "vlqe", - "id": "aiunknwgksu" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" }, "osDisk": { "name": "wfttw", @@ -136,12 +134,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -158,12 +156,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -176,7 +174,7 @@ }, "networkProfile": { "healthProbe": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -187,7 +185,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -199,7 +197,7 @@ "name": "oezqhkidfhyywlfzwuotilrpbqnjg", "properties": { "subnet": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -217,7 +215,7 @@ } ], "publicIPPrefix": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -230,22 +228,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -268,7 +266,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "qoersmt" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -295,8 +293,7 @@ "autoUpgradeMinorVersion": true, "enableAutomaticUpgrade": true, "settings": {}, - "protectedSettings": {}, - "provisioningState": "jquzzuhvarugybjwdooovfrgqtpe", + "provisioningState": "Succeeded", "provisionAfterExtensions": [ "nftzosroolbcwmpupujzqwqe" ], @@ -304,21 +301,16 @@ "protectedSettingsFromKeyVault": { "secretUrl": "vyhzfkqsqanacgzjthpjoe", "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } } }, - "id": "fmheufuaqonfvirwrpd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" } ], "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" }, "licenseType": "v", - "priority": "Regular", - "evictionPolicy": "Deallocate", - "billingProfile": { - "maxPrice": 2 - }, "scheduledEventsProfile": { "terminateNotificationProfile": { "notBeforeTimeout": "iljppmmw", @@ -332,7 +324,7 @@ "userData": "s", "capacityReservation": { "capacityReservationGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -340,8 +332,7 @@ { "tags": "eyrqjbib", "order": 5, - "packageReferenceId": "lfxqiadouhmbovcd", - "configurationReference": "ulztmiavpojpbpbddgnuuiimxcpau", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true } @@ -354,71 +345,22 @@ } }, "serviceArtifactReference": { - "id": "qlkeeyskyr" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { "id": "mubredelfbshboaxrsxiajihahaa", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "oriasdwawveilgusfrn", - "publisher": "rxoajzb", - "type": "vhrtgbaqdkbrrqxsdiiaqxksmqukl", - "typeHandlerVersion": "bvzbiibps", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "provisioningState": "tzbaituagn", - "instanceView": { - "name": "ip", - "type": "woadxvobquacooaujyg", - "typeHandlerVersion": "ftkkqxdqiofgsusvxekdcpua", - "substatuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ], - "statuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "vyhzfkqsqanacgzjthpjoe", - "sourceVault": { - "id": "groxwd" - } - }, - "provisionAfterExtensions": [ - "lwsfavklrgzuwmyxscskt" - ] - }, - "location": "wrqxhbqaebwkzmcdmngyqmhogc", - "id": "ovmtxndtfwvcxnw", - "name": "zudiuxzkgqhxaam", - "type": "lpnynhnniohtotmkznxku", - "tags": { - "key7356": "apuftleiygpnemfzryiop" - } - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true }, "timeCreated": "2024-04-29T21:51:44.043Z" }, "computeApiVersion": "2023-07-01", "platformFaultDomainCount": 1 - } + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" }, "zones": [ "zone1", @@ -438,6 +380,13 @@ "tags": { "key3518": "luvrnuvsgdpbuofdskkcoqhfh" }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, "location": "westus", "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", "name": "testFleet", diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_ListByResourceGroup.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_ListByResourceGroup.json index ad7bc37f6910..e94357690c84 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_ListByResourceGroup.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_ListByResourceGroup.json @@ -37,7 +37,6 @@ "osProfile": { "computerNamePrefix": "o", "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", - "customData": "xjjib", "windowsConfiguration": { "provisionVMAgent": true, "enableAutomaticUpdates": true, @@ -46,8 +45,7 @@ { "passName": "OobeSystem", "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "AutoLogon", - "content": "bubmqbxjkj" + "settingName": "AutoLogon" } ], "patchSettings": { @@ -93,7 +91,7 @@ "secrets": [ { "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -115,7 +113,7 @@ "exactVersion": "zjbntmiskjexlr", "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", "communityGalleryImageId": "vlqe", - "id": "aiunknwgksu" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" }, "osDisk": { "name": "wfttw", @@ -137,12 +135,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -159,12 +157,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -177,7 +175,7 @@ }, "networkProfile": { "healthProbe": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -188,7 +186,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -200,7 +198,7 @@ "name": "oezqhkidfhyywlfzwuotilrpbqnjg", "properties": { "subnet": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -218,7 +216,7 @@ } ], "publicIPPrefix": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -231,22 +229,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -269,7 +267,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "qoersmt" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -296,8 +294,7 @@ "autoUpgradeMinorVersion": true, "enableAutomaticUpgrade": true, "settings": {}, - "protectedSettings": {}, - "provisioningState": "jquzzuhvarugybjwdooovfrgqtpe", + "provisioningState": "Succeeded", "provisionAfterExtensions": [ "nftzosroolbcwmpupujzqwqe" ], @@ -305,11 +302,11 @@ "protectedSettingsFromKeyVault": { "secretUrl": "vyhzfkqsqanacgzjthpjoe", "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } } }, - "id": "fmheufuaqonfvirwrpd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" } ], "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" @@ -328,7 +325,7 @@ "userData": "s", "capacityReservation": { "capacityReservationGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -336,8 +333,7 @@ { "tags": "eyrqjbib", "order": 5, - "packageReferenceId": "lfxqiadouhmbovcd", - "configurationReference": "ulztmiavpojpbpbddgnuuiimxcpau", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true } @@ -350,71 +346,22 @@ } }, "serviceArtifactReference": { - "id": "qlkeeyskyr" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { "id": "mubredelfbshboaxrsxiajihahaa", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "oriasdwawveilgusfrn", - "publisher": "rxoajzb", - "type": "vhrtgbaqdkbrrqxsdiiaqxksmqukl", - "typeHandlerVersion": "bvzbiibps", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "provisioningState": "tzbaituagn", - "instanceView": { - "name": "ip", - "type": "woadxvobquacooaujyg", - "typeHandlerVersion": "ftkkqxdqiofgsusvxekdcpua", - "substatuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ], - "statuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "vyhzfkqsqanacgzjthpjoe", - "sourceVault": { - "id": "groxwd" - } - }, - "provisionAfterExtensions": [ - "lwsfavklrgzuwmyxscskt" - ] - }, - "location": "wrqxhbqaebwkzmcdmngyqmhogc", - "id": "ovmtxndtfwvcxnw", - "name": "zudiuxzkgqhxaam", - "type": "lpnynhnniohtotmkznxku", - "tags": { - "key7356": "apuftleiygpnemfzryiop" - } - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true }, "timeCreated": "2024-04-29T21:51:44.043Z" }, "computeApiVersion": "2023-07-01", "platformFaultDomainCount": 1 - } + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" }, "zones": [ "zone1", @@ -431,6 +378,13 @@ } } }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, "tags": { "key3518": "luvrnuvsgdpbuofdskkcoqhfh" }, diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_ListBySubscription.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_ListBySubscription.json index 0c9de85a88ba..a708351de4b3 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_ListBySubscription.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_ListBySubscription.json @@ -36,7 +36,6 @@ "osProfile": { "computerNamePrefix": "o", "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", - "customData": "xjjib", "windowsConfiguration": { "provisionVMAgent": true, "enableAutomaticUpdates": true, @@ -45,8 +44,7 @@ { "passName": "OobeSystem", "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "AutoLogon", - "content": "bubmqbxjkj" + "settingName": "AutoLogon" } ], "patchSettings": { @@ -92,7 +90,7 @@ "secrets": [ { "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -114,7 +112,7 @@ "exactVersion": "zjbntmiskjexlr", "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", "communityGalleryImageId": "vlqe", - "id": "aiunknwgksu" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" }, "osDisk": { "name": "wfttw", @@ -136,12 +134,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -158,12 +156,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -176,7 +174,7 @@ }, "networkProfile": { "healthProbe": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -187,7 +185,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -199,7 +197,7 @@ "name": "oezqhkidfhyywlfzwuotilrpbqnjg", "properties": { "subnet": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -217,7 +215,7 @@ } ], "publicIPPrefix": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -230,22 +228,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -268,7 +266,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "qoersmt" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -295,8 +293,7 @@ "autoUpgradeMinorVersion": true, "enableAutomaticUpgrade": true, "settings": {}, - "protectedSettings": {}, - "provisioningState": "jquzzuhvarugybjwdooovfrgqtpe", + "provisioningState": "Succeeded", "provisionAfterExtensions": [ "nftzosroolbcwmpupujzqwqe" ], @@ -304,11 +301,11 @@ "protectedSettingsFromKeyVault": { "secretUrl": "vyhzfkqsqanacgzjthpjoe", "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } } }, - "id": "fmheufuaqonfvirwrpd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" } ], "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" @@ -327,7 +324,7 @@ "userData": "s", "capacityReservation": { "capacityReservationGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -335,8 +332,7 @@ { "tags": "eyrqjbib", "order": 5, - "packageReferenceId": "lfxqiadouhmbovcd", - "configurationReference": "ulztmiavpojpbpbddgnuuiimxcpau", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true } @@ -349,71 +345,22 @@ } }, "serviceArtifactReference": { - "id": "qlkeeyskyr" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { "id": "mubredelfbshboaxrsxiajihahaa", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "oriasdwawveilgusfrn", - "publisher": "rxoajzb", - "type": "vhrtgbaqdkbrrqxsdiiaqxksmqukl", - "typeHandlerVersion": "bvzbiibps", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "provisioningState": "tzbaituagn", - "instanceView": { - "name": "ip", - "type": "woadxvobquacooaujyg", - "typeHandlerVersion": "ftkkqxdqiofgsusvxekdcpua", - "substatuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ], - "statuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "vyhzfkqsqanacgzjthpjoe", - "sourceVault": { - "id": "groxwd" - } - }, - "provisionAfterExtensions": [ - "lwsfavklrgzuwmyxscskt" - ] - }, - "location": "wrqxhbqaebwkzmcdmngyqmhogc", - "id": "ovmtxndtfwvcxnw", - "name": "zudiuxzkgqhxaam", - "type": "lpnynhnniohtotmkznxku", - "tags": { - "key7356": "apuftleiygpnemfzryiop" - } - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true }, "timeCreated": "2024-04-29T21:51:44.043Z" }, "computeApiVersion": "2023-07-01", "platformFaultDomainCount": 1 - } + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" }, "zones": [ "zone1", @@ -430,6 +377,13 @@ } } }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, "tags": { "key3518": "luvrnuvsgdpbuofdskkcoqhfh" }, diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_ListVirtualMachineScaleSets.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_ListVirtualMachineScaleSets.json index 628c68be9aed..90fbbfd5c47f 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_ListVirtualMachineScaleSets.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_ListVirtualMachineScaleSets.json @@ -25,8 +25,8 @@ } ], "innererror": { - "exceptiontype": "sfaomfpoaptnbxchrfskm", - "errordetail": "ihjwbwykq" + "exceptionType": "sfaomfpoaptnbxchrfskm", + "errorDetail": "ihjwbwykq" }, "code": "OverconstrainedAllocationRequest", "target": "nhaj", diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_Update.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_Update.json index 621ccf96f741..c987029fbeb5 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_Update.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_Update.json @@ -94,7 +94,7 @@ "secrets": [ { "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -115,7 +115,7 @@ "version": "wvpcqefgtmqdgltiuz", "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", "communityGalleryImageId": "vlqe", - "id": "aiunknwgksu" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" }, "osDisk": { "name": "wfttw", @@ -137,12 +137,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -159,12 +159,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -177,7 +177,7 @@ }, "networkProfile": { "healthProbe": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -188,7 +188,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -200,7 +200,7 @@ "name": "oezqhkidfhyywlfzwuotilrpbqnjg", "properties": { "subnet": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -218,7 +218,7 @@ } ], "publicIPPrefix": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -231,22 +231,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -269,7 +269,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "qoersmt" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -303,7 +303,7 @@ "protectedSettingsFromKeyVault": { "secretUrl": "vyhzfkqsqanacgzjthpjoe", "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } } } @@ -325,7 +325,7 @@ "userData": "s", "capacityReservation": { "capacityReservationGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -333,7 +333,7 @@ { "tags": "eyrqjbib", "order": 5, - "packageReferenceId": "lfxqiadouhmbovcd", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "configurationReference": "ulztmiavpojpbpbddgnuuiimxcpau", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true @@ -347,59 +347,14 @@ } }, "serviceArtifactReference": { - "id": "qlkeeyskyr" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { - "id": "mubredelfbshboaxrsxiajihahaa", + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "oriasdwawveilgusfrn", - "publisher": "rxoajzb", - "type": "vhrtgbaqdkbrrqxsdiiaqxksmqukl", - "typeHandlerVersion": "bvzbiibps", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "instanceView": { - "name": "ip", - "type": "woadxvobquacooaujyg", - "typeHandlerVersion": "ftkkqxdqiofgsusvxekdcpua", - "substatuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ], - "statuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "vyhzfkqsqanacgzjthpjoe", - "sourceVault": { - "id": "groxwd" - } - }, - "provisionAfterExtensions": [ - "lwsfavklrgzuwmyxscskt" - ] - }, - "location": "wrqxhbqaebwkzmcdmngyqmhogc", - "tags": {} - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true } }, "computeApiVersion": "2023-07-01", @@ -497,7 +452,7 @@ "secrets": [ { "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "vaultCertificates": [ { @@ -518,7 +473,7 @@ "version": "wvpcqefgtmqdgltiuz", "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", "communityGalleryImageId": "vlqe", - "id": "aiunknwgksu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}", "exactVersion": "zjbntmiskjexlr" }, "osDisk": { @@ -541,12 +496,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -563,12 +518,12 @@ "managedDisk": { "storageAccountType": "Standard_LRS", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" }, "securityProfile": { "securityEncryptionType": "VMGuestStateOnly", "diskEncryptionSet": { - "id": "vmatqblzjalbatdepyzqmnd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" } } }, @@ -581,7 +536,7 @@ }, "networkProfile": { "healthProbe": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" }, "networkInterfaceConfigurations": [ { @@ -592,7 +547,7 @@ "disableTcpStateTracking": true, "enableFpga": true, "networkSecurityGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" }, "dnsSettings": { "dnsServers": [ @@ -604,7 +559,7 @@ "name": "oezqhkidfhyywlfzwuotilrpbqnjg", "properties": { "subnet": { - "id": "cmkfcjhmrwxwqtac" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" }, "primary": true, "publicIPAddressConfiguration": { @@ -622,7 +577,7 @@ } ], "publicIPPrefix": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" }, "publicIPAddressVersion": "IPv4", "deleteOption": "Delete" @@ -635,22 +590,22 @@ "privateIPAddressVersion": "IPv4", "applicationGatewayBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" } ], "applicationSecurityGroups": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" } ], "loadBalancerBackendAddressPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" } ], "loadBalancerInboundNatPools": [ { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" } ] } @@ -673,7 +628,7 @@ "encryptionAtHost": true, "securityType": "TrustedLaunch", "encryptionIdentity": { - "userAssignedIdentityResourceId": "qoersmt" + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" }, "proxyAgentSettings": { "enabled": true, @@ -698,8 +653,6 @@ "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", "autoUpgradeMinorVersion": true, "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, "provisionAfterExtensions": [ "nftzosroolbcwmpupujzqwqe" ], @@ -707,13 +660,14 @@ "protectedSettingsFromKeyVault": { "secretUrl": "vyhzfkqsqanacgzjthpjoe", "sourceVault": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } }, - "provisioningState": "jquzzuhvarugybjwdooovfrgqtpe" + "settings": {}, + "provisioningState": "Succeeded" }, "type": "cmeam", - "id": "fmheufuaqonfvirwrpd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" } ], "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" @@ -732,7 +686,7 @@ "userData": "s", "capacityReservation": { "capacityReservationGroup": { - "id": "groxwd" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" } }, "applicationProfile": { @@ -740,8 +694,7 @@ { "tags": "eyrqjbib", "order": 5, - "packageReferenceId": "lfxqiadouhmbovcd", - "configurationReference": "ulztmiavpojpbpbddgnuuiimxcpau", + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", "treatFailureAsDeploymentFailure": true, "enableAutomaticUpgrade": true } @@ -754,70 +707,23 @@ } }, "serviceArtifactReference": { - "id": "qlkeeyskyr" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" }, "securityPostureReference": { - "id": "mubredelfbshboaxrsxiajihahaa", + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", "excludeExtensions": [ - { - "properties": { - "forceUpdateTag": "oriasdwawveilgusfrn", - "publisher": "rxoajzb", - "type": "vhrtgbaqdkbrrqxsdiiaqxksmqukl", - "typeHandlerVersion": "bvzbiibps", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": {}, - "protectedSettings": {}, - "instanceView": { - "name": "ip", - "type": "woadxvobquacooaujyg", - "typeHandlerVersion": "ftkkqxdqiofgsusvxekdcpua", - "substatuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ], - "statuses": [ - { - "code": "kuehuahsdozupmjrtp", - "level": "Info", - "displayStatus": "pomenhgqjoelbxvsqwxxexqxv", - "message": "jxjjmlwbjylzvrislyyflhnmizhiu", - "time": "2024-04-29T21:51:44.042Z" - } - ] - }, - "suppressFailures": true, - "protectedSettingsFromKeyVault": { - "secretUrl": "vyhzfkqsqanacgzjthpjoe", - "sourceVault": { - "id": "groxwd" - } - }, - "provisionAfterExtensions": [ - "lwsfavklrgzuwmyxscskt" - ], - "provisioningState": "tzbaituagn" - }, - "location": "wrqxhbqaebwkzmcdmngyqmhogc", - "tags": {}, - "id": "ovmtxndtfwvcxnw", - "name": "zudiuxzkgqhxaam", - "type": "lpnynhnniohtotmkznxku" - } - ] + "{securityPostureVMExtensionName}" + ], + "isOverridable": true }, "timeCreated": "2024-04-29T21:51:44.043Z" }, "computeApiVersion": "2023-07-01", "platformFaultDomainCount": 1 }, - "provisioningState": "Creating" + "provisioningState": "Creating", + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" }, "zones": [ "zone1", diff --git a/specification/azurefleet/resource-manager/readme.md b/specification/azurefleet/resource-manager/readme.md index d3f91ed2ee8c..d6726ce99f11 100644 --- a/specification/azurefleet/resource-manager/readme.md +++ b/specification/azurefleet/resource-manager/readme.md @@ -31,6 +31,21 @@ suppressions: - code: PatchBodyParametersSchema from: azurefleet.json reason: Suppress Patch rule as properties are defined by Compute RP and cannot be changed in AzureFleet. + - code: AvoidAdditionalProperties + from: azurefleet.json + where: + - $.definitions.VirtualMachineExtensionProperties.properties.protectedSettings + - $.definitions.VirtualMachineExtensionProperties.properties.settings + - $.definitions.VirtualMachineScaleSetExtensionProperties.properties.protectedSettings + - $.definitions.VirtualMachineScaleSetExtensionProperties.properties.settings + reason: Property "settings" and "protectedSettings" for VirtualMachineExtension + and VirtualMachineScaleSetExtensionProperties were previously defined like an empty object. + - code: DefinitionsPropertiesNamesCamelCase + from: azurefleet.json + where: + - $.definitions.VirtualMachineScaleSetDataDisk.properties.diskIOPSReadWrite + reason: Property "diskIOPSReadWrite" does not follow Camel Case and can't be changed as it is being + defined previously in Microsoft.Compute like this. ``` ### Tag: package-preview-2023-11 @@ -71,6 +86,7 @@ swagger-to-sdk: - repo: azure-cli-extensions - repo: azure-powershell ``` + ## Az See configuration in [readme.az.md](./readme.az.md) diff --git a/specification/azurelargeinstance/AzureLargeInstance.Management/tspconfig.yaml b/specification/azurelargeinstance/AzureLargeInstance.Management/tspconfig.yaml index 1b841cd17569..58c0ad2a9ede 100644 --- a/specification/azurelargeinstance/AzureLargeInstance.Management/tspconfig.yaml +++ b/specification/azurelargeinstance/AzureLargeInstance.Management/tspconfig.yaml @@ -7,6 +7,9 @@ options: "@azure-tools/typespec-autorest": emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/azurelargeinstance.json" examples-directory: "{project-root}/examples" use-read-only-status-schema: true diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/GalleryImages.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/GalleryImages.tsp index 4948e6367a32..d8b9c89f6cbb 100644 --- a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/GalleryImages.tsp +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/GalleryImages.tsp @@ -49,7 +49,7 @@ interface GalleryImages { delete is ArmResourceDeleteWithoutOkAsync; @doc("Lists all of the gallery images in the specified resource group. Use the nextLink property in the response to get the next page of gallery images.") - list is ArmResourceListByParent; + listByResourceGroup is ArmResourceListByParent; @doc("Lists all of the gallery images in the specified subscription. Use the nextLink property in the response to get the next page of gallery images.") listAll is ArmListBySubscription; diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/GuestAgent.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/GuestAgent.tsp index e7c453668417..7d09e4b71034 100644 --- a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/GuestAgent.tsp +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/GuestAgent.tsp @@ -42,5 +42,5 @@ interface GuestAgents { delete is ArmResourceDeleteWithoutOkAsync; @doc("Returns the list of GuestAgent of the given vm.") - list is ArmResourceListByParent; + listByVirtualMachineInstance is ArmResourceListByParent; } diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/HybridIdentityMetadata.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/HybridIdentityMetadata.tsp index f6c7cb5dc404..a56739975467 100644 --- a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/HybridIdentityMetadata.tsp +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/HybridIdentityMetadata.tsp @@ -36,5 +36,5 @@ interface HybridIdentityMetadataGroup { get is ArmResourceRead; @doc("Returns the list of HybridIdentityMetadata of the given vm.") - list is ArmResourceListByParent; + listByVirtualMachineInstance is ArmResourceListByParent; } diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/LogicalNetworks.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/LogicalNetworks.tsp index d0d28d24df54..ddac7729c509 100644 --- a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/LogicalNetworks.tsp +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/LogicalNetworks.tsp @@ -49,7 +49,7 @@ interface LogicalNetworks { delete is ArmResourceDeleteWithoutOkAsync; @doc("Lists all of the logical networks in the specified resource group. Use the nextLink property in the response to get the next page of logical networks.") - list is ArmResourceListByParent; + listByResourceGroup is ArmResourceListByParent; @doc("Lists all of the logical networks in the specified subscription. Use the nextLink property in the response to get the next page of logical networks.") listAll is ArmListBySubscription; diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/MarketplaceGalleryImages.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/MarketplaceGalleryImages.tsp index e763cfe68247..875896ea1edb 100644 --- a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/MarketplaceGalleryImages.tsp +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/MarketplaceGalleryImages.tsp @@ -50,7 +50,7 @@ interface MarketplaceGalleryImages { delete is ArmResourceDeleteWithoutOkAsync; @doc("Lists all of the marketplace gallery images in the specified resource group. Use the nextLink property in the response to get the next page of marketplace gallery images.") - list is ArmResourceListByParent; + listByResourceGroup is ArmResourceListByParent; @doc("Lists all of the marketplace gallery images in the specified subscription. Use the nextLink property in the response to get the next page of marketplace gallery images.") listAll is ArmListBySubscription; diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/NetworkInterfaces.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/NetworkInterfaces.tsp index 30c6d7f11fe7..76f4355a051b 100644 --- a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/NetworkInterfaces.tsp +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/NetworkInterfaces.tsp @@ -49,7 +49,7 @@ interface NetworkInterfaces { delete is ArmResourceDeleteWithoutOkAsync; @doc("Lists all of the network interfaces in the specified resource group. Use the nextLink property in the response to get the next page of network interfaces.") - list is ArmResourceListByParent; + listByResourceGroup is ArmResourceListByParent; @doc("Lists all of the network interfaces in the specified subscription. Use the nextLink property in the response to get the next page of network interfaces.") listAll is ArmListBySubscription; diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/NetworkSecurityGroups.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/NetworkSecurityGroups.tsp index 4f712714116e..8c8b2e70eac7 100644 --- a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/NetworkSecurityGroups.tsp +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/NetworkSecurityGroups.tsp @@ -46,7 +46,7 @@ interface NetworkSecurityGroups { delete is ArmResourceDeleteWithoutOkAsync; @doc("Gets all network security groups in a resource group.") - list is ArmResourceListByParent; + listByResourceGroup is ArmResourceListByParent; @doc("Gets all network security groups in a subscription.") listAll is ArmListBySubscription; diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/SecurityRules.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/SecurityRules.tsp index a2e58268e493..140e5b58dc69 100644 --- a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/SecurityRules.tsp +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/SecurityRules.tsp @@ -42,5 +42,5 @@ interface SecurityRules { delete is ArmResourceDeleteWithoutOkAsync; @doc("Gets all security rules in a Network Security Group.") - list is ArmResourceListByParent; + listByNetworkSecurityGroup is ArmResourceListByParent; } diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/StorageContainers.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/StorageContainers.tsp index 22546b6b08e5..8c97b3a2920f 100644 --- a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/StorageContainers.tsp +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/StorageContainers.tsp @@ -47,7 +47,7 @@ interface StorageContainers { delete is ArmResourceDeleteWithoutOkAsync; @doc("Lists all of the storage containers in the specified resource group. Use the nextLink property in the response to get the next page of storage containers.") - list is ArmResourceListByParent; + listByResourceGroup is ArmResourceListByParent; @doc("Lists all of the storage containers in the specified subscription. Use the nextLink property in the response to get the next page of storage containers.") listAll is ArmListBySubscription; diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/VirtualHardDisks.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/VirtualHardDisks.tsp index c40e222784d1..d5c11774c069 100644 --- a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/VirtualHardDisks.tsp +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/VirtualHardDisks.tsp @@ -48,7 +48,7 @@ interface VirtualHardDisks { delete is ArmResourceDeleteWithoutOkAsync; @doc("Lists all of the virtual hard disks in the specified resource group. Use the nextLink property in the response to get the next page of virtual hard disks.") - list is ArmResourceListByParent; + listByResourceGroup is ArmResourceListByParent; @doc("Lists all of the virtual hard disks in the specified subscription. Use the nextLink property in the response to get the next page of virtual hard disks.") listAll is ArmListBySubscription; diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/tspconfig.yaml b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/tspconfig.yaml index 0a082d97d76d..28aa0342cccd 100644 --- a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/tspconfig.yaml +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/tspconfig.yaml @@ -5,6 +5,9 @@ options: use-read-only-status-schema: true emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/StackHCIVM/{version-status}/{version}/stackhcivm.json" examples-directory: "{project-root}/examples" linter: diff --git a/specification/azurestackhci/Operations.Management/tspconfig.yaml b/specification/azurestackhci/Operations.Management/tspconfig.yaml index dc13f45348b5..7bfd4bf58b80 100644 --- a/specification/azurestackhci/Operations.Management/tspconfig.yaml +++ b/specification/azurestackhci/Operations.Management/tspconfig.yaml @@ -5,6 +5,9 @@ options: use-read-only-status-schema: true emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/operations/{version-status}/{version}/operations.json" examples-directory: "{project-root}/examples" linter: diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.md b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.md index 25421f6157a2..c31464409a33 100644 --- a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.md +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.md @@ -228,7 +228,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js diff --git a/specification/batch/Azure.Batch/client.tsp b/specification/batch/Azure.Batch/client.tsp index 646d764ec8bd..d8a623867040 100644 --- a/specification/batch/Azure.Batch/client.tsp +++ b/specification/batch/Azure.Batch/client.tsp @@ -3,6 +3,248 @@ import "./main.tsp"; using Azure.ClientGenerator.Core; +@TypeSpec.Versioning.useDependency(Azure.Core.Versions.v1_0_Preview_2) +@TypeSpec.Versioning.useDependency(Azure.Batch.Versions.v2024_02_01) +namespace Client; +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "" +#suppress "@azure-tools/typespec-azure-core/no-rpc-path-params" "" +@client({ + name: "BatchClient", + service: Azure.Batch, +}) +interface BatchClient { + listApplications is Azure.Batch.Applications.listApplications; + getApplication is Azure.Batch.Applications.getApplication; + + listPoolUsageMetrics is Azure.Batch.Pools.listPoolUsageMetrics; + createPool is Azure.Batch.Pools.createPool; + listPools is Azure.Batch.Pools.listPools; + deletePool is Azure.Batch.Pools.deletePool; + poolExists is Azure.Batch.Pools.poolExists; + getPool is Azure.Batch.Pools.getPool; + updatePool is Azure.Batch.Pools.updatePool; + disablePoolAutoScale is Azure.Batch.Pools.disablePoolAutoScale; + enablePoolAutoScale is Azure.Batch.Pools.enablePoolAutoScale; + evaluatePoolAutoScale is Azure.Batch.Pools.evaluatePoolAutoScale; + resizePool is Azure.Batch.Pools.resizePool; + stopPoolResize is Azure.Batch.Pools.stopPoolResize; + replacePoolProperties is Azure.Batch.Pools.replacePoolProperties; + removeNodes is Azure.Batch.Pools.removeNodes; + listSupportedImages is Azure.Batch.Pools.listSupportedImages; + listPoolNodeCounts is Azure.Batch.Pools.listPoolNodeCounts; + + deleteJob is Azure.Batch.Jobs.deleteJob; + getJob is Azure.Batch.Jobs.getJob; + updateJob is Azure.Batch.Jobs.updateJob; + replaceJob is Azure.Batch.Jobs.replaceJob; + disableJob is Azure.Batch.Jobs.disableJob; + enableJob is Azure.Batch.Jobs.enableJob; + terminateJob is Azure.Batch.Jobs.terminateJob; + createJob is Azure.Batch.Jobs.createJob; + listJobs is Azure.Batch.Jobs.listJobs; + listJobsFromSchedule is Azure.Batch.Jobs.listJobsFromSchedule; + listJobPreparationAndReleaseTaskStatus is Azure.Batch.Jobs.listJobPreparationAndReleaseTaskStatus; + getJobTaskCounts is Azure.Batch.Jobs.getJobTaskCounts; + + jobScheduleExists is Azure.Batch.JobSchedules.jobScheduleExists; + deleteJobSchedule is Azure.Batch.JobSchedules.deleteJobSchedule; + getJobSchedule is Azure.Batch.JobSchedules.getJobSchedule; + updateJobSchedule is Azure.Batch.JobSchedules.updateJobSchedule; + replaceJobSchedule is Azure.Batch.JobSchedules.replaceJobSchedule; + disableJobSchedule is Azure.Batch.JobSchedules.disableJobSchedule; + enableJobSchedule is Azure.Batch.JobSchedules.enableJobSchedule; + terminateJobSchedule is Azure.Batch.JobSchedules.terminateJobSchedule; + createJobSchedule is Azure.Batch.JobSchedules.createJobSchedule; + listJobSchedules is Azure.Batch.JobSchedules.listJobSchedules; + + createTask is Azure.Batch.Tasks.createTask; + listTasks is Azure.Batch.Tasks.listTasks; + createTaskCollection is Azure.Batch.Tasks.createTaskCollection; + deleteTask is Azure.Batch.Tasks.deleteTask; + getTask is Azure.Batch.Tasks.getTask; + replaceTask is Azure.Batch.Tasks.replaceTask; + listSubTasks is Azure.Batch.Tasks.listSubTasks; + terminateTask is Azure.Batch.Tasks.terminateTask; + reactivateTask is Azure.Batch.Tasks.reactivateTask; + deleteTaskFile is Azure.Batch.Tasks.deleteTaskFile; + getTaskFile is Azure.Batch.Tasks.getTaskFile; + getTaskFileProperties is Azure.Batch.Tasks.getTaskFileProperties; + listTaskFiles is Azure.Batch.Tasks.listTaskFiles; + + createNodeUser is Azure.Batch.Nodes.createNodeUser; + deleteNodeUser is Azure.Batch.Nodes.deleteNodeUser; + replaceNodeUser is Azure.Batch.Nodes.replaceNodeUser; + getNode is Azure.Batch.Nodes.getNode; + rebootNode is Azure.Batch.Nodes.rebootNode; + disableNodeScheduling is Azure.Batch.Nodes.disableNodeScheduling; + enableNodeScheduling is Azure.Batch.Nodes.enableNodeScheduling; + getNodeRemoteLoginSettings is Azure.Batch.Nodes.getNodeRemoteLoginSettings; + uploadNodeLogs is Azure.Batch.Nodes.uploadNodeLogs; + listNodes is Azure.Batch.Nodes.listNodes; + getNodeExtension is Azure.Batch.Nodes.getNodeExtension; + listNodeExtensions is Azure.Batch.Nodes.listNodeExtensions; + deleteNodeFile is Azure.Batch.Nodes.deleteNodeFile; + getNodeFile is Azure.Batch.Nodes.getNodeFile; + getNodeFileProperties is Azure.Batch.Nodes.getNodeFileProperties; + listNodeFiles is Azure.Batch.Nodes.listNodeFiles; +} + +/* C SHARP OVERRIDES */ +// Api overrides +@@access(Azure.Batch.Pools.poolExists, Access.internal, "csharp"); +@@access(Azure.Batch.JobSchedules.jobScheduleExists, Access.internal, "csharp"); +@@access(Azure.Batch.Tasks.getTaskFileProperties, Access.internal, "csharp"); +@@access(Azure.Batch.Nodes.getNodeFileProperties, Access.internal, "csharp"); + +/* JAVA OVERRIDES */ +// client name overrides +@@clientName(BatchClient.listApplications, "listApplicationsInternal", "java"); +@@clientName(BatchClient.getApplication, "getApplicationInternal", "java"); + +@@clientName(BatchClient.listPoolUsageMetrics, + "listPoolUsageMetricsInternal", + "java" +); +@@clientName(BatchClient.createPool, "createPoolInternal", "java"); +@@clientName(BatchClient.listPools, "listPoolsInternal", "java"); +@@clientName(BatchClient.deletePool, "deletePoolInternal", "java"); +@@clientName(BatchClient.poolExists, "poolExistsInternal", "java"); +@@clientName(BatchClient.getPool, "getPoolInternal", "java"); +@@clientName(BatchClient.updatePool, "updatePoolInternal", "java"); +@@clientName(BatchClient.disablePoolAutoScale, + "disablePoolAutoScaleInternal", + "java" +); +@@clientName(BatchClient.enablePoolAutoScale, + "enablePoolAutoScaleInternal", + "java" +); +@@clientName(BatchClient.evaluatePoolAutoScale, + "evaluatePoolAutoScaleInternal", + "java" +); +@@clientName(BatchClient.resizePool, "resizePoolInternal", "java"); +@@clientName(BatchClient.stopPoolResize, "stopPoolResizeInternal", "java"); +@@clientName(BatchClient.replacePoolProperties, + "replacePoolPropertiesInternal", + "java" +); +@@clientName(BatchClient.removeNodes, "removeNodesInternal", "java"); +@@clientName(BatchClient.listSupportedImages, + "listSupportedImagesInternal", + "java" +); +@@clientName(BatchClient.listPoolNodeCounts, + "listPoolNodeCountsInternal", + "java" +); + +@@clientName(BatchClient.deleteJob, "deleteJobInternal", "java"); +@@clientName(BatchClient.getJob, "getJobInternal", "java"); +@@clientName(BatchClient.updateJob, "updateJobInternal", "java"); +@@clientName(BatchClient.replaceJob, "replaceJobInternal", "java"); +@@clientName(BatchClient.disableJob, "disableJobInternal", "java"); +@@clientName(BatchClient.enableJob, "enableJobInternal", "java"); +@@clientName(BatchClient.terminateJob, "terminateJobInternal", "java"); +@@clientName(BatchClient.createJob, "createJobInternal", "java"); +@@clientName(BatchClient.listJobs, "listJobsInternal", "java"); +@@clientName(BatchClient.listJobsFromSchedule, + "listJobsFromScheduleInternal", + "java" +); +@@clientName(BatchClient.listJobPreparationAndReleaseTaskStatus, + "listJobPreparationAndReleaseTaskStatusInternal", + "java" +); +@@clientName(BatchClient.getJobTaskCounts, "getJobTaskCountsInternal", "java"); + +@@clientName(BatchClient.jobScheduleExists, + "jobScheduleExistsInternal", + "java" +); +@@clientName(BatchClient.deleteJobSchedule, + "deleteJobScheduleInternal", + "java" +); +@@clientName(BatchClient.getJobSchedule, "getJobScheduleInternal", "java"); +@@clientName(BatchClient.updateJobSchedule, + "updateJobScheduleInternal", + "java" +); +@@clientName(BatchClient.replaceJobSchedule, + "replaceJobScheduleInternal", + "java" +); +@@clientName(BatchClient.disableJobSchedule, + "disableJobScheduleInternal", + "java" +); +@@clientName(BatchClient.enableJobSchedule, + "enableJobScheduleInternal", + "java" +); +@@clientName(BatchClient.terminateJobSchedule, + "terminateJobScheduleInternal", + "java" +); +@@clientName(BatchClient.createJobSchedule, + "createJobScheduleInternal", + "java" +); +@@clientName(BatchClient.listJobSchedules, "listJobSchedulesInternal", "java"); + +@@clientName(BatchClient.createTask, "createTaskInternal", "java"); +@@clientName(BatchClient.listTasks, "listTasksInternal", "java"); +@@clientName(BatchClient.createTaskCollection, + "createTaskCollectionInternal", + "java" +); +@@clientName(BatchClient.deleteTask, "deleteTaskInternal", "java"); +@@clientName(BatchClient.getTask, "getTaskInternal", "java"); +@@clientName(BatchClient.replaceTask, "replaceTaskInternal", "java"); +@@clientName(BatchClient.listSubTasks, "listSubTasksInternal", "java"); +@@clientName(BatchClient.terminateTask, "terminateTaskInternal", "java"); +@@clientName(BatchClient.reactivateTask, "reactivateTaskInternal", "java"); +@@clientName(BatchClient.deleteTaskFile, "deleteTaskFileInternal", "java"); +@@clientName(BatchClient.getTaskFile, "getTaskFileInternal", "java"); +@@clientName(BatchClient.getTaskFileProperties, + "getTaskFilePropertiesInternal", + "java" +); +@@clientName(BatchClient.listTaskFiles, "listTaskFilesInternal", "java"); + +@@clientName(BatchClient.createNodeUser, "createNodeUserInternal", "java"); +@@clientName(BatchClient.deleteNodeUser, "deleteNodeUserInternal", "java"); +@@clientName(BatchClient.replaceNodeUser, "replaceNodeUserInternal", "java"); +@@clientName(BatchClient.getNode, "getNodeInternal", "java"); +@@clientName(BatchClient.rebootNode, "rebootNodeInternal", "java"); +@@clientName(BatchClient.disableNodeScheduling, + "disableNodeSchedulingInternal", + "java" +); +@@clientName(BatchClient.enableNodeScheduling, + "enableNodeSchedulingInternal", + "java" +); +@@clientName(BatchClient.getNodeRemoteLoginSettings, + "getNodeRemoteLoginSettingsInternal", + "java" +); +@@clientName(BatchClient.uploadNodeLogs, "uploadNodeLogsInternal", "java"); +@@clientName(BatchClient.listNodes, "listNodesInternal", "java"); +@@clientName(BatchClient.getNodeExtension, "getNodeExtensionInternal", "java"); +@@clientName(BatchClient.listNodeExtensions, + "listNodeExtensionsInternal", + "java" +); +@@clientName(BatchClient.deleteNodeFile, "deleteNodeFileInternal", "java"); +@@clientName(BatchClient.getNodeFile, "getNodeFileInternal", "java"); +@@clientName(BatchClient.getNodeFileProperties, + "getNodeFilePropertiesInternal", + "java" +); +@@clientName(BatchClient.listNodeFiles, "listNodeFilesInternal", "java"); + // operation overrides @@access(Azure.Batch.ListOperation, Access.internal, "java"); @@access(Azure.Batch.ReadOperation, Access.internal, "java"); @@ -18,12 +260,6 @@ using Azure.ClientGenerator.Core; "java" ); -// Api overrides -@@access(Azure.Batch.Batch.poolExists, Access.internal, "csharp"); -@@access(Azure.Batch.Batch.jobScheduleExists, Access.internal, "csharp"); -@@access(Azure.Batch.Batch.getTaskFileProperties, Access.internal, "csharp"); -@@access(Azure.Batch.Batch.getNodeFileProperties, Access.internal, "csharp"); - // model overrides @@access(Azure.Batch.BatchApplicationListResult, Access.public, "java"); @@access(Azure.Batch.BatchApplication, Access.public, "java"); @@ -70,6 +306,7 @@ using Azure.ClientGenerator.Core; @@access(Azure.Batch.BatchNodeUserUpdateContent, Access.public, "java"); @@access(Azure.Batch.BatchNode, Access.public, "java"); @@access(Azure.Batch.BatchNodeRebootContent, Access.public, "java"); +@@access(Azure.Batch.BatchNodeReimageContent, Access.public, "java"); @@access(Azure.Batch.BatchNodeDisableSchedulingContent, Access.public, "java"); @@access(Azure.Batch.BatchNodeRemoteLoginSettings, Access.public, "java"); @@access(Azure.Batch.UploadBatchServiceLogsContent, Access.public, "java"); diff --git a/specification/batch/Azure.Batch/common.tsp b/specification/batch/Azure.Batch/common.tsp index e92f0df0a4a3..d8dcf315b881 100644 --- a/specification/batch/Azure.Batch/common.tsp +++ b/specification/batch/Azure.Batch/common.tsp @@ -101,7 +101,7 @@ op ReplaceOperation is RpcOperation< #suppress "@azure-tools/typespec-azure-core/no-error-status-codes" "Azure REST API guidelines recommend using 'default' error response for all error cases. Avoid defining custom 4xx or 5xx error cases." #suppress "@azure-tools/typespec-azure-core/no-response-body" "Legacy behavior" -@doc("New rpc operation allowing multiple repsonses") +@doc("New rpc operation allowing multiple responses") @Foundations.Private.needsRoute @head op ResourceInfoOperationWithAdditionalResponse< @@ -183,7 +183,7 @@ alias FileResponseHeaders = { @header("Content-Length") @doc("The length of the file.") - contentLength: int64; + contentLength: string; ...BatchEtagResponseHeaders; diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/AccountListPoolNodeCounts.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/AccountListPoolNodeCounts.json deleted file mode 100644 index f613f9f189a0..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/AccountListPoolNodeCounts.json +++ /dev/null @@ -1,129 +0,0 @@ -{ - "operationId": "Batch_ListPoolNodeCounts", - "title": "NodeCountsPayload", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "poolId": "pool1", - "dedicated": { - "creating": 0, - "idle": 0, - "leavingPool": 0, - "offline": 0, - "preempted": 0, - "rebooting": 0, - "reimaging": 0, - "running": 0, - "starting": 0, - "startTaskFailed": 0, - "unknown": 0, - "unusable": 0, - "waitingForStartTask": 0, - "upgradingOS": 0, - "total": 0 - }, - "lowPriority": { - "creating": 0, - "idle": 0, - "leavingPool": 0, - "offline": 0, - "preempted": 0, - "rebooting": 0, - "reimaging": 0, - "running": 2, - "starting": 1, - "startTaskFailed": 0, - "unknown": 0, - "unusable": 0, - "waitingForStartTask": 0, - "upgradingOS": 0, - "total": 3 - } - }, - { - "poolId": "pool2", - "dedicated": { - "creating": 0, - "idle": 1, - "leavingPool": 0, - "offline": 3, - "preempted": 0, - "rebooting": 0, - "reimaging": 0, - "running": 0, - "starting": 0, - "startTaskFailed": 0, - "unknown": 0, - "unusable": 0, - "waitingForStartTask": 0, - "upgradingOS": 0, - "total": 4 - }, - "lowPriority": { - "creating": 0, - "idle": 0, - "leavingPool": 0, - "offline": 0, - "preempted": 0, - "rebooting": 0, - "reimaging": 0, - "running": 0, - "starting": 0, - "startTaskFailed": 0, - "unknown": 0, - "unusable": 0, - "waitingForStartTask": 0, - "upgradingOS": 0, - "total": 0 - } - }, - { - "poolId": "pool3", - "dedicated": { - "creating": 0, - "idle": 5, - "leavingPool": 0, - "offline": 0, - "preempted": 0, - "rebooting": 0, - "reimaging": 4, - "running": 0, - "starting": 0, - "startTaskFailed": 0, - "unknown": 0, - "unusable": 0, - "waitingForStartTask": 0, - "upgradingOS": 0, - "total": 9 - }, - "lowPriority": { - "creating": 7, - "idle": 0, - "leavingPool": 0, - "offline": 0, - "preempted": 0, - "rebooting": 0, - "reimaging": 0, - "running": 4, - "starting": 0, - "startTaskFailed": 0, - "unknown": 0, - "unusable": 0, - "waitingForStartTask": 0, - "upgradingOS": 0, - "total": 11 - } - } - ] - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/AccountListSupportedImages.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/AccountListSupportedImages.json deleted file mode 100644 index 6987a7964959..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/AccountListSupportedImages.json +++ /dev/null @@ -1,78 +0,0 @@ -{ - "operationId": "Batch_ListSupportedImages", - "title": "Account list node agent skus", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "nodeAgentSKUId": "batch.node.centos 7", - "imageReference": { - "publisher": "OpenLogic", - "offer": "CentOS", - "sku": "7.2", - "version": "latest" - }, - "verificationType": "verified", - "capabilities": [ - "DockerCompatible", - "NvidiaTeslaDriverInstalled" - ], - "osType": "linux" - }, - { - "nodeAgentSKUId": "batch.node.centos 7", - "imageReference": { - "publisher": "OpenLogic", - "offer": "CentOS", - "sku": "7.1", - "version": "latest" - }, - "verificationType": "unverified", - "osType": "linux", - "batchSupportEndOfLife": "2019-11-01T00:00:00.0Z" - }, - { - "nodeAgentSKUId": "batch.node.debian 8", - "imageReference": { - "publisher": "Credativ", - "offer": "Debian", - "sku": "8", - "version": "latest" - }, - "verificationType": "verified", - "osType": "linux" - }, - { - "nodeAgentSKUId": "batch.node.windows amd64", - "imageReference": { - "publisher": "MicrosoftWindowsServer", - "offer": "WindowsServer", - "sku": "2012-R2-Datacenter", - "version": "latest" - }, - "verificationType": "verified", - "osType": "windows" - }, - { - "nodeAgentSKUId": "batch.node.windows amd64", - "imageReference": { - "publisher": "MicrosoftWindowsServer", - "offer": "WindowsServer", - "sku": "2012-Datacenter", - "version": "latest" - }, - "verificationType": "verified", - "osType": "windows" - } - ] - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/ApplicationGet.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/ApplicationGet.json deleted file mode 100644 index 738c87bc223b..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/ApplicationGet.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "operationId": "Batch_GetApplication", - "title": "Get applications", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "applicationId": "my_application_id" - }, - "responses": { - "200": { - "body": { - "id": "my_application_id", - "versions": [ - "v1.0" - ], - "displayName": "my_display_name" - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/ApplicationList.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/ApplicationList.json deleted file mode 100644 index 87a0e2329135..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/ApplicationList.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "operationId": "Batch_ListApplications", - "title": "List applications", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "my_application_id", - "versions": [ - "v1.0" - ], - "displayName": "my_display_name" - } - ] - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Applications_GetApplication.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Applications_GetApplication.json new file mode 100644 index 000000000000..e18b17fbaab0 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Applications_GetApplication.json @@ -0,0 +1,22 @@ +{ + "operationId": "Applications_GetApplication", + "title": "Get applications", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "applicationId": "my_application_id" + }, + "responses": { + "200": { + "body": { + "id": "my_application_id", + "versions": [ + "v1.0" + ], + "displayName": "my_display_name" + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Applications_ListApplications.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Applications_ListApplications.json new file mode 100644 index 000000000000..d4c8edbf5e5a --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Applications_ListApplications.json @@ -0,0 +1,25 @@ +{ + "operationId": "Applications_ListApplications", + "title": "List applications", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "my_application_id", + "versions": [ + "v1.0" + ], + "displayName": "my_display_name" + } + ] + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/BatchNodeExtensionGet.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/BatchNodeExtensionGet.json deleted file mode 100644 index f1ca14f2f17e..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/BatchNodeExtensionGet.json +++ /dev/null @@ -1,37 +0,0 @@ -{ - "operationId": "Batch_GetNodeExtension", - "title": "Get batch node extension", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "poolId": "poolId", - "nodeId": "tvm-1695681911_2-20161122t193202z", - "extensionName": "batchNodeExtension", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "instanceView": { - "name": "batchNodeExtension", - "statuses": [ - { - "code": "ProvisioningState/succeeded", - "level": "Info", - "displayStatus": "Provisioning succeeded", - "message": "Enable succeeded: Enabling and starting agent and controller" - } - ] - }, - "vmExtension": { - "name": "batchNodeExtension", - "publisher": "Microsoft.Azure.Extensions", - "type": "CustomScript", - "typeHandlerVersion": "2.0", - "autoUpgradeMinorVersion": true - } - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/BatchNodeExtensionList.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/BatchNodeExtensionList.json deleted file mode 100644 index 03882514b379..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/BatchNodeExtensionList.json +++ /dev/null @@ -1,61 +0,0 @@ -{ - "operationId": "Batch_ListNodeExtensions", - "title": "List compute node extensions", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "nodeId": "tvm-1695681911_2-20161122t193202z", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "instanceView": { - "name": "batchNodeExtension", - "statuses": [ - { - "code": "ProvisioningState/succeeded", - "level": "Info", - "displayStatus": "Provisioning succeeded", - "message": "Enable succeeded: Enabling and starting agent and controller" - } - ] - }, - "vmExtension": { - "name": "batchNodeExtension", - "publisher": "Microsoft.Azure.Extensions", - "type": "CustomScript", - "typeHandlerVersion": "2.0", - "autoUpgradeMinorVersion": true - } - }, - { - "instanceView": { - "name": "customExtension", - "statuses": [ - { - "code": "ProvisioningState/succeeded", - "level": "Info", - "displayStatus": "Provisioning succeeded", - "message": "ExtensionOperation:enable. Status:Success" - } - ] - }, - "vmExtension": { - "name": "customExtension", - "publisher": "Microsoft.Azure.Geneva", - "type": "GenevaMonitoring", - "typeHandlerVersion": "2.0", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true - } - } - ] - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/FileDeleteFromNode.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/FileDeleteFromNode.json deleted file mode 100644 index da9f49aeed3b..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/FileDeleteFromNode.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "operationId": "Batch_DeleteNodeFile", - "title": "File delete from node", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "nodeId": "tvm-1695681911_1-20161122t193202z", - "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "recursive": false - }, - "responses": { - "200": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/FileDeleteFromTask.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/FileDeleteFromTask.json deleted file mode 100644 index b5b7a691b4f8..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/FileDeleteFromTask.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "operationId": "Batch_DeleteTaskFile", - "title": "File delete from task", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "taskId": "task1", - "filePath": "wd\\testFile.txt", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "recursive": false - }, - "responses": { - "200": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/FileGetFromNode.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/FileGetFromNode.json deleted file mode 100644 index 7e5a1b9b336b..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/FileGetFromNode.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "operationId": "Batch_GetNodeFile", - "title": "Get File From Compute Node", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "nodeId": "nodeId", - "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", - "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", - "ocp-batch-file-isdirectory": "false", - "Content-Length": "17", - "Content-Type": "application/octet-stream", - "body": "This is actually a byte stream. This request/response is being presented as a string for readability in the example" - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/FileGetFromTask.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/FileGetFromTask.json deleted file mode 100644 index 28566edf56ab..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/FileGetFromTask.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "operationId": "Batch_GetTaskFile", - "title": "Get File From Task", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "taskId": "task1", - "filePath": "wd\\testFile.txt", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", - "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", - "ocp-batch-file-isdirectory": "false", - "Content-Length": "17", - "Content-Type": "application/octet-stream", - "body": "This is actually a byte stream. This request/response is being presented as a string for readability in the example" - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/FileGetPropertiesFromNode.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/FileGetPropertiesFromNode.json deleted file mode 100644 index ac1a82fd5bcb..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/FileGetPropertiesFromNode.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "operationId": "Batch_GetNodeFileProperties", - "title": "File get properties from node", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "nodeId": "nodeId", - "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", - "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", - "ocp-batch-file-isdirectory": "false", - "Content-Length": "17", - "Content-Type": "application/octet-stream" - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/FileGetPropertiesFromTask.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/FileGetPropertiesFromTask.json deleted file mode 100644 index 9032d4768b77..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/FileGetPropertiesFromTask.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "operationId": "Batch_GetTaskFileProperties", - "title": "File get properties from task", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "taskId": "taskId", - "filePath": "wd\\testFile.txt", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", - "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", - "ocp-batch-file-isdirectory": "false", - "Content-Length": "17", - "Content-Type": "application/octet-stream" - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/FileListFromNode.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/FileListFromNode.json deleted file mode 100644 index 68b23892ccc5..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/FileListFromNode.json +++ /dev/null @@ -1,48 +0,0 @@ -{ - "operationId": "Batch_ListNodeFiles", - "title": "File list from node", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "nodeId": "tvm-1695681911_1-20161122t193202z", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "recursive": false - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "shared", - "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/shared", - "isDirectory": true - }, - { - "name": "startup\\ProcessEnv.cmd", - "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/startup\\ProcessEnv.cmd", - "isDirectory": false, - "properties": { - "creationTime": "2014-09-19T21:56:17.679195Z", - "lastModified": "2014-09-19T21:56:17.679195Z", - "contentLength": 1813, - "contentType": "application/octet-stream" - } - }, - { - "name": "startup\\stderr.txt", - "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/startup\\stderr.txt", - "isDirectory": false, - "properties": { - "creationTime": "2014-09-19T21:56:17.5590855Z", - "lastModified": "2014-09-19T21:56:17.5590855Z", - "contentLength": 0, - "contentType": "application/octet-stream" - } - } - ] - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/FileListFromTask.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/FileListFromTask.json deleted file mode 100644 index 20d49989c8a0..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/FileListFromTask.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "operationId": "Batch_ListTaskFiles", - "title": "File list from task", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "taskId": "taskId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "recursive": false - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "startup\\ProcessEnv.cmd", - "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId/files/startup\\ProcessEnv.cmd", - "isDirectory": false, - "properties": { - "creationTime": "2014-09-19T21:56:17.679195Z", - "lastModified": "2014-09-19T21:56:17.679195Z", - "contentLength": 1813, - "contentType": "application/octet-stream" - } - }, - { - "name": "startup\\stderr.txt", - "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId/files/startup\\stderr.txt", - "isDirectory": false, - "properties": { - "creationTime": "2014-09-19T21:56:17.5590855Z", - "lastModified": "2014-09-19T21:56:17.5590855Z", - "contentLength": 0, - "contentType": "application/octet-stream" - } - } - ] - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobCreate_Basic.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobCreate_Basic.json deleted file mode 100644 index 0ad432d26cf5..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobCreate_Basic.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "operationId": "Batch_CreateJob", - "title": "Creates a basic job", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "job": { - "id": "jobId", - "priority": 0, - "poolInfo": { - "poolId": "poolId" - } - } - }, - "responses": { - "201": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobCreate_Complex.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobCreate_Complex.json deleted file mode 100644 index 2ece9cf6ca27..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobCreate_Complex.json +++ /dev/null @@ -1,118 +0,0 @@ -{ - "operationId": "Batch_CreateJob", - "title": "Creates a complex job", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "job": { - "id": "jobId", - "priority": 100, - "constraints": { - "maxWallClockTime": "PT1H", - "maxTaskRetryCount": -1 - }, - "jobManagerTask": { - "id": "taskId", - "commandLine": "myprogram.exe", - "resourceFiles": [ - { - "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram.exe?sas", - "filePath": "myprogram.exe" - }, - { - "storageContainerUrl": "http://mystorage1.blob.core.windows.net/data?sas", - "filePath": "datafolder" - } - ], - "environmentSettings": [ - { - "name": "myvariable", - "value": "myvalue" - } - ], - "constraints": { - "maxWallClockTime": "PT1H", - "maxTaskRetryCount": 0, - "retentionTime": "PT1H" - }, - "requiredSlots": 2, - "killJobOnCompletion": false, - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "admin" - } - }, - "runExclusive": true - }, - "poolInfo": { - "autoPoolSpecification": { - "autoPoolIdPrefix": "mypool", - "poolLifetimeOption": "job", - "pool": { - "vmSize": "Standard_D1_v2", - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "MicrosoftWindowsServer", - "offer": "WindowsServer", - "sku": "2016-datacenter-smalldisk", - "version": "latest" - }, - "nodeAgentSKUId": "batch.node.windows amd64" - }, - "resizeTimeout": "PT15M", - "targetDedicatedNodes": 3, - "targetLowPriorityNodes": 0, - "taskSlotsPerNode": 2, - "taskSchedulingPolicy": { - "nodeFillType": "spread" - }, - "enableAutoScale": false, - "enableInterNodeCommunication": true, - "startTask": { - "commandLine": "myprogram2.exe", - "resourceFiles": [ - { - "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram2.exe?sas", - "filePath": "myprogram2.exe" - } - ], - "environmentSettings": [ - { - "name": "myvariable", - "value": "myvalue" - } - ], - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "admin" - } - }, - "maxTaskRetryCount": 2, - "waitForSuccess": true - }, - "metadata": [ - { - "name": "myproperty", - "value": "myvalue" - } - ], - "targetNodeCommunicationMode": "default" - } - } - }, - "metadata": [ - { - "name": "myproperty", - "value": "myvalue" - } - ] - } - }, - "responses": { - "201": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobDelete.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobDelete.json deleted file mode 100644 index 88a65f34775a..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobDelete.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "operationId": "Batch_DeleteJob", - "title": "Delete Job", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "202": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobDisable.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobDisable.json deleted file mode 100644 index 096976ec9e42..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobDisable.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "operationId": "Batch_DisableJob", - "title": "Job disable", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "content": { - "disableTasks": "terminate" - } - }, - "responses": { - "202": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobEnable.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobEnable.json deleted file mode 100644 index d8ffa6551896..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobEnable.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "operationId": "Batch_EnableJob", - "title": "Job enable", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "202": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobGet.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobGet.json deleted file mode 100644 index 7b7fdef9e0e7..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobGet.json +++ /dev/null @@ -1,45 +0,0 @@ -{ - "operationId": "Batch_GetJob", - "title": "Job get", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "id": "jobId", - "url": "https://account.region.batch.azure.com/jobs/jobId", - "eTag": "0x8D4100FC49F0278", - "lastModified": "2016-11-19T00:05:27.5391608Z", - "creationTime": "2016-11-19T00:05:25.311915Z", - "state": "completed", - "stateTransitionTime": "2016-11-19T00:05:27.578581Z", - "previousState": "active", - "previousStateTransitionTime": "2016-11-19T00:05:27.2137716Z", - "priority": 0, - "maxParallelTasks": -1, - "allowTaskPreemption": false, - "usesTaskDependencies": false, - "constraints": { - "maxWallClockTime": "P10675199DT2H48M5.4775807S", - "maxTaskRetryCount": 0 - }, - "poolInfo": { - "poolId": "poolId" - }, - "executionInfo": { - "startTime": "2016-11-19T00:05:25.3309105Z", - "endTime": "2016-11-19T00:05:27.578581Z", - "poolId": "poolId", - "terminateReason": "UserTerminate" - }, - "onAllTasksComplete": "noaction", - "onTaskFailure": "noaction" - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobGetTaskCounts.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobGetTaskCounts.json deleted file mode 100644 index 44c35dfefc05..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobGetTaskCounts.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "operationId": "Batch_GetJobTaskCounts", - "title": "Job get task counts", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "taskCounts": { - "active": 5, - "running": 7, - "completed": 4, - "succeeded": 2, - "failed": 2 - }, - "taskSlotCounts": { - "active": 5, - "running": 7, - "completed": 4, - "succeeded": 2, - "failed": 2 - } - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobList.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobList.json deleted file mode 100644 index 6c8282b040b7..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobList.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "operationId": "Batch_ListJobs", - "title": "Job list", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "jobId", - "url": "https://account.region.batch.azure.com/jobs/jobId", - "eTag": "0x8D4100FC46D5BF4", - "lastModified": "2016-11-19T00:05:27.2137716Z", - "creationTime": "2016-11-19T00:05:25.311915Z", - "state": "active", - "stateTransitionTime": "2016-11-19T00:05:27.2137716Z", - "previousState": "disabled", - "previousStateTransitionTime": "2016-11-19T00:05:26.88777Z", - "priority": 0, - "maxParallelTasks": -1, - "allowTaskPreemption": false, - "usesTaskDependencies": false, - "constraints": { - "maxWallClockTime": "P10675199DT2H48M5.4775807S", - "maxTaskRetryCount": 0 - }, - "poolInfo": { - "poolId": "poolId" - }, - "executionInfo": { - "startTime": "2016-11-19T00:05:25.3309105Z", - "poolId": "poolId" - }, - "onAllTasksComplete": "noaction", - "onTaskFailure": "noaction" - } - ] - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobListFromJobSchedule.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobListFromJobSchedule.json deleted file mode 100644 index b43983007f9a..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobListFromJobSchedule.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "operationId": "Batch_ListJobsFromSchedule", - "title": "List Job Under Job Schedule", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobScheduleId": "jobScheduleId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "jobId", - "url": "https://account.region.batch.azure.com/jobs/jobId", - "eTag": "0x8D4100FC46D5BF4", - "lastModified": "2016-11-19T00:05:27.2137716Z", - "creationTime": "2016-11-19T00:05:25.311915Z", - "state": "active", - "stateTransitionTime": "2016-11-19T00:05:27.2137716Z", - "previousState": "disabled", - "previousStateTransitionTime": "2016-11-19T00:05:26.88777Z", - "priority": 0, - "maxParallelTasks": -1, - "allowTaskPreemption": false, - "usesTaskDependencies": false, - "constraints": { - "maxWallClockTime": "P10675199DT2H48M5.4775807S", - "maxTaskRetryCount": 0 - }, - "poolInfo": { - "poolId": "poolId" - }, - "executionInfo": { - "startTime": "2016-11-19T00:05:25.3309105Z", - "poolId": "poolId" - }, - "onAllTasksComplete": "noaction", - "onTaskFailure": "noaction" - } - ] - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobListPreparationAndReleaseTaskStatus.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobListPreparationAndReleaseTaskStatus.json deleted file mode 100644 index 8e3cab74dcfe..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobListPreparationAndReleaseTaskStatus.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "operationId": "Batch_ListJobPreparationAndReleaseTaskStatus", - "title": "Job list preparation and release task status", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "poolId": "poolId", - "nodeId": "tvm-2167304207_1-20140905t174658z", - "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z", - "jobPreparationTaskExecutionInfo": { - "state": "completed", - "startTime": "2015-05-01T10:20:31Z", - "endTime": "2015-05-02T20:12:42Z", - "taskRootDirectory": "tasks/myjob/job-1/myjobpreptask", - "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z/files/tasks/myjob/job-1/myjobpreptask", - "exitCode": 0, - "retryCount": 0 - }, - "jobReleaseTaskExecutionInfo": { - "state": "completed", - "startTime": "2015-05-01T10:20:31Z", - "endTime": "2015-05-02T20:12:42Z", - "taskRootDirectory": "tasks/myjob/job-1/myjobreleasetask", - "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z/files/tasks/myjob/job-1/myjobreleasetask", - "exitCode": 0 - } - } - ], - "odata.nextLink": "https://account.region.batch.azure.com/jobs/myjob/jobpreparationandreleasestatus?$skipToken=tvm-2167304207_1-20140905t174658z&api-version=2024-02-01.19.0" - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobPatch.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobPatch.json deleted file mode 100644 index 2d6cb6308411..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobPatch.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "operationId": "Batch_UpdateJob", - "title": "Job patch", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "job": { - "priority": 100, - "constraints": { - "maxWallClockTime": "PT1H", - "maxTaskRetryCount": -1 - }, - "poolInfo": { - "poolId": "poolId" - } - } - }, - "responses": { - "200": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobScheduleCreate_Basic.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobScheduleCreate_Basic.json deleted file mode 100644 index 99ab243382ce..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobScheduleCreate_Basic.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "operationId": "Batch_CreateJobSchedule", - "title": "Creates a basic JobSchedule", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "jobSchedule": { - "id": "jobScheduleId", - "schedule": { - "recurrenceInterval": "PT5M" - }, - "jobSpecification": { - "poolInfo": { - "poolId": "poolId" - } - } - } - }, - "responses": { - "201": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobScheduleCreate_Complex.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobScheduleCreate_Complex.json deleted file mode 100644 index fdae20cb6a52..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobScheduleCreate_Complex.json +++ /dev/null @@ -1,126 +0,0 @@ -{ - "operationId": "Batch_CreateJobSchedule", - "title": "Creates a complex JobScheduleAdd", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "jobSchedule": { - "id": "jobScheduleId", - "schedule": { - "doNotRunUntil": "2014-09-10T02:30:00.000Z", - "doNotRunAfter": "2014-09-10T06:30:00.000Z", - "startWindow": "PT1M", - "recurrenceInterval": "PT5M" - }, - "jobSpecification": { - "priority": 100, - "constraints": { - "maxWallClockTime": "PT1H", - "maxTaskRetryCount": -1 - }, - "jobManagerTask": { - "id": "mytask1", - "commandLine": "myprogram.exe", - "resourceFiles": [ - { - "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram.exe?sas", - "filePath": "myprogram.exe" - }, - { - "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/test.txt?sas", - "filePath": "test.txt" - } - ], - "environmentSettings": [ - { - "name": "myvariable", - "value": "myvalue" - } - ], - "constraints": { - "maxWallClockTime": "PT1H", - "maxTaskRetryCount": 0, - "retentionTime": "PT1H" - }, - "requiredSlots": 2, - "killJobOnCompletion": true, - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "nonadmin" - } - }, - "runExclusive": true - }, - "poolInfo": { - "autoPoolSpecification": { - "autoPoolIdPrefix": "mypool", - "poolLifetimeOption": "jobschedule", - "pool": { - "vmSize": "Standard_D1_v2", - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "MicrosoftWindowsServer", - "offer": "WindowsServer", - "sku": "2016-datacenter-smalldisk", - "version": "latest" - }, - "nodeAgentSKUId": "batch.node.windows amd64" - }, - "resizeTimeout": "PT15M", - "targetDedicatedNodes": 3, - "targetLowPriorityNodes": 0, - "taskSlotsPerNode": 2, - "taskSchedulingPolicy": { - "nodeFillType": "spread" - }, - "enableAutoScale": false, - "enableInterNodeCommunication": true, - "startTask": { - "commandLine": "myprogram2.exe", - "resourceFiles": [ - { - "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram2.exe?sas", - "filePath": "myprogram2.exe" - } - ], - "environmentSettings": [ - { - "name": "myvariable", - "value": "myvalue" - } - ], - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "admin" - } - }, - "maxTaskRetryCount": 2, - "waitForSuccess": true - }, - "metadata": [ - { - "name": "myproperty", - "value": "myvalue" - } - ], - "targetNodeCommunicationMode": "default" - } - } - } - }, - "metadata": [ - { - "name": "myproperty", - "value": "myvalue" - } - ] - } - }, - "responses": { - "201": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobScheduleDelete.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobScheduleDelete.json deleted file mode 100644 index 33fc294b493c..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobScheduleDelete.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "operationId": "Batch_DeleteJobSchedule", - "title": "JobSchedule delete", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobScheduleId": "jobScheduleId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "202": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobScheduleDisable.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobScheduleDisable.json deleted file mode 100644 index 8b9b0add1575..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobScheduleDisable.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "operationId": "Batch_DisableJobSchedule", - "title": "JobSchedule disable", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobScheduleId": "jobScheduleId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "204": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobScheduleEnable.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobScheduleEnable.json deleted file mode 100644 index dada6efbb4c4..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobScheduleEnable.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "operationId": "Batch_EnableJobSchedule", - "title": "JobSchedule enable", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobScheduleId": "jobScheduleId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "204": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobScheduleExists.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobScheduleExists.json deleted file mode 100644 index f74c2f7c90a5..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobScheduleExists.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "operationId": "Batch_JobScheduleExists", - "title": "Check Job Schedule Exists", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobScheduleId": "jobScheduleId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": {}, - "404": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobScheduleGet.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobScheduleGet.json deleted file mode 100644 index 224776fa102a..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobScheduleGet.json +++ /dev/null @@ -1,48 +0,0 @@ -{ - "operationId": "Batch_GetJobSchedule", - "title": "JobSchedule get", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobScheduleId": "jobScheduleId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "id": "jobScheduleId", - "url": "https://account.region.batch.azure.com/jobschedules/jobScheduleId", - "eTag": "0x8D40FFD2E848323", - "lastModified": "2016-11-18T21:52:24.7661347Z", - "creationTime": "2016-11-18T21:52:22.5431125Z", - "state": "completed", - "stateTransitionTime": "2016-11-18T21:52:24.8371778Z", - "previousState": "active", - "previousStateTransitionTime": "2016-11-18T21:52:24.0064874Z", - "jobSpecification": { - "priority": 0, - "maxParallelTasks": -1, - "allowTaskPreemption": false, - "usesTaskDependencies": false, - "onAllTasksComplete": "noaction", - "onTaskFailure": "noaction", - "constraints": { - "maxWallClockTime": "P10675199DT2H48M5.4775807S", - "maxTaskRetryCount": 0 - }, - "poolInfo": { - "poolId": "testPool" - } - }, - "executionInfo": { - "recentJob": { - "url": "https://account.region.batch.azure.com/jobschedules/jobScheduleId:job-1", - "id": "jobScheduleId:job-1" - }, - "endTime": "2016-11-18T21:52:24.8371778Z" - } - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobScheduleList.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobScheduleList.json deleted file mode 100644 index 9559a72029cb..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobScheduleList.json +++ /dev/null @@ -1,79 +0,0 @@ -{ - "operationId": "Batch_ListJobSchedules", - "title": "JobSchedule list", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "jobSchedule1", - "url": "https://account.region.batch.azure.com/jobschedules/jobSchedule1", - "eTag": "0x8D40FFD2E10996A", - "lastModified": "2016-11-18T21:52:24.0064874Z", - "creationTime": "2016-11-18T21:52:22.5431125Z", - "state": "active", - "stateTransitionTime": "2016-11-18T21:52:24.0064874Z", - "previousState": "disabled", - "previousStateTransitionTime": "2016-11-18T21:52:23.6471782Z", - "jobSpecification": { - "priority": 0, - "maxParallelTasks": -1, - "allowTaskPreemption": false, - "usesTaskDependencies": false, - "onAllTasksComplete": "noaction", - "onTaskFailure": "noaction", - "constraints": { - "maxWallClockTime": "P10675199DT2H48M5.4775807S", - "maxTaskRetryCount": 0 - }, - "poolInfo": { - "poolId": "poolId" - } - }, - "executionInfo": { - "recentJob": { - "url": "https://account.region.batch.azure.com/jobs/jobSchedule1:job-1", - "id": "jobSchedule1:job-1" - } - } - }, - { - "id": "jobSchedule2", - "url": "https://account.region.batch.azure.com/jobschedules/jobSchedule2", - "eTag": "0x8D40FFCFF760B51", - "lastModified": "2016-11-18T21:51:05.8184017Z", - "creationTime": "2016-11-18T21:51:05.8184017Z", - "state": "active", - "stateTransitionTime": "2016-11-18T21:51:05.8184017Z", - "schedule": { - "doNotRunUntil": "2020-01-01T12:30:00Z" - }, - "jobSpecification": { - "priority": 0, - "maxParallelTasks": -1, - "usesTaskDependencies": false, - "onAllTasksComplete": "noaction", - "onTaskFailure": "noaction", - "constraints": { - "maxWallClockTime": "P10675199DT2H48M5.4775807S", - "maxTaskRetryCount": 0 - }, - "poolInfo": { - "poolId": "testPool2" - } - }, - "executionInfo": { - "nextRunTime": "2020-01-01T12:30:00Z" - } - } - ] - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedulePatch.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedulePatch.json deleted file mode 100644 index 6b464dc76c36..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedulePatch.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "operationId": "Batch_UpdateJobSchedule", - "title": "JobSchedule patch", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobScheduleId": "jobScheduleId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "jobSchedule": { - "schedule": { - "doNotRunUntil": "2025-01-01T12:30:00Z" - }, - "jobSpecification": { - "priority": 0, - "usesTaskDependencies": false, - "constraints": { - "maxWallClockTime": "P10675199DT2H48M5.4775807S", - "maxTaskRetryCount": 0 - }, - "poolInfo": { - "poolId": "poolId" - } - } - } - }, - "responses": { - "200": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobScheduleTerminate.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobScheduleTerminate.json deleted file mode 100644 index 46fc6228dbe8..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobScheduleTerminate.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "operationId": "Batch_TerminateJobSchedule", - "title": "JobSchedule terminate", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobScheduleId": "jobScheduleId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "202": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobScheduleUpdate.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobScheduleUpdate.json deleted file mode 100644 index 2063e67201b0..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobScheduleUpdate.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "operationId": "Batch_ReplaceJobSchedule", - "title": "JobSchedule update", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobScheduleId": "jobScheduleId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "jobSchedule": { - "schedule": { - "doNotRunUntil": "2025-01-01T12:30:00Z" - }, - "jobSpecification": { - "priority": 0, - "usesTaskDependencies": false, - "constraints": { - "maxWallClockTime": "P10675199DT2H48M5.4775807S", - "maxTaskRetryCount": 0 - }, - "poolInfo": { - "poolId": "poolId" - } - } - } - }, - "responses": { - "200": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_CreateJobSchedule_Basic.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_CreateJobSchedule_Basic.json new file mode 100644 index 000000000000..73996de79a79 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_CreateJobSchedule_Basic.json @@ -0,0 +1,24 @@ +{ + "operationId": "JobSchedules_CreateJobSchedule", + "title": "Creates a basic JobSchedule", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobSchedule": { + "id": "jobScheduleId", + "schedule": { + "recurrenceInterval": "PT5M" + }, + "jobSpecification": { + "poolInfo": { + "poolId": "poolId" + } + } + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_CreateJobSchedule_Complex.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_CreateJobSchedule_Complex.json new file mode 100644 index 000000000000..6d4387e11cfe --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_CreateJobSchedule_Complex.json @@ -0,0 +1,126 @@ +{ + "operationId": "JobSchedules_CreateJobSchedule", + "title": "Creates a complex JobScheduleAdd", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobSchedule": { + "id": "jobScheduleId", + "schedule": { + "doNotRunUntil": "2014-09-10T02:30:00.000Z", + "doNotRunAfter": "2014-09-10T06:30:00.000Z", + "startWindow": "PT1M", + "recurrenceInterval": "PT5M" + }, + "jobSpecification": { + "priority": 100, + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": -1 + }, + "jobManagerTask": { + "id": "mytask1", + "commandLine": "myprogram.exe", + "resourceFiles": [ + { + "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram.exe?sas", + "filePath": "myprogram.exe" + }, + { + "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/test.txt?sas", + "filePath": "test.txt" + } + ], + "environmentSettings": [ + { + "name": "myvariable", + "value": "myvalue" + } + ], + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": 0, + "retentionTime": "PT1H" + }, + "requiredSlots": 2, + "killJobOnCompletion": true, + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "runExclusive": true + }, + "poolInfo": { + "autoPoolSpecification": { + "autoPoolIdPrefix": "mypool", + "poolLifetimeOption": "jobschedule", + "pool": { + "vmSize": "Standard_D1_v2", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.windows amd64" + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 2, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false, + "enableInterNodeCommunication": true, + "startTask": { + "commandLine": "myprogram2.exe", + "resourceFiles": [ + { + "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram2.exe?sas", + "filePath": "myprogram2.exe" + } + ], + "environmentSettings": [ + { + "name": "myvariable", + "value": "myvalue" + } + ], + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "admin" + } + }, + "maxTaskRetryCount": 2, + "waitForSuccess": true + }, + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ], + "targetNodeCommunicationMode": "default" + } + } + } + }, + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ] + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_DeleteJobSchedule.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_DeleteJobSchedule.json new file mode 100644 index 000000000000..4eb1b3ba028d --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_DeleteJobSchedule.json @@ -0,0 +1,14 @@ +{ + "operationId": "JobSchedules_DeleteJobSchedule", + "title": "JobSchedule delete", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_DisableJobSchedule.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_DisableJobSchedule.json new file mode 100644 index 000000000000..641df039a089 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_DisableJobSchedule.json @@ -0,0 +1,14 @@ +{ + "operationId": "JobSchedules_DisableJobSchedule", + "title": "JobSchedule disable", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "204": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_EnableJobSchedule.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_EnableJobSchedule.json new file mode 100644 index 000000000000..f34cbbb0fc1b --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_EnableJobSchedule.json @@ -0,0 +1,14 @@ +{ + "operationId": "JobSchedules_EnableJobSchedule", + "title": "JobSchedule enable", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "204": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_GetJobSchedule.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_GetJobSchedule.json new file mode 100644 index 000000000000..223be7fe95b6 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_GetJobSchedule.json @@ -0,0 +1,48 @@ +{ + "operationId": "JobSchedules_GetJobSchedule", + "title": "JobSchedule get", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "jobScheduleId", + "url": "https://account.region.batch.azure.com/jobschedules/jobScheduleId", + "eTag": "0x8D40FFD2E848323", + "lastModified": "2016-11-18T21:52:24.7661347Z", + "creationTime": "2016-11-18T21:52:22.5431125Z", + "state": "completed", + "stateTransitionTime": "2016-11-18T21:52:24.8371778Z", + "previousState": "active", + "previousStateTransitionTime": "2016-11-18T21:52:24.0064874Z", + "jobSpecification": { + "priority": 0, + "maxParallelTasks": -1, + "allowTaskPreemption": false, + "usesTaskDependencies": false, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction", + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "testPool" + } + }, + "executionInfo": { + "recentJob": { + "url": "https://account.region.batch.azure.com/jobschedules/jobScheduleId:job-1", + "id": "jobScheduleId:job-1" + }, + "endTime": "2016-11-18T21:52:24.8371778Z" + } + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_JobScheduleExists.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_JobScheduleExists.json new file mode 100644 index 000000000000..00d523f0fe70 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_JobScheduleExists.json @@ -0,0 +1,15 @@ +{ + "operationId": "JobSchedules_JobScheduleExists", + "title": "Check Job Schedule Exists", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": {}, + "404": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_ListJobSchedules.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_ListJobSchedules.json new file mode 100644 index 000000000000..5f873b246975 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_ListJobSchedules.json @@ -0,0 +1,79 @@ +{ + "operationId": "JobSchedules_ListJobSchedules", + "title": "JobSchedule list", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "jobSchedule1", + "url": "https://account.region.batch.azure.com/jobschedules/jobSchedule1", + "eTag": "0x8D40FFD2E10996A", + "lastModified": "2016-11-18T21:52:24.0064874Z", + "creationTime": "2016-11-18T21:52:22.5431125Z", + "state": "active", + "stateTransitionTime": "2016-11-18T21:52:24.0064874Z", + "previousState": "disabled", + "previousStateTransitionTime": "2016-11-18T21:52:23.6471782Z", + "jobSpecification": { + "priority": 0, + "maxParallelTasks": -1, + "allowTaskPreemption": false, + "usesTaskDependencies": false, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction", + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + } + }, + "executionInfo": { + "recentJob": { + "url": "https://account.region.batch.azure.com/jobs/jobSchedule1:job-1", + "id": "jobSchedule1:job-1" + } + } + }, + { + "id": "jobSchedule2", + "url": "https://account.region.batch.azure.com/jobschedules/jobSchedule2", + "eTag": "0x8D40FFCFF760B51", + "lastModified": "2016-11-18T21:51:05.8184017Z", + "creationTime": "2016-11-18T21:51:05.8184017Z", + "state": "active", + "stateTransitionTime": "2016-11-18T21:51:05.8184017Z", + "schedule": { + "doNotRunUntil": "2020-01-01T12:30:00Z" + }, + "jobSpecification": { + "priority": 0, + "maxParallelTasks": -1, + "usesTaskDependencies": false, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction", + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "testPool2" + } + }, + "executionInfo": { + "nextRunTime": "2020-01-01T12:30:00Z" + } + } + ] + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_ReplaceJobSchedule.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_ReplaceJobSchedule.json new file mode 100644 index 000000000000..3625de2dd434 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_ReplaceJobSchedule.json @@ -0,0 +1,30 @@ +{ + "operationId": "JobSchedules_ReplaceJobSchedule", + "title": "JobSchedule patch", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobSchedule": { + "schedule": { + "doNotRunUntil": "2025-01-01T12:30:00Z" + }, + "jobSpecification": { + "priority": 0, + "usesTaskDependencies": false, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + } + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_TerminateJobSchedule.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_TerminateJobSchedule.json new file mode 100644 index 000000000000..ffd2a483d448 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_TerminateJobSchedule.json @@ -0,0 +1,14 @@ +{ + "operationId": "JobSchedules_TerminateJobSchedule", + "title": "JobSchedule terminate", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_UpdateJobSchedule.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_UpdateJobSchedule.json new file mode 100644 index 000000000000..069a43caf6be --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_UpdateJobSchedule.json @@ -0,0 +1,30 @@ +{ + "operationId": "JobSchedules_UpdateJobSchedule", + "title": "JobSchedule update", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobSchedule": { + "schedule": { + "doNotRunUntil": "2025-01-01T12:30:00Z" + }, + "jobSpecification": { + "priority": 0, + "usesTaskDependencies": false, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + } + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobTerminate.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobTerminate.json deleted file mode 100644 index cebd240db243..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobTerminate.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "operationId": "Batch_TerminateJob", - "title": "Job terminate", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "jobTerminateParameter": { - "terminateReason": "User supplied termination reason" - } - }, - "responses": { - "202": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobUpdate.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobUpdate.json deleted file mode 100644 index 7b23d33fa41e..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobUpdate.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "operationId": "Batch_ReplaceJob", - "title": "Job update", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "job": { - "priority": 100, - "constraints": { - "maxWallClockTime": "PT1H", - "maxTaskRetryCount": -1 - }, - "poolInfo": { - "poolId": "poolId" - } - } - }, - "responses": { - "200": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_CreateJob_Basic.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_CreateJob_Basic.json new file mode 100644 index 000000000000..baab498938f8 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_CreateJob_Basic.json @@ -0,0 +1,20 @@ +{ + "operationId": "Jobs_CreateJob", + "title": "Creates a basic job", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "job": { + "id": "jobId", + "priority": 0, + "poolInfo": { + "poolId": "poolId" + } + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_CreateJob_Complex.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_CreateJob_Complex.json new file mode 100644 index 000000000000..e84804756085 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_CreateJob_Complex.json @@ -0,0 +1,118 @@ +{ + "operationId": "Jobs_CreateJob", + "title": "Creates a complex job", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "job": { + "id": "jobId", + "priority": 100, + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": -1 + }, + "jobManagerTask": { + "id": "taskId", + "commandLine": "myprogram.exe", + "resourceFiles": [ + { + "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram.exe?sas", + "filePath": "myprogram.exe" + }, + { + "storageContainerUrl": "http://mystorage1.blob.core.windows.net/data?sas", + "filePath": "datafolder" + } + ], + "environmentSettings": [ + { + "name": "myvariable", + "value": "myvalue" + } + ], + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": 0, + "retentionTime": "PT1H" + }, + "requiredSlots": 2, + "killJobOnCompletion": false, + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "admin" + } + }, + "runExclusive": true + }, + "poolInfo": { + "autoPoolSpecification": { + "autoPoolIdPrefix": "mypool", + "poolLifetimeOption": "job", + "pool": { + "vmSize": "Standard_D1_v2", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.windows amd64" + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 2, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false, + "enableInterNodeCommunication": true, + "startTask": { + "commandLine": "myprogram2.exe", + "resourceFiles": [ + { + "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram2.exe?sas", + "filePath": "myprogram2.exe" + } + ], + "environmentSettings": [ + { + "name": "myvariable", + "value": "myvalue" + } + ], + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "admin" + } + }, + "maxTaskRetryCount": 2, + "waitForSuccess": true + }, + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ], + "targetNodeCommunicationMode": "default" + } + } + }, + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ] + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_DeleteJob.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_DeleteJob.json new file mode 100644 index 000000000000..dc0f8e197ecf --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_DeleteJob.json @@ -0,0 +1,14 @@ +{ + "operationId": "Jobs_DeleteJob", + "title": "Delete Job", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_DisableJob.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_DisableJob.json new file mode 100644 index 000000000000..976ee3ca6169 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_DisableJob.json @@ -0,0 +1,17 @@ +{ + "operationId": "Jobs_DisableJob", + "title": "Job disable", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "content": { + "disableTasks": "terminate" + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_EnableJob.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_EnableJob.json new file mode 100644 index 000000000000..ec972d834143 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_EnableJob.json @@ -0,0 +1,14 @@ +{ + "operationId": "Jobs_EnableJob", + "title": "Job enable", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_GetJob.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_GetJob.json new file mode 100644 index 000000000000..fa59fbe1be5d --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_GetJob.json @@ -0,0 +1,45 @@ +{ + "operationId": "Jobs_GetJob", + "title": "Job get", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "jobId", + "url": "https://account.region.batch.azure.com/jobs/jobId", + "eTag": "0x8D4100FC49F0278", + "lastModified": "2016-11-19T00:05:27.5391608Z", + "creationTime": "2016-11-19T00:05:25.311915Z", + "state": "completed", + "stateTransitionTime": "2016-11-19T00:05:27.578581Z", + "previousState": "active", + "previousStateTransitionTime": "2016-11-19T00:05:27.2137716Z", + "priority": 0, + "maxParallelTasks": -1, + "allowTaskPreemption": false, + "usesTaskDependencies": false, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + }, + "executionInfo": { + "startTime": "2016-11-19T00:05:25.3309105Z", + "endTime": "2016-11-19T00:05:27.578581Z", + "poolId": "poolId", + "terminateReason": "UserTerminate" + }, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction" + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_GetJobTaskCounts.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_GetJobTaskCounts.json new file mode 100644 index 000000000000..70f734727ce2 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_GetJobTaskCounts.json @@ -0,0 +1,31 @@ +{ + "operationId": "Jobs_GetJobTaskCounts", + "title": "Job get task counts", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "taskCounts": { + "active": 5, + "running": 7, + "completed": 4, + "succeeded": 2, + "failed": 2 + }, + "taskSlotCounts": { + "active": 5, + "running": 7, + "completed": 4, + "succeeded": 2, + "failed": 2 + } + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_ListJobPreparationAndReleaseTaskStatus.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_ListJobPreparationAndReleaseTaskStatus.json new file mode 100644 index 000000000000..03e36673a779 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_ListJobPreparationAndReleaseTaskStatus.json @@ -0,0 +1,42 @@ +{ + "operationId": "Jobs_ListJobPreparationAndReleaseTaskStatus", + "title": "Job list preparation and release task status", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "poolId": "poolId", + "nodeId": "tvm-2167304207_1-20140905t174658z", + "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z", + "jobPreparationTaskExecutionInfo": { + "state": "completed", + "startTime": "2015-05-01T10:20:31Z", + "endTime": "2015-05-02T20:12:42Z", + "taskRootDirectory": "tasks/myjob/job-1/myjobpreptask", + "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z/files/tasks/myjob/job-1/myjobpreptask", + "exitCode": 0, + "retryCount": 0 + }, + "jobReleaseTaskExecutionInfo": { + "state": "completed", + "startTime": "2015-05-01T10:20:31Z", + "endTime": "2015-05-02T20:12:42Z", + "taskRootDirectory": "tasks/myjob/job-1/myjobreleasetask", + "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z/files/tasks/myjob/job-1/myjobreleasetask", + "exitCode": 0 + } + } + ], + "odata.nextLink": "https://account.region.batch.azure.com/jobs/myjob/jobpreparationandreleasestatus?$skipToken=tvm-2167304207_1-20140905t174658z&api-version=2024-02-01.19.0" + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_ListJobs.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_ListJobs.json new file mode 100644 index 000000000000..487658237517 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_ListJobs.json @@ -0,0 +1,46 @@ +{ + "operationId": "Jobs_ListJobs", + "title": "Job list", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "jobId", + "url": "https://account.region.batch.azure.com/jobs/jobId", + "eTag": "0x8D4100FC46D5BF4", + "lastModified": "2016-11-19T00:05:27.2137716Z", + "creationTime": "2016-11-19T00:05:25.311915Z", + "state": "active", + "stateTransitionTime": "2016-11-19T00:05:27.2137716Z", + "previousState": "disabled", + "previousStateTransitionTime": "2016-11-19T00:05:26.88777Z", + "priority": 0, + "maxParallelTasks": -1, + "allowTaskPreemption": false, + "usesTaskDependencies": false, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + }, + "executionInfo": { + "startTime": "2016-11-19T00:05:25.3309105Z", + "poolId": "poolId" + }, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction" + } + ] + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_ListJobsFromSchedule.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_ListJobsFromSchedule.json new file mode 100644 index 000000000000..2ba6158c6d78 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_ListJobsFromSchedule.json @@ -0,0 +1,47 @@ +{ + "operationId": "Jobs_ListJobsFromSchedule", + "title": "List Job Under Job Schedule", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "jobId", + "url": "https://account.region.batch.azure.com/jobs/jobId", + "eTag": "0x8D4100FC46D5BF4", + "lastModified": "2016-11-19T00:05:27.2137716Z", + "creationTime": "2016-11-19T00:05:25.311915Z", + "state": "active", + "stateTransitionTime": "2016-11-19T00:05:27.2137716Z", + "previousState": "disabled", + "previousStateTransitionTime": "2016-11-19T00:05:26.88777Z", + "priority": 0, + "maxParallelTasks": -1, + "allowTaskPreemption": false, + "usesTaskDependencies": false, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + }, + "executionInfo": { + "startTime": "2016-11-19T00:05:25.3309105Z", + "poolId": "poolId" + }, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction" + } + ] + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_ReplaceJob.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_ReplaceJob.json new file mode 100644 index 000000000000..e7b75ae8aefd --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_ReplaceJob.json @@ -0,0 +1,24 @@ +{ + "operationId": "Jobs_ReplaceJob", + "title": "Job patch", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "job": { + "priority": 100, + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": -1 + }, + "poolInfo": { + "poolId": "poolId" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_TerminateJob.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_TerminateJob.json new file mode 100644 index 000000000000..2ec4cbd216a1 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_TerminateJob.json @@ -0,0 +1,17 @@ +{ + "operationId": "Jobs_TerminateJob", + "title": "Job terminate", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobTerminateParameter": { + "terminateReason": "User supplied termination reason" + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_UpdateJob.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_UpdateJob.json new file mode 100644 index 000000000000..b1ddadf806fd --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_UpdateJob.json @@ -0,0 +1,24 @@ +{ + "operationId": "Jobs_UpdateJob", + "title": "Job update", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "job": { + "priority": 100, + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": -1 + }, + "poolInfo": { + "poolId": "poolId" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/NodeCreateUser.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/NodeCreateUser.json deleted file mode 100644 index 5c701646c2e9..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/NodeCreateUser.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "operationId": "Batch_CreateNodeUser", - "title": "Node create user", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "nodeId": "tvm-1695681911_1-20161121t182739z", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "user": { - "name": "userName", - "isAdmin": false, - "expiryTime": "2017-08-01T00:00:00Z", - "password": "Password" - } - }, - "responses": { - "201": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/NodeDeleteUser.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/NodeDeleteUser.json deleted file mode 100644 index c1fb80818626..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/NodeDeleteUser.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "operationId": "Batch_DeleteNodeUser", - "title": "Node delete user", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "nodeId": "tvm-1695681911_1-20161121t182739z", - "userName": "userName", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/NodeDisableScheduling.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/NodeDisableScheduling.json deleted file mode 100644 index 3f277f6925b8..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/NodeDisableScheduling.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "operationId": "Batch_DisableNodeScheduling", - "title": "Node disable scheduling", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "nodeId": "tvm-1695681911_1-20161122t193202z", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "nodeDisableSchedulingParameter": { - "nodeDisableSchedulingOption": "terminate" - } - }, - "responses": { - "200": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/NodeEnableScheduling.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/NodeEnableScheduling.json deleted file mode 100644 index ae2ad5159151..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/NodeEnableScheduling.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "operationId": "Batch_EnableNodeScheduling", - "title": "Node enable scheduling", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "nodeId": "tvm-1695681911_1-20161122t193202z", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/NodeGetRemoteLoginSettings.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/NodeGetRemoteLoginSettings.json deleted file mode 100644 index 19c212fc2c4b..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/NodeGetRemoteLoginSettings.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "operationId": "Batch_GetNodeRemoteLoginSettings", - "title": "Node get remote login settings", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "nodeId": "tvm-1695681911_1-20161121t182739z", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "remoteLoginIPAddress": "1.1.1.1", - "remoteLoginPort": 50000 - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/NodeGet_Basic.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/NodeGet_Basic.json deleted file mode 100644 index 524ccd210fef..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/NodeGet_Basic.json +++ /dev/null @@ -1,54 +0,0 @@ -{ - "operationId": "Batch_GetNode", - "title": "Node get", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "poolId": "poolId", - "nodeId": "tvm-1695681911_2-20161122t193202z", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "id": "tvm-1695681911_2-20161122t193202z", - "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z", - "state": "idle", - "schedulingState": "enabled", - "stateTransitionTime": "2016-11-22T19:37:31.4285526Z", - "lastBootTime": "2016-11-22T19:37:28.623369Z", - "allocationTime": "2016-11-22T19:32:02.8155319Z", - "ipAddress": "1.1.1.1", - "affinityId": "TVM:tvm-1695681911_2-20161122t193202z", - "vmSize": "small", - "totalTasksRun": 0, - "totalTasksSucceeded": 0, - "runningTasksCount": 0, - "isDedicated": true, - "startTask": { - "commandLine": "cmd /c echo hello", - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "nonadmin" - } - }, - "maxTaskRetryCount": 0, - "waitForSuccess": false - }, - "startTaskInfo": { - "state": "completed", - "startTime": "2016-11-22T19:37:31.4285526Z", - "endTime": "2016-11-22T19:37:31.838028Z", - "exitCode": 0, - "retryCount": 0 - }, - "nodeAgentInfo": { - "version": "1.2.0.0", - "lastUpdateTime": "2016-11-22T19:37:28.623369Z" - } - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/NodeList.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/NodeList.json deleted file mode 100644 index ca850f66805e..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/NodeList.json +++ /dev/null @@ -1,136 +0,0 @@ -{ - "operationId": "Batch_ListNodes", - "title": "Node list", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "tvm-1695681911_1-20161122t193202z", - "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z", - "state": "idle", - "schedulingState": "enabled", - "stateTransitionTime": "2016-11-22T22:22:27.2236818Z", - "lastBootTime": "2016-11-22T22:22:24.4634125Z", - "allocationTime": "2016-11-22T19:32:02.8155319Z", - "ipAddress": "1.1.1.1", - "affinityId": "TVM:tvm-1695681911_1-20161122t193202z", - "vmSize": "small", - "totalTasksRun": 0, - "totalTasksSucceeded": 0, - "runningTasksCount": 0, - "runningTaskSlotsCount": 0, - "isDedicated": true, - "startTask": { - "commandLine": "cmd /c echo hello", - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "nonadmin" - } - }, - "maxTaskRetryCount": 0, - "waitForSuccess": false - }, - "startTaskInfo": { - "state": "completed", - "startTime": "2016-11-22T22:22:27.2236818Z", - "endTime": "2016-11-22T22:22:27.567189Z", - "exitCode": 0, - "retryCount": 0 - }, - "nodeAgentInfo": { - "version": "1.2.0.0", - "lastUpdateTime": "2016-11-22T22:22:24.4634125Z" - } - }, - { - "id": "tvm-1695681911_2-20161122t193202z", - "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z", - "state": "idle", - "schedulingState": "enabled", - "stateTransitionTime": "2016-11-22T19:37:31.4285526Z", - "lastBootTime": "2016-11-22T19:37:28.623369Z", - "allocationTime": "2016-11-22T19:32:02.8155319Z", - "ipAddress": "1.1.1.1", - "affinityId": "TVM:tvm-1695681911_2-20161122t193202z", - "vmSize": "small", - "totalTasksRun": 0, - "totalTasksSucceeded": 0, - "runningTasksCount": 0, - "runningTaskSlotsCount": 0, - "isDedicated": true, - "startTask": { - "commandLine": "cmd /c echo hello", - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "nonadmin" - } - }, - "maxTaskRetryCount": 0, - "waitForSuccess": false - }, - "startTaskInfo": { - "state": "completed", - "startTime": "2016-11-22T19:37:31.4285526Z", - "endTime": "2016-11-22T19:37:31.838028Z", - "exitCode": 0, - "retryCount": 0 - }, - "nodeAgentInfo": { - "version": "1.2.0.0", - "lastUpdateTime": "2016-11-22T22:22:24.4634125Z" - } - }, - { - "id": "tvm-1695681911_3-20161122t193202z", - "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_3-20161122t193202z", - "state": "idle", - "schedulingState": "enabled", - "stateTransitionTime": "2016-11-22T19:36:51.0013378Z", - "lastBootTime": "2016-11-22T19:36:48.21721Z", - "allocationTime": "2016-11-22T19:32:02.8155319Z", - "ipAddress": "1.1.1.1", - "affinityId": "TVM:tvm-1695681911_3-20161122t193202z", - "vmSize": "small", - "totalTasksRun": 0, - "totalTasksSucceeded": 0, - "runningTasksCount": 0, - "runningTaskSlotsCount": 0, - "isDedicated": true, - "startTask": { - "commandLine": "cmd /c echo hello", - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "nonadmin" - } - }, - "maxTaskRetryCount": 0, - "waitForSuccess": false - }, - "startTaskInfo": { - "state": "completed", - "startTime": "2016-11-22T19:36:51.0013378Z", - "endTime": "2016-11-22T19:36:51.2363447Z", - "exitCode": 0, - "retryCount": 0 - }, - "nodeAgentInfo": { - "version": "1.2.0.0", - "lastUpdateTime": "2016-11-22T22:22:24.4634125Z" - } - } - ] - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/NodeReboot.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/NodeReboot.json deleted file mode 100644 index ef88d7ea7515..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/NodeReboot.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "operationId": "Batch_RebootNode", - "title": "Node reboot", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "nodeId": "tvm-1695681911_1-20161122t193202z", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "nodeRebootParameter": { - "nodeRebootOption": "terminate" - } - }, - "responses": { - "202": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/NodeUpdateUser.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/NodeUpdateUser.json deleted file mode 100644 index e6f9be65b381..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/NodeUpdateUser.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "operationId": "Batch_ReplaceNodeUser", - "title": "Node update user", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "nodeId": "tvm-1695681911_1-20161121t182739z", - "userName": "userName", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "content": { - "password": "12345", - "expiryTime": "2016-11-27T00:45:48.7320857Z" - } - }, - "responses": { - "200": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/NodeUploadBatchServiceLogs.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/NodeUploadBatchServiceLogs.json deleted file mode 100644 index 3bc55e1ca6e9..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/NodeUploadBatchServiceLogs.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "operationId": "Batch_UploadNodeLogs", - "title": "Upload BatchService Logs", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "nodeId": "tvm-1695681911_1-20161121t182739z", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "content": { - "containerUrl": "https://somestorageacct.blob.core.windows.net/batch-compute-node-logs?se=2017-12-09T18%3A51%3A00Z&sp=w&sv=2016-05-31&sr=c&sig", - "startTime": "2017-11-27T00:00:00Z" - } - }, - "responses": { - "200": { - "body": { - "virtualDirectoryName": "poolId/tvm-1695681911-1-20161121t182739z/0795539d-82fe-48e3-bbff-2964905b6de0", - "numberOfFilesUploaded": 8 - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_CreateNodeUser.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_CreateNodeUser.json new file mode 100644 index 000000000000..1f3232520cd9 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_CreateNodeUser.json @@ -0,0 +1,21 @@ +{ + "operationId": "Nodes_CreateNodeUser", + "title": "Node create user", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "user": { + "name": "userName", + "isAdmin": false, + "expiryTime": "2017-08-01T00:00:00Z", + "password": "Password" + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_DeleteNodeFile.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_DeleteNodeFile.json new file mode 100644 index 000000000000..ed146c43d47b --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_DeleteNodeFile.json @@ -0,0 +1,17 @@ +{ + "operationId": "Nodes_DeleteNodeFile", + "title": "File delete from node", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "recursive": false + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_DeleteNodeUser.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_DeleteNodeUser.json new file mode 100644 index 000000000000..999f12cc26e8 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_DeleteNodeUser.json @@ -0,0 +1,16 @@ +{ + "operationId": "Nodes_DeleteNodeUser", + "title": "Node delete user", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "userName": "userName", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_DisableNodeScheduling.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_DisableNodeScheduling.json new file mode 100644 index 000000000000..c62df5ec29e8 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_DisableNodeScheduling.json @@ -0,0 +1,18 @@ +{ + "operationId": "Nodes_DisableNodeScheduling", + "title": "Node disable scheduling", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "nodeDisableSchedulingParameter": { + "nodeDisableSchedulingOption": "terminate" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_EnableNodeScheduling.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_EnableNodeScheduling.json new file mode 100644 index 000000000000..f64ddacbb438 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_EnableNodeScheduling.json @@ -0,0 +1,15 @@ +{ + "operationId": "Nodes_EnableNodeScheduling", + "title": "Node enable scheduling", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_GetNode.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_GetNode.json new file mode 100644 index 000000000000..e4f594070200 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_GetNode.json @@ -0,0 +1,54 @@ +{ + "operationId": "Nodes_GetNode", + "title": "Node get", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "poolId": "poolId", + "nodeId": "tvm-1695681911_2-20161122t193202z", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "tvm-1695681911_2-20161122t193202z", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z", + "state": "idle", + "schedulingState": "enabled", + "stateTransitionTime": "2016-11-22T19:37:31.4285526Z", + "lastBootTime": "2016-11-22T19:37:28.623369Z", + "allocationTime": "2016-11-22T19:32:02.8155319Z", + "ipAddress": "1.1.1.1", + "affinityId": "TVM:tvm-1695681911_2-20161122t193202z", + "vmSize": "small", + "totalTasksRun": 0, + "totalTasksSucceeded": 0, + "runningTasksCount": 0, + "isDedicated": true, + "startTask": { + "commandLine": "cmd /c echo hello", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "startTaskInfo": { + "state": "completed", + "startTime": "2016-11-22T19:37:31.4285526Z", + "endTime": "2016-11-22T19:37:31.838028Z", + "exitCode": 0, + "retryCount": 0 + }, + "nodeAgentInfo": { + "version": "1.2.0.0", + "lastUpdateTime": "2016-11-22T19:37:28.623369Z" + } + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_GetNodeExtension.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_GetNodeExtension.json new file mode 100644 index 000000000000..6504539dc06b --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_GetNodeExtension.json @@ -0,0 +1,37 @@ +{ + "operationId": "Nodes_GetNodeExtension", + "title": "Get batch node extension", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "poolId": "poolId", + "nodeId": "tvm-1695681911_2-20161122t193202z", + "extensionName": "batchNodeExtension", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "instanceView": { + "name": "batchNodeExtension", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": "Enable succeeded: Enabling and starting agent and controller" + } + ] + }, + "vmExtension": { + "name": "batchNodeExtension", + "publisher": "Microsoft.Azure.Extensions", + "type": "CustomScript", + "typeHandlerVersion": "2.0", + "autoUpgradeMinorVersion": true + } + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_GetNodeFile.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_GetNodeFile.json new file mode 100644 index 000000000000..c7198ff8d4ed --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_GetNodeFile.json @@ -0,0 +1,23 @@ +{ + "operationId": "Nodes_GetNodeFile", + "title": "Get File From Compute Node", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "nodeId": "nodeId", + "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", + "ocp-batch-file-isdirectory": "false", + "Content-Length": "17", + "Content-Type": "application/octet-stream", + "body": "This is actually a byte stream. This request/response is being presented as a string for readability in the example" + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_GetNodeFileProperties.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_GetNodeFileProperties.json new file mode 100644 index 000000000000..90073c586af3 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_GetNodeFileProperties.json @@ -0,0 +1,22 @@ +{ + "operationId": "Nodes_GetNodeFileProperties", + "title": "File get properties from node", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "nodeId": "nodeId", + "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", + "ocp-batch-file-isdirectory": "false", + "Content-Length": "17", + "Content-Type": "application/octet-stream" + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_GetNodeRemoteLoginSettings.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_GetNodeRemoteLoginSettings.json new file mode 100644 index 000000000000..b26c660050ab --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_GetNodeRemoteLoginSettings.json @@ -0,0 +1,20 @@ +{ + "operationId": "Nodes_GetNodeRemoteLoginSettings", + "title": "Node get remote login settings", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "remoteLoginIPAddress": "1.1.1.1", + "remoteLoginPort": 50000 + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_ListNodeExtensions.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_ListNodeExtensions.json new file mode 100644 index 000000000000..aa7faefe4938 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_ListNodeExtensions.json @@ -0,0 +1,61 @@ +{ + "operationId": "Nodes_ListNodeExtensions", + "title": "List compute node extensions", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_2-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "instanceView": { + "name": "batchNodeExtension", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": "Enable succeeded: Enabling and starting agent and controller" + } + ] + }, + "vmExtension": { + "name": "batchNodeExtension", + "publisher": "Microsoft.Azure.Extensions", + "type": "CustomScript", + "typeHandlerVersion": "2.0", + "autoUpgradeMinorVersion": true + } + }, + { + "instanceView": { + "name": "customExtension", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": "ExtensionOperation:enable. Status:Success" + } + ] + }, + "vmExtension": { + "name": "customExtension", + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true + } + } + ] + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_ListNodeFiles.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_ListNodeFiles.json new file mode 100644 index 000000000000..164111ec8a3d --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_ListNodeFiles.json @@ -0,0 +1,48 @@ +{ + "operationId": "Nodes_ListNodeFiles", + "title": "File list from node", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "recursive": false + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "shared", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/shared", + "isDirectory": true + }, + { + "name": "startup\\ProcessEnv.cmd", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/startup\\ProcessEnv.cmd", + "isDirectory": false, + "properties": { + "creationTime": "2014-09-19T21:56:17.679195Z", + "lastModified": "2014-09-19T21:56:17.679195Z", + "contentLength": "1813", + "contentType": "application/octet-stream" + } + }, + { + "name": "startup\\stderr.txt", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/startup\\stderr.txt", + "isDirectory": false, + "properties": { + "creationTime": "2014-09-19T21:56:17.5590855Z", + "lastModified": "2014-09-19T21:56:17.5590855Z", + "contentLength": "0", + "contentType": "application/octet-stream" + } + } + ] + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_ListNodes.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_ListNodes.json new file mode 100644 index 000000000000..6c3fd0244810 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_ListNodes.json @@ -0,0 +1,136 @@ +{ + "operationId": "Nodes_ListNodes", + "title": "Node list", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "tvm-1695681911_1-20161122t193202z", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z", + "state": "idle", + "schedulingState": "enabled", + "stateTransitionTime": "2016-11-22T22:22:27.2236818Z", + "lastBootTime": "2016-11-22T22:22:24.4634125Z", + "allocationTime": "2016-11-22T19:32:02.8155319Z", + "ipAddress": "1.1.1.1", + "affinityId": "TVM:tvm-1695681911_1-20161122t193202z", + "vmSize": "small", + "totalTasksRun": 0, + "totalTasksSucceeded": 0, + "runningTasksCount": 0, + "runningTaskSlotsCount": 0, + "isDedicated": true, + "startTask": { + "commandLine": "cmd /c echo hello", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "startTaskInfo": { + "state": "completed", + "startTime": "2016-11-22T22:22:27.2236818Z", + "endTime": "2016-11-22T22:22:27.567189Z", + "exitCode": 0, + "retryCount": 0 + }, + "nodeAgentInfo": { + "version": "1.2.0.0", + "lastUpdateTime": "2016-11-22T22:22:24.4634125Z" + } + }, + { + "id": "tvm-1695681911_2-20161122t193202z", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z", + "state": "idle", + "schedulingState": "enabled", + "stateTransitionTime": "2016-11-22T19:37:31.4285526Z", + "lastBootTime": "2016-11-22T19:37:28.623369Z", + "allocationTime": "2016-11-22T19:32:02.8155319Z", + "ipAddress": "1.1.1.1", + "affinityId": "TVM:tvm-1695681911_2-20161122t193202z", + "vmSize": "small", + "totalTasksRun": 0, + "totalTasksSucceeded": 0, + "runningTasksCount": 0, + "runningTaskSlotsCount": 0, + "isDedicated": true, + "startTask": { + "commandLine": "cmd /c echo hello", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "startTaskInfo": { + "state": "completed", + "startTime": "2016-11-22T19:37:31.4285526Z", + "endTime": "2016-11-22T19:37:31.838028Z", + "exitCode": 0, + "retryCount": 0 + }, + "nodeAgentInfo": { + "version": "1.2.0.0", + "lastUpdateTime": "2016-11-22T22:22:24.4634125Z" + } + }, + { + "id": "tvm-1695681911_3-20161122t193202z", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_3-20161122t193202z", + "state": "idle", + "schedulingState": "enabled", + "stateTransitionTime": "2016-11-22T19:36:51.0013378Z", + "lastBootTime": "2016-11-22T19:36:48.21721Z", + "allocationTime": "2016-11-22T19:32:02.8155319Z", + "ipAddress": "1.1.1.1", + "affinityId": "TVM:tvm-1695681911_3-20161122t193202z", + "vmSize": "small", + "totalTasksRun": 0, + "totalTasksSucceeded": 0, + "runningTasksCount": 0, + "runningTaskSlotsCount": 0, + "isDedicated": true, + "startTask": { + "commandLine": "cmd /c echo hello", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "startTaskInfo": { + "state": "completed", + "startTime": "2016-11-22T19:36:51.0013378Z", + "endTime": "2016-11-22T19:36:51.2363447Z", + "exitCode": 0, + "retryCount": 0 + }, + "nodeAgentInfo": { + "version": "1.2.0.0", + "lastUpdateTime": "2016-11-22T22:22:24.4634125Z" + } + } + ] + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_RebootNode.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_RebootNode.json new file mode 100644 index 000000000000..d828bf48908d --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_RebootNode.json @@ -0,0 +1,18 @@ +{ + "operationId": "Nodes_RebootNode", + "title": "Node reboot", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "nodeRebootParameter": { + "nodeRebootOption": "terminate" + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_ReplaceNodeUser.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_ReplaceNodeUser.json new file mode 100644 index 000000000000..7408e05d475b --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_ReplaceNodeUser.json @@ -0,0 +1,20 @@ +{ + "operationId": "Nodes_ReplaceNodeUser", + "title": "Node update user", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "userName": "userName", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "content": { + "password": "12345", + "expiryTime": "2016-11-27T00:45:48.7320857Z" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_UploadNodeLogs.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_UploadNodeLogs.json new file mode 100644 index 000000000000..ac111761c050 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_UploadNodeLogs.json @@ -0,0 +1,24 @@ +{ + "operationId": "Nodes_UploadNodeLogs", + "title": "Upload BatchService Logs", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "content": { + "containerUrl": "https://somestorageacct.blob.core.windows.net/batch-compute-node-logs?se=2017-12-09T18%3A51%3A00Z&sp=w&sv=2016-05-31&sr=c&sig", + "startTime": "2017-11-27T00:00:00Z" + } + }, + "responses": { + "200": { + "body": { + "virtualDirectoryName": "poolId/tvm-1695681911-1-20161121t182739z/0795539d-82fe-48e3-bbff-2964905b6de0", + "numberOfFilesUploaded": 8 + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolCreate_AcceleratedNetworking.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolCreate_AcceleratedNetworking.json deleted file mode 100644 index e0c1107c6b59..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolCreate_AcceleratedNetworking.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "operationId": "Batch_CreatePool", - "title": "Creates a pool with accelerated networking", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Thu, 27 Apr 2023 05:31:01 GMT", - "pool": { - "id": "mypool01", - "vmSize": "Standard_D1_v2", - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "MicrosoftWindowsServer", - "offer": "WindowsServer", - "sku": "2016-datacenter-smalldisk", - "version": "latest" - }, - "nodeAgentSKUId": "batch.node.windows amd64" - }, - "targetDedicatedNodes": 2, - "networkConfiguration": { - "enableAcceleratedNetworking": true - } - } - }, - "responses": { - "201": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolCreate_MountConfiguration.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolCreate_MountConfiguration.json deleted file mode 100644 index 25605e105834..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolCreate_MountConfiguration.json +++ /dev/null @@ -1,72 +0,0 @@ -{ - "operationId": "Batch_CreatePool", - "title": "Creates a pool with mount drive specified", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-data": "Fri, 17 Feb 2017 00:00:00 GMT", - "pool": { - "id": "pool2", - "vmSize": "standard_a1", - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "UbuntuServer", - "sku": "20_04-lts" - }, - "nodeAgentSKUId": "batch.node.ubuntu 20.04" - }, - "mountConfiguration": [ - { - "azureBlobFileSystemConfiguration": { - "accountName": "accountName", - "containerName": "blobContainerName", - "accountKey": "accountKey", - "relativeMountPath": "bfusepath" - } - }, - { - "azureFileShareConfiguration": { - "accountName": "accountName", - "azureFileUrl": "https://myaccount.file.core.windows.net/fileshare", - "accountKey": "accountKey", - "relativeMountPath": "filesharepath", - "mountOptions": "mount options ver=1.0" - } - }, - { - "nfsMountConfiguration": { - "source": "somesource nfs url", - "relativeMountPath": "mountpath", - "mountOptions": "mount options ver=1.0" - } - }, - { - "cifsMountConfiguration": { - "username": "accountName", - "password": "password", - "source": "//myaccount.file.core.windows.net/file", - "relativeMountPath": "mountpath", - "mountOptions": "mount options ver=1.0" - } - } - ], - "resizeTimeout": "PT15M", - "targetDedicatedNodes": 5, - "targetLowPriorityNodes": 0, - "taskSlotsPerNode": 3, - "taskSchedulingPolicy": { - "nodeFillType": "spread" - }, - "enableAutoScale": false - } - }, - "responses": { - "201": { - "request-id": "00000000-0000-0000-0000-000000000000", - "ETag": "0x8D45765A6A2DC04", - "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolCreate_OSDisk.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolCreate_OSDisk.json deleted file mode 100644 index 39d35892a8b7..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolCreate_OSDisk.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "operationId": "Batch_CreatePool", - "title": "Creates a VirtualMachineConfiguration pool with OS disk", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Wed, 23 Aug 2023 08:40:02 GMT", - "pool": { - "id": "mypool001", - "vmSize": "standard_d2s_v3", - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "0001-com-ubuntu-server-focal", - "sku": "20_04-lts" - }, - "osDisk": { - "diskSizeGB": 100, - "managedDisk": { - "storageAccountType": "standardssd_lrs" - }, - "caching": "readwrite", - "ephemeralOSDiskSettings": { - "placement": "cachedisk" - } - }, - "nodeAgentSKUId": "batch.node.ubuntu 20.04" - }, - "resizeTimeout": "PT15M", - "targetDedicatedNodes": 1, - "targetLowPriorityNodes": 0, - "taskSlotsPerNode": 1, - "enableAutoScale": false - } - }, - "responses": { - "201": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolCreate_ResourceTags.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolCreate_ResourceTags.json deleted file mode 100644 index 8ad7d85da214..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolCreate_ResourceTags.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "operationId": "Batch_CreatePool", - "title": "Creates a simple pool with resourceTags", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Wed, 14 Jun 2023 06:39:01 GMT", - "pool": { - "id": "mypool001", - "vmSize": "STANDARD_DC2s_V2", - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "UbuntuServer", - "sku": "18_04-lts-gen2", - "version": "latest" - }, - "nodeAgentSKUId": "batch.node.ubuntu 18.04" - }, - "targetDedicatedNodes": 1, - "resourceTags": { - "TagName1": "TagValue1", - "TagName2": "TagValue2" - } - } - }, - "responses": { - "201": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolCreate_SecurityProfile.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolCreate_SecurityProfile.json deleted file mode 100644 index f73991adc790..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolCreate_SecurityProfile.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "operationId": "Batch_CreatePool", - "title": "Creates a pool with SecurityProfile", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Wed, 14 Jun 2023 06:39:01 GMT", - "pool": { - "id": "mypool001", - "vmSize": "STANDARD_DC2s_V2", - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "UbuntuServer", - "sku": "18_04-lts-gen2", - "version": "latest" - }, - "nodeAgentSKUId": "batch.node.ubuntu 18.04", - "securityProfile": { - "securityType": "trustedLaunch", - "encryptionAtHost": true, - "uefiSettings": { - "secureBootEnabled": false, - "vTpmEnabled": null - } - } - }, - "targetDedicatedNodes": 1 - } - }, - "responses": { - "201": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolCreate_VirtualMachineConfiguration.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolCreate_VirtualMachineConfiguration.json deleted file mode 100644 index 122ee465e422..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolCreate_VirtualMachineConfiguration.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "operationId": "Batch_CreatePool", - "title": "Creates a VirtualMachineConfiguration pool", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "pool": { - "id": "pool2", - "vmSize": "standard_a1", - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "0001-com-ubuntu-server-focal", - "sku": "20_04-lts" - }, - "nodeAgentSKUId": "batch.node.ubuntu 20.04" - }, - "resizeTimeout": "PT15M", - "targetDedicatedNodes": 5, - "targetLowPriorityNodes": 0, - "taskSlotsPerNode": 3, - "taskSchedulingPolicy": { - "nodeFillType": "spread" - }, - "enableAutoScale": false, - "enableInterNodeCommunication": true, - "metadata": [ - { - "name": "myproperty", - "value": "myvalue" - } - ] - } - }, - "responses": { - "201": { - "request-id": "00000000-0000-0000-0000-000000000000", - "ETag": "0x8D45765A6A2DC04", - "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolCreate_VirtualMachineConfigurationWithContainers.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolCreate_VirtualMachineConfigurationWithContainers.json deleted file mode 100644 index 8cb6d94a1988..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolCreate_VirtualMachineConfigurationWithContainers.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "operationId": "Batch_CreatePool", - "title": "Creates a VirtualMachineConfiguration pool with containers", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "pool": { - "id": "pool2", - "vmSize": "standard_a1", - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "0001-com-ubuntu-server-focal", - "sku": "120_04-lts" - }, - "nodeAgentSKUId": "batch.node.ubuntu 20.04", - "containerConfiguration": { - "type": "dockerCompatible", - "containerImageNames": [ - "busybox" - ] - } - }, - "resizeTimeout": "PT15M", - "targetDedicatedNodes": 5, - "targetLowPriorityNodes": 0, - "taskSlotsPerNode": 3, - "taskSchedulingPolicy": { - "nodeFillType": "spread" - }, - "enableAutoScale": false - } - }, - "responses": { - "201": { - "request-id": "00000000-0000-0000-0000-000000000000", - "ETag": "0x8D45765A6A2DC04", - "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolCreate_VirtualMachineConfigurationWithExtensions.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolCreate_VirtualMachineConfigurationWithExtensions.json deleted file mode 100644 index 7b4e76b3e190..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolCreate_VirtualMachineConfigurationWithExtensions.json +++ /dev/null @@ -1,59 +0,0 @@ -{ - "operationId": "Batch_CreatePool", - "title": "Creates a VirtualMachineConfiguration pool with extensions", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "pool": { - "id": "pool2", - "vmSize": "standard_a1", - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "0001-com-ubuntu-server-focal", - "sku": "20_04-lts" - }, - "nodeAgentSKUId": "batch.node.ubuntu 20.04", - "extensions": [ - { - "name": "batchextension1", - "type": "KeyVaultForLinux", - "publisher": "Microsoft.Azure.KeyVault", - "typeHandlerVersion": "2.0", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": { - "secretsManagementSettingsKey": "secretsManagementSettingsValue", - "authenticationSettingsKey": "authenticationSettingsValue" - } - } - ] - }, - "resizeTimeout": "PT15M", - "targetDedicatedNodes": 5, - "targetLowPriorityNodes": 0, - "taskSlotsPerNode": 3, - "taskSchedulingPolicy": { - "nodeFillType": "spread" - }, - "enableAutoScale": false, - "enableInterNodeCommunication": true, - "metadata": [ - { - "name": "myproperty", - "value": "myvalue" - } - ], - "targetNodeCommunicationMode": "simplified" - } - }, - "responses": { - "201": { - "request-id": "00000000-0000-0000-0000-000000000000", - "ETag": "0x8D45765A6A2DC04", - "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolCreate_VirtualMachineConfigurationWithServiceArtifactReference.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolCreate_VirtualMachineConfigurationWithServiceArtifactReference.json deleted file mode 100644 index e69d99c87eaa..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolCreate_VirtualMachineConfigurationWithServiceArtifactReference.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "operationId": "Batch_CreatePool", - "title": "Creates a VirtualMachineConfiguration pool with ServiceArtifactReference", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Thu, 11 May 2023 08:03:01 GMT", - "pool": { - "id": "mypool002", - "vmSize": "Standard_A1_v2", - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "MicrosoftWindowsServer", - "offer": "WindowsServer", - "sku": "2016-datacenter-smalldisk", - "version": "latest" - }, - "windowsConfiguration": { - "enableAutomaticUpdates": false - }, - "serviceArtifactReference": { - "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile" - }, - "nodeAgentSKUId": "batch.node.windows amd64" - }, - "targetDedicatedNodes": 2 - } - }, - "responses": { - "201": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolDelete.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolDelete.json deleted file mode 100644 index 884f8b3d2c8f..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolDelete.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "operationId": "Batch_DeletePool", - "title": "Pool delete", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "202": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolDisableAutoScale.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolDisableAutoScale.json deleted file mode 100644 index 9d5593339c6e..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolDisableAutoScale.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "operationId": "Batch_DisablePoolAutoScale", - "title": "Disable pool autoscale", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolEnableAutoscale.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolEnableAutoscale.json deleted file mode 100644 index 942a0ec50306..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolEnableAutoscale.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "operationId": "Batch_EnablePoolAutoScale", - "title": "Pool enable autoscale", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "content": { - "autoScaleFormula": "$TargetDedicated=0", - "autoScaleEvaluationInterval": "PT8M" - } - }, - "responses": { - "200": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolEvaluateAutoscale.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolEvaluateAutoscale.json deleted file mode 100644 index dd8d13fab35c..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolEvaluateAutoscale.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "operationId": "Batch_EvaluatePoolAutoScale", - "title": "Pool evaluate autoscale", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "content": { - "autoScaleFormula": "$TargetDedicated=1" - } - }, - "responses": { - "200": { - "body": { - "timestamp": "2016-11-22T19:39:28.5246331Z", - "results": "$TargetDedicated=1;$NodeDeallocationOption=requeue" - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolExists.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolExists.json deleted file mode 100644 index 4487a33b8a45..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolExists.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "operationId": "Batch_PoolExists", - "title": "Check Pool Exists", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": {}, - "404": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolGet_AcceleratedNetworking.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolGet_AcceleratedNetworking.json deleted file mode 100644 index 0521b88bec1b..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolGet_AcceleratedNetworking.json +++ /dev/null @@ -1,52 +0,0 @@ -{ - "operationId": "Batch_GetPool", - "title": "Get a pool with AcceleratedNetworking", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "pool", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 28 Apr 2023 02:43:01 GMT" - }, - "responses": { - "200": { - "body": { - "id": "pool", - "url": "https://account.region.batch.azure.com/pools/pool", - "eTag": "0x8DB4792BE8566A2", - "lastModified": "2023-04-28T02:46:19.0268066Z", - "creationTime": "2023-04-28T02:46:19.0268066Z", - "state": "active", - "stateTransitionTime": "2023-04-28T02:46:19.0268066Z", - "allocationState": "steady", - "allocationStateTransitionTime": "2023-04-28T02:47:17.9169655Z", - "vmSize": "standard_d1_v2", - "resizeTimeout": "PT15M", - "currentDedicatedNodes": 2, - "targetDedicatedNodes": 2, - "currentLowPriorityNodes": 0, - "targetLowPriorityNodes": 0, - "enableAutoScale": false, - "enableInterNodeCommunication": false, - "taskSlotsPerNode": 1, - "taskSchedulingPolicy": { - "nodeFillType": "spread" - }, - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "MicrosoftWindowsServer", - "offer": "WindowsServer", - "sku": "2016-datacenter-smalldisk", - "version": "latest" - }, - "nodeAgentSKUId": "batch.node.windows amd64" - }, - "networkConfiguration": { - "dynamicVNetAssignmentScope": "none", - "enableAcceleratedNetworking": true - }, - "currentNodeCommunicationMode": "classic" - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolGet_Basic.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolGet_Basic.json deleted file mode 100644 index b5eabfe3d4f9..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolGet_Basic.json +++ /dev/null @@ -1,58 +0,0 @@ -{ - "operationId": "Batch_GetPool", - "title": "Pool get", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "pool", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "id": "pool", - "url": "https://account.region.batch.azure.com/pools/pool", - "eTag": "0x8D413091E739A56", - "lastModified": "2016-11-22T18:55:25.2608598Z", - "creationTime": "2016-11-22T18:55:24.2632496Z", - "state": "active", - "stateTransitionTime": "2016-11-22T18:55:24.2632496Z", - "allocationState": "steady", - "allocationStateTransitionTime": "2016-11-22T18:55:24.8154041Z", - "vmSize": "standard_a1", - "resizeTimeout": "PT15M", - "currentDedicatedNodes": 0, - "currentLowPriorityNodes": 0, - "targetDedicatedNodes": 0, - "targetLowPriorityNodes": 0, - "enableAutoScale": false, - "enableInterNodeCommunication": false, - "startTask": { - "commandLine": "/bin/bash -c 'echo start task'", - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "nonadmin" - } - }, - "maxTaskRetryCount": 0, - "waitForSuccess": false - }, - "taskSlotsPerNode": 1, - "taskSchedulingPolicy": { - "nodeFillType": "spread" - }, - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "0001-com-ubuntu-server-focal", - "sku": "20_04-lts", - "version": "latest" - }, - "nodeAgentSKUId": "batch.node.ubuntu 20.04" - } - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolGet_SecurityProfile.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolGet_SecurityProfile.json deleted file mode 100644 index 2b27085e3ec0..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolGet_SecurityProfile.json +++ /dev/null @@ -1,55 +0,0 @@ -{ - "operationId": "Batch_GetPool", - "title": "Get a VirtualMachineConfiguration pool with SecurityProfile", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "mypool001", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Wed, 14 Jun 2023 06:39:01 GMT" - }, - "responses": { - "200": { - "body": { - "id": "mypool001", - "url": "https://account.region.batch.azure.com/pools/pool", - "eTag": "0x8DB6CA2DFF530D1", - "lastModified": "2023-06-14T06:45:00.0946897Z", - "creationTime": "2023-06-14T06:45:00.0946897Z", - "state": "active", - "stateTransitionTime": "2023-06-14T06:45:00.0946897Z", - "allocationState": "steady", - "allocationStateTransitionTime": "2023-06-14T06:45:59.4770341Z", - "vmSize": "standard_dc2s_v2", - "resizeTimeout": "PT15M", - "currentDedicatedNodes": 1, - "targetDedicatedNodes": 1, - "currentLowPriorityNodes": 0, - "targetLowPriorityNodes": 0, - "enableAutoScale": false, - "enableInterNodeCommunication": false, - "taskSlotsPerNode": 1, - "taskSchedulingPolicy": { - "nodeFillType": "spread" - }, - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "UbuntuServer", - "sku": "18_04-lts-gen2", - "version": "latest" - }, - "nodeAgentSKUId": "batch.node.ubuntu 18.04", - "securityProfile": { - "securityType": "trustedLaunch", - "encryptionAtHost": true, - "uefiSettings": { - "secureBootEnabled": false - } - } - }, - "currentNodeCommunicationMode": "classic" - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolGet_VirtualMachineConfigurationWithExtensions.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolGet_VirtualMachineConfigurationWithExtensions.json deleted file mode 100644 index a4ee35317597..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolGet_VirtualMachineConfigurationWithExtensions.json +++ /dev/null @@ -1,74 +0,0 @@ -{ - "operationId": "Batch_GetPool", - "title": "Get a VirtualMachineConfiguration pool with extensions", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "pool", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "id": "pool", - "url": "https://account.region.batch.azure.com/pools/pool", - "eTag": "0x8D413091E739A56", - "lastModified": "2016-11-22T18:55:25.2608598Z", - "creationTime": "2016-11-22T18:55:24.2632496Z", - "state": "active", - "stateTransitionTime": "2016-11-22T18:55:24.2632496Z", - "allocationState": "steady", - "allocationStateTransitionTime": "2016-11-22T18:55:24.8154041Z", - "vmSize": "standard_a1", - "resizeTimeout": "PT15M", - "currentDedicatedNodes": 0, - "currentLowPriorityNodes": 0, - "targetDedicatedNodes": 0, - "targetLowPriorityNodes": 0, - "enableAutoScale": false, - "enableInterNodeCommunication": false, - "startTask": { - "commandLine": "/bin/bash -c 'echo start task'", - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "nonadmin" - } - }, - "maxTaskRetryCount": 0, - "waitForSuccess": false - }, - "taskSlotsPerNode": 1, - "taskSchedulingPolicy": { - "nodeFillType": "spread" - }, - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "0001-com-ubuntu-server-focal", - "sku": "20_04-lts", - "version": "latest" - }, - "nodeAgentSKUId": "batch.node.ubuntu 20.04", - "extensions": [ - { - "name": "batchextension1", - "type": "KeyVaultForLinux", - "publisher": "Microsoft.Azure.KeyVault", - "typeHandlerVersion": "2.0", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": { - "secretsManagementSettingsKey": "secretsManagementSettingsValue", - "authenticationSettingsKey": "authenticationSettingsValue" - } - } - ] - }, - "targetNodeCommunicationMode": "classic", - "currentNodeCommunicationMode": "classic" - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolGet_VirtualMachineConfigurationWithOSDisk.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolGet_VirtualMachineConfigurationWithOSDisk.json deleted file mode 100644 index d53e77fae752..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolGet_VirtualMachineConfigurationWithOSDisk.json +++ /dev/null @@ -1,58 +0,0 @@ -{ - "operationId": "Batch_GetPool", - "title": "Add a VirtualMachineConfiguration pool with OS disk", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "mypool001", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Wed, 23 Aug 2023 08:42:01 GMT" - }, - "responses": { - "200": { - "body": { - "id": "mypool001", - "url": "http://localhost:20302/testaccount1tls/pools/mypool001", - "eTag": "0x8DBA3B4E91CD7B7", - "lastModified": "2023-08-23T08:42:40.3479479Z", - "creationTime": "2023-08-23T08:42:40.3479479Z", - "state": "active", - "stateTransitionTime": "2023-08-23T08:42:40.3479479Z", - "allocationState": "steady", - "allocationStateTransitionTime": "2023-08-23T08:42:53.8587829Z", - "vmSize": "standard_d2s_v3", - "resizeTimeout": "PT15M", - "currentDedicatedNodes": 1, - "targetDedicatedNodes": 1, - "currentLowPriorityNodes": 0, - "targetLowPriorityNodes": 0, - "enableAutoScale": false, - "enableInterNodeCommunication": false, - "taskSlotsPerNode": 1, - "taskSchedulingPolicy": { - "nodeFillType": "spread" - }, - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "0001-com-ubuntu-server-focal", - "sku": "20_04-lts", - "version": "latest" - }, - "osDisk": { - "ephemeralOSDiskSettings": { - "placement": "cachedisk" - }, - "managedDisk": { - "storageAccountType": "standardssd_lrs" - }, - "diskSizeGB": 100, - "caching": "readwrite" - }, - "nodeAgentSKUId": "batch.node.ubuntu 20.04" - }, - "currentNodeCommunicationMode": "classic" - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolGet_VirtualMachineConfigurationWithServiceArtifactReference.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolGet_VirtualMachineConfigurationWithServiceArtifactReference.json deleted file mode 100644 index 1f165f7a4423..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolGet_VirtualMachineConfigurationWithServiceArtifactReference.json +++ /dev/null @@ -1,54 +0,0 @@ -{ - "operationId": "Batch_GetPool", - "title": "Get a VirtualMachineConfiguration pool with ServiceArtifactReference", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "pool", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Thu, 11 May 2023 08:08:01 GMT" - }, - "responses": { - "200": { - "body": { - "id": "pool", - "url": "https://account.region.batch.azure.com/pools/pool", - "eTag": "0x8DB51F652DFC78F", - "lastModified": "2023-05-11T08:04:19.7259151Z", - "creationTime": "2023-05-11T08:04:19.7259151Z", - "state": "active", - "stateTransitionTime": "2023-05-11T08:04:19.7259151Z", - "allocationState": "steady", - "allocationStateTransitionTime": "2023-05-11T08:05:22.0020052Z", - "vmSize": "standard_a1_v2", - "resizeTimeout": "PT15M", - "currentDedicatedNodes": 2, - "targetDedicatedNodes": 2, - "currentLowPriorityNodes": 0, - "targetLowPriorityNodes": 0, - "enableAutoScale": false, - "enableInterNodeCommunication": false, - "taskSlotsPerNode": 1, - "taskSchedulingPolicy": { - "nodeFillType": "spread" - }, - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "MicrosoftWindowsServer", - "offer": "WindowsServer", - "sku": "2016-datacenter-smalldisk", - "version": "latest" - }, - "nodeAgentSKUId": "batch.node.windows amd64", - "windowsConfiguration": { - "enableAutomaticUpdates": false - }, - "serviceArtifactReference": { - "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile" - } - }, - "currentNodeCommunicationMode": "classic" - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolListUsageMetrics.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolListUsageMetrics.json deleted file mode 100644 index e89b5477c10e..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolListUsageMetrics.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "operationId": "Batch_ListPoolUsageMetrics", - "title": "Pool list usage metrics", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "startTime": "2013-04-01T00:00:00Z", - "endTime": "2013-04-01T00:30:00Z", - "poolId": "p1", - "vmSize": "a1", - "totalCoreHours": 39.384838 - }, - { - "startTime": "2013-04-01T00:30:00Z", - "endTime": "2013-04-01T01:00:00Z", - "poolId": "p2", - "vmSize": "a8", - "totalCoreHours": 3039.384838 - } - ] - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolList_Basic.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolList_Basic.json deleted file mode 100644 index e1937687c63e..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolList_Basic.json +++ /dev/null @@ -1,61 +0,0 @@ -{ - "operationId": "Batch_ListPools", - "title": "Pool list", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "testPool", - "url": "https://accountname.region.batch.azure.com/pools/testPool", - "eTag": "0x8D4123BEF87D233", - "lastModified": "2016-11-21T18:26:39.7108787Z", - "creationTime": "2016-11-21T18:26:39.7108787Z", - "state": "active", - "stateTransitionTime": "2016-11-21T18:26:39.7108787Z", - "allocationState": "steady", - "allocationStateTransitionTime": "2016-11-21T18:27:40.287803Z", - "vmSize": "Standard_D1_v2", - "resizeTimeout": "PT15M", - "currentDedicatedNodes": 3, - "currentLowPriorityNodes": 0, - "targetDedicatedNodes": 3, - "targetLowPriorityNodes": 0, - "enableAutoScale": false, - "enableInterNodeCommunication": false, - "startTask": { - "commandLine": "cmd /c echo hello", - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "nonadmin" - } - }, - "maxTaskRetryCount": 0, - "waitForSuccess": false - }, - "taskSlotsPerNode": 1, - "taskSchedulingPolicy": { - "nodeFillType": "spread" - }, - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "MicrosoftWindowsServer", - "offer": "WindowsServer", - "sku": "2016-datacenter-smalldisk", - "version": "latest" - }, - "nodeAgentSKUId": "batch.node.windows amd64" - } - } - ] - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolPatch.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolPatch.json deleted file mode 100644 index acd6b43a7165..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolPatch.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "operationId": "Batch_UpdatePool", - "title": "Patch the Pool", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "pool": { - "startTask": { - "commandLine": "/bin/bash -c 'echo start task'" - } - } - }, - "responses": { - "200": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolRemoveNodes.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolRemoveNodes.json deleted file mode 100644 index ec83c9b3d182..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolRemoveNodes.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "operationId": "Batch_RemoveNodes", - "title": "Pool remove nodes", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "content": { - "nodeList": [ - "tvm-1695681911_1-20161122t224741z", - "tvm-1695681911_2-20161122t224741z" - ] - } - }, - "responses": { - "202": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolResize.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolResize.json deleted file mode 100644 index 017bcaf9a6ec..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolResize.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "operationId": "Batch_ResizePool", - "title": "Pool resize", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "resizePool", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "content": { - "targetDedicatedNodes": 1, - "targetLowPriorityNodes": 0 - } - }, - "responses": { - "202": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolStopResize.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolStopResize.json deleted file mode 100644 index b4ac327f755d..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolStopResize.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "operationId": "Batch_StopPoolResize", - "title": "Pool stop resize", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "202": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolUpdate.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolUpdate.json deleted file mode 100644 index bc958ae9fc79..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/PoolUpdate.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "operationId": "Batch_ReplacePoolProperties", - "title": "Pool update", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "pool": { - "startTask": { - "commandLine": "/bin/bash -c 'echo start task'" - }, - "applicationPackageReferences": [], - "metadata": [] - } - }, - "responses": { - "204": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_AcceleratedNetworking.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_AcceleratedNetworking.json new file mode 100644 index 000000000000..51ce88f34fd3 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_AcceleratedNetworking.json @@ -0,0 +1,30 @@ +{ + "operationId": "Pools_CreatePool", + "title": "Creates a pool with accelerated networking", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Thu, 27 Apr 2023 05:31:01 GMT", + "pool": { + "id": "mypool01", + "vmSize": "Standard_D1_v2", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.windows amd64" + }, + "targetDedicatedNodes": 2, + "networkConfiguration": { + "enableAcceleratedNetworking": true + } + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_MountConfiguration.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_MountConfiguration.json new file mode 100644 index 000000000000..86c734c6f9ca --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_MountConfiguration.json @@ -0,0 +1,72 @@ +{ + "operationId": "Pools_CreatePool", + "title": "Creates a pool with mount drive specified", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-data": "Fri, 17 Feb 2017 00:00:00 GMT", + "pool": { + "id": "pool2", + "vmSize": "standard_a1", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "20_04-lts" + }, + "nodeAgentSKUId": "batch.node.ubuntu 20.04" + }, + "mountConfiguration": [ + { + "azureBlobFileSystemConfiguration": { + "accountName": "accountName", + "containerName": "blobContainerName", + "accountKey": "accountKey", + "relativeMountPath": "bfusepath" + } + }, + { + "azureFileShareConfiguration": { + "accountName": "accountName", + "azureFileUrl": "https://myaccount.file.core.windows.net/fileshare", + "accountKey": "accountKey", + "relativeMountPath": "filesharepath", + "mountOptions": "mount options ver=1.0" + } + }, + { + "nfsMountConfiguration": { + "source": "somesource nfs url", + "relativeMountPath": "mountpath", + "mountOptions": "mount options ver=1.0" + } + }, + { + "cifsMountConfiguration": { + "username": "accountName", + "password": "password", + "source": "//myaccount.file.core.windows.net/file", + "relativeMountPath": "mountpath", + "mountOptions": "mount options ver=1.0" + } + } + ], + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 5, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 3, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false + } + }, + "responses": { + "201": { + "request-id": "00000000-0000-0000-0000-000000000000", + "ETag": "0x8D45765A6A2DC04", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_OSDisk.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_OSDisk.json new file mode 100644 index 000000000000..f144330b8d1b --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_OSDisk.json @@ -0,0 +1,40 @@ +{ + "operationId": "Pools_CreatePool", + "title": "Creates a VirtualMachineConfiguration pool with OS disk", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Wed, 23 Aug 2023 08:40:02 GMT", + "pool": { + "id": "mypool001", + "vmSize": "standard_d2s_v3", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts" + }, + "osDisk": { + "diskSizeGB": 100, + "managedDisk": { + "storageAccountType": "standardssd_lrs" + }, + "caching": "readwrite", + "ephemeralOSDiskSettings": { + "placement": "cachedisk" + } + }, + "nodeAgentSKUId": "batch.node.ubuntu 20.04" + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 1, + "enableAutoScale": false + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_ResourceTags.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_ResourceTags.json new file mode 100644 index 000000000000..0457709ba9c5 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_ResourceTags.json @@ -0,0 +1,31 @@ +{ + "operationId": "Pools_CreatePool", + "title": "Creates a simple pool with resourceTags", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Wed, 14 Jun 2023 06:39:01 GMT", + "pool": { + "id": "mypool001", + "vmSize": "STANDARD_DC2s_V2", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "18_04-lts-gen2", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.ubuntu 18.04" + }, + "targetDedicatedNodes": 1, + "resourceTags": { + "TagName1": "TagValue1", + "TagName2": "TagValue2" + } + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_SecurityProfile.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_SecurityProfile.json new file mode 100644 index 000000000000..769bd5b7ceab --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_SecurityProfile.json @@ -0,0 +1,35 @@ +{ + "operationId": "Pools_CreatePool", + "title": "Creates a pool with SecurityProfile", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Wed, 14 Jun 2023 06:39:01 GMT", + "pool": { + "id": "mypool001", + "vmSize": "STANDARD_DC2s_V2", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "18_04-lts-gen2", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.ubuntu 18.04", + "securityProfile": { + "securityType": "trustedLaunch", + "encryptionAtHost": true, + "uefiSettings": { + "secureBootEnabled": false, + "vTpmEnabled": null + } + } + }, + "targetDedicatedNodes": 1 + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_VirtualMachineConfiguration.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_VirtualMachineConfiguration.json new file mode 100644 index 000000000000..fdda1fc4bd29 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_VirtualMachineConfiguration.json @@ -0,0 +1,44 @@ +{ + "operationId": "Pools_CreatePool", + "title": "Creates a VirtualMachineConfiguration pool", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "pool": { + "id": "pool2", + "vmSize": "standard_a1", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts" + }, + "nodeAgentSKUId": "batch.node.ubuntu 20.04" + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 5, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 3, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false, + "enableInterNodeCommunication": true, + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ] + } + }, + "responses": { + "201": { + "request-id": "00000000-0000-0000-0000-000000000000", + "ETag": "0x8D45765A6A2DC04", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_VirtualMachineConfigurationWithContainers.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_VirtualMachineConfigurationWithContainers.json new file mode 100644 index 000000000000..6c93e93aebf9 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_VirtualMachineConfigurationWithContainers.json @@ -0,0 +1,43 @@ +{ + "operationId": "Pools_CreatePool", + "title": "Creates a VirtualMachineConfiguration pool with containers", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "pool": { + "id": "pool2", + "vmSize": "standard_a1", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "120_04-lts" + }, + "nodeAgentSKUId": "batch.node.ubuntu 20.04", + "containerConfiguration": { + "type": "dockerCompatible", + "containerImageNames": [ + "busybox" + ] + } + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 5, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 3, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false + } + }, + "responses": { + "201": { + "request-id": "00000000-0000-0000-0000-000000000000", + "ETag": "0x8D45765A6A2DC04", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_VirtualMachineConfigurationWithExtensions.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_VirtualMachineConfigurationWithExtensions.json new file mode 100644 index 000000000000..ec470c8b9617 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_VirtualMachineConfigurationWithExtensions.json @@ -0,0 +1,59 @@ +{ + "operationId": "Pools_CreatePool", + "title": "Creates a VirtualMachineConfiguration pool with extensions", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "pool": { + "id": "pool2", + "vmSize": "standard_a1", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts" + }, + "nodeAgentSKUId": "batch.node.ubuntu 20.04", + "extensions": [ + { + "name": "batchextension1", + "type": "KeyVaultForLinux", + "publisher": "Microsoft.Azure.KeyVault", + "typeHandlerVersion": "2.0", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": { + "secretsManagementSettingsKey": "secretsManagementSettingsValue", + "authenticationSettingsKey": "authenticationSettingsValue" + } + } + ] + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 5, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 3, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false, + "enableInterNodeCommunication": true, + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ], + "targetNodeCommunicationMode": "simplified" + } + }, + "responses": { + "201": { + "request-id": "00000000-0000-0000-0000-000000000000", + "ETag": "0x8D45765A6A2DC04", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_VirtualMachineConfigurationWithServiceArtifactReference.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_VirtualMachineConfigurationWithServiceArtifactReference.json new file mode 100644 index 000000000000..28aa0e11bd67 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_VirtualMachineConfigurationWithServiceArtifactReference.json @@ -0,0 +1,33 @@ +{ + "operationId": "Pools_CreatePool", + "title": "Creates a VirtualMachineConfiguration pool with ServiceArtifactReference", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Thu, 11 May 2023 08:03:01 GMT", + "pool": { + "id": "mypool002", + "vmSize": "Standard_A1_v2", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "windowsConfiguration": { + "enableAutomaticUpdates": false + }, + "serviceArtifactReference": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile" + }, + "nodeAgentSKUId": "batch.node.windows amd64" + }, + "targetDedicatedNodes": 2 + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_DeletePool.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_DeletePool.json new file mode 100644 index 000000000000..88c53b1b46e2 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_DeletePool.json @@ -0,0 +1,14 @@ +{ + "operationId": "Pools_DeletePool", + "title": "Pool delete", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_DisablePoolAutoScale.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_DisablePoolAutoScale.json new file mode 100644 index 000000000000..ac34fc088182 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_DisablePoolAutoScale.json @@ -0,0 +1,14 @@ +{ + "operationId": "Pools_DisablePoolAutoScale", + "title": "Disable pool autoscale", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_EnablePoolAutoscale.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_EnablePoolAutoscale.json new file mode 100644 index 000000000000..e6a2627b9274 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_EnablePoolAutoscale.json @@ -0,0 +1,18 @@ +{ + "operationId": "Pools_EnablePoolAutoScale", + "title": "Pool enable autoscale", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "content": { + "autoScaleFormula": "$TargetDedicated=0", + "autoScaleEvaluationInterval": "PT8M" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_EvaluatePoolAutoscale.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_EvaluatePoolAutoscale.json new file mode 100644 index 000000000000..1c05283aab88 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_EvaluatePoolAutoscale.json @@ -0,0 +1,22 @@ +{ + "operationId": "Pools_EvaluatePoolAutoScale", + "title": "Pool evaluate autoscale", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "content": { + "autoScaleFormula": "$TargetDedicated=1" + } + }, + "responses": { + "200": { + "body": { + "timestamp": "2016-11-22T19:39:28.5246331Z", + "results": "$TargetDedicated=1;$NodeDeallocationOption=requeue" + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_AcceleratedNetworking.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_AcceleratedNetworking.json new file mode 100644 index 000000000000..fcb46bf1c1a2 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_AcceleratedNetworking.json @@ -0,0 +1,52 @@ +{ + "operationId": "Pools_GetPool", + "title": "Get a pool with AcceleratedNetworking", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "pool", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 28 Apr 2023 02:43:01 GMT" + }, + "responses": { + "200": { + "body": { + "id": "pool", + "url": "https://account.region.batch.azure.com/pools/pool", + "eTag": "0x8DB4792BE8566A2", + "lastModified": "2023-04-28T02:46:19.0268066Z", + "creationTime": "2023-04-28T02:46:19.0268066Z", + "state": "active", + "stateTransitionTime": "2023-04-28T02:46:19.0268066Z", + "allocationState": "steady", + "allocationStateTransitionTime": "2023-04-28T02:47:17.9169655Z", + "vmSize": "standard_d1_v2", + "resizeTimeout": "PT15M", + "currentDedicatedNodes": 2, + "targetDedicatedNodes": 2, + "currentLowPriorityNodes": 0, + "targetLowPriorityNodes": 0, + "enableAutoScale": false, + "enableInterNodeCommunication": false, + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.windows amd64" + }, + "networkConfiguration": { + "dynamicVNetAssignmentScope": "none", + "enableAcceleratedNetworking": true + }, + "currentNodeCommunicationMode": "classic" + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_Basic.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_Basic.json new file mode 100644 index 000000000000..9bae3ce6828b --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_Basic.json @@ -0,0 +1,58 @@ +{ + "operationId": "Pools_GetPool", + "title": "Pool get", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "pool", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "pool", + "url": "https://account.region.batch.azure.com/pools/pool", + "eTag": "0x8D413091E739A56", + "lastModified": "2016-11-22T18:55:25.2608598Z", + "creationTime": "2016-11-22T18:55:24.2632496Z", + "state": "active", + "stateTransitionTime": "2016-11-22T18:55:24.2632496Z", + "allocationState": "steady", + "allocationStateTransitionTime": "2016-11-22T18:55:24.8154041Z", + "vmSize": "standard_a1", + "resizeTimeout": "PT15M", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "targetDedicatedNodes": 0, + "targetLowPriorityNodes": 0, + "enableAutoScale": false, + "enableInterNodeCommunication": false, + "startTask": { + "commandLine": "/bin/bash -c 'echo start task'", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.ubuntu 20.04" + } + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_SecurityProfile.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_SecurityProfile.json new file mode 100644 index 000000000000..f020e3b32e0b --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_SecurityProfile.json @@ -0,0 +1,55 @@ +{ + "operationId": "Pools_GetPool", + "title": "Get a VirtualMachineConfiguration pool with SecurityProfile", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "mypool001", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Wed, 14 Jun 2023 06:39:01 GMT" + }, + "responses": { + "200": { + "body": { + "id": "mypool001", + "url": "https://account.region.batch.azure.com/pools/pool", + "eTag": "0x8DB6CA2DFF530D1", + "lastModified": "2023-06-14T06:45:00.0946897Z", + "creationTime": "2023-06-14T06:45:00.0946897Z", + "state": "active", + "stateTransitionTime": "2023-06-14T06:45:00.0946897Z", + "allocationState": "steady", + "allocationStateTransitionTime": "2023-06-14T06:45:59.4770341Z", + "vmSize": "standard_dc2s_v2", + "resizeTimeout": "PT15M", + "currentDedicatedNodes": 1, + "targetDedicatedNodes": 1, + "currentLowPriorityNodes": 0, + "targetLowPriorityNodes": 0, + "enableAutoScale": false, + "enableInterNodeCommunication": false, + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "18_04-lts-gen2", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.ubuntu 18.04", + "securityProfile": { + "securityType": "trustedLaunch", + "encryptionAtHost": true, + "uefiSettings": { + "secureBootEnabled": false + } + } + }, + "currentNodeCommunicationMode": "classic" + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_VirtualMachineConfigurationWithExtensions.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_VirtualMachineConfigurationWithExtensions.json new file mode 100644 index 000000000000..82a7e7b9162e --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_VirtualMachineConfigurationWithExtensions.json @@ -0,0 +1,74 @@ +{ + "operationId": "Pools_GetPool", + "title": "Get a VirtualMachineConfiguration pool with extensions", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "pool", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "pool", + "url": "https://account.region.batch.azure.com/pools/pool", + "eTag": "0x8D413091E739A56", + "lastModified": "2016-11-22T18:55:25.2608598Z", + "creationTime": "2016-11-22T18:55:24.2632496Z", + "state": "active", + "stateTransitionTime": "2016-11-22T18:55:24.2632496Z", + "allocationState": "steady", + "allocationStateTransitionTime": "2016-11-22T18:55:24.8154041Z", + "vmSize": "standard_a1", + "resizeTimeout": "PT15M", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "targetDedicatedNodes": 0, + "targetLowPriorityNodes": 0, + "enableAutoScale": false, + "enableInterNodeCommunication": false, + "startTask": { + "commandLine": "/bin/bash -c 'echo start task'", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.ubuntu 20.04", + "extensions": [ + { + "name": "batchextension1", + "type": "KeyVaultForLinux", + "publisher": "Microsoft.Azure.KeyVault", + "typeHandlerVersion": "2.0", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": { + "secretsManagementSettingsKey": "secretsManagementSettingsValue", + "authenticationSettingsKey": "authenticationSettingsValue" + } + } + ] + }, + "targetNodeCommunicationMode": "classic", + "currentNodeCommunicationMode": "classic" + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_VirtualMachineConfigurationWithOSDisk.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_VirtualMachineConfigurationWithOSDisk.json new file mode 100644 index 000000000000..6574e2cbb14a --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_VirtualMachineConfigurationWithOSDisk.json @@ -0,0 +1,58 @@ +{ + "operationId": "Pools_GetPool", + "title": "Add a VirtualMachineConfiguration pool with OS disk", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "mypool001", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Wed, 23 Aug 2023 08:42:01 GMT" + }, + "responses": { + "200": { + "body": { + "id": "mypool001", + "url": "http://localhost:20302/testaccount1tls/pools/mypool001", + "eTag": "0x8DBA3B4E91CD7B7", + "lastModified": "2023-08-23T08:42:40.3479479Z", + "creationTime": "2023-08-23T08:42:40.3479479Z", + "state": "active", + "stateTransitionTime": "2023-08-23T08:42:40.3479479Z", + "allocationState": "steady", + "allocationStateTransitionTime": "2023-08-23T08:42:53.8587829Z", + "vmSize": "standard_d2s_v3", + "resizeTimeout": "PT15M", + "currentDedicatedNodes": 1, + "targetDedicatedNodes": 1, + "currentLowPriorityNodes": 0, + "targetLowPriorityNodes": 0, + "enableAutoScale": false, + "enableInterNodeCommunication": false, + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts", + "version": "latest" + }, + "osDisk": { + "ephemeralOSDiskSettings": { + "placement": "cachedisk" + }, + "managedDisk": { + "storageAccountType": "standardssd_lrs" + }, + "diskSizeGB": 100, + "caching": "readwrite" + }, + "nodeAgentSKUId": "batch.node.ubuntu 20.04" + }, + "currentNodeCommunicationMode": "classic" + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_VirtualMachineConfigurationWithServiceArtifactReference.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_VirtualMachineConfigurationWithServiceArtifactReference.json new file mode 100644 index 000000000000..7462de39af56 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_VirtualMachineConfigurationWithServiceArtifactReference.json @@ -0,0 +1,54 @@ +{ + "operationId": "Pools_GetPool", + "title": "Get a VirtualMachineConfiguration pool with ServiceArtifactReference", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "pool", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Thu, 11 May 2023 08:08:01 GMT" + }, + "responses": { + "200": { + "body": { + "id": "pool", + "url": "https://account.region.batch.azure.com/pools/pool", + "eTag": "0x8DB51F652DFC78F", + "lastModified": "2023-05-11T08:04:19.7259151Z", + "creationTime": "2023-05-11T08:04:19.7259151Z", + "state": "active", + "stateTransitionTime": "2023-05-11T08:04:19.7259151Z", + "allocationState": "steady", + "allocationStateTransitionTime": "2023-05-11T08:05:22.0020052Z", + "vmSize": "standard_a1_v2", + "resizeTimeout": "PT15M", + "currentDedicatedNodes": 2, + "targetDedicatedNodes": 2, + "currentLowPriorityNodes": 0, + "targetLowPriorityNodes": 0, + "enableAutoScale": false, + "enableInterNodeCommunication": false, + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.windows amd64", + "windowsConfiguration": { + "enableAutomaticUpdates": false + }, + "serviceArtifactReference": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile" + } + }, + "currentNodeCommunicationMode": "classic" + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ListPoolNodeCounts.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ListPoolNodeCounts.json new file mode 100644 index 000000000000..d3cbbb642b61 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ListPoolNodeCounts.json @@ -0,0 +1,129 @@ +{ + "operationId": "Pools_ListPoolNodeCounts", + "title": "NodeCountsPayload", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "poolId": "pool1", + "dedicated": { + "creating": 0, + "idle": 0, + "leavingPool": 0, + "offline": 0, + "preempted": 0, + "rebooting": 0, + "reimaging": 0, + "running": 0, + "starting": 0, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "upgradingOS": 0, + "total": 0 + }, + "lowPriority": { + "creating": 0, + "idle": 0, + "leavingPool": 0, + "offline": 0, + "preempted": 0, + "rebooting": 0, + "reimaging": 0, + "running": 2, + "starting": 1, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "upgradingOS": 0, + "total": 3 + } + }, + { + "poolId": "pool2", + "dedicated": { + "creating": 0, + "idle": 1, + "leavingPool": 0, + "offline": 3, + "preempted": 0, + "rebooting": 0, + "reimaging": 0, + "running": 0, + "starting": 0, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "upgradingOS": 0, + "total": 4 + }, + "lowPriority": { + "creating": 0, + "idle": 0, + "leavingPool": 0, + "offline": 0, + "preempted": 0, + "rebooting": 0, + "reimaging": 0, + "running": 0, + "starting": 0, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "upgradingOS": 0, + "total": 0 + } + }, + { + "poolId": "pool3", + "dedicated": { + "creating": 0, + "idle": 5, + "leavingPool": 0, + "offline": 0, + "preempted": 0, + "rebooting": 0, + "reimaging": 4, + "running": 0, + "starting": 0, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "upgradingOS": 0, + "total": 9 + }, + "lowPriority": { + "creating": 7, + "idle": 0, + "leavingPool": 0, + "offline": 0, + "preempted": 0, + "rebooting": 0, + "reimaging": 0, + "running": 4, + "starting": 0, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "upgradingOS": 0, + "total": 11 + } + } + ] + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ListPoolUsageMetrics.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ListPoolUsageMetrics.json new file mode 100644 index 000000000000..82cbeab87d2b --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ListPoolUsageMetrics.json @@ -0,0 +1,32 @@ +{ + "operationId": "Pools_ListPoolUsageMetrics", + "title": "Pool list usage metrics", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "startTime": "2013-04-01T00:00:00Z", + "endTime": "2013-04-01T00:30:00Z", + "poolId": "p1", + "vmSize": "a1", + "totalCoreHours": 39.384838 + }, + { + "startTime": "2013-04-01T00:30:00Z", + "endTime": "2013-04-01T01:00:00Z", + "poolId": "p2", + "vmSize": "a8", + "totalCoreHours": 3039.384838 + } + ] + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ListPools_Basic.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ListPools_Basic.json new file mode 100644 index 000000000000..0883574a2b13 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ListPools_Basic.json @@ -0,0 +1,61 @@ +{ + "operationId": "Pools_ListPools", + "title": "Pool list", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "testPool", + "url": "https://accountname.region.batch.azure.com/pools/testPool", + "eTag": "0x8D4123BEF87D233", + "lastModified": "2016-11-21T18:26:39.7108787Z", + "creationTime": "2016-11-21T18:26:39.7108787Z", + "state": "active", + "stateTransitionTime": "2016-11-21T18:26:39.7108787Z", + "allocationState": "steady", + "allocationStateTransitionTime": "2016-11-21T18:27:40.287803Z", + "vmSize": "Standard_D1_v2", + "resizeTimeout": "PT15M", + "currentDedicatedNodes": 3, + "currentLowPriorityNodes": 0, + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0, + "enableAutoScale": false, + "enableInterNodeCommunication": false, + "startTask": { + "commandLine": "cmd /c echo hello", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.windows amd64" + } + } + ] + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ListSupportedImages.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ListSupportedImages.json new file mode 100644 index 000000000000..41c98e95f421 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ListSupportedImages.json @@ -0,0 +1,78 @@ +{ + "operationId": "Pools_ListSupportedImages", + "title": "Account list node agent skus", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "nodeAgentSKUId": "batch.node.centos 7", + "imageReference": { + "publisher": "OpenLogic", + "offer": "CentOS", + "sku": "7.2", + "version": "latest" + }, + "verificationType": "verified", + "capabilities": [ + "DockerCompatible", + "NvidiaTeslaDriverInstalled" + ], + "osType": "linux" + }, + { + "nodeAgentSKUId": "batch.node.centos 7", + "imageReference": { + "publisher": "OpenLogic", + "offer": "CentOS", + "sku": "7.1", + "version": "latest" + }, + "verificationType": "unverified", + "osType": "linux", + "batchSupportEndOfLife": "2019-11-01T00:00:00.0Z" + }, + { + "nodeAgentSKUId": "batch.node.debian 8", + "imageReference": { + "publisher": "Credativ", + "offer": "Debian", + "sku": "8", + "version": "latest" + }, + "verificationType": "verified", + "osType": "linux" + }, + { + "nodeAgentSKUId": "batch.node.windows amd64", + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2012-R2-Datacenter", + "version": "latest" + }, + "verificationType": "verified", + "osType": "windows" + }, + { + "nodeAgentSKUId": "batch.node.windows amd64", + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2012-Datacenter", + "version": "latest" + }, + "verificationType": "verified", + "osType": "windows" + } + ] + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_PoolExists.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_PoolExists.json new file mode 100644 index 000000000000..3b7076be3a60 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_PoolExists.json @@ -0,0 +1,15 @@ +{ + "operationId": "Pools_PoolExists", + "title": "Check Pool Exists", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": {}, + "404": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_RemoveNodes.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_RemoveNodes.json new file mode 100644 index 000000000000..94f6e1387660 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_RemoveNodes.json @@ -0,0 +1,20 @@ +{ + "operationId": "Pools_RemoveNodes", + "title": "Pool remove nodes", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "content": { + "nodeList": [ + "tvm-1695681911_1-20161122t224741z", + "tvm-1695681911_2-20161122t224741z" + ] + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ReplacePoolProperties.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ReplacePoolProperties.json new file mode 100644 index 000000000000..93cb8d88b580 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ReplacePoolProperties.json @@ -0,0 +1,21 @@ +{ + "operationId": "Pools_ReplacePoolProperties", + "title": "Pool update", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "pool": { + "startTask": { + "commandLine": "/bin/bash -c 'echo start task'" + }, + "applicationPackageReferences": [], + "metadata": [] + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ResizePool.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ResizePool.json new file mode 100644 index 000000000000..fcfd1e063b38 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ResizePool.json @@ -0,0 +1,18 @@ +{ + "operationId": "Pools_ResizePool", + "title": "Pool resize", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "resizePool", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "content": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_StopPoolResize.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_StopPoolResize.json new file mode 100644 index 000000000000..db1f0716dfed --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_StopPoolResize.json @@ -0,0 +1,14 @@ +{ + "operationId": "Pools_StopPoolResize", + "title": "Pool stop resize", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_UpdatePool.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_UpdatePool.json new file mode 100644 index 000000000000..1138f17ad957 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_UpdatePool.json @@ -0,0 +1,19 @@ +{ + "operationId": "Pools_UpdatePool", + "title": "Patch the Pool", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "pool": { + "startTask": { + "commandLine": "/bin/bash -c 'echo start task'" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskCreateCollection_Basic.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskCreateCollection_Basic.json deleted file mode 100644 index bbb1ba53bea1..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskCreateCollection_Basic.json +++ /dev/null @@ -1,45 +0,0 @@ -{ - "operationId": "Batch_CreateTaskCollection", - "title": "Creates a basic collection of tasks", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "taskCollection": { - "value": [ - { - "id": "simple1", - "commandLine": "cmd /c dir /s" - }, - { - "id": "simple2", - "commandLine": "cmd /c dir /s" - } - ] - } - }, - "responses": { - "200": { - "body": { - "value": [ - { - "status": "success", - "taskId": "simple1", - "eTag": "0x8D3D623CD661246", - "lastModified": "2016-09-06T07:02:44.7589958Z", - "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple1" - }, - { - "status": "success", - "taskId": "simple2", - "eTag": "0x8D3D623CD7072CC", - "lastModified": "2016-09-06T07:02:44.8270028Z", - "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple2" - } - ] - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskCreateCollection_Complex.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskCreateCollection_Complex.json deleted file mode 100644 index 235c85a4dd10..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskCreateCollection_Complex.json +++ /dev/null @@ -1,80 +0,0 @@ -{ - "operationId": "Batch_CreateTaskCollection", - "title": "Creates a complex collection of tasks", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "taskCollection": { - "value": [ - { - "id": "complex1", - "commandLine": "cmd /c dir /s", - "resourceFiles": [ - { - "autoStorageContainerName": "containerName", - "filePath": "data" - } - ], - "environmentSettings": [ - { - "name": "env1", - "value": "value1" - }, - { - "name": "env2", - "value": "value2" - } - ], - "affinityInfo": { - "affinityId": "affinityId" - }, - "constraints": { - "maxWallClockTime": "P1D", - "retentionTime": "P2D", - "maxTaskRetryCount": 5 - }, - "requiredSlots": 2, - "multiInstanceSettings": { - "numberOfInstances": 3, - "coordinationCommandLine": "cmd /c echo coordinating", - "commonResourceFiles": [ - { - "httpUrl": "https://common.blob.core.windows.net/", - "filePath": "common.exe" - } - ] - } - }, - { - "id": "simple3", - "commandLine": "cmd /c dir /s" - } - ] - } - }, - "responses": { - "200": { - "body": { - "value": [ - { - "taskId": "simple3", - "status": "success", - "eTag": "0x8D3D623CE295629", - "lastModified": "2016-09-06T07:02:46.0386857Z", - "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple3" - }, - { - "taskId": "complex1", - "status": "success", - "eTag": "0x8D3D623CE29A412", - "lastModified": "2016-09-06T07:02:46.0406802Z", - "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/complex1" - } - ] - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskCreate_Basic.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskCreate_Basic.json deleted file mode 100644 index e15e32a3e996..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskCreate_Basic.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "operationId": "Batch_CreateTask", - "title": "Creates a basic task", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "task": { - "id": "task1", - "commandLine": "cmd /c echo task1" - } - }, - "responses": { - "201": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskCreate_ContainerSettings.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskCreate_ContainerSettings.json deleted file mode 100644 index eba78d2dd5b6..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskCreate_ContainerSettings.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "operationId": "Batch_CreateTask", - "title": "Creates a task with container settings", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "task": { - "id": "taskId", - "commandLine": "bash -c 'echo hello'", - "containerSettings": { - "imageName": "ubuntu", - "containerRunOptions": "--rm" - }, - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "nonadmin" - } - } - } - }, - "responses": { - "201": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskCreate_ExitConditions.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskCreate_ExitConditions.json deleted file mode 100644 index ad04eb33b757..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskCreate_ExitConditions.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "operationId": "Batch_CreateTask", - "title": "Creates a task with exit conditions", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "task": { - "id": "taskId", - "commandLine": "cmd /c exit 3", - "exitConditions": { - "exitCodeRanges": [ - { - "start": 2, - "end": 4, - "exitOptions": { - "jobAction": "terminate" - } - } - ] - }, - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "nonadmin" - } - } - } - }, - "responses": { - "201": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskCreate_RequiredSlots.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskCreate_RequiredSlots.json deleted file mode 100644 index 7912671c718c..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskCreate_RequiredSlots.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "operationId": "Batch_CreateTask", - "title": "Creates a task with extra slot requirement", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "task": { - "id": "task1", - "requiredSlots": 2, - "commandLine": "cmd /c echo task1" - } - }, - "responses": { - "201": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskDelete.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskDelete.json deleted file mode 100644 index ca488f1f0c76..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskDelete.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "operationId": "Batch_DeleteTask", - "title": "Task delete", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "taskId": "taskId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskGet.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskGet.json deleted file mode 100644 index aa2c816a7ae4..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskGet.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "operationId": "Batch_GetTask", - "title": "Task get", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "taskId": "taskId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "id": "testTask", - "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId", - "eTag": "0x8D3D62350711C55", - "creationTime": "2016-09-06T06:59:15.1161429Z", - "lastModified": "2016-09-06T06:59:15.1161429Z", - "state": "active", - "stateTransitionTime": "2016-09-06T06:59:15.1161429Z", - "commandLine": "cmd /c hostname", - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "nonadmin" - } - }, - "multiInstanceSettings": { - "numberOfInstances": 3, - "coordinationCommandLine": "cmd /c echo coordinating" - }, - "constraints": { - "maxWallClockTime": "P10675199DT2H48M5.4775807S", - "retentionTime": "P10675199DT2H48M5.4775807S", - "maxTaskRetryCount": 0 - }, - "requiredSlots": 2, - "executionInfo": { - "retryCount": 0, - "requeueCount": 0 - } - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskList.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskList.json deleted file mode 100644 index 507b92dc8bfb..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskList.json +++ /dev/null @@ -1,71 +0,0 @@ -{ - "operationId": "Batch_ListTasks", - "title": "Task list", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "task1", - "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/task1", - "eTag": "0x8D4125FD1A825A4", - "creationTime": "2016-11-21T22:43:31.4733476Z", - "lastModified": "2016-11-21T22:43:31.4733476Z", - "state": "active", - "stateTransitionTime": "2016-11-21T22:43:31.4733476Z", - "commandLine": "cmd /c echo task1", - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "nonadmin" - } - }, - "constraints": { - "maxWallClockTime": "P10675199DT2H48M5.4775807S", - "retentionTime": "P10675199DT2H48M5.4775807S", - "maxTaskRetryCount": 0 - }, - "requiredSlots": 2, - "executionInfo": { - "retryCount": 0, - "requeueCount": 0 - } - }, - { - "id": "task2", - "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/task2", - "eTag": "0x8D4125FD2153345", - "creationTime": "2016-11-21T22:43:31.6736345Z", - "lastModified": "2016-11-21T22:43:32.1880389Z", - "state": "active", - "stateTransitionTime": "2016-11-21T22:43:31.6736345Z", - "commandLine": "cmd /c echo task2", - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "nonadmin" - } - }, - "constraints": { - "maxWallClockTime": "P10675199DT2H48M5.4775807S", - "retentionTime": "P10675199DT2H48M5.4775807S", - "maxTaskRetryCount": 3 - }, - "requiredSlots": 2, - "executionInfo": { - "retryCount": 0, - "requeueCount": 0 - } - } - ] - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskListSubtasks.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskListSubtasks.json deleted file mode 100644 index 2ee550ff4a8e..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskListSubtasks.json +++ /dev/null @@ -1,52 +0,0 @@ -{ - "operationId": "Batch_ListSubTasks", - "title": "Task list subtasks", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "taskId": "taskId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": 1, - "startTime": "2016-09-06T06:59:16.3139271Z", - "endTime": "2016-09-06T06:59:20.0242024Z", - "state": "completed", - "stateTransitionTime": "2016-09-06T06:59:20.0242024Z", - "previousState": "running", - "previousStateTransitionTime": "2016-09-06T06:59:16.3139271Z", - "exitCode": 0, - "nodeInfo": { - "affinityId": "TVM:tvm-2544493925_3-20160905t051718z", - "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_3-20160905t051718z", - "poolId": "mpiPool", - "nodeId": "tvm-2544493925_3-20160905t051718z", - "taskRootDirectory": "\\workitems\\jobId\\job-1\\taskId\\1", - "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_3-20160905t051718z/files//workitems/jobId/job-1/taskId/1" - } - }, - { - "id": 2, - "startTime": "2016-09-06T06:59:16.9702844Z", - "state": "running", - "stateTransitionTime": "2016-09-06T06:59:16.9702844Z", - "nodeInfo": { - "affinityId": "TVM:tvm-2544493925_2-20160905t051718z", - "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_2-20160905t051718z", - "poolId": "mpiPool", - "nodeId": "tvm-2544493925_2-20160905t051718z", - "taskRootDirectory": "\\workitems\\jobId\\job-1\\taskId\\2", - "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_2-20160905t051718z/files//workitems/jobId/job-1/taskId/2" - } - } - ] - } - } - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskReactivate.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskReactivate.json deleted file mode 100644 index 3f2e368e983a..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskReactivate.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "operationId": "Batch_ReactivateTask", - "title": "Task reactivate", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "taskId": "taskId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "204": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskTerminate.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskTerminate.json deleted file mode 100644 index ad57365f11d8..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskTerminate.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "operationId": "Batch_TerminateTask", - "title": "Task terminate", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "taskId": "taskId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "204": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskUpdate.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskUpdate.json deleted file mode 100644 index bf6c2eb4a5c9..000000000000 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/TaskUpdate.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "operationId": "Batch_ReplaceTask", - "title": "Task update", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "taskId": "taskId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "task": { - "constraints": { - "maxWallClockTime": "PT1H", - "maxTaskRetryCount": 3, - "retentionTime": "PT1H" - } - } - }, - "responses": { - "200": {} - } -} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTaskCollection_Basic.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTaskCollection_Basic.json new file mode 100644 index 000000000000..ef37e3605956 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTaskCollection_Basic.json @@ -0,0 +1,45 @@ +{ + "operationId": "Tasks_CreateTaskCollection", + "title": "Creates a basic collection of tasks", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "taskCollection": { + "value": [ + { + "id": "simple1", + "commandLine": "cmd /c dir /s" + }, + { + "id": "simple2", + "commandLine": "cmd /c dir /s" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "status": "success", + "taskId": "simple1", + "eTag": "0x8D3D623CD661246", + "lastModified": "2016-09-06T07:02:44.7589958Z", + "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple1" + }, + { + "status": "success", + "taskId": "simple2", + "eTag": "0x8D3D623CD7072CC", + "lastModified": "2016-09-06T07:02:44.8270028Z", + "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple2" + } + ] + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTaskCollection_Complex.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTaskCollection_Complex.json new file mode 100644 index 000000000000..5d3ea8180cf6 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTaskCollection_Complex.json @@ -0,0 +1,80 @@ +{ + "operationId": "Tasks_CreateTaskCollection", + "title": "Creates a complex collection of tasks", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "taskCollection": { + "value": [ + { + "id": "complex1", + "commandLine": "cmd /c dir /s", + "resourceFiles": [ + { + "autoStorageContainerName": "containerName", + "filePath": "data" + } + ], + "environmentSettings": [ + { + "name": "env1", + "value": "value1" + }, + { + "name": "env2", + "value": "value2" + } + ], + "affinityInfo": { + "affinityId": "affinityId" + }, + "constraints": { + "maxWallClockTime": "P1D", + "retentionTime": "P2D", + "maxTaskRetryCount": 5 + }, + "requiredSlots": 2, + "multiInstanceSettings": { + "numberOfInstances": 3, + "coordinationCommandLine": "cmd /c echo coordinating", + "commonResourceFiles": [ + { + "httpUrl": "https://common.blob.core.windows.net/", + "filePath": "common.exe" + } + ] + } + }, + { + "id": "simple3", + "commandLine": "cmd /c dir /s" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "taskId": "simple3", + "status": "success", + "eTag": "0x8D3D623CE295629", + "lastModified": "2016-09-06T07:02:46.0386857Z", + "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple3" + }, + { + "taskId": "complex1", + "status": "success", + "eTag": "0x8D3D623CE29A412", + "lastModified": "2016-09-06T07:02:46.0406802Z", + "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/complex1" + } + ] + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTask_Basic.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTask_Basic.json new file mode 100644 index 000000000000..9ac29f42ba78 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTask_Basic.json @@ -0,0 +1,18 @@ +{ + "operationId": "Tasks_CreateTask", + "title": "Creates a basic task", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "task": { + "id": "task1", + "commandLine": "cmd /c echo task1" + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTask_ContainerSettings.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTask_ContainerSettings.json new file mode 100644 index 000000000000..55bd01e12b65 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTask_ContainerSettings.json @@ -0,0 +1,28 @@ +{ + "operationId": "Tasks_CreateTask", + "title": "Creates a task with container settings", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "task": { + "id": "taskId", + "commandLine": "bash -c 'echo hello'", + "containerSettings": { + "imageName": "ubuntu", + "containerRunOptions": "--rm" + }, + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + } + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTask_ExitConditions.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTask_ExitConditions.json new file mode 100644 index 000000000000..4031c4a776cf --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTask_ExitConditions.json @@ -0,0 +1,35 @@ +{ + "operationId": "Tasks_CreateTask", + "title": "Creates a task with exit conditions", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "task": { + "id": "taskId", + "commandLine": "cmd /c exit 3", + "exitConditions": { + "exitCodeRanges": [ + { + "start": 2, + "end": 4, + "exitOptions": { + "jobAction": "terminate" + } + } + ] + }, + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + } + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTask_RequiredSlots.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTask_RequiredSlots.json new file mode 100644 index 000000000000..6b14c38c96ea --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTask_RequiredSlots.json @@ -0,0 +1,19 @@ +{ + "operationId": "Tasks_CreateTask", + "title": "Creates a task with extra slot requirement", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "task": { + "id": "task1", + "requiredSlots": 2, + "commandLine": "cmd /c echo task1" + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_DeleteTask.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_DeleteTask.json new file mode 100644 index 000000000000..0f7d404c37a5 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_DeleteTask.json @@ -0,0 +1,15 @@ +{ + "operationId": "Tasks_DeleteTask", + "title": "Task delete", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_DeleteTaskFile.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_DeleteTaskFile.json new file mode 100644 index 000000000000..0908b20f659a --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_DeleteTaskFile.json @@ -0,0 +1,17 @@ +{ + "operationId": "Tasks_DeleteTaskFile", + "title": "File delete from task", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "taskId": "task1", + "filePath": "wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "recursive": false + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_GetTask.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_GetTask.json new file mode 100644 index 000000000000..3e8e2daaf788 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_GetTask.json @@ -0,0 +1,46 @@ +{ + "operationId": "Tasks_GetTask", + "title": "Task get", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "testTask", + "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId", + "eTag": "0x8D3D62350711C55", + "creationTime": "2016-09-06T06:59:15.1161429Z", + "lastModified": "2016-09-06T06:59:15.1161429Z", + "state": "active", + "stateTransitionTime": "2016-09-06T06:59:15.1161429Z", + "commandLine": "cmd /c hostname", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "multiInstanceSettings": { + "numberOfInstances": 3, + "coordinationCommandLine": "cmd /c echo coordinating" + }, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "retentionTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "requiredSlots": 2, + "executionInfo": { + "retryCount": 0, + "requeueCount": 0 + } + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_GetTaskFile.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_GetTaskFile.json new file mode 100644 index 000000000000..14df3ed4f5ef --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_GetTaskFile.json @@ -0,0 +1,23 @@ +{ + "operationId": "Tasks_GetTaskFile", + "title": "Get File From Task", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "taskId": "task1", + "filePath": "wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", + "ocp-batch-file-isdirectory": "false", + "Content-Length": "17", + "Content-Type": "application/octet-stream", + "body": "This is actually a byte stream. This request/response is being presented as a string for readability in the example" + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_GetTaskFileProperties.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_GetTaskFileProperties.json new file mode 100644 index 000000000000..a4b6bb55369e --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_GetTaskFileProperties.json @@ -0,0 +1,22 @@ +{ + "operationId": "Tasks_GetTaskFileProperties", + "title": "File get properties from task", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "taskId": "taskId", + "filePath": "wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", + "ocp-batch-file-isdirectory": "false", + "Content-Length": "17", + "Content-Type": "application/octet-stream" + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_ListSubTasks.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_ListSubTasks.json new file mode 100644 index 000000000000..cf4efa6d84c0 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_ListSubTasks.json @@ -0,0 +1,52 @@ +{ + "operationId": "Tasks_ListSubTasks", + "title": "Task list subtasks", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": 1, + "startTime": "2016-09-06T06:59:16.3139271Z", + "endTime": "2016-09-06T06:59:20.0242024Z", + "state": "completed", + "stateTransitionTime": "2016-09-06T06:59:20.0242024Z", + "previousState": "running", + "previousStateTransitionTime": "2016-09-06T06:59:16.3139271Z", + "exitCode": 0, + "nodeInfo": { + "affinityId": "TVM:tvm-2544493925_3-20160905t051718z", + "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_3-20160905t051718z", + "poolId": "mpiPool", + "nodeId": "tvm-2544493925_3-20160905t051718z", + "taskRootDirectory": "\\workitems\\jobId\\job-1\\taskId\\1", + "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_3-20160905t051718z/files//workitems/jobId/job-1/taskId/1" + } + }, + { + "id": 2, + "startTime": "2016-09-06T06:59:16.9702844Z", + "state": "running", + "stateTransitionTime": "2016-09-06T06:59:16.9702844Z", + "nodeInfo": { + "affinityId": "TVM:tvm-2544493925_2-20160905t051718z", + "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_2-20160905t051718z", + "poolId": "mpiPool", + "nodeId": "tvm-2544493925_2-20160905t051718z", + "taskRootDirectory": "\\workitems\\jobId\\job-1\\taskId\\2", + "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_2-20160905t051718z/files//workitems/jobId/job-1/taskId/2" + } + } + ] + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_ListTaskFiles.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_ListTaskFiles.json new file mode 100644 index 000000000000..9d3e580e4afb --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_ListTaskFiles.json @@ -0,0 +1,43 @@ +{ + "operationId": "Tasks_ListTaskFiles", + "title": "File list from task", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "recursive": false + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "startup\\ProcessEnv.cmd", + "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId/files/startup\\ProcessEnv.cmd", + "isDirectory": false, + "properties": { + "creationTime": "2014-09-19T21:56:17.679195Z", + "lastModified": "2014-09-19T21:56:17.679195Z", + "contentLength": "1813", + "contentType": "application/octet-stream" + } + }, + { + "name": "startup\\stderr.txt", + "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId/files/startup\\stderr.txt", + "isDirectory": false, + "properties": { + "creationTime": "2014-09-19T21:56:17.5590855Z", + "lastModified": "2014-09-19T21:56:17.5590855Z", + "contentLength": "0", + "contentType": "application/octet-stream" + } + } + ] + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_ListTasks.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_ListTasks.json new file mode 100644 index 000000000000..e0fe12da8340 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_ListTasks.json @@ -0,0 +1,71 @@ +{ + "operationId": "Tasks_ListTasks", + "title": "Task list", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "task1", + "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/task1", + "eTag": "0x8D4125FD1A825A4", + "creationTime": "2016-11-21T22:43:31.4733476Z", + "lastModified": "2016-11-21T22:43:31.4733476Z", + "state": "active", + "stateTransitionTime": "2016-11-21T22:43:31.4733476Z", + "commandLine": "cmd /c echo task1", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "retentionTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "requiredSlots": 2, + "executionInfo": { + "retryCount": 0, + "requeueCount": 0 + } + }, + { + "id": "task2", + "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/task2", + "eTag": "0x8D4125FD2153345", + "creationTime": "2016-11-21T22:43:31.6736345Z", + "lastModified": "2016-11-21T22:43:32.1880389Z", + "state": "active", + "stateTransitionTime": "2016-11-21T22:43:31.6736345Z", + "commandLine": "cmd /c echo task2", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "retentionTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 3 + }, + "requiredSlots": 2, + "executionInfo": { + "retryCount": 0, + "requeueCount": 0 + } + } + ] + } + } + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_ReactivateTask.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_ReactivateTask.json new file mode 100644 index 000000000000..12a5ad7b37a7 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_ReactivateTask.json @@ -0,0 +1,15 @@ +{ + "operationId": "Tasks_ReactivateTask", + "title": "Task reactivate", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "204": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_ReplaceTask.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_ReplaceTask.json new file mode 100644 index 000000000000..eb8822a9b419 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_ReplaceTask.json @@ -0,0 +1,22 @@ +{ + "operationId": "Tasks_ReplaceTask", + "title": "Task update", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "task": { + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": 3, + "retentionTime": "PT1H" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_TerminateTask.json b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_TerminateTask.json new file mode 100644 index 000000000000..823bfe3c92dc --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_TerminateTask.json @@ -0,0 +1,15 @@ +{ + "operationId": "Tasks_TerminateTask", + "title": "Task terminate", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "204": {} + } +} diff --git a/specification/batch/Azure.Batch/models.tsp b/specification/batch/Azure.Batch/models.tsp index fd927c8f2632..f39c195e83ea 100644 --- a/specification/batch/Azure.Batch/models.tsp +++ b/specification/batch/Azure.Batch/models.tsp @@ -1051,7 +1051,7 @@ model FileProperties { lastModified: utcDateTime; @doc("The length of the file.") - contentLength: int64; + contentLength: string; @doc("The content type of the file.") contentType?: string; @@ -3769,6 +3769,12 @@ model BatchNodeRebootContent { nodeRebootOption?: BatchNodeRebootOption; } +@doc("Parameters for reimaging an Azure Batch Compute Node.") +model BatchNodeReimageContent { + @doc("When to reimage the Compute Node and what to do with currently running Tasks. The default value is requeue.") + nodeReimageOption?: BatchNodeReimageOption; +} + @doc("Parameters for disabling scheduling on an Azure Batch Compute Node.") model BatchNodeDisableSchedulingContent { @doc("What to do with currently running Tasks when disabling Task scheduling on the Compute Node. The default value is requeue.") diff --git a/specification/batch/Azure.Batch/routes.tsp b/specification/batch/Azure.Batch/routes.tsp index 43036ef3a0c6..476d12647cce 100644 --- a/specification/batch/Azure.Batch/routes.tsp +++ b/specification/batch/Azure.Batch/routes.tsp @@ -17,17 +17,9 @@ namespace Azure.Batch; // Interfaces //////////////////// -#suppress "@azure-tools/typespec-azure-core/no-response-body" "The body of non-204 responses should not be empty." -#suppress "@azure-tools/typespec-azure-core/no-error-status-codes" "Azure REST API guidelines recommend using 'default' error response for all error cases. Avoid defining custom 4xx or 5xx error cases." -#suppress "@azure-tools/typespec-azure-core/no-rpc-path-params" "Operations defined using BatchOperation should not have path parameters." -#suppress "@azure-tools/typespec-azure-core/casing-style" "The names of Model types must use camelCase" -#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "Operation 'Exists' should be defined using a signature from the Azure.Core namespace." -#suppress "@azure-tools/typespec-azure-core/rpc-operation-request-body" "BatchOperation with '@get' cannot have a body." -@client({ - name: "BatchClient", - service: Azure.Batch, -}) -interface Batch { +#suppress "@azure-tools/typespec-azure-core/no-rpc-path-params" "" +@tag("Applications") +interface Applications { @summary("Lists all of the applications available in the specified Account.") @doc(""" This operation returns only Applications and versions that are available for @@ -58,7 +50,14 @@ interface Batch { }, BatchApplication >; +} +#suppress "@azure-tools/typespec-azure-core/no-response-body" "" +#suppress "@azure-tools/typespec-azure-core/no-rpc-path-params" "" +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "" +#suppress "@azure-tools/typespec-azure-core/no-error-status-codes" "" +@tag("Pools") +interface Pools { @summary(""" Lists the usage metrics, aggregated by Pool across individual time intervals, for the specified Account. @@ -387,7 +386,12 @@ interface Batch { }, BatchPoolNodeCountsListResult >; +} +#suppress "@azure-tools/typespec-azure-core/no-rpc-path-params" "" +#suppress "@azure-tools/typespec-azure-core/no-response-body" "" +@tag("Jobs") +interface Jobs { @summary("Deletes a Job.") @doc(""" Deleting a Job also deletes all Tasks that are part of that Job, and all Job @@ -695,7 +699,14 @@ interface Batch { }, BatchTaskCountsResult >; +} +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "" +#suppress "@azure-tools/typespec-azure-core/no-response-body" "" +#suppress "@azure-tools/typespec-azure-core/no-error-status-codes" "" +#suppress "@azure-tools/typespec-azure-core/no-rpc-path-params" "" +@tag("Job Schedules") +interface JobSchedules { @summary("Checks the specified Job Schedule exists.") @doc("Checks the specified Job Schedule exists.") @route("/jobschedules/{jobScheduleId}") @@ -884,7 +895,13 @@ interface Batch { }, BatchJobScheduleListResult >; +} +#suppress "@azure-tools/typespec-azure-core/no-rpc-path-params" "" +#suppress "@azure-tools/typespec-azure-core/no-response-body" "" +#suppress "@azure-tools/typespec-azure-core/casing-style" "" +@tag("Tasks") +interface Tasks { @summary("Creates a Task to the specified Job.") @doc(""" The maximum lifetime of a Task from addition to completion is 180 days. If a @@ -1222,7 +1239,13 @@ interface Batch { }, BatchNodeFileListResult >; +} +#suppress "@azure-tools/typespec-azure-core/no-rpc-path-params" "" +#suppress "@azure-tools/typespec-azure-core/no-response-body" "" +#suppress "@azure-tools/typespec-azure-core/casing-style" "" +@tag("Nodes") +interface Nodes { @summary("Adds a user Account to the specified Compute Node.") @doc(""" You can add a user Account to a Compute Node only when it is in the idle or diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/BatchService.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/BatchService.json index d48941f3dabc..6379be5574ac 100644 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/BatchService.json +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/BatchService.json @@ -51,11 +51,33 @@ } } }, - "tags": [], + "tags": [ + { + "name": "Applications" + }, + { + "name": "Pools" + }, + { + "name": "Jobs" + }, + { + "name": "Job Schedules" + }, + { + "name": "Tasks" + }, + { + "name": "Nodes" + } + ], "paths": { "/applications": { "get": { - "operationId": "Batch_ListApplications", + "operationId": "Applications_ListApplications", + "tags": [ + "Applications" + ], "summary": "Lists all of the applications available in the specified Account.", "description": "This operation returns only Applications and versions that are available for\nuse on Compute Nodes; that is, that can be used in an Package reference. For\nadministrator information about applications and versions that are not yet\navailable to Compute Nodes, use the Azure portal or the Azure Resource Manager\nAPI.", "parameters": [ @@ -144,7 +166,7 @@ }, "x-ms-examples": { "List applications": { - "$ref": "./examples/ApplicationList.json" + "$ref": "./examples/Applications_ListApplications.json" } }, "x-ms-pageable": { @@ -154,7 +176,10 @@ }, "/applications/{applicationId}": { "get": { - "operationId": "Batch_GetApplication", + "operationId": "Applications_GetApplication", + "tags": [ + "Applications" + ], "summary": "Gets information about the specified Application.", "description": "This operation returns only Applications and versions that are available for\nuse on Compute Nodes; that is, that can be used in an Package reference. For\nadministrator information about Applications and versions that are not yet\navailable to Compute Nodes, use the Azure portal or the Azure Resource Manager\nAPI.", "parameters": [ @@ -239,14 +264,17 @@ }, "x-ms-examples": { "Get applications": { - "$ref": "./examples/ApplicationGet.json" + "$ref": "./examples/Applications_GetApplication.json" } } } }, "/jobs": { "get": { - "operationId": "Batch_ListJobs", + "operationId": "Jobs_ListJobs", + "tags": [ + "Jobs" + ], "summary": "Lists all of the Jobs in the specified Account.", "description": "Lists all of the Jobs in the specified Account.", "parameters": [ @@ -364,7 +392,7 @@ }, "x-ms-examples": { "Job list": { - "$ref": "./examples/JobList.json" + "$ref": "./examples/Jobs_ListJobs.json" } }, "x-ms-pageable": { @@ -372,7 +400,10 @@ } }, "post": { - "operationId": "Batch_CreateJob", + "operationId": "Jobs_CreateJob", + "tags": [ + "Jobs" + ], "summary": "Creates a Job to the specified Account.", "description": "The Batch service supports two ways to control the work done as part of a Job.\nIn the first approach, the user specifies a Job Manager Task. The Batch service\nlaunches this Task when it is ready to start the Job. The Job Manager Task\ncontrols all other Tasks that run under this Job, by using the Task APIs. In\nthe second approach, the user directly controls the execution of Tasks under an\nactive Job, by using the Task APIs. Also note: when naming Jobs, avoid\nincluding sensitive information such as user names or secret project names.\nThis information may appear in telemetry logs accessible to Microsoft Support\nengineers.", "consumes": [ @@ -463,17 +494,20 @@ }, "x-ms-examples": { "Creates a basic job": { - "$ref": "./examples/JobCreate_Basic.json" + "$ref": "./examples/Jobs_CreateJob_Basic.json" }, "Creates a complex job": { - "$ref": "./examples/JobCreate_Complex.json" + "$ref": "./examples/Jobs_CreateJob_Complex.json" } } } }, "/jobs/{jobId}": { "get": { - "operationId": "Batch_GetJob", + "operationId": "Jobs_GetJob", + "tags": [ + "Jobs" + ], "summary": "Gets information about the specified Job.", "description": "Gets information about the specified Job.", "parameters": [ @@ -614,12 +648,15 @@ }, "x-ms-examples": { "Job get": { - "$ref": "./examples/JobGet.json" + "$ref": "./examples/Jobs_GetJob.json" } } }, "put": { - "operationId": "Batch_ReplaceJob", + "operationId": "Jobs_ReplaceJob", + "tags": [ + "Jobs" + ], "summary": "Updates the properties of the specified Job.", "description": "This fully replaces all the updatable properties of the Job. For example, if\nthe Job has constraints associated with it and if constraints is not specified\nwith this request, then the Batch service will remove the existing constraints.", "consumes": [ @@ -750,13 +787,16 @@ } }, "x-ms-examples": { - "Job update": { - "$ref": "./examples/JobUpdate.json" + "Job patch": { + "$ref": "./examples/Jobs_ReplaceJob.json" } } }, "patch": { - "operationId": "Batch_UpdateJob", + "operationId": "Jobs_UpdateJob", + "tags": [ + "Jobs" + ], "summary": "Updates the properties of the specified Job.", "description": "This replaces only the Job properties specified in the request. For example, if\nthe Job has constraints, and a request does not specify the constraints\nelement, then the Job keeps the existing constraints.", "consumes": [ @@ -887,13 +927,16 @@ } }, "x-ms-examples": { - "Job patch": { - "$ref": "./examples/JobPatch.json" + "Job update": { + "$ref": "./examples/Jobs_UpdateJob.json" } } }, "delete": { - "operationId": "Batch_DeleteJob", + "operationId": "Jobs_DeleteJob", + "tags": [ + "Jobs" + ], "summary": "Deletes a Job.", "description": "Deleting a Job also deletes all Tasks that are part of that Job, and all Job\nstatistics. This also overrides the retention period for Task data; that is, if\nthe Job contains Tasks which are still retained on Compute Nodes, the Batch\nservices deletes those Tasks' working directories and all their contents. When\na Delete Job request is received, the Batch service sets the Job to the\ndeleting state. All update operations on a Job that is in deleting state will\nfail with status code 409 (Conflict), with additional information indicating\nthat the Job is being deleted.", "parameters": [ @@ -1000,14 +1043,17 @@ }, "x-ms-examples": { "Delete Job": { - "$ref": "./examples/JobDelete.json" + "$ref": "./examples/Jobs_DeleteJob.json" } } } }, "/jobs/{jobId}/addtaskcollection": { "post": { - "operationId": "Batch_CreateTaskCollection", + "operationId": "Tasks_CreateTaskCollection", + "tags": [ + "Tasks" + ], "summary": "Adds a collection of Tasks to the specified Job.", "description": "Note that each Task must have a unique ID. The Batch service may not return the\nresults for each Task in the same order the Tasks were submitted in this\nrequest. If the server times out or the connection is closed during the\nrequest, the request may have been partially or fully processed, or not at all.\nIn such cases, the user should re-issue the request. Note that it is up to the\nuser to correctly handle failures when re-issuing a request. For example, you\nshould use the same Task IDs during a retry so that if the prior operation\nsucceeded, the retry will not create extra Tasks unexpectedly. If the response\ncontains any Tasks which failed to add, a client can retry the request. In a\nretry, it is most efficient to resubmit only Tasks that failed to add, and to\nomit Tasks that were successfully added on the first attempt. The maximum\nlifetime of a Task from addition to completion is 180 days. If a Task has not\ncompleted within 180 days of being added it will be terminated by the Batch\nservice and left in whatever state it was in at that time.", "consumes": [ @@ -1104,17 +1150,20 @@ }, "x-ms-examples": { "Creates a basic collection of tasks": { - "$ref": "./examples/TaskCreateCollection_Basic.json" + "$ref": "./examples/Tasks_CreateTaskCollection_Basic.json" }, "Creates a complex collection of tasks": { - "$ref": "./examples/TaskCreateCollection_Complex.json" + "$ref": "./examples/Tasks_CreateTaskCollection_Complex.json" } } } }, "/jobs/{jobId}/disable": { "post": { - "operationId": "Batch_DisableJob", + "operationId": "Jobs_DisableJob", + "tags": [ + "Jobs" + ], "summary": "Disables the specified Job, preventing new Tasks from running.", "description": "The Batch Service immediately moves the Job to the disabling state. Batch then\nuses the disableTasks parameter to determine what to do with the currently\nrunning Tasks of the Job. The Job remains in the disabling state until the\ndisable operation is completed and all Tasks have been dealt with according to\nthe disableTasks option; the Job then moves to the disabled state. No new Tasks\nare started under the Job until it moves back to active state. If you try to\ndisable a Job that is in any state other than active, disabling, or disabled,\nthe request fails with status code 409.", "consumes": [ @@ -1246,14 +1295,17 @@ }, "x-ms-examples": { "Job disable": { - "$ref": "./examples/JobDisable.json" + "$ref": "./examples/Jobs_DisableJob.json" } } } }, "/jobs/{jobId}/enable": { "post": { - "operationId": "Batch_EnableJob", + "operationId": "Jobs_EnableJob", + "tags": [ + "Jobs" + ], "summary": "Enables the specified Job, allowing new Tasks to run.", "description": "When you call this API, the Batch service sets a disabled Job to the enabling\nstate. After the this operation is completed, the Job moves to the active\nstate, and scheduling of new Tasks under the Job resumes. The Batch service\ndoes not allow a Task to remain in the active state for more than 180 days.\nTherefore, if you enable a Job containing active Tasks which were added more\nthan 180 days ago, those Tasks will not run.", "parameters": [ @@ -1373,14 +1425,17 @@ }, "x-ms-examples": { "Job enable": { - "$ref": "./examples/JobEnable.json" + "$ref": "./examples/Jobs_EnableJob.json" } } } }, "/jobs/{jobId}/jobpreparationandreleasetaskstatus": { "get": { - "operationId": "Batch_ListJobPreparationAndReleaseTaskStatus", + "operationId": "Jobs_ListJobPreparationAndReleaseTaskStatus", + "tags": [ + "Jobs" + ], "summary": "Lists the execution status of the Job Preparation and Job Release Task for the\nspecified Job across the Compute Nodes where the Job has run.", "description": "This API returns the Job Preparation and Job Release Task status on all Compute\nNodes that have run the Job Preparation or Job Release Task. This includes\nCompute Nodes which have since been removed from the Pool. If this API is\ninvoked on a Job which has no Job Preparation or Job Release Task, the Batch\nservice returns HTTP status code 409 (Conflict) with an error code of\nJobPreparationTaskNotSpecified.", "parameters": [ @@ -1494,7 +1549,7 @@ }, "x-ms-examples": { "Job list preparation and release task status": { - "$ref": "./examples/JobListPreparationAndReleaseTaskStatus.json" + "$ref": "./examples/Jobs_ListJobPreparationAndReleaseTaskStatus.json" } }, "x-ms-pageable": { @@ -1504,7 +1559,10 @@ }, "/jobs/{jobId}/taskcounts": { "get": { - "operationId": "Batch_GetJobTaskCounts", + "operationId": "Jobs_GetJobTaskCounts", + "tags": [ + "Jobs" + ], "summary": "Gets the Task counts for the specified Job.", "description": "Task counts provide a count of the Tasks by active, running or completed Task\nstate, and a count of Tasks which succeeded or failed. Tasks in the preparing\nstate are counted as running. Note that the numbers returned may not always be\nup to date. If you need exact task counts, use a list query.", "parameters": [ @@ -1589,14 +1647,17 @@ }, "x-ms-examples": { "Job get task counts": { - "$ref": "./examples/JobGetTaskCounts.json" + "$ref": "./examples/Jobs_GetJobTaskCounts.json" } } } }, "/jobs/{jobId}/tasks": { "get": { - "operationId": "Batch_ListTasks", + "operationId": "Tasks_ListTasks", + "tags": [ + "Tasks" + ], "summary": "Lists all of the Tasks that are associated with the specified Job.", "description": "For multi-instance Tasks, information such as affinityId, executionInfo and\nnodeInfo refer to the primary Task. Use the list subtasks API to retrieve\ninformation about subtasks.", "parameters": [ @@ -1721,7 +1782,7 @@ }, "x-ms-examples": { "Task list": { - "$ref": "./examples/TaskList.json" + "$ref": "./examples/Tasks_ListTasks.json" } }, "x-ms-pageable": { @@ -1729,7 +1790,10 @@ } }, "post": { - "operationId": "Batch_CreateTask", + "operationId": "Tasks_CreateTask", + "tags": [ + "Tasks" + ], "summary": "Creates a Task to the specified Job.", "description": "The maximum lifetime of a Task from addition to completion is 180 days. If a\nTask has not completed within 180 days of being added it will be terminated by\nthe Batch service and left in whatever state it was in at that time.", "consumes": [ @@ -1827,23 +1891,26 @@ }, "x-ms-examples": { "Creates a basic task": { - "$ref": "./examples/TaskCreate_Basic.json" + "$ref": "./examples/Tasks_CreateTask_Basic.json" }, "Creates a task with container settings": { - "$ref": "./examples/TaskCreate_ContainerSettings.json" + "$ref": "./examples/Tasks_CreateTask_ContainerSettings.json" }, "Creates a task with exit conditions": { - "$ref": "./examples/TaskCreate_ExitConditions.json" + "$ref": "./examples/Tasks_CreateTask_ExitConditions.json" }, "Creates a task with extra slot requirement": { - "$ref": "./examples/TaskCreate_RequiredSlots.json" + "$ref": "./examples/Tasks_CreateTask_RequiredSlots.json" } } } }, "/jobs/{jobId}/tasks/{taskId}": { "get": { - "operationId": "Batch_GetTask", + "operationId": "Tasks_GetTask", + "tags": [ + "Tasks" + ], "summary": "Gets information about the specified Task.", "description": "For multi-instance Tasks, information such as affinityId, executionInfo and\nnodeInfo refer to the primary Task. Use the list subtasks API to retrieve\ninformation about subtasks.", "parameters": [ @@ -1995,12 +2062,15 @@ }, "x-ms-examples": { "Task get": { - "$ref": "./examples/TaskGet.json" + "$ref": "./examples/Tasks_GetTask.json" } } }, "put": { - "operationId": "Batch_ReplaceTask", + "operationId": "Tasks_ReplaceTask", + "tags": [ + "Tasks" + ], "description": "Updates the properties of the specified Task.", "consumes": [ "application/json; odata=minimalmetadata" @@ -2138,12 +2208,15 @@ }, "x-ms-examples": { "Task update": { - "$ref": "./examples/TaskUpdate.json" + "$ref": "./examples/Tasks_ReplaceTask.json" } } }, "delete": { - "operationId": "Batch_DeleteTask", + "operationId": "Tasks_DeleteTask", + "tags": [ + "Tasks" + ], "summary": "Deletes a Task from the specified Job.", "description": "When a Task is deleted, all of the files in its directory on the Compute Node\nwhere it ran are also deleted (regardless of the retention time). For\nmulti-instance Tasks, the delete Task operation applies synchronously to the\nprimary task; subtasks and their files are then deleted asynchronously in the\nbackground.", "parameters": [ @@ -2257,14 +2330,17 @@ }, "x-ms-examples": { "Task delete": { - "$ref": "./examples/TaskDelete.json" + "$ref": "./examples/Tasks_DeleteTask.json" } } } }, "/jobs/{jobId}/tasks/{taskId}/files": { "get": { - "operationId": "Batch_ListTaskFiles", + "operationId": "Tasks_ListTaskFiles", + "tags": [ + "Tasks" + ], "summary": "Lists the files in a Task's directory on its Compute Node.", "description": "Lists the files in a Task's directory on its Compute Node.", "parameters": [ @@ -2381,7 +2457,7 @@ }, "x-ms-examples": { "File list from task": { - "$ref": "./examples/FileListFromTask.json" + "$ref": "./examples/Tasks_ListTaskFiles.json" } }, "x-ms-pageable": { @@ -2391,7 +2467,10 @@ }, "/jobs/{jobId}/tasks/{taskId}/files/{filePath}": { "get": { - "operationId": "Batch_GetTaskFile", + "operationId": "Tasks_GetTaskFile", + "tags": [ + "Tasks" + ], "description": "Returns the content of the specified Task file.", "produces": [ "application/octet-stream", @@ -2491,8 +2570,7 @@ }, "headers": { "Content-Length": { - "type": "integer", - "format": "int64", + "type": "string", "description": "The length of the file." }, "ETag": { @@ -2540,12 +2618,15 @@ }, "x-ms-examples": { "Get File From Task": { - "$ref": "./examples/FileGetFromTask.json" + "$ref": "./examples/Tasks_GetTaskFile.json" } } }, "delete": { - "operationId": "Batch_DeleteTaskFile", + "operationId": "Tasks_DeleteTaskFile", + "tags": [ + "Tasks" + ], "summary": "Deletes the specified Task file from the Compute Node where the Task ran.", "description": "Deletes the specified Task file from the Compute Node where the Task ran.", "parameters": [ @@ -2639,12 +2720,15 @@ }, "x-ms-examples": { "File delete from task": { - "$ref": "./examples/FileDeleteFromTask.json" + "$ref": "./examples/Tasks_DeleteTaskFile.json" } } }, "head": { - "operationId": "Batch_GetTaskFileProperties", + "operationId": "Tasks_GetTaskFileProperties", + "tags": [ + "Tasks" + ], "description": "Gets the properties of the specified Task file.", "parameters": [ { @@ -2730,8 +2814,7 @@ "description": "The request has succeeded.", "headers": { "Content-Length": { - "type": "integer", - "format": "int64", + "type": "string", "description": "The length of the file." }, "ETag": { @@ -2779,14 +2862,17 @@ }, "x-ms-examples": { "File get properties from task": { - "$ref": "./examples/FileGetPropertiesFromTask.json" + "$ref": "./examples/Tasks_GetTaskFileProperties.json" } } } }, "/jobs/{jobId}/tasks/{taskId}/reactivate": { "post": { - "operationId": "Batch_ReactivateTask", + "operationId": "Tasks_ReactivateTask", + "tags": [ + "Tasks" + ], "summary": "Reactivates a Task, allowing it to run again even if its retry count has been\nexhausted.", "description": "Reactivation makes a Task eligible to be retried again up to its maximum retry\ncount. The Task's state is changed to active. As the Task is no longer in the\ncompleted state, any previous exit code or failure information is no longer\navailable after reactivation. Each time a Task is reactivated, its retry count\nis reset to 0. Reactivation will fail for Tasks that are not completed or that\npreviously completed successfully (with an exit code of 0). Additionally, it\nwill fail if the Job has completed (or is terminating or deleting).", "parameters": [ @@ -2913,14 +2999,17 @@ }, "x-ms-examples": { "Task reactivate": { - "$ref": "./examples/TaskReactivate.json" + "$ref": "./examples/Tasks_ReactivateTask.json" } } } }, "/jobs/{jobId}/tasks/{taskId}/subtasksinfo": { "get": { - "operationId": "Batch_ListSubTasks", + "operationId": "Tasks_ListSubTasks", + "tags": [ + "Tasks" + ], "summary": "Lists all of the subtasks that are associated with the specified multi-instance\nTask.", "description": "If the Task is not a multi-instance Task then this returns an empty collection.", "parameters": [ @@ -3023,7 +3112,7 @@ }, "x-ms-examples": { "Task list subtasks": { - "$ref": "./examples/TaskListSubtasks.json" + "$ref": "./examples/Tasks_ListSubTasks.json" } }, "x-ms-pageable": { @@ -3033,7 +3122,10 @@ }, "/jobs/{jobId}/tasks/{taskId}/terminate": { "post": { - "operationId": "Batch_TerminateTask", + "operationId": "Tasks_TerminateTask", + "tags": [ + "Tasks" + ], "summary": "Terminates the specified Task.", "description": "When the Task has been terminated, it moves to the completed state. For\nmulti-instance Tasks, the terminate Task operation applies synchronously to the\nprimary task; subtasks are then terminated asynchronously in the background.", "parameters": [ @@ -3160,14 +3252,17 @@ }, "x-ms-examples": { "Task terminate": { - "$ref": "./examples/TaskTerminate.json" + "$ref": "./examples/Tasks_TerminateTask.json" } } } }, "/jobs/{jobId}/terminate": { "post": { - "operationId": "Batch_TerminateJob", + "operationId": "Jobs_TerminateJob", + "tags": [ + "Jobs" + ], "summary": "Terminates the specified Job, marking it as completed.", "description": "When a Terminate Job request is received, the Batch service sets the Job to the\nterminating state. The Batch service then terminates any running Tasks\nassociated with the Job and runs any required Job release Tasks. Then the Job\nmoves into the completed state. If there are any Tasks in the Job in the active\nstate, they will remain in the active state. Once a Job is terminated, new\nTasks cannot be added and any remaining active Tasks will not be scheduled.", "consumes": [ @@ -3299,14 +3394,17 @@ }, "x-ms-examples": { "Job terminate": { - "$ref": "./examples/JobTerminate.json" + "$ref": "./examples/Jobs_TerminateJob.json" } } } }, "/jobschedules": { "get": { - "operationId": "Batch_ListJobSchedules", + "operationId": "JobSchedules_ListJobSchedules", + "tags": [ + "Job Schedules" + ], "summary": "Lists all of the Job Schedules in the specified Account.", "description": "Lists all of the Job Schedules in the specified Account.", "parameters": [ @@ -3424,7 +3522,7 @@ }, "x-ms-examples": { "JobSchedule list": { - "$ref": "./examples/JobScheduleList.json" + "$ref": "./examples/JobSchedules_ListJobSchedules.json" } }, "x-ms-pageable": { @@ -3432,7 +3530,10 @@ } }, "post": { - "operationId": "Batch_CreateJobSchedule", + "operationId": "JobSchedules_CreateJobSchedule", + "tags": [ + "Job Schedules" + ], "summary": "Creates a Job Schedule to the specified Account.", "description": "Creates a Job Schedule to the specified Account.", "consumes": [ @@ -3523,17 +3624,20 @@ }, "x-ms-examples": { "Creates a basic JobSchedule": { - "$ref": "./examples/JobScheduleCreate_Basic.json" + "$ref": "./examples/JobSchedules_CreateJobSchedule_Basic.json" }, "Creates a complex JobScheduleAdd": { - "$ref": "./examples/JobScheduleCreate_Complex.json" + "$ref": "./examples/JobSchedules_CreateJobSchedule_Complex.json" } } } }, "/jobschedules/{jobScheduleId}": { "get": { - "operationId": "Batch_GetJobSchedule", + "operationId": "JobSchedules_GetJobSchedule", + "tags": [ + "Job Schedules" + ], "description": "Gets information about the specified Job Schedule.", "parameters": [ { @@ -3673,12 +3777,15 @@ }, "x-ms-examples": { "JobSchedule get": { - "$ref": "./examples/JobScheduleGet.json" + "$ref": "./examples/JobSchedules_GetJobSchedule.json" } } }, "put": { - "operationId": "Batch_ReplaceJobSchedule", + "operationId": "JobSchedules_ReplaceJobSchedule", + "tags": [ + "Job Schedules" + ], "summary": "Updates the properties of the specified Job Schedule.", "description": "This fully replaces all the updatable properties of the Job Schedule. For\nexample, if the schedule property is not specified with this request, then the\nBatch service will remove the existing schedule. Changes to a Job Schedule only\nimpact Jobs created by the schedule after the update has taken place; currently\nrunning Jobs are unaffected.", "consumes": [ @@ -3809,13 +3916,16 @@ } }, "x-ms-examples": { - "JobSchedule update": { - "$ref": "./examples/JobScheduleUpdate.json" + "JobSchedule patch": { + "$ref": "./examples/JobSchedules_ReplaceJobSchedule.json" } } }, "patch": { - "operationId": "Batch_UpdateJobSchedule", + "operationId": "JobSchedules_UpdateJobSchedule", + "tags": [ + "Job Schedules" + ], "summary": "Updates the properties of the specified Job Schedule.", "description": "This replaces only the Job Schedule properties specified in the request. For\nexample, if the schedule property is not specified with this request, then the\nBatch service will keep the existing schedule. Changes to a Job Schedule only\nimpact Jobs created by the schedule after the update has taken place; currently\nrunning Jobs are unaffected.", "consumes": [ @@ -3946,13 +4056,16 @@ } }, "x-ms-examples": { - "JobSchedule patch": { - "$ref": "./examples/JobSchedulePatch.json" + "JobSchedule update": { + "$ref": "./examples/JobSchedules_UpdateJobSchedule.json" } } }, "delete": { - "operationId": "Batch_DeleteJobSchedule", + "operationId": "JobSchedules_DeleteJobSchedule", + "tags": [ + "Job Schedules" + ], "summary": "Deletes a Job Schedule from the specified Account.", "description": "When you delete a Job Schedule, this also deletes all Jobs and Tasks under that\nschedule. When Tasks are deleted, all the files in their working directories on\nthe Compute Nodes are also deleted (the retention period is ignored). The Job\nSchedule statistics are no longer accessible once the Job Schedule is deleted,\nthough they are still counted towards Account lifetime statistics.", "parameters": [ @@ -4059,12 +4172,15 @@ }, "x-ms-examples": { "JobSchedule delete": { - "$ref": "./examples/JobScheduleDelete.json" + "$ref": "./examples/JobSchedules_DeleteJobSchedule.json" } } }, "head": { - "operationId": "Batch_JobScheduleExists", + "operationId": "JobSchedules_JobScheduleExists", + "tags": [ + "Job Schedules" + ], "summary": "Checks the specified Job Schedule exists.", "description": "Checks the specified Job Schedule exists.", "parameters": [ @@ -4183,14 +4299,17 @@ }, "x-ms-examples": { "Check Job Schedule Exists": { - "$ref": "./examples/JobScheduleExists.json" + "$ref": "./examples/JobSchedules_JobScheduleExists.json" } } } }, "/jobschedules/{jobScheduleId}/disable": { "post": { - "operationId": "Batch_DisableJobSchedule", + "operationId": "JobSchedules_DisableJobSchedule", + "tags": [ + "Job Schedules" + ], "summary": "Disables a Job Schedule.", "description": "No new Jobs will be created until the Job Schedule is enabled again.", "parameters": [ @@ -4310,14 +4429,17 @@ }, "x-ms-examples": { "JobSchedule disable": { - "$ref": "./examples/JobScheduleDisable.json" + "$ref": "./examples/JobSchedules_DisableJobSchedule.json" } } } }, "/jobschedules/{jobScheduleId}/enable": { "post": { - "operationId": "Batch_EnableJobSchedule", + "operationId": "JobSchedules_EnableJobSchedule", + "tags": [ + "Job Schedules" + ], "summary": "Enables a Job Schedule.", "description": "Enables a Job Schedule.", "parameters": [ @@ -4437,14 +4559,17 @@ }, "x-ms-examples": { "JobSchedule enable": { - "$ref": "./examples/JobScheduleEnable.json" + "$ref": "./examples/JobSchedules_EnableJobSchedule.json" } } } }, "/jobschedules/{jobScheduleId}/jobs": { "get": { - "operationId": "Batch_ListJobsFromSchedule", + "operationId": "Jobs_ListJobsFromSchedule", + "tags": [ + "Jobs" + ], "summary": "Lists the Jobs that have been created under the specified Job Schedule.", "description": "Lists the Jobs that have been created under the specified Job Schedule.", "parameters": [ @@ -4569,7 +4694,7 @@ }, "x-ms-examples": { "List Job Under Job Schedule": { - "$ref": "./examples/JobListFromJobSchedule.json" + "$ref": "./examples/Jobs_ListJobsFromSchedule.json" } }, "x-ms-pageable": { @@ -4579,7 +4704,10 @@ }, "/jobschedules/{jobScheduleId}/terminate": { "post": { - "operationId": "Batch_TerminateJobSchedule", + "operationId": "JobSchedules_TerminateJobSchedule", + "tags": [ + "Job Schedules" + ], "summary": "Terminates a Job Schedule.", "description": "Terminates a Job Schedule.", "parameters": [ @@ -4699,14 +4827,17 @@ }, "x-ms-examples": { "JobSchedule terminate": { - "$ref": "./examples/JobScheduleTerminate.json" + "$ref": "./examples/JobSchedules_TerminateJobSchedule.json" } } } }, "/nodecounts": { "get": { - "operationId": "Batch_ListPoolNodeCounts", + "operationId": "Pools_ListPoolNodeCounts", + "tags": [ + "Pools" + ], "description": "Gets the number of Compute Nodes in each state, grouped by Pool. Note that the\nnumbers returned may not always be up to date. If you need exact node counts,\nuse a list query.", "parameters": [ { @@ -4801,7 +4932,7 @@ }, "x-ms-examples": { "NodeCountsPayload": { - "$ref": "./examples/AccountListPoolNodeCounts.json" + "$ref": "./examples/Pools_ListPoolNodeCounts.json" } }, "x-ms-pageable": { @@ -4811,7 +4942,10 @@ }, "/pools": { "get": { - "operationId": "Batch_ListPools", + "operationId": "Pools_ListPools", + "tags": [ + "Pools" + ], "summary": "Lists all of the Pools in the specified Account.", "description": "Lists all of the Pools in the specified Account.", "parameters": [ @@ -4929,7 +5063,7 @@ }, "x-ms-examples": { "Pool list": { - "$ref": "./examples/PoolList_Basic.json" + "$ref": "./examples/Pools_ListPools_Basic.json" } }, "x-ms-pageable": { @@ -4937,7 +5071,10 @@ } }, "post": { - "operationId": "Batch_CreatePool", + "operationId": "Pools_CreatePool", + "tags": [ + "Pools" + ], "summary": "Creates a Pool to the specified Account.", "description": "When naming Pools, avoid including sensitive information such as user names or\nsecret project names. This information may appear in telemetry logs accessible\nto Microsoft Support engineers.", "consumes": [ @@ -5028,38 +5165,41 @@ }, "x-ms-examples": { "Creates a VirtualMachineConfiguration pool": { - "$ref": "./examples/PoolCreate_VirtualMachineConfiguration.json" + "$ref": "./examples/Pools_CreatePool_VirtualMachineConfiguration.json" }, "Creates a VirtualMachineConfiguration pool with OS disk": { - "$ref": "./examples/PoolCreate_OSDisk.json" + "$ref": "./examples/Pools_CreatePool_OSDisk.json" }, "Creates a VirtualMachineConfiguration pool with ServiceArtifactReference": { - "$ref": "./examples/PoolCreate_VirtualMachineConfigurationWithServiceArtifactReference.json" + "$ref": "./examples/Pools_CreatePool_VirtualMachineConfigurationWithServiceArtifactReference.json" }, "Creates a VirtualMachineConfiguration pool with containers": { - "$ref": "./examples/PoolCreate_VirtualMachineConfigurationWithContainers.json" + "$ref": "./examples/Pools_CreatePool_VirtualMachineConfigurationWithContainers.json" }, "Creates a VirtualMachineConfiguration pool with extensions": { - "$ref": "./examples/PoolCreate_VirtualMachineConfigurationWithExtensions.json" + "$ref": "./examples/Pools_CreatePool_VirtualMachineConfigurationWithExtensions.json" }, "Creates a pool with SecurityProfile": { - "$ref": "./examples/PoolCreate_SecurityProfile.json" + "$ref": "./examples/Pools_CreatePool_SecurityProfile.json" }, "Creates a pool with accelerated networking": { - "$ref": "./examples/PoolCreate_AcceleratedNetworking.json" + "$ref": "./examples/Pools_CreatePool_AcceleratedNetworking.json" }, "Creates a pool with mount drive specified": { - "$ref": "./examples/PoolCreate_MountConfiguration.json" + "$ref": "./examples/Pools_CreatePool_MountConfiguration.json" }, "Creates a simple pool with resourceTags": { - "$ref": "./examples/PoolCreate_ResourceTags.json" + "$ref": "./examples/Pools_CreatePool_ResourceTags.json" } } } }, "/pools/{poolId}": { "get": { - "operationId": "Batch_GetPool", + "operationId": "Pools_GetPool", + "tags": [ + "Pools" + ], "description": "Gets information about the specified Pool.", "parameters": [ { @@ -5199,27 +5339,30 @@ }, "x-ms-examples": { "Add a VirtualMachineConfiguration pool with OS disk": { - "$ref": "./examples/PoolGet_VirtualMachineConfigurationWithOSDisk.json" + "$ref": "./examples/Pools_GetPool_VirtualMachineConfigurationWithOSDisk.json" }, "Get a VirtualMachineConfiguration pool with SecurityProfile": { - "$ref": "./examples/PoolGet_SecurityProfile.json" + "$ref": "./examples/Pools_GetPool_SecurityProfile.json" }, "Get a VirtualMachineConfiguration pool with ServiceArtifactReference": { - "$ref": "./examples/PoolGet_VirtualMachineConfigurationWithServiceArtifactReference.json" + "$ref": "./examples/Pools_GetPool_VirtualMachineConfigurationWithServiceArtifactReference.json" }, "Get a VirtualMachineConfiguration pool with extensions": { - "$ref": "./examples/PoolGet_VirtualMachineConfigurationWithExtensions.json" + "$ref": "./examples/Pools_GetPool_VirtualMachineConfigurationWithExtensions.json" }, "Get a pool with AcceleratedNetworking": { - "$ref": "./examples/PoolGet_AcceleratedNetworking.json" + "$ref": "./examples/Pools_GetPool_AcceleratedNetworking.json" }, "Pool get": { - "$ref": "./examples/PoolGet_Basic.json" + "$ref": "./examples/Pools_GetPool_Basic.json" } } }, "patch": { - "operationId": "Batch_UpdatePool", + "operationId": "Pools_UpdatePool", + "tags": [ + "Pools" + ], "summary": "Updates the properties of the specified Pool.", "description": "This only replaces the Pool properties specified in the request. For example,\nif the Pool has a StartTask associated with it, and a request does not specify\na StartTask element, then the Pool keeps the existing StartTask.", "consumes": [ @@ -5351,12 +5494,15 @@ }, "x-ms-examples": { "Patch the Pool": { - "$ref": "./examples/PoolPatch.json" + "$ref": "./examples/Pools_UpdatePool.json" } } }, "delete": { - "operationId": "Batch_DeletePool", + "operationId": "Pools_DeletePool", + "tags": [ + "Pools" + ], "summary": "Deletes a Pool from the specified Account.", "description": "When you request that a Pool be deleted, the following actions occur: the Pool\nstate is set to deleting; any ongoing resize operation on the Pool are stopped;\nthe Batch service starts resizing the Pool to zero Compute Nodes; any Tasks\nrunning on existing Compute Nodes are terminated and requeued (as if a resize\nPool operation had been requested with the default requeue option); finally,\nthe Pool is removed from the system. Because running Tasks are requeued, the\nuser can rerun these Tasks by updating their Job to target a different Pool.\nThe Tasks can then run on the new Pool. If you want to override the requeue\nbehavior, then you should call resize Pool explicitly to shrink the Pool to\nzero size before deleting the Pool. If you call an Update, Patch or Delete API\non a Pool in the deleting state, it will fail with HTTP status code 409 with\nerror code PoolBeingDeleted.", "parameters": [ @@ -5463,12 +5609,15 @@ }, "x-ms-examples": { "Pool delete": { - "$ref": "./examples/PoolDelete.json" + "$ref": "./examples/Pools_DeletePool.json" } } }, "head": { - "operationId": "Batch_PoolExists", + "operationId": "Pools_PoolExists", + "tags": [ + "Pools" + ], "description": "Gets basic properties of a Pool.", "parameters": [ { @@ -5586,14 +5735,17 @@ }, "x-ms-examples": { "Check Pool Exists": { - "$ref": "./examples/PoolExists.json" + "$ref": "./examples/Pools_PoolExists.json" } } } }, "/pools/{poolId}/disableautoscale": { "post": { - "operationId": "Batch_DisablePoolAutoScale", + "operationId": "Pools_DisablePoolAutoScale", + "tags": [ + "Pools" + ], "summary": "Disables automatic scaling for a Pool.", "description": "Disables automatic scaling for a Pool.", "parameters": [ @@ -5679,14 +5831,17 @@ }, "x-ms-examples": { "Disable pool autoscale": { - "$ref": "./examples/PoolDisableAutoScale.json" + "$ref": "./examples/Pools_DisablePoolAutoScale.json" } } } }, "/pools/{poolId}/enableautoscale": { "post": { - "operationId": "Batch_EnablePoolAutoScale", + "operationId": "Pools_EnablePoolAutoScale", + "tags": [ + "Pools" + ], "summary": "Enables automatic scaling for a Pool.", "description": "You cannot enable automatic scaling on a Pool if a resize operation is in\nprogress on the Pool. If automatic scaling of the Pool is currently disabled,\nyou must specify a valid autoscale formula as part of the request. If automatic\nscaling of the Pool is already enabled, you may specify a new autoscale formula\nand/or a new evaluation interval. You cannot call this API for the same Pool\nmore than once every 30 seconds.", "consumes": [ @@ -5818,14 +5973,17 @@ }, "x-ms-examples": { "Pool enable autoscale": { - "$ref": "./examples/PoolEnableAutoscale.json" + "$ref": "./examples/Pools_EnablePoolAutoscale.json" } } } }, "/pools/{poolId}/evaluateautoscale": { "post": { - "operationId": "Batch_EvaluatePoolAutoScale", + "operationId": "Pools_EvaluatePoolAutoScale", + "tags": [ + "Pools" + ], "summary": "Gets the result of evaluating an automatic scaling formula on the Pool.", "description": "This API is primarily for validating an autoscale formula, as it simply returns\nthe result without applying the formula to the Pool. The Pool must have auto\nscaling enabled in order to evaluate a formula.", "consumes": [ @@ -5926,14 +6084,17 @@ }, "x-ms-examples": { "Pool evaluate autoscale": { - "$ref": "./examples/PoolEvaluateAutoscale.json" + "$ref": "./examples/Pools_EvaluatePoolAutoscale.json" } } } }, "/pools/{poolId}/nodes": { "get": { - "operationId": "Batch_ListNodes", + "operationId": "Nodes_ListNodes", + "tags": [ + "Nodes" + ], "summary": "Lists the Compute Nodes in the specified Pool.", "description": "Lists the Compute Nodes in the specified Pool.", "parameters": [ @@ -6047,7 +6208,7 @@ }, "x-ms-examples": { "Node list": { - "$ref": "./examples/NodeList.json" + "$ref": "./examples/Nodes_ListNodes.json" } }, "x-ms-pageable": { @@ -6057,7 +6218,10 @@ }, "/pools/{poolId}/nodes/{nodeId}": { "get": { - "operationId": "Batch_GetNode", + "operationId": "Nodes_GetNode", + "tags": [ + "Nodes" + ], "summary": "Gets information about the specified Compute Node.", "description": "Gets information about the specified Compute Node.", "parameters": [ @@ -6160,14 +6324,17 @@ }, "x-ms-examples": { "Node get": { - "$ref": "./examples/NodeGet_Basic.json" + "$ref": "./examples/Nodes_GetNode.json" } } } }, "/pools/{poolId}/nodes/{nodeId}/disablescheduling": { "post": { - "operationId": "Batch_DisableNodeScheduling", + "operationId": "Nodes_DisableNodeScheduling", + "tags": [ + "Nodes" + ], "summary": "Disables Task scheduling on the specified Compute Node.", "description": "You can disable Task scheduling on a Compute Node only if its current\nscheduling state is enabled.", "consumes": [ @@ -6272,14 +6439,17 @@ }, "x-ms-examples": { "Node disable scheduling": { - "$ref": "./examples/NodeDisableScheduling.json" + "$ref": "./examples/Nodes_DisableNodeScheduling.json" } } } }, "/pools/{poolId}/nodes/{nodeId}/enablescheduling": { "post": { - "operationId": "Batch_EnableNodeScheduling", + "operationId": "Nodes_EnableNodeScheduling", + "tags": [ + "Nodes" + ], "summary": "Enables Task scheduling on the specified Compute Node.", "description": "You can enable Task scheduling on a Compute Node only if its current scheduling\nstate is disabled", "parameters": [ @@ -6372,14 +6542,17 @@ }, "x-ms-examples": { "Node enable scheduling": { - "$ref": "./examples/NodeEnableScheduling.json" + "$ref": "./examples/Nodes_EnableNodeScheduling.json" } } } }, "/pools/{poolId}/nodes/{nodeId}/extensions": { "get": { - "operationId": "Batch_ListNodeExtensions", + "operationId": "Nodes_ListNodeExtensions", + "tags": [ + "Nodes" + ], "summary": "Lists the Compute Nodes Extensions in the specified Pool.", "description": "Lists the Compute Nodes Extensions in the specified Pool.", "parameters": [ @@ -6493,7 +6666,7 @@ }, "x-ms-examples": { "List compute node extensions": { - "$ref": "./examples/BatchNodeExtensionList.json" + "$ref": "./examples/Nodes_ListNodeExtensions.json" } }, "x-ms-pageable": { @@ -6503,7 +6676,10 @@ }, "/pools/{poolId}/nodes/{nodeId}/extensions/{extensionName}": { "get": { - "operationId": "Batch_GetNodeExtension", + "operationId": "Nodes_GetNodeExtension", + "tags": [ + "Nodes" + ], "summary": "Gets information about the specified Compute Node Extension.", "description": "Gets information about the specified Compute Node Extension.", "parameters": [ @@ -6613,14 +6789,17 @@ }, "x-ms-examples": { "Get batch node extension": { - "$ref": "./examples/BatchNodeExtensionGet.json" + "$ref": "./examples/Nodes_GetNodeExtension.json" } } } }, "/pools/{poolId}/nodes/{nodeId}/files": { "get": { - "operationId": "Batch_ListNodeFiles", + "operationId": "Nodes_ListNodeFiles", + "tags": [ + "Nodes" + ], "summary": "Lists all of the files in Task directories on the specified Compute Node.", "description": "Lists all of the files in Task directories on the specified Compute Node.", "parameters": [ @@ -6737,7 +6916,7 @@ }, "x-ms-examples": { "File list from node": { - "$ref": "./examples/FileListFromNode.json" + "$ref": "./examples/Nodes_ListNodeFiles.json" } }, "x-ms-pageable": { @@ -6747,7 +6926,10 @@ }, "/pools/{poolId}/nodes/{nodeId}/files/{filePath}": { "get": { - "operationId": "Batch_GetNodeFile", + "operationId": "Nodes_GetNodeFile", + "tags": [ + "Nodes" + ], "description": "Returns the content of the specified Compute Node file.", "produces": [ "application/octet-stream", @@ -6847,8 +7029,7 @@ }, "headers": { "Content-Length": { - "type": "integer", - "format": "int64", + "type": "string", "description": "The length of the file." }, "ETag": { @@ -6896,12 +7077,15 @@ }, "x-ms-examples": { "Get File From Compute Node": { - "$ref": "./examples/FileGetFromNode.json" + "$ref": "./examples/Nodes_GetNodeFile.json" } } }, "delete": { - "operationId": "Batch_DeleteNodeFile", + "operationId": "Nodes_DeleteNodeFile", + "tags": [ + "Nodes" + ], "summary": "Deletes the specified file from the Compute Node.", "description": "Deletes the specified file from the Compute Node.", "parameters": [ @@ -6995,12 +7179,15 @@ }, "x-ms-examples": { "File delete from node": { - "$ref": "./examples/FileDeleteFromNode.json" + "$ref": "./examples/Nodes_DeleteNodeFile.json" } } }, "head": { - "operationId": "Batch_GetNodeFileProperties", + "operationId": "Nodes_GetNodeFileProperties", + "tags": [ + "Nodes" + ], "description": "Gets the properties of the specified Compute Node file.", "parameters": [ { @@ -7086,8 +7273,7 @@ "description": "The request has succeeded.", "headers": { "Content-Length": { - "type": "integer", - "format": "int64", + "type": "string", "description": "The length of the file." }, "ETag": { @@ -7135,14 +7321,17 @@ }, "x-ms-examples": { "File get properties from node": { - "$ref": "./examples/FileGetPropertiesFromNode.json" + "$ref": "./examples/Nodes_GetNodeFileProperties.json" } } } }, "/pools/{poolId}/nodes/{nodeId}/reboot": { "post": { - "operationId": "Batch_RebootNode", + "operationId": "Nodes_RebootNode", + "tags": [ + "Nodes" + ], "summary": "Restarts the specified Compute Node.", "description": "You can restart a Compute Node only if it is in an idle or running state.", "consumes": [ @@ -7247,14 +7436,17 @@ }, "x-ms-examples": { "Node reboot": { - "$ref": "./examples/NodeReboot.json" + "$ref": "./examples/Nodes_RebootNode.json" } } } }, "/pools/{poolId}/nodes/{nodeId}/remoteloginsettings": { "get": { - "operationId": "Batch_GetNodeRemoteLoginSettings", + "operationId": "Nodes_GetNodeRemoteLoginSettings", + "tags": [ + "Nodes" + ], "summary": "Gets the settings required for remote login to a Compute Node.", "description": "Before you can remotely login to a Compute Node using the remote login\nsettings, you must create a user Account on the Compute Node. This API can be\ninvoked only on Pools created with the virtual machine configuration property.", "parameters": [ @@ -7346,14 +7538,17 @@ }, "x-ms-examples": { "Node get remote login settings": { - "$ref": "./examples/NodeGetRemoteLoginSettings.json" + "$ref": "./examples/Nodes_GetNodeRemoteLoginSettings.json" } } } }, "/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs": { "post": { - "operationId": "Batch_UploadNodeLogs", + "operationId": "Nodes_UploadNodeLogs", + "tags": [ + "Nodes" + ], "summary": "Upload Azure Batch service log files from the specified Compute Node to Azure\nBlob Storage.", "description": "This is for gathering Azure Batch service log files in an automated fashion\nfrom Compute Nodes if you are experiencing an error and wish to escalate to\nAzure support. The Azure Batch service log files should be shared with Azure\nsupport to aid in debugging issues with the Batch service.", "consumes": [ @@ -7457,14 +7652,17 @@ }, "x-ms-examples": { "Upload BatchService Logs": { - "$ref": "./examples/NodeUploadBatchServiceLogs.json" + "$ref": "./examples/Nodes_UploadNodeLogs.json" } } } }, "/pools/{poolId}/nodes/{nodeId}/users": { "post": { - "operationId": "Batch_CreateNodeUser", + "operationId": "Nodes_CreateNodeUser", + "tags": [ + "Nodes" + ], "summary": "Adds a user Account to the specified Compute Node.", "description": "You can add a user Account to a Compute Node only when it is in the idle or\nrunning state.", "consumes": [ @@ -7569,14 +7767,17 @@ }, "x-ms-examples": { "Node create user": { - "$ref": "./examples/NodeCreateUser.json" + "$ref": "./examples/Nodes_CreateNodeUser.json" } } } }, "/pools/{poolId}/nodes/{nodeId}/users/{userName}": { "put": { - "operationId": "Batch_ReplaceNodeUser", + "operationId": "Nodes_ReplaceNodeUser", + "tags": [ + "Nodes" + ], "summary": "Updates the password and expiration time of a user Account on the specified Compute Node.", "description": "This operation replaces of all the updatable properties of the Account. For\nexample, if the expiryTime element is not specified, the current value is\nreplaced with the default value, not left unmodified. You can update a user\nAccount on a Compute Node only when it is in the idle or running state.", "consumes": [ @@ -7688,12 +7889,15 @@ }, "x-ms-examples": { "Node update user": { - "$ref": "./examples/NodeUpdateUser.json" + "$ref": "./examples/Nodes_ReplaceNodeUser.json" } } }, "delete": { - "operationId": "Batch_DeleteNodeUser", + "operationId": "Nodes_DeleteNodeUser", + "tags": [ + "Nodes" + ], "summary": "Deletes a user Account from the specified Compute Node.", "description": "You can delete a user Account to a Compute Node only when it is in the idle or\nrunning state.", "parameters": [ @@ -7780,14 +7984,17 @@ }, "x-ms-examples": { "Node delete user": { - "$ref": "./examples/NodeDeleteUser.json" + "$ref": "./examples/Nodes_DeleteNodeUser.json" } } } }, "/pools/{poolId}/removenodes": { "post": { - "operationId": "Batch_RemoveNodes", + "operationId": "Pools_RemoveNodes", + "tags": [ + "Pools" + ], "summary": "Removes Compute Nodes from the specified Pool.", "description": "This operation can only run when the allocation state of the Pool is steady.\nWhen this operation runs, the allocation state changes from steady to resizing.\nEach request may remove up to 100 nodes.", "consumes": [ @@ -7919,14 +8126,17 @@ }, "x-ms-examples": { "Pool remove nodes": { - "$ref": "./examples/PoolRemoveNodes.json" + "$ref": "./examples/Pools_RemoveNodes.json" } } } }, "/pools/{poolId}/resize": { "post": { - "operationId": "Batch_ResizePool", + "operationId": "Pools_ResizePool", + "tags": [ + "Pools" + ], "summary": "Changes the number of Compute Nodes that are assigned to a Pool.", "description": "You can only resize a Pool when its allocation state is steady. If the Pool is\nalready resizing, the request fails with status code 409. When you resize a\nPool, the Pool's allocation state changes from steady to resizing. You cannot\nresize Pools which are configured for automatic scaling. If you try to do this,\nthe Batch service returns an error 409. If you resize a Pool downwards, the\nBatch service chooses which Compute Nodes to remove. To remove specific Compute\nNodes, use the Pool remove Compute Nodes API instead.", "consumes": [ @@ -8058,14 +8268,17 @@ }, "x-ms-examples": { "Pool resize": { - "$ref": "./examples/PoolResize.json" + "$ref": "./examples/Pools_ResizePool.json" } } } }, "/pools/{poolId}/stopresize": { "post": { - "operationId": "Batch_StopPoolResize", + "operationId": "Pools_StopPoolResize", + "tags": [ + "Pools" + ], "summary": "Stops an ongoing resize operation on the Pool.", "description": "This does not restore the Pool to its previous state before the resize\noperation: it only stops any further changes being made, and the Pool maintains\nits current state. After stopping, the Pool stabilizes at the number of Compute\nNodes it was at when the stop operation was done. During the stop operation,\nthe Pool allocation state changes first to stopping and then to steady. A\nresize operation need not be an explicit resize Pool request; this API can also\nbe used to halt the initial sizing of the Pool when it is created.", "parameters": [ @@ -8185,14 +8398,17 @@ }, "x-ms-examples": { "Pool stop resize": { - "$ref": "./examples/PoolStopResize.json" + "$ref": "./examples/Pools_StopPoolResize.json" } } } }, "/pools/{poolId}/updateproperties": { "post": { - "operationId": "Batch_ReplacePoolProperties", + "operationId": "Pools_ReplacePoolProperties", + "tags": [ + "Pools" + ], "summary": "Updates the properties of the specified Pool.", "description": "This fully replaces all the updatable properties of the Pool. For example, if\nthe Pool has a StartTask associated with it and if StartTask is not specified\nwith this request, then the Batch service will remove the existing StartTask.", "consumes": [ @@ -8290,14 +8506,17 @@ }, "x-ms-examples": { "Pool update": { - "$ref": "./examples/PoolUpdate.json" + "$ref": "./examples/Pools_ReplacePoolProperties.json" } } } }, "/poolusagemetrics": { "get": { - "operationId": "Batch_ListPoolUsageMetrics", + "operationId": "Pools_ListPoolUsageMetrics", + "tags": [ + "Pools" + ], "summary": "Lists the usage metrics, aggregated by Pool across individual time intervals,\nfor the specified Account.", "description": "If you do not specify a $filter clause including a poolId, the response\nincludes all Pools that existed in the Account in the time range of the\nreturned aggregation intervals. If you do not specify a $filter clause\nincluding a startTime or endTime these filters default to the start and end\ntimes of the last aggregation interval currently available; that is, only the\nlast aggregation interval is returned.", "parameters": [ @@ -8409,7 +8628,7 @@ }, "x-ms-examples": { "Pool list usage metrics": { - "$ref": "./examples/PoolListUsageMetrics.json" + "$ref": "./examples/Pools_ListPoolUsageMetrics.json" } }, "x-ms-pageable": { @@ -8419,7 +8638,10 @@ }, "/supportedimages": { "get": { - "operationId": "Batch_ListSupportedImages", + "operationId": "Pools_ListSupportedImages", + "tags": [ + "Pools" + ], "summary": "Lists all Virtual Machine Images supported by the Azure Batch service.", "description": "Lists all Virtual Machine Images supported by the Azure Batch service.", "parameters": [ @@ -8515,7 +8737,7 @@ }, "x-ms-examples": { "Account list node agent skus": { - "$ref": "./examples/AccountListSupportedImages.json" + "$ref": "./examples/Pools_ListSupportedImages.json" } }, "x-ms-pageable": { @@ -11194,6 +11416,16 @@ ] } }, + "BatchNodeReimageContent": { + "type": "object", + "description": "Parameters for reimaging an Azure Batch Compute Node.", + "properties": { + "nodeReimageOption": { + "$ref": "#/definitions/BatchNodeReimageOption", + "description": "When to reimage the Compute Node and what to do with currently running Tasks. The default value is requeue." + } + } + }, "BatchNodeReimageOption": { "type": "string", "description": "BatchNodeReimageOption enums", @@ -14266,8 +14498,7 @@ "description": "The time at which the file was last modified." }, "contentLength": { - "type": "integer", - "format": "int64", + "type": "string", "description": "The length of the file." }, "contentType": { diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/AccountListPoolNodeCounts.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/AccountListPoolNodeCounts.json deleted file mode 100644 index f613f9f189a0..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/AccountListPoolNodeCounts.json +++ /dev/null @@ -1,129 +0,0 @@ -{ - "operationId": "Batch_ListPoolNodeCounts", - "title": "NodeCountsPayload", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "poolId": "pool1", - "dedicated": { - "creating": 0, - "idle": 0, - "leavingPool": 0, - "offline": 0, - "preempted": 0, - "rebooting": 0, - "reimaging": 0, - "running": 0, - "starting": 0, - "startTaskFailed": 0, - "unknown": 0, - "unusable": 0, - "waitingForStartTask": 0, - "upgradingOS": 0, - "total": 0 - }, - "lowPriority": { - "creating": 0, - "idle": 0, - "leavingPool": 0, - "offline": 0, - "preempted": 0, - "rebooting": 0, - "reimaging": 0, - "running": 2, - "starting": 1, - "startTaskFailed": 0, - "unknown": 0, - "unusable": 0, - "waitingForStartTask": 0, - "upgradingOS": 0, - "total": 3 - } - }, - { - "poolId": "pool2", - "dedicated": { - "creating": 0, - "idle": 1, - "leavingPool": 0, - "offline": 3, - "preempted": 0, - "rebooting": 0, - "reimaging": 0, - "running": 0, - "starting": 0, - "startTaskFailed": 0, - "unknown": 0, - "unusable": 0, - "waitingForStartTask": 0, - "upgradingOS": 0, - "total": 4 - }, - "lowPriority": { - "creating": 0, - "idle": 0, - "leavingPool": 0, - "offline": 0, - "preempted": 0, - "rebooting": 0, - "reimaging": 0, - "running": 0, - "starting": 0, - "startTaskFailed": 0, - "unknown": 0, - "unusable": 0, - "waitingForStartTask": 0, - "upgradingOS": 0, - "total": 0 - } - }, - { - "poolId": "pool3", - "dedicated": { - "creating": 0, - "idle": 5, - "leavingPool": 0, - "offline": 0, - "preempted": 0, - "rebooting": 0, - "reimaging": 4, - "running": 0, - "starting": 0, - "startTaskFailed": 0, - "unknown": 0, - "unusable": 0, - "waitingForStartTask": 0, - "upgradingOS": 0, - "total": 9 - }, - "lowPriority": { - "creating": 7, - "idle": 0, - "leavingPool": 0, - "offline": 0, - "preempted": 0, - "rebooting": 0, - "reimaging": 0, - "running": 4, - "starting": 0, - "startTaskFailed": 0, - "unknown": 0, - "unusable": 0, - "waitingForStartTask": 0, - "upgradingOS": 0, - "total": 11 - } - } - ] - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/AccountListSupportedImages.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/AccountListSupportedImages.json deleted file mode 100644 index 6987a7964959..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/AccountListSupportedImages.json +++ /dev/null @@ -1,78 +0,0 @@ -{ - "operationId": "Batch_ListSupportedImages", - "title": "Account list node agent skus", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "nodeAgentSKUId": "batch.node.centos 7", - "imageReference": { - "publisher": "OpenLogic", - "offer": "CentOS", - "sku": "7.2", - "version": "latest" - }, - "verificationType": "verified", - "capabilities": [ - "DockerCompatible", - "NvidiaTeslaDriverInstalled" - ], - "osType": "linux" - }, - { - "nodeAgentSKUId": "batch.node.centos 7", - "imageReference": { - "publisher": "OpenLogic", - "offer": "CentOS", - "sku": "7.1", - "version": "latest" - }, - "verificationType": "unverified", - "osType": "linux", - "batchSupportEndOfLife": "2019-11-01T00:00:00.0Z" - }, - { - "nodeAgentSKUId": "batch.node.debian 8", - "imageReference": { - "publisher": "Credativ", - "offer": "Debian", - "sku": "8", - "version": "latest" - }, - "verificationType": "verified", - "osType": "linux" - }, - { - "nodeAgentSKUId": "batch.node.windows amd64", - "imageReference": { - "publisher": "MicrosoftWindowsServer", - "offer": "WindowsServer", - "sku": "2012-R2-Datacenter", - "version": "latest" - }, - "verificationType": "verified", - "osType": "windows" - }, - { - "nodeAgentSKUId": "batch.node.windows amd64", - "imageReference": { - "publisher": "MicrosoftWindowsServer", - "offer": "WindowsServer", - "sku": "2012-Datacenter", - "version": "latest" - }, - "verificationType": "verified", - "osType": "windows" - } - ] - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/ApplicationGet.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/ApplicationGet.json deleted file mode 100644 index 738c87bc223b..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/ApplicationGet.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "operationId": "Batch_GetApplication", - "title": "Get applications", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "applicationId": "my_application_id" - }, - "responses": { - "200": { - "body": { - "id": "my_application_id", - "versions": [ - "v1.0" - ], - "displayName": "my_display_name" - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/ApplicationList.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/ApplicationList.json deleted file mode 100644 index 87a0e2329135..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/ApplicationList.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "operationId": "Batch_ListApplications", - "title": "List applications", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "my_application_id", - "versions": [ - "v1.0" - ], - "displayName": "my_display_name" - } - ] - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Applications_GetApplication.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Applications_GetApplication.json new file mode 100644 index 000000000000..e18b17fbaab0 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Applications_GetApplication.json @@ -0,0 +1,22 @@ +{ + "operationId": "Applications_GetApplication", + "title": "Get applications", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "applicationId": "my_application_id" + }, + "responses": { + "200": { + "body": { + "id": "my_application_id", + "versions": [ + "v1.0" + ], + "displayName": "my_display_name" + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Applications_ListApplications.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Applications_ListApplications.json new file mode 100644 index 000000000000..d4c8edbf5e5a --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Applications_ListApplications.json @@ -0,0 +1,25 @@ +{ + "operationId": "Applications_ListApplications", + "title": "List applications", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "my_application_id", + "versions": [ + "v1.0" + ], + "displayName": "my_display_name" + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/BatchNodeExtensionGet.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/BatchNodeExtensionGet.json deleted file mode 100644 index f1ca14f2f17e..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/BatchNodeExtensionGet.json +++ /dev/null @@ -1,37 +0,0 @@ -{ - "operationId": "Batch_GetNodeExtension", - "title": "Get batch node extension", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "poolId": "poolId", - "nodeId": "tvm-1695681911_2-20161122t193202z", - "extensionName": "batchNodeExtension", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "instanceView": { - "name": "batchNodeExtension", - "statuses": [ - { - "code": "ProvisioningState/succeeded", - "level": "Info", - "displayStatus": "Provisioning succeeded", - "message": "Enable succeeded: Enabling and starting agent and controller" - } - ] - }, - "vmExtension": { - "name": "batchNodeExtension", - "publisher": "Microsoft.Azure.Extensions", - "type": "CustomScript", - "typeHandlerVersion": "2.0", - "autoUpgradeMinorVersion": true - } - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/BatchNodeExtensionList.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/BatchNodeExtensionList.json deleted file mode 100644 index 03882514b379..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/BatchNodeExtensionList.json +++ /dev/null @@ -1,61 +0,0 @@ -{ - "operationId": "Batch_ListNodeExtensions", - "title": "List compute node extensions", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "nodeId": "tvm-1695681911_2-20161122t193202z", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "instanceView": { - "name": "batchNodeExtension", - "statuses": [ - { - "code": "ProvisioningState/succeeded", - "level": "Info", - "displayStatus": "Provisioning succeeded", - "message": "Enable succeeded: Enabling and starting agent and controller" - } - ] - }, - "vmExtension": { - "name": "batchNodeExtension", - "publisher": "Microsoft.Azure.Extensions", - "type": "CustomScript", - "typeHandlerVersion": "2.0", - "autoUpgradeMinorVersion": true - } - }, - { - "instanceView": { - "name": "customExtension", - "statuses": [ - { - "code": "ProvisioningState/succeeded", - "level": "Info", - "displayStatus": "Provisioning succeeded", - "message": "ExtensionOperation:enable. Status:Success" - } - ] - }, - "vmExtension": { - "name": "customExtension", - "publisher": "Microsoft.Azure.Geneva", - "type": "GenevaMonitoring", - "typeHandlerVersion": "2.0", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true - } - } - ] - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/FileDeleteFromNode.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/FileDeleteFromNode.json deleted file mode 100644 index da9f49aeed3b..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/FileDeleteFromNode.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "operationId": "Batch_DeleteNodeFile", - "title": "File delete from node", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "nodeId": "tvm-1695681911_1-20161122t193202z", - "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "recursive": false - }, - "responses": { - "200": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/FileDeleteFromTask.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/FileDeleteFromTask.json deleted file mode 100644 index b5b7a691b4f8..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/FileDeleteFromTask.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "operationId": "Batch_DeleteTaskFile", - "title": "File delete from task", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "taskId": "task1", - "filePath": "wd\\testFile.txt", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "recursive": false - }, - "responses": { - "200": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/FileGetFromNode.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/FileGetFromNode.json deleted file mode 100644 index 7e5a1b9b336b..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/FileGetFromNode.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "operationId": "Batch_GetNodeFile", - "title": "Get File From Compute Node", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "nodeId": "nodeId", - "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", - "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", - "ocp-batch-file-isdirectory": "false", - "Content-Length": "17", - "Content-Type": "application/octet-stream", - "body": "This is actually a byte stream. This request/response is being presented as a string for readability in the example" - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/FileGetFromTask.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/FileGetFromTask.json deleted file mode 100644 index 28566edf56ab..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/FileGetFromTask.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "operationId": "Batch_GetTaskFile", - "title": "Get File From Task", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "taskId": "task1", - "filePath": "wd\\testFile.txt", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", - "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", - "ocp-batch-file-isdirectory": "false", - "Content-Length": "17", - "Content-Type": "application/octet-stream", - "body": "This is actually a byte stream. This request/response is being presented as a string for readability in the example" - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/FileGetPropertiesFromNode.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/FileGetPropertiesFromNode.json deleted file mode 100644 index ac1a82fd5bcb..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/FileGetPropertiesFromNode.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "operationId": "Batch_GetNodeFileProperties", - "title": "File get properties from node", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "nodeId": "nodeId", - "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", - "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", - "ocp-batch-file-isdirectory": "false", - "Content-Length": "17", - "Content-Type": "application/octet-stream" - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/FileGetPropertiesFromTask.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/FileGetPropertiesFromTask.json deleted file mode 100644 index 9032d4768b77..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/FileGetPropertiesFromTask.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "operationId": "Batch_GetTaskFileProperties", - "title": "File get properties from task", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "taskId": "taskId", - "filePath": "wd\\testFile.txt", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", - "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", - "ocp-batch-file-isdirectory": "false", - "Content-Length": "17", - "Content-Type": "application/octet-stream" - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/FileListFromNode.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/FileListFromNode.json deleted file mode 100644 index 68b23892ccc5..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/FileListFromNode.json +++ /dev/null @@ -1,48 +0,0 @@ -{ - "operationId": "Batch_ListNodeFiles", - "title": "File list from node", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "nodeId": "tvm-1695681911_1-20161122t193202z", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "recursive": false - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "shared", - "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/shared", - "isDirectory": true - }, - { - "name": "startup\\ProcessEnv.cmd", - "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/startup\\ProcessEnv.cmd", - "isDirectory": false, - "properties": { - "creationTime": "2014-09-19T21:56:17.679195Z", - "lastModified": "2014-09-19T21:56:17.679195Z", - "contentLength": 1813, - "contentType": "application/octet-stream" - } - }, - { - "name": "startup\\stderr.txt", - "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/startup\\stderr.txt", - "isDirectory": false, - "properties": { - "creationTime": "2014-09-19T21:56:17.5590855Z", - "lastModified": "2014-09-19T21:56:17.5590855Z", - "contentLength": 0, - "contentType": "application/octet-stream" - } - } - ] - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/FileListFromTask.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/FileListFromTask.json deleted file mode 100644 index 20d49989c8a0..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/FileListFromTask.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "operationId": "Batch_ListTaskFiles", - "title": "File list from task", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "taskId": "taskId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "recursive": false - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "startup\\ProcessEnv.cmd", - "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId/files/startup\\ProcessEnv.cmd", - "isDirectory": false, - "properties": { - "creationTime": "2014-09-19T21:56:17.679195Z", - "lastModified": "2014-09-19T21:56:17.679195Z", - "contentLength": 1813, - "contentType": "application/octet-stream" - } - }, - { - "name": "startup\\stderr.txt", - "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId/files/startup\\stderr.txt", - "isDirectory": false, - "properties": { - "creationTime": "2014-09-19T21:56:17.5590855Z", - "lastModified": "2014-09-19T21:56:17.5590855Z", - "contentLength": 0, - "contentType": "application/octet-stream" - } - } - ] - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobCreate_Basic.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobCreate_Basic.json deleted file mode 100644 index 0ad432d26cf5..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobCreate_Basic.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "operationId": "Batch_CreateJob", - "title": "Creates a basic job", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "job": { - "id": "jobId", - "priority": 0, - "poolInfo": { - "poolId": "poolId" - } - } - }, - "responses": { - "201": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobCreate_Complex.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobCreate_Complex.json deleted file mode 100644 index 2ece9cf6ca27..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobCreate_Complex.json +++ /dev/null @@ -1,118 +0,0 @@ -{ - "operationId": "Batch_CreateJob", - "title": "Creates a complex job", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "job": { - "id": "jobId", - "priority": 100, - "constraints": { - "maxWallClockTime": "PT1H", - "maxTaskRetryCount": -1 - }, - "jobManagerTask": { - "id": "taskId", - "commandLine": "myprogram.exe", - "resourceFiles": [ - { - "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram.exe?sas", - "filePath": "myprogram.exe" - }, - { - "storageContainerUrl": "http://mystorage1.blob.core.windows.net/data?sas", - "filePath": "datafolder" - } - ], - "environmentSettings": [ - { - "name": "myvariable", - "value": "myvalue" - } - ], - "constraints": { - "maxWallClockTime": "PT1H", - "maxTaskRetryCount": 0, - "retentionTime": "PT1H" - }, - "requiredSlots": 2, - "killJobOnCompletion": false, - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "admin" - } - }, - "runExclusive": true - }, - "poolInfo": { - "autoPoolSpecification": { - "autoPoolIdPrefix": "mypool", - "poolLifetimeOption": "job", - "pool": { - "vmSize": "Standard_D1_v2", - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "MicrosoftWindowsServer", - "offer": "WindowsServer", - "sku": "2016-datacenter-smalldisk", - "version": "latest" - }, - "nodeAgentSKUId": "batch.node.windows amd64" - }, - "resizeTimeout": "PT15M", - "targetDedicatedNodes": 3, - "targetLowPriorityNodes": 0, - "taskSlotsPerNode": 2, - "taskSchedulingPolicy": { - "nodeFillType": "spread" - }, - "enableAutoScale": false, - "enableInterNodeCommunication": true, - "startTask": { - "commandLine": "myprogram2.exe", - "resourceFiles": [ - { - "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram2.exe?sas", - "filePath": "myprogram2.exe" - } - ], - "environmentSettings": [ - { - "name": "myvariable", - "value": "myvalue" - } - ], - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "admin" - } - }, - "maxTaskRetryCount": 2, - "waitForSuccess": true - }, - "metadata": [ - { - "name": "myproperty", - "value": "myvalue" - } - ], - "targetNodeCommunicationMode": "default" - } - } - }, - "metadata": [ - { - "name": "myproperty", - "value": "myvalue" - } - ] - } - }, - "responses": { - "201": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobDelete.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobDelete.json deleted file mode 100644 index 88a65f34775a..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobDelete.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "operationId": "Batch_DeleteJob", - "title": "Delete Job", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "202": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobDisable.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobDisable.json deleted file mode 100644 index 096976ec9e42..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobDisable.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "operationId": "Batch_DisableJob", - "title": "Job disable", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "content": { - "disableTasks": "terminate" - } - }, - "responses": { - "202": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobEnable.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobEnable.json deleted file mode 100644 index d8ffa6551896..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobEnable.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "operationId": "Batch_EnableJob", - "title": "Job enable", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "202": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobGet.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobGet.json deleted file mode 100644 index 7b7fdef9e0e7..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobGet.json +++ /dev/null @@ -1,45 +0,0 @@ -{ - "operationId": "Batch_GetJob", - "title": "Job get", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "id": "jobId", - "url": "https://account.region.batch.azure.com/jobs/jobId", - "eTag": "0x8D4100FC49F0278", - "lastModified": "2016-11-19T00:05:27.5391608Z", - "creationTime": "2016-11-19T00:05:25.311915Z", - "state": "completed", - "stateTransitionTime": "2016-11-19T00:05:27.578581Z", - "previousState": "active", - "previousStateTransitionTime": "2016-11-19T00:05:27.2137716Z", - "priority": 0, - "maxParallelTasks": -1, - "allowTaskPreemption": false, - "usesTaskDependencies": false, - "constraints": { - "maxWallClockTime": "P10675199DT2H48M5.4775807S", - "maxTaskRetryCount": 0 - }, - "poolInfo": { - "poolId": "poolId" - }, - "executionInfo": { - "startTime": "2016-11-19T00:05:25.3309105Z", - "endTime": "2016-11-19T00:05:27.578581Z", - "poolId": "poolId", - "terminateReason": "UserTerminate" - }, - "onAllTasksComplete": "noaction", - "onTaskFailure": "noaction" - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobGetTaskCounts.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobGetTaskCounts.json deleted file mode 100644 index 44c35dfefc05..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobGetTaskCounts.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "operationId": "Batch_GetJobTaskCounts", - "title": "Job get task counts", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "taskCounts": { - "active": 5, - "running": 7, - "completed": 4, - "succeeded": 2, - "failed": 2 - }, - "taskSlotCounts": { - "active": 5, - "running": 7, - "completed": 4, - "succeeded": 2, - "failed": 2 - } - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobList.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobList.json deleted file mode 100644 index 6c8282b040b7..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobList.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "operationId": "Batch_ListJobs", - "title": "Job list", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "jobId", - "url": "https://account.region.batch.azure.com/jobs/jobId", - "eTag": "0x8D4100FC46D5BF4", - "lastModified": "2016-11-19T00:05:27.2137716Z", - "creationTime": "2016-11-19T00:05:25.311915Z", - "state": "active", - "stateTransitionTime": "2016-11-19T00:05:27.2137716Z", - "previousState": "disabled", - "previousStateTransitionTime": "2016-11-19T00:05:26.88777Z", - "priority": 0, - "maxParallelTasks": -1, - "allowTaskPreemption": false, - "usesTaskDependencies": false, - "constraints": { - "maxWallClockTime": "P10675199DT2H48M5.4775807S", - "maxTaskRetryCount": 0 - }, - "poolInfo": { - "poolId": "poolId" - }, - "executionInfo": { - "startTime": "2016-11-19T00:05:25.3309105Z", - "poolId": "poolId" - }, - "onAllTasksComplete": "noaction", - "onTaskFailure": "noaction" - } - ] - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobListFromJobSchedule.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobListFromJobSchedule.json deleted file mode 100644 index b43983007f9a..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobListFromJobSchedule.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "operationId": "Batch_ListJobsFromSchedule", - "title": "List Job Under Job Schedule", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobScheduleId": "jobScheduleId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "jobId", - "url": "https://account.region.batch.azure.com/jobs/jobId", - "eTag": "0x8D4100FC46D5BF4", - "lastModified": "2016-11-19T00:05:27.2137716Z", - "creationTime": "2016-11-19T00:05:25.311915Z", - "state": "active", - "stateTransitionTime": "2016-11-19T00:05:27.2137716Z", - "previousState": "disabled", - "previousStateTransitionTime": "2016-11-19T00:05:26.88777Z", - "priority": 0, - "maxParallelTasks": -1, - "allowTaskPreemption": false, - "usesTaskDependencies": false, - "constraints": { - "maxWallClockTime": "P10675199DT2H48M5.4775807S", - "maxTaskRetryCount": 0 - }, - "poolInfo": { - "poolId": "poolId" - }, - "executionInfo": { - "startTime": "2016-11-19T00:05:25.3309105Z", - "poolId": "poolId" - }, - "onAllTasksComplete": "noaction", - "onTaskFailure": "noaction" - } - ] - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobListPreparationAndReleaseTaskStatus.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobListPreparationAndReleaseTaskStatus.json deleted file mode 100644 index 8e3cab74dcfe..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobListPreparationAndReleaseTaskStatus.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "operationId": "Batch_ListJobPreparationAndReleaseTaskStatus", - "title": "Job list preparation and release task status", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "poolId": "poolId", - "nodeId": "tvm-2167304207_1-20140905t174658z", - "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z", - "jobPreparationTaskExecutionInfo": { - "state": "completed", - "startTime": "2015-05-01T10:20:31Z", - "endTime": "2015-05-02T20:12:42Z", - "taskRootDirectory": "tasks/myjob/job-1/myjobpreptask", - "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z/files/tasks/myjob/job-1/myjobpreptask", - "exitCode": 0, - "retryCount": 0 - }, - "jobReleaseTaskExecutionInfo": { - "state": "completed", - "startTime": "2015-05-01T10:20:31Z", - "endTime": "2015-05-02T20:12:42Z", - "taskRootDirectory": "tasks/myjob/job-1/myjobreleasetask", - "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z/files/tasks/myjob/job-1/myjobreleasetask", - "exitCode": 0 - } - } - ], - "odata.nextLink": "https://account.region.batch.azure.com/jobs/myjob/jobpreparationandreleasestatus?$skipToken=tvm-2167304207_1-20140905t174658z&api-version=2024-02-01.19.0" - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobPatch.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobPatch.json deleted file mode 100644 index 2d6cb6308411..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobPatch.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "operationId": "Batch_UpdateJob", - "title": "Job patch", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "job": { - "priority": 100, - "constraints": { - "maxWallClockTime": "PT1H", - "maxTaskRetryCount": -1 - }, - "poolInfo": { - "poolId": "poolId" - } - } - }, - "responses": { - "200": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobScheduleCreate_Basic.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobScheduleCreate_Basic.json deleted file mode 100644 index 99ab243382ce..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobScheduleCreate_Basic.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "operationId": "Batch_CreateJobSchedule", - "title": "Creates a basic JobSchedule", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "jobSchedule": { - "id": "jobScheduleId", - "schedule": { - "recurrenceInterval": "PT5M" - }, - "jobSpecification": { - "poolInfo": { - "poolId": "poolId" - } - } - } - }, - "responses": { - "201": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobScheduleCreate_Complex.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobScheduleCreate_Complex.json deleted file mode 100644 index fdae20cb6a52..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobScheduleCreate_Complex.json +++ /dev/null @@ -1,126 +0,0 @@ -{ - "operationId": "Batch_CreateJobSchedule", - "title": "Creates a complex JobScheduleAdd", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "jobSchedule": { - "id": "jobScheduleId", - "schedule": { - "doNotRunUntil": "2014-09-10T02:30:00.000Z", - "doNotRunAfter": "2014-09-10T06:30:00.000Z", - "startWindow": "PT1M", - "recurrenceInterval": "PT5M" - }, - "jobSpecification": { - "priority": 100, - "constraints": { - "maxWallClockTime": "PT1H", - "maxTaskRetryCount": -1 - }, - "jobManagerTask": { - "id": "mytask1", - "commandLine": "myprogram.exe", - "resourceFiles": [ - { - "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram.exe?sas", - "filePath": "myprogram.exe" - }, - { - "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/test.txt?sas", - "filePath": "test.txt" - } - ], - "environmentSettings": [ - { - "name": "myvariable", - "value": "myvalue" - } - ], - "constraints": { - "maxWallClockTime": "PT1H", - "maxTaskRetryCount": 0, - "retentionTime": "PT1H" - }, - "requiredSlots": 2, - "killJobOnCompletion": true, - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "nonadmin" - } - }, - "runExclusive": true - }, - "poolInfo": { - "autoPoolSpecification": { - "autoPoolIdPrefix": "mypool", - "poolLifetimeOption": "jobschedule", - "pool": { - "vmSize": "Standard_D1_v2", - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "MicrosoftWindowsServer", - "offer": "WindowsServer", - "sku": "2016-datacenter-smalldisk", - "version": "latest" - }, - "nodeAgentSKUId": "batch.node.windows amd64" - }, - "resizeTimeout": "PT15M", - "targetDedicatedNodes": 3, - "targetLowPriorityNodes": 0, - "taskSlotsPerNode": 2, - "taskSchedulingPolicy": { - "nodeFillType": "spread" - }, - "enableAutoScale": false, - "enableInterNodeCommunication": true, - "startTask": { - "commandLine": "myprogram2.exe", - "resourceFiles": [ - { - "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram2.exe?sas", - "filePath": "myprogram2.exe" - } - ], - "environmentSettings": [ - { - "name": "myvariable", - "value": "myvalue" - } - ], - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "admin" - } - }, - "maxTaskRetryCount": 2, - "waitForSuccess": true - }, - "metadata": [ - { - "name": "myproperty", - "value": "myvalue" - } - ], - "targetNodeCommunicationMode": "default" - } - } - } - }, - "metadata": [ - { - "name": "myproperty", - "value": "myvalue" - } - ] - } - }, - "responses": { - "201": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobScheduleDelete.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobScheduleDelete.json deleted file mode 100644 index 33fc294b493c..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobScheduleDelete.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "operationId": "Batch_DeleteJobSchedule", - "title": "JobSchedule delete", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobScheduleId": "jobScheduleId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "202": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobScheduleDisable.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobScheduleDisable.json deleted file mode 100644 index 8b9b0add1575..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobScheduleDisable.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "operationId": "Batch_DisableJobSchedule", - "title": "JobSchedule disable", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobScheduleId": "jobScheduleId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "204": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobScheduleEnable.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobScheduleEnable.json deleted file mode 100644 index dada6efbb4c4..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobScheduleEnable.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "operationId": "Batch_EnableJobSchedule", - "title": "JobSchedule enable", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobScheduleId": "jobScheduleId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "204": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobScheduleExists.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobScheduleExists.json deleted file mode 100644 index f74c2f7c90a5..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobScheduleExists.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "operationId": "Batch_JobScheduleExists", - "title": "Check Job Schedule Exists", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobScheduleId": "jobScheduleId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": {}, - "404": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobScheduleGet.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobScheduleGet.json deleted file mode 100644 index 224776fa102a..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobScheduleGet.json +++ /dev/null @@ -1,48 +0,0 @@ -{ - "operationId": "Batch_GetJobSchedule", - "title": "JobSchedule get", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobScheduleId": "jobScheduleId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "id": "jobScheduleId", - "url": "https://account.region.batch.azure.com/jobschedules/jobScheduleId", - "eTag": "0x8D40FFD2E848323", - "lastModified": "2016-11-18T21:52:24.7661347Z", - "creationTime": "2016-11-18T21:52:22.5431125Z", - "state": "completed", - "stateTransitionTime": "2016-11-18T21:52:24.8371778Z", - "previousState": "active", - "previousStateTransitionTime": "2016-11-18T21:52:24.0064874Z", - "jobSpecification": { - "priority": 0, - "maxParallelTasks": -1, - "allowTaskPreemption": false, - "usesTaskDependencies": false, - "onAllTasksComplete": "noaction", - "onTaskFailure": "noaction", - "constraints": { - "maxWallClockTime": "P10675199DT2H48M5.4775807S", - "maxTaskRetryCount": 0 - }, - "poolInfo": { - "poolId": "testPool" - } - }, - "executionInfo": { - "recentJob": { - "url": "https://account.region.batch.azure.com/jobschedules/jobScheduleId:job-1", - "id": "jobScheduleId:job-1" - }, - "endTime": "2016-11-18T21:52:24.8371778Z" - } - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobScheduleList.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobScheduleList.json deleted file mode 100644 index 9559a72029cb..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobScheduleList.json +++ /dev/null @@ -1,79 +0,0 @@ -{ - "operationId": "Batch_ListJobSchedules", - "title": "JobSchedule list", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "jobSchedule1", - "url": "https://account.region.batch.azure.com/jobschedules/jobSchedule1", - "eTag": "0x8D40FFD2E10996A", - "lastModified": "2016-11-18T21:52:24.0064874Z", - "creationTime": "2016-11-18T21:52:22.5431125Z", - "state": "active", - "stateTransitionTime": "2016-11-18T21:52:24.0064874Z", - "previousState": "disabled", - "previousStateTransitionTime": "2016-11-18T21:52:23.6471782Z", - "jobSpecification": { - "priority": 0, - "maxParallelTasks": -1, - "allowTaskPreemption": false, - "usesTaskDependencies": false, - "onAllTasksComplete": "noaction", - "onTaskFailure": "noaction", - "constraints": { - "maxWallClockTime": "P10675199DT2H48M5.4775807S", - "maxTaskRetryCount": 0 - }, - "poolInfo": { - "poolId": "poolId" - } - }, - "executionInfo": { - "recentJob": { - "url": "https://account.region.batch.azure.com/jobs/jobSchedule1:job-1", - "id": "jobSchedule1:job-1" - } - } - }, - { - "id": "jobSchedule2", - "url": "https://account.region.batch.azure.com/jobschedules/jobSchedule2", - "eTag": "0x8D40FFCFF760B51", - "lastModified": "2016-11-18T21:51:05.8184017Z", - "creationTime": "2016-11-18T21:51:05.8184017Z", - "state": "active", - "stateTransitionTime": "2016-11-18T21:51:05.8184017Z", - "schedule": { - "doNotRunUntil": "2020-01-01T12:30:00Z" - }, - "jobSpecification": { - "priority": 0, - "maxParallelTasks": -1, - "usesTaskDependencies": false, - "onAllTasksComplete": "noaction", - "onTaskFailure": "noaction", - "constraints": { - "maxWallClockTime": "P10675199DT2H48M5.4775807S", - "maxTaskRetryCount": 0 - }, - "poolInfo": { - "poolId": "testPool2" - } - }, - "executionInfo": { - "nextRunTime": "2020-01-01T12:30:00Z" - } - } - ] - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedulePatch.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedulePatch.json deleted file mode 100644 index 6b464dc76c36..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedulePatch.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "operationId": "Batch_UpdateJobSchedule", - "title": "JobSchedule patch", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobScheduleId": "jobScheduleId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "jobSchedule": { - "schedule": { - "doNotRunUntil": "2025-01-01T12:30:00Z" - }, - "jobSpecification": { - "priority": 0, - "usesTaskDependencies": false, - "constraints": { - "maxWallClockTime": "P10675199DT2H48M5.4775807S", - "maxTaskRetryCount": 0 - }, - "poolInfo": { - "poolId": "poolId" - } - } - } - }, - "responses": { - "200": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobScheduleTerminate.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobScheduleTerminate.json deleted file mode 100644 index 46fc6228dbe8..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobScheduleTerminate.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "operationId": "Batch_TerminateJobSchedule", - "title": "JobSchedule terminate", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobScheduleId": "jobScheduleId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "202": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobScheduleUpdate.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobScheduleUpdate.json deleted file mode 100644 index 2063e67201b0..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobScheduleUpdate.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "operationId": "Batch_ReplaceJobSchedule", - "title": "JobSchedule update", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobScheduleId": "jobScheduleId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "jobSchedule": { - "schedule": { - "doNotRunUntil": "2025-01-01T12:30:00Z" - }, - "jobSpecification": { - "priority": 0, - "usesTaskDependencies": false, - "constraints": { - "maxWallClockTime": "P10675199DT2H48M5.4775807S", - "maxTaskRetryCount": 0 - }, - "poolInfo": { - "poolId": "poolId" - } - } - } - }, - "responses": { - "200": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_CreateJobSchedule_Basic.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_CreateJobSchedule_Basic.json new file mode 100644 index 000000000000..73996de79a79 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_CreateJobSchedule_Basic.json @@ -0,0 +1,24 @@ +{ + "operationId": "JobSchedules_CreateJobSchedule", + "title": "Creates a basic JobSchedule", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobSchedule": { + "id": "jobScheduleId", + "schedule": { + "recurrenceInterval": "PT5M" + }, + "jobSpecification": { + "poolInfo": { + "poolId": "poolId" + } + } + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_CreateJobSchedule_Complex.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_CreateJobSchedule_Complex.json new file mode 100644 index 000000000000..6d4387e11cfe --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_CreateJobSchedule_Complex.json @@ -0,0 +1,126 @@ +{ + "operationId": "JobSchedules_CreateJobSchedule", + "title": "Creates a complex JobScheduleAdd", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobSchedule": { + "id": "jobScheduleId", + "schedule": { + "doNotRunUntil": "2014-09-10T02:30:00.000Z", + "doNotRunAfter": "2014-09-10T06:30:00.000Z", + "startWindow": "PT1M", + "recurrenceInterval": "PT5M" + }, + "jobSpecification": { + "priority": 100, + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": -1 + }, + "jobManagerTask": { + "id": "mytask1", + "commandLine": "myprogram.exe", + "resourceFiles": [ + { + "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram.exe?sas", + "filePath": "myprogram.exe" + }, + { + "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/test.txt?sas", + "filePath": "test.txt" + } + ], + "environmentSettings": [ + { + "name": "myvariable", + "value": "myvalue" + } + ], + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": 0, + "retentionTime": "PT1H" + }, + "requiredSlots": 2, + "killJobOnCompletion": true, + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "runExclusive": true + }, + "poolInfo": { + "autoPoolSpecification": { + "autoPoolIdPrefix": "mypool", + "poolLifetimeOption": "jobschedule", + "pool": { + "vmSize": "Standard_D1_v2", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.windows amd64" + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 2, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false, + "enableInterNodeCommunication": true, + "startTask": { + "commandLine": "myprogram2.exe", + "resourceFiles": [ + { + "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram2.exe?sas", + "filePath": "myprogram2.exe" + } + ], + "environmentSettings": [ + { + "name": "myvariable", + "value": "myvalue" + } + ], + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "admin" + } + }, + "maxTaskRetryCount": 2, + "waitForSuccess": true + }, + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ], + "targetNodeCommunicationMode": "default" + } + } + } + }, + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ] + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_DeleteJobSchedule.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_DeleteJobSchedule.json new file mode 100644 index 000000000000..4eb1b3ba028d --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_DeleteJobSchedule.json @@ -0,0 +1,14 @@ +{ + "operationId": "JobSchedules_DeleteJobSchedule", + "title": "JobSchedule delete", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_DisableJobSchedule.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_DisableJobSchedule.json new file mode 100644 index 000000000000..641df039a089 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_DisableJobSchedule.json @@ -0,0 +1,14 @@ +{ + "operationId": "JobSchedules_DisableJobSchedule", + "title": "JobSchedule disable", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "204": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_EnableJobSchedule.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_EnableJobSchedule.json new file mode 100644 index 000000000000..f34cbbb0fc1b --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_EnableJobSchedule.json @@ -0,0 +1,14 @@ +{ + "operationId": "JobSchedules_EnableJobSchedule", + "title": "JobSchedule enable", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "204": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_GetJobSchedule.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_GetJobSchedule.json new file mode 100644 index 000000000000..223be7fe95b6 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_GetJobSchedule.json @@ -0,0 +1,48 @@ +{ + "operationId": "JobSchedules_GetJobSchedule", + "title": "JobSchedule get", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "jobScheduleId", + "url": "https://account.region.batch.azure.com/jobschedules/jobScheduleId", + "eTag": "0x8D40FFD2E848323", + "lastModified": "2016-11-18T21:52:24.7661347Z", + "creationTime": "2016-11-18T21:52:22.5431125Z", + "state": "completed", + "stateTransitionTime": "2016-11-18T21:52:24.8371778Z", + "previousState": "active", + "previousStateTransitionTime": "2016-11-18T21:52:24.0064874Z", + "jobSpecification": { + "priority": 0, + "maxParallelTasks": -1, + "allowTaskPreemption": false, + "usesTaskDependencies": false, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction", + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "testPool" + } + }, + "executionInfo": { + "recentJob": { + "url": "https://account.region.batch.azure.com/jobschedules/jobScheduleId:job-1", + "id": "jobScheduleId:job-1" + }, + "endTime": "2016-11-18T21:52:24.8371778Z" + } + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_JobScheduleExists.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_JobScheduleExists.json new file mode 100644 index 000000000000..00d523f0fe70 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_JobScheduleExists.json @@ -0,0 +1,15 @@ +{ + "operationId": "JobSchedules_JobScheduleExists", + "title": "Check Job Schedule Exists", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": {}, + "404": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_ListJobSchedules.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_ListJobSchedules.json new file mode 100644 index 000000000000..5f873b246975 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_ListJobSchedules.json @@ -0,0 +1,79 @@ +{ + "operationId": "JobSchedules_ListJobSchedules", + "title": "JobSchedule list", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "jobSchedule1", + "url": "https://account.region.batch.azure.com/jobschedules/jobSchedule1", + "eTag": "0x8D40FFD2E10996A", + "lastModified": "2016-11-18T21:52:24.0064874Z", + "creationTime": "2016-11-18T21:52:22.5431125Z", + "state": "active", + "stateTransitionTime": "2016-11-18T21:52:24.0064874Z", + "previousState": "disabled", + "previousStateTransitionTime": "2016-11-18T21:52:23.6471782Z", + "jobSpecification": { + "priority": 0, + "maxParallelTasks": -1, + "allowTaskPreemption": false, + "usesTaskDependencies": false, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction", + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + } + }, + "executionInfo": { + "recentJob": { + "url": "https://account.region.batch.azure.com/jobs/jobSchedule1:job-1", + "id": "jobSchedule1:job-1" + } + } + }, + { + "id": "jobSchedule2", + "url": "https://account.region.batch.azure.com/jobschedules/jobSchedule2", + "eTag": "0x8D40FFCFF760B51", + "lastModified": "2016-11-18T21:51:05.8184017Z", + "creationTime": "2016-11-18T21:51:05.8184017Z", + "state": "active", + "stateTransitionTime": "2016-11-18T21:51:05.8184017Z", + "schedule": { + "doNotRunUntil": "2020-01-01T12:30:00Z" + }, + "jobSpecification": { + "priority": 0, + "maxParallelTasks": -1, + "usesTaskDependencies": false, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction", + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "testPool2" + } + }, + "executionInfo": { + "nextRunTime": "2020-01-01T12:30:00Z" + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_ReplaceJobSchedule.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_ReplaceJobSchedule.json new file mode 100644 index 000000000000..3625de2dd434 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_ReplaceJobSchedule.json @@ -0,0 +1,30 @@ +{ + "operationId": "JobSchedules_ReplaceJobSchedule", + "title": "JobSchedule patch", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobSchedule": { + "schedule": { + "doNotRunUntil": "2025-01-01T12:30:00Z" + }, + "jobSpecification": { + "priority": 0, + "usesTaskDependencies": false, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + } + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_TerminateJobSchedule.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_TerminateJobSchedule.json new file mode 100644 index 000000000000..ffd2a483d448 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_TerminateJobSchedule.json @@ -0,0 +1,14 @@ +{ + "operationId": "JobSchedules_TerminateJobSchedule", + "title": "JobSchedule terminate", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_UpdateJobSchedule.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_UpdateJobSchedule.json new file mode 100644 index 000000000000..069a43caf6be --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobSchedules_UpdateJobSchedule.json @@ -0,0 +1,30 @@ +{ + "operationId": "JobSchedules_UpdateJobSchedule", + "title": "JobSchedule update", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobSchedule": { + "schedule": { + "doNotRunUntil": "2025-01-01T12:30:00Z" + }, + "jobSpecification": { + "priority": 0, + "usesTaskDependencies": false, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + } + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobTerminate.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobTerminate.json deleted file mode 100644 index cebd240db243..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobTerminate.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "operationId": "Batch_TerminateJob", - "title": "Job terminate", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "jobTerminateParameter": { - "terminateReason": "User supplied termination reason" - } - }, - "responses": { - "202": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobUpdate.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobUpdate.json deleted file mode 100644 index 7b23d33fa41e..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/JobUpdate.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "operationId": "Batch_ReplaceJob", - "title": "Job update", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "job": { - "priority": 100, - "constraints": { - "maxWallClockTime": "PT1H", - "maxTaskRetryCount": -1 - }, - "poolInfo": { - "poolId": "poolId" - } - } - }, - "responses": { - "200": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_CreateJob_Basic.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_CreateJob_Basic.json new file mode 100644 index 000000000000..baab498938f8 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_CreateJob_Basic.json @@ -0,0 +1,20 @@ +{ + "operationId": "Jobs_CreateJob", + "title": "Creates a basic job", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "job": { + "id": "jobId", + "priority": 0, + "poolInfo": { + "poolId": "poolId" + } + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_CreateJob_Complex.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_CreateJob_Complex.json new file mode 100644 index 000000000000..e84804756085 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_CreateJob_Complex.json @@ -0,0 +1,118 @@ +{ + "operationId": "Jobs_CreateJob", + "title": "Creates a complex job", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "job": { + "id": "jobId", + "priority": 100, + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": -1 + }, + "jobManagerTask": { + "id": "taskId", + "commandLine": "myprogram.exe", + "resourceFiles": [ + { + "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram.exe?sas", + "filePath": "myprogram.exe" + }, + { + "storageContainerUrl": "http://mystorage1.blob.core.windows.net/data?sas", + "filePath": "datafolder" + } + ], + "environmentSettings": [ + { + "name": "myvariable", + "value": "myvalue" + } + ], + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": 0, + "retentionTime": "PT1H" + }, + "requiredSlots": 2, + "killJobOnCompletion": false, + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "admin" + } + }, + "runExclusive": true + }, + "poolInfo": { + "autoPoolSpecification": { + "autoPoolIdPrefix": "mypool", + "poolLifetimeOption": "job", + "pool": { + "vmSize": "Standard_D1_v2", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.windows amd64" + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 2, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false, + "enableInterNodeCommunication": true, + "startTask": { + "commandLine": "myprogram2.exe", + "resourceFiles": [ + { + "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram2.exe?sas", + "filePath": "myprogram2.exe" + } + ], + "environmentSettings": [ + { + "name": "myvariable", + "value": "myvalue" + } + ], + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "admin" + } + }, + "maxTaskRetryCount": 2, + "waitForSuccess": true + }, + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ], + "targetNodeCommunicationMode": "default" + } + } + }, + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ] + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_DeleteJob.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_DeleteJob.json new file mode 100644 index 000000000000..dc0f8e197ecf --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_DeleteJob.json @@ -0,0 +1,14 @@ +{ + "operationId": "Jobs_DeleteJob", + "title": "Delete Job", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_DisableJob.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_DisableJob.json new file mode 100644 index 000000000000..976ee3ca6169 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_DisableJob.json @@ -0,0 +1,17 @@ +{ + "operationId": "Jobs_DisableJob", + "title": "Job disable", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "content": { + "disableTasks": "terminate" + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_EnableJob.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_EnableJob.json new file mode 100644 index 000000000000..ec972d834143 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_EnableJob.json @@ -0,0 +1,14 @@ +{ + "operationId": "Jobs_EnableJob", + "title": "Job enable", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_GetJob.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_GetJob.json new file mode 100644 index 000000000000..fa59fbe1be5d --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_GetJob.json @@ -0,0 +1,45 @@ +{ + "operationId": "Jobs_GetJob", + "title": "Job get", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "jobId", + "url": "https://account.region.batch.azure.com/jobs/jobId", + "eTag": "0x8D4100FC49F0278", + "lastModified": "2016-11-19T00:05:27.5391608Z", + "creationTime": "2016-11-19T00:05:25.311915Z", + "state": "completed", + "stateTransitionTime": "2016-11-19T00:05:27.578581Z", + "previousState": "active", + "previousStateTransitionTime": "2016-11-19T00:05:27.2137716Z", + "priority": 0, + "maxParallelTasks": -1, + "allowTaskPreemption": false, + "usesTaskDependencies": false, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + }, + "executionInfo": { + "startTime": "2016-11-19T00:05:25.3309105Z", + "endTime": "2016-11-19T00:05:27.578581Z", + "poolId": "poolId", + "terminateReason": "UserTerminate" + }, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction" + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_GetJobTaskCounts.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_GetJobTaskCounts.json new file mode 100644 index 000000000000..70f734727ce2 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_GetJobTaskCounts.json @@ -0,0 +1,31 @@ +{ + "operationId": "Jobs_GetJobTaskCounts", + "title": "Job get task counts", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "taskCounts": { + "active": 5, + "running": 7, + "completed": 4, + "succeeded": 2, + "failed": 2 + }, + "taskSlotCounts": { + "active": 5, + "running": 7, + "completed": 4, + "succeeded": 2, + "failed": 2 + } + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_ListJobPreparationAndReleaseTaskStatus.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_ListJobPreparationAndReleaseTaskStatus.json new file mode 100644 index 000000000000..03e36673a779 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_ListJobPreparationAndReleaseTaskStatus.json @@ -0,0 +1,42 @@ +{ + "operationId": "Jobs_ListJobPreparationAndReleaseTaskStatus", + "title": "Job list preparation and release task status", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "poolId": "poolId", + "nodeId": "tvm-2167304207_1-20140905t174658z", + "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z", + "jobPreparationTaskExecutionInfo": { + "state": "completed", + "startTime": "2015-05-01T10:20:31Z", + "endTime": "2015-05-02T20:12:42Z", + "taskRootDirectory": "tasks/myjob/job-1/myjobpreptask", + "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z/files/tasks/myjob/job-1/myjobpreptask", + "exitCode": 0, + "retryCount": 0 + }, + "jobReleaseTaskExecutionInfo": { + "state": "completed", + "startTime": "2015-05-01T10:20:31Z", + "endTime": "2015-05-02T20:12:42Z", + "taskRootDirectory": "tasks/myjob/job-1/myjobreleasetask", + "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z/files/tasks/myjob/job-1/myjobreleasetask", + "exitCode": 0 + } + } + ], + "odata.nextLink": "https://account.region.batch.azure.com/jobs/myjob/jobpreparationandreleasestatus?$skipToken=tvm-2167304207_1-20140905t174658z&api-version=2024-02-01.19.0" + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_ListJobs.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_ListJobs.json new file mode 100644 index 000000000000..487658237517 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_ListJobs.json @@ -0,0 +1,46 @@ +{ + "operationId": "Jobs_ListJobs", + "title": "Job list", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "jobId", + "url": "https://account.region.batch.azure.com/jobs/jobId", + "eTag": "0x8D4100FC46D5BF4", + "lastModified": "2016-11-19T00:05:27.2137716Z", + "creationTime": "2016-11-19T00:05:25.311915Z", + "state": "active", + "stateTransitionTime": "2016-11-19T00:05:27.2137716Z", + "previousState": "disabled", + "previousStateTransitionTime": "2016-11-19T00:05:26.88777Z", + "priority": 0, + "maxParallelTasks": -1, + "allowTaskPreemption": false, + "usesTaskDependencies": false, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + }, + "executionInfo": { + "startTime": "2016-11-19T00:05:25.3309105Z", + "poolId": "poolId" + }, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction" + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_ListJobsFromSchedule.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_ListJobsFromSchedule.json new file mode 100644 index 000000000000..2ba6158c6d78 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_ListJobsFromSchedule.json @@ -0,0 +1,47 @@ +{ + "operationId": "Jobs_ListJobsFromSchedule", + "title": "List Job Under Job Schedule", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "jobId", + "url": "https://account.region.batch.azure.com/jobs/jobId", + "eTag": "0x8D4100FC46D5BF4", + "lastModified": "2016-11-19T00:05:27.2137716Z", + "creationTime": "2016-11-19T00:05:25.311915Z", + "state": "active", + "stateTransitionTime": "2016-11-19T00:05:27.2137716Z", + "previousState": "disabled", + "previousStateTransitionTime": "2016-11-19T00:05:26.88777Z", + "priority": 0, + "maxParallelTasks": -1, + "allowTaskPreemption": false, + "usesTaskDependencies": false, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + }, + "executionInfo": { + "startTime": "2016-11-19T00:05:25.3309105Z", + "poolId": "poolId" + }, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction" + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_ReplaceJob.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_ReplaceJob.json new file mode 100644 index 000000000000..e7b75ae8aefd --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_ReplaceJob.json @@ -0,0 +1,24 @@ +{ + "operationId": "Jobs_ReplaceJob", + "title": "Job patch", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "job": { + "priority": 100, + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": -1 + }, + "poolInfo": { + "poolId": "poolId" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_TerminateJob.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_TerminateJob.json new file mode 100644 index 000000000000..2ec4cbd216a1 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_TerminateJob.json @@ -0,0 +1,17 @@ +{ + "operationId": "Jobs_TerminateJob", + "title": "Job terminate", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobTerminateParameter": { + "terminateReason": "User supplied termination reason" + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_UpdateJob.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_UpdateJob.json new file mode 100644 index 000000000000..b1ddadf806fd --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Jobs_UpdateJob.json @@ -0,0 +1,24 @@ +{ + "operationId": "Jobs_UpdateJob", + "title": "Job update", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "job": { + "priority": 100, + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": -1 + }, + "poolInfo": { + "poolId": "poolId" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/NodeCreateUser.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/NodeCreateUser.json deleted file mode 100644 index 5c701646c2e9..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/NodeCreateUser.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "operationId": "Batch_CreateNodeUser", - "title": "Node create user", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "nodeId": "tvm-1695681911_1-20161121t182739z", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "user": { - "name": "userName", - "isAdmin": false, - "expiryTime": "2017-08-01T00:00:00Z", - "password": "Password" - } - }, - "responses": { - "201": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/NodeDeleteUser.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/NodeDeleteUser.json deleted file mode 100644 index c1fb80818626..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/NodeDeleteUser.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "operationId": "Batch_DeleteNodeUser", - "title": "Node delete user", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "nodeId": "tvm-1695681911_1-20161121t182739z", - "userName": "userName", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/NodeDisableScheduling.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/NodeDisableScheduling.json deleted file mode 100644 index 3f277f6925b8..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/NodeDisableScheduling.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "operationId": "Batch_DisableNodeScheduling", - "title": "Node disable scheduling", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "nodeId": "tvm-1695681911_1-20161122t193202z", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "nodeDisableSchedulingParameter": { - "nodeDisableSchedulingOption": "terminate" - } - }, - "responses": { - "200": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/NodeEnableScheduling.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/NodeEnableScheduling.json deleted file mode 100644 index ae2ad5159151..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/NodeEnableScheduling.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "operationId": "Batch_EnableNodeScheduling", - "title": "Node enable scheduling", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "nodeId": "tvm-1695681911_1-20161122t193202z", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/NodeGetRemoteLoginSettings.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/NodeGetRemoteLoginSettings.json deleted file mode 100644 index 19c212fc2c4b..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/NodeGetRemoteLoginSettings.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "operationId": "Batch_GetNodeRemoteLoginSettings", - "title": "Node get remote login settings", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "nodeId": "tvm-1695681911_1-20161121t182739z", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "remoteLoginIPAddress": "1.1.1.1", - "remoteLoginPort": 50000 - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/NodeGet_Basic.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/NodeGet_Basic.json deleted file mode 100644 index 524ccd210fef..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/NodeGet_Basic.json +++ /dev/null @@ -1,54 +0,0 @@ -{ - "operationId": "Batch_GetNode", - "title": "Node get", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "poolId": "poolId", - "nodeId": "tvm-1695681911_2-20161122t193202z", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "id": "tvm-1695681911_2-20161122t193202z", - "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z", - "state": "idle", - "schedulingState": "enabled", - "stateTransitionTime": "2016-11-22T19:37:31.4285526Z", - "lastBootTime": "2016-11-22T19:37:28.623369Z", - "allocationTime": "2016-11-22T19:32:02.8155319Z", - "ipAddress": "1.1.1.1", - "affinityId": "TVM:tvm-1695681911_2-20161122t193202z", - "vmSize": "small", - "totalTasksRun": 0, - "totalTasksSucceeded": 0, - "runningTasksCount": 0, - "isDedicated": true, - "startTask": { - "commandLine": "cmd /c echo hello", - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "nonadmin" - } - }, - "maxTaskRetryCount": 0, - "waitForSuccess": false - }, - "startTaskInfo": { - "state": "completed", - "startTime": "2016-11-22T19:37:31.4285526Z", - "endTime": "2016-11-22T19:37:31.838028Z", - "exitCode": 0, - "retryCount": 0 - }, - "nodeAgentInfo": { - "version": "1.2.0.0", - "lastUpdateTime": "2016-11-22T19:37:28.623369Z" - } - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/NodeList.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/NodeList.json deleted file mode 100644 index ca850f66805e..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/NodeList.json +++ /dev/null @@ -1,136 +0,0 @@ -{ - "operationId": "Batch_ListNodes", - "title": "Node list", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "tvm-1695681911_1-20161122t193202z", - "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z", - "state": "idle", - "schedulingState": "enabled", - "stateTransitionTime": "2016-11-22T22:22:27.2236818Z", - "lastBootTime": "2016-11-22T22:22:24.4634125Z", - "allocationTime": "2016-11-22T19:32:02.8155319Z", - "ipAddress": "1.1.1.1", - "affinityId": "TVM:tvm-1695681911_1-20161122t193202z", - "vmSize": "small", - "totalTasksRun": 0, - "totalTasksSucceeded": 0, - "runningTasksCount": 0, - "runningTaskSlotsCount": 0, - "isDedicated": true, - "startTask": { - "commandLine": "cmd /c echo hello", - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "nonadmin" - } - }, - "maxTaskRetryCount": 0, - "waitForSuccess": false - }, - "startTaskInfo": { - "state": "completed", - "startTime": "2016-11-22T22:22:27.2236818Z", - "endTime": "2016-11-22T22:22:27.567189Z", - "exitCode": 0, - "retryCount": 0 - }, - "nodeAgentInfo": { - "version": "1.2.0.0", - "lastUpdateTime": "2016-11-22T22:22:24.4634125Z" - } - }, - { - "id": "tvm-1695681911_2-20161122t193202z", - "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z", - "state": "idle", - "schedulingState": "enabled", - "stateTransitionTime": "2016-11-22T19:37:31.4285526Z", - "lastBootTime": "2016-11-22T19:37:28.623369Z", - "allocationTime": "2016-11-22T19:32:02.8155319Z", - "ipAddress": "1.1.1.1", - "affinityId": "TVM:tvm-1695681911_2-20161122t193202z", - "vmSize": "small", - "totalTasksRun": 0, - "totalTasksSucceeded": 0, - "runningTasksCount": 0, - "runningTaskSlotsCount": 0, - "isDedicated": true, - "startTask": { - "commandLine": "cmd /c echo hello", - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "nonadmin" - } - }, - "maxTaskRetryCount": 0, - "waitForSuccess": false - }, - "startTaskInfo": { - "state": "completed", - "startTime": "2016-11-22T19:37:31.4285526Z", - "endTime": "2016-11-22T19:37:31.838028Z", - "exitCode": 0, - "retryCount": 0 - }, - "nodeAgentInfo": { - "version": "1.2.0.0", - "lastUpdateTime": "2016-11-22T22:22:24.4634125Z" - } - }, - { - "id": "tvm-1695681911_3-20161122t193202z", - "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_3-20161122t193202z", - "state": "idle", - "schedulingState": "enabled", - "stateTransitionTime": "2016-11-22T19:36:51.0013378Z", - "lastBootTime": "2016-11-22T19:36:48.21721Z", - "allocationTime": "2016-11-22T19:32:02.8155319Z", - "ipAddress": "1.1.1.1", - "affinityId": "TVM:tvm-1695681911_3-20161122t193202z", - "vmSize": "small", - "totalTasksRun": 0, - "totalTasksSucceeded": 0, - "runningTasksCount": 0, - "runningTaskSlotsCount": 0, - "isDedicated": true, - "startTask": { - "commandLine": "cmd /c echo hello", - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "nonadmin" - } - }, - "maxTaskRetryCount": 0, - "waitForSuccess": false - }, - "startTaskInfo": { - "state": "completed", - "startTime": "2016-11-22T19:36:51.0013378Z", - "endTime": "2016-11-22T19:36:51.2363447Z", - "exitCode": 0, - "retryCount": 0 - }, - "nodeAgentInfo": { - "version": "1.2.0.0", - "lastUpdateTime": "2016-11-22T22:22:24.4634125Z" - } - } - ] - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/NodeReboot.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/NodeReboot.json deleted file mode 100644 index ef88d7ea7515..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/NodeReboot.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "operationId": "Batch_RebootNode", - "title": "Node reboot", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "nodeId": "tvm-1695681911_1-20161122t193202z", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "nodeRebootParameter": { - "nodeRebootOption": "terminate" - } - }, - "responses": { - "202": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/NodeUpdateUser.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/NodeUpdateUser.json deleted file mode 100644 index e6f9be65b381..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/NodeUpdateUser.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "operationId": "Batch_ReplaceNodeUser", - "title": "Node update user", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "nodeId": "tvm-1695681911_1-20161121t182739z", - "userName": "userName", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "content": { - "password": "12345", - "expiryTime": "2016-11-27T00:45:48.7320857Z" - } - }, - "responses": { - "200": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/NodeUploadBatchServiceLogs.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/NodeUploadBatchServiceLogs.json deleted file mode 100644 index 3bc55e1ca6e9..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/NodeUploadBatchServiceLogs.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "operationId": "Batch_UploadNodeLogs", - "title": "Upload BatchService Logs", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "nodeId": "tvm-1695681911_1-20161121t182739z", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "content": { - "containerUrl": "https://somestorageacct.blob.core.windows.net/batch-compute-node-logs?se=2017-12-09T18%3A51%3A00Z&sp=w&sv=2016-05-31&sr=c&sig", - "startTime": "2017-11-27T00:00:00Z" - } - }, - "responses": { - "200": { - "body": { - "virtualDirectoryName": "poolId/tvm-1695681911-1-20161121t182739z/0795539d-82fe-48e3-bbff-2964905b6de0", - "numberOfFilesUploaded": 8 - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_CreateNodeUser.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_CreateNodeUser.json new file mode 100644 index 000000000000..1f3232520cd9 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_CreateNodeUser.json @@ -0,0 +1,21 @@ +{ + "operationId": "Nodes_CreateNodeUser", + "title": "Node create user", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "user": { + "name": "userName", + "isAdmin": false, + "expiryTime": "2017-08-01T00:00:00Z", + "password": "Password" + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_DeleteNodeFile.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_DeleteNodeFile.json new file mode 100644 index 000000000000..ed146c43d47b --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_DeleteNodeFile.json @@ -0,0 +1,17 @@ +{ + "operationId": "Nodes_DeleteNodeFile", + "title": "File delete from node", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "recursive": false + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_DeleteNodeUser.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_DeleteNodeUser.json new file mode 100644 index 000000000000..999f12cc26e8 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_DeleteNodeUser.json @@ -0,0 +1,16 @@ +{ + "operationId": "Nodes_DeleteNodeUser", + "title": "Node delete user", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "userName": "userName", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_DisableNodeScheduling.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_DisableNodeScheduling.json new file mode 100644 index 000000000000..c62df5ec29e8 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_DisableNodeScheduling.json @@ -0,0 +1,18 @@ +{ + "operationId": "Nodes_DisableNodeScheduling", + "title": "Node disable scheduling", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "nodeDisableSchedulingParameter": { + "nodeDisableSchedulingOption": "terminate" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_EnableNodeScheduling.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_EnableNodeScheduling.json new file mode 100644 index 000000000000..f64ddacbb438 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_EnableNodeScheduling.json @@ -0,0 +1,15 @@ +{ + "operationId": "Nodes_EnableNodeScheduling", + "title": "Node enable scheduling", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_GetNode.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_GetNode.json new file mode 100644 index 000000000000..e4f594070200 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_GetNode.json @@ -0,0 +1,54 @@ +{ + "operationId": "Nodes_GetNode", + "title": "Node get", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "poolId": "poolId", + "nodeId": "tvm-1695681911_2-20161122t193202z", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "tvm-1695681911_2-20161122t193202z", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z", + "state": "idle", + "schedulingState": "enabled", + "stateTransitionTime": "2016-11-22T19:37:31.4285526Z", + "lastBootTime": "2016-11-22T19:37:28.623369Z", + "allocationTime": "2016-11-22T19:32:02.8155319Z", + "ipAddress": "1.1.1.1", + "affinityId": "TVM:tvm-1695681911_2-20161122t193202z", + "vmSize": "small", + "totalTasksRun": 0, + "totalTasksSucceeded": 0, + "runningTasksCount": 0, + "isDedicated": true, + "startTask": { + "commandLine": "cmd /c echo hello", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "startTaskInfo": { + "state": "completed", + "startTime": "2016-11-22T19:37:31.4285526Z", + "endTime": "2016-11-22T19:37:31.838028Z", + "exitCode": 0, + "retryCount": 0 + }, + "nodeAgentInfo": { + "version": "1.2.0.0", + "lastUpdateTime": "2016-11-22T19:37:28.623369Z" + } + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_GetNodeExtension.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_GetNodeExtension.json new file mode 100644 index 000000000000..6504539dc06b --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_GetNodeExtension.json @@ -0,0 +1,37 @@ +{ + "operationId": "Nodes_GetNodeExtension", + "title": "Get batch node extension", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "poolId": "poolId", + "nodeId": "tvm-1695681911_2-20161122t193202z", + "extensionName": "batchNodeExtension", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "instanceView": { + "name": "batchNodeExtension", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": "Enable succeeded: Enabling and starting agent and controller" + } + ] + }, + "vmExtension": { + "name": "batchNodeExtension", + "publisher": "Microsoft.Azure.Extensions", + "type": "CustomScript", + "typeHandlerVersion": "2.0", + "autoUpgradeMinorVersion": true + } + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_GetNodeFile.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_GetNodeFile.json new file mode 100644 index 000000000000..c7198ff8d4ed --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_GetNodeFile.json @@ -0,0 +1,23 @@ +{ + "operationId": "Nodes_GetNodeFile", + "title": "Get File From Compute Node", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "nodeId": "nodeId", + "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", + "ocp-batch-file-isdirectory": "false", + "Content-Length": "17", + "Content-Type": "application/octet-stream", + "body": "This is actually a byte stream. This request/response is being presented as a string for readability in the example" + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_GetNodeFileProperties.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_GetNodeFileProperties.json new file mode 100644 index 000000000000..90073c586af3 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_GetNodeFileProperties.json @@ -0,0 +1,22 @@ +{ + "operationId": "Nodes_GetNodeFileProperties", + "title": "File get properties from node", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "nodeId": "nodeId", + "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", + "ocp-batch-file-isdirectory": "false", + "Content-Length": "17", + "Content-Type": "application/octet-stream" + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_GetNodeRemoteLoginSettings.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_GetNodeRemoteLoginSettings.json new file mode 100644 index 000000000000..b26c660050ab --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_GetNodeRemoteLoginSettings.json @@ -0,0 +1,20 @@ +{ + "operationId": "Nodes_GetNodeRemoteLoginSettings", + "title": "Node get remote login settings", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "remoteLoginIPAddress": "1.1.1.1", + "remoteLoginPort": 50000 + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_ListNodeExtensions.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_ListNodeExtensions.json new file mode 100644 index 000000000000..aa7faefe4938 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_ListNodeExtensions.json @@ -0,0 +1,61 @@ +{ + "operationId": "Nodes_ListNodeExtensions", + "title": "List compute node extensions", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_2-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "instanceView": { + "name": "batchNodeExtension", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": "Enable succeeded: Enabling and starting agent and controller" + } + ] + }, + "vmExtension": { + "name": "batchNodeExtension", + "publisher": "Microsoft.Azure.Extensions", + "type": "CustomScript", + "typeHandlerVersion": "2.0", + "autoUpgradeMinorVersion": true + } + }, + { + "instanceView": { + "name": "customExtension", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": "ExtensionOperation:enable. Status:Success" + } + ] + }, + "vmExtension": { + "name": "customExtension", + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_ListNodeFiles.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_ListNodeFiles.json new file mode 100644 index 000000000000..164111ec8a3d --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_ListNodeFiles.json @@ -0,0 +1,48 @@ +{ + "operationId": "Nodes_ListNodeFiles", + "title": "File list from node", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "recursive": false + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "shared", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/shared", + "isDirectory": true + }, + { + "name": "startup\\ProcessEnv.cmd", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/startup\\ProcessEnv.cmd", + "isDirectory": false, + "properties": { + "creationTime": "2014-09-19T21:56:17.679195Z", + "lastModified": "2014-09-19T21:56:17.679195Z", + "contentLength": "1813", + "contentType": "application/octet-stream" + } + }, + { + "name": "startup\\stderr.txt", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/startup\\stderr.txt", + "isDirectory": false, + "properties": { + "creationTime": "2014-09-19T21:56:17.5590855Z", + "lastModified": "2014-09-19T21:56:17.5590855Z", + "contentLength": "0", + "contentType": "application/octet-stream" + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_ListNodes.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_ListNodes.json new file mode 100644 index 000000000000..6c3fd0244810 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_ListNodes.json @@ -0,0 +1,136 @@ +{ + "operationId": "Nodes_ListNodes", + "title": "Node list", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "tvm-1695681911_1-20161122t193202z", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z", + "state": "idle", + "schedulingState": "enabled", + "stateTransitionTime": "2016-11-22T22:22:27.2236818Z", + "lastBootTime": "2016-11-22T22:22:24.4634125Z", + "allocationTime": "2016-11-22T19:32:02.8155319Z", + "ipAddress": "1.1.1.1", + "affinityId": "TVM:tvm-1695681911_1-20161122t193202z", + "vmSize": "small", + "totalTasksRun": 0, + "totalTasksSucceeded": 0, + "runningTasksCount": 0, + "runningTaskSlotsCount": 0, + "isDedicated": true, + "startTask": { + "commandLine": "cmd /c echo hello", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "startTaskInfo": { + "state": "completed", + "startTime": "2016-11-22T22:22:27.2236818Z", + "endTime": "2016-11-22T22:22:27.567189Z", + "exitCode": 0, + "retryCount": 0 + }, + "nodeAgentInfo": { + "version": "1.2.0.0", + "lastUpdateTime": "2016-11-22T22:22:24.4634125Z" + } + }, + { + "id": "tvm-1695681911_2-20161122t193202z", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z", + "state": "idle", + "schedulingState": "enabled", + "stateTransitionTime": "2016-11-22T19:37:31.4285526Z", + "lastBootTime": "2016-11-22T19:37:28.623369Z", + "allocationTime": "2016-11-22T19:32:02.8155319Z", + "ipAddress": "1.1.1.1", + "affinityId": "TVM:tvm-1695681911_2-20161122t193202z", + "vmSize": "small", + "totalTasksRun": 0, + "totalTasksSucceeded": 0, + "runningTasksCount": 0, + "runningTaskSlotsCount": 0, + "isDedicated": true, + "startTask": { + "commandLine": "cmd /c echo hello", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "startTaskInfo": { + "state": "completed", + "startTime": "2016-11-22T19:37:31.4285526Z", + "endTime": "2016-11-22T19:37:31.838028Z", + "exitCode": 0, + "retryCount": 0 + }, + "nodeAgentInfo": { + "version": "1.2.0.0", + "lastUpdateTime": "2016-11-22T22:22:24.4634125Z" + } + }, + { + "id": "tvm-1695681911_3-20161122t193202z", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_3-20161122t193202z", + "state": "idle", + "schedulingState": "enabled", + "stateTransitionTime": "2016-11-22T19:36:51.0013378Z", + "lastBootTime": "2016-11-22T19:36:48.21721Z", + "allocationTime": "2016-11-22T19:32:02.8155319Z", + "ipAddress": "1.1.1.1", + "affinityId": "TVM:tvm-1695681911_3-20161122t193202z", + "vmSize": "small", + "totalTasksRun": 0, + "totalTasksSucceeded": 0, + "runningTasksCount": 0, + "runningTaskSlotsCount": 0, + "isDedicated": true, + "startTask": { + "commandLine": "cmd /c echo hello", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "startTaskInfo": { + "state": "completed", + "startTime": "2016-11-22T19:36:51.0013378Z", + "endTime": "2016-11-22T19:36:51.2363447Z", + "exitCode": 0, + "retryCount": 0 + }, + "nodeAgentInfo": { + "version": "1.2.0.0", + "lastUpdateTime": "2016-11-22T22:22:24.4634125Z" + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_RebootNode.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_RebootNode.json new file mode 100644 index 000000000000..d828bf48908d --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_RebootNode.json @@ -0,0 +1,18 @@ +{ + "operationId": "Nodes_RebootNode", + "title": "Node reboot", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "nodeRebootParameter": { + "nodeRebootOption": "terminate" + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_ReplaceNodeUser.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_ReplaceNodeUser.json new file mode 100644 index 000000000000..7408e05d475b --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_ReplaceNodeUser.json @@ -0,0 +1,20 @@ +{ + "operationId": "Nodes_ReplaceNodeUser", + "title": "Node update user", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "userName": "userName", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "content": { + "password": "12345", + "expiryTime": "2016-11-27T00:45:48.7320857Z" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_UploadNodeLogs.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_UploadNodeLogs.json new file mode 100644 index 000000000000..ac111761c050 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Nodes_UploadNodeLogs.json @@ -0,0 +1,24 @@ +{ + "operationId": "Nodes_UploadNodeLogs", + "title": "Upload BatchService Logs", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "content": { + "containerUrl": "https://somestorageacct.blob.core.windows.net/batch-compute-node-logs?se=2017-12-09T18%3A51%3A00Z&sp=w&sv=2016-05-31&sr=c&sig", + "startTime": "2017-11-27T00:00:00Z" + } + }, + "responses": { + "200": { + "body": { + "virtualDirectoryName": "poolId/tvm-1695681911-1-20161121t182739z/0795539d-82fe-48e3-bbff-2964905b6de0", + "numberOfFilesUploaded": 8 + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolCreate_AcceleratedNetworking.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolCreate_AcceleratedNetworking.json deleted file mode 100644 index e0c1107c6b59..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolCreate_AcceleratedNetworking.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "operationId": "Batch_CreatePool", - "title": "Creates a pool with accelerated networking", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Thu, 27 Apr 2023 05:31:01 GMT", - "pool": { - "id": "mypool01", - "vmSize": "Standard_D1_v2", - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "MicrosoftWindowsServer", - "offer": "WindowsServer", - "sku": "2016-datacenter-smalldisk", - "version": "latest" - }, - "nodeAgentSKUId": "batch.node.windows amd64" - }, - "targetDedicatedNodes": 2, - "networkConfiguration": { - "enableAcceleratedNetworking": true - } - } - }, - "responses": { - "201": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolCreate_MountConfiguration.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolCreate_MountConfiguration.json deleted file mode 100644 index 25605e105834..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolCreate_MountConfiguration.json +++ /dev/null @@ -1,72 +0,0 @@ -{ - "operationId": "Batch_CreatePool", - "title": "Creates a pool with mount drive specified", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-data": "Fri, 17 Feb 2017 00:00:00 GMT", - "pool": { - "id": "pool2", - "vmSize": "standard_a1", - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "UbuntuServer", - "sku": "20_04-lts" - }, - "nodeAgentSKUId": "batch.node.ubuntu 20.04" - }, - "mountConfiguration": [ - { - "azureBlobFileSystemConfiguration": { - "accountName": "accountName", - "containerName": "blobContainerName", - "accountKey": "accountKey", - "relativeMountPath": "bfusepath" - } - }, - { - "azureFileShareConfiguration": { - "accountName": "accountName", - "azureFileUrl": "https://myaccount.file.core.windows.net/fileshare", - "accountKey": "accountKey", - "relativeMountPath": "filesharepath", - "mountOptions": "mount options ver=1.0" - } - }, - { - "nfsMountConfiguration": { - "source": "somesource nfs url", - "relativeMountPath": "mountpath", - "mountOptions": "mount options ver=1.0" - } - }, - { - "cifsMountConfiguration": { - "username": "accountName", - "password": "password", - "source": "//myaccount.file.core.windows.net/file", - "relativeMountPath": "mountpath", - "mountOptions": "mount options ver=1.0" - } - } - ], - "resizeTimeout": "PT15M", - "targetDedicatedNodes": 5, - "targetLowPriorityNodes": 0, - "taskSlotsPerNode": 3, - "taskSchedulingPolicy": { - "nodeFillType": "spread" - }, - "enableAutoScale": false - } - }, - "responses": { - "201": { - "request-id": "00000000-0000-0000-0000-000000000000", - "ETag": "0x8D45765A6A2DC04", - "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolCreate_OSDisk.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolCreate_OSDisk.json deleted file mode 100644 index 39d35892a8b7..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolCreate_OSDisk.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "operationId": "Batch_CreatePool", - "title": "Creates a VirtualMachineConfiguration pool with OS disk", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Wed, 23 Aug 2023 08:40:02 GMT", - "pool": { - "id": "mypool001", - "vmSize": "standard_d2s_v3", - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "0001-com-ubuntu-server-focal", - "sku": "20_04-lts" - }, - "osDisk": { - "diskSizeGB": 100, - "managedDisk": { - "storageAccountType": "standardssd_lrs" - }, - "caching": "readwrite", - "ephemeralOSDiskSettings": { - "placement": "cachedisk" - } - }, - "nodeAgentSKUId": "batch.node.ubuntu 20.04" - }, - "resizeTimeout": "PT15M", - "targetDedicatedNodes": 1, - "targetLowPriorityNodes": 0, - "taskSlotsPerNode": 1, - "enableAutoScale": false - } - }, - "responses": { - "201": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolCreate_ResourceTags.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolCreate_ResourceTags.json deleted file mode 100644 index 8ad7d85da214..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolCreate_ResourceTags.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "operationId": "Batch_CreatePool", - "title": "Creates a simple pool with resourceTags", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Wed, 14 Jun 2023 06:39:01 GMT", - "pool": { - "id": "mypool001", - "vmSize": "STANDARD_DC2s_V2", - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "UbuntuServer", - "sku": "18_04-lts-gen2", - "version": "latest" - }, - "nodeAgentSKUId": "batch.node.ubuntu 18.04" - }, - "targetDedicatedNodes": 1, - "resourceTags": { - "TagName1": "TagValue1", - "TagName2": "TagValue2" - } - } - }, - "responses": { - "201": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolCreate_SecurityProfile.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolCreate_SecurityProfile.json deleted file mode 100644 index f73991adc790..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolCreate_SecurityProfile.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "operationId": "Batch_CreatePool", - "title": "Creates a pool with SecurityProfile", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Wed, 14 Jun 2023 06:39:01 GMT", - "pool": { - "id": "mypool001", - "vmSize": "STANDARD_DC2s_V2", - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "UbuntuServer", - "sku": "18_04-lts-gen2", - "version": "latest" - }, - "nodeAgentSKUId": "batch.node.ubuntu 18.04", - "securityProfile": { - "securityType": "trustedLaunch", - "encryptionAtHost": true, - "uefiSettings": { - "secureBootEnabled": false, - "vTpmEnabled": null - } - } - }, - "targetDedicatedNodes": 1 - } - }, - "responses": { - "201": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolCreate_VirtualMachineConfiguration.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolCreate_VirtualMachineConfiguration.json deleted file mode 100644 index 122ee465e422..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolCreate_VirtualMachineConfiguration.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "operationId": "Batch_CreatePool", - "title": "Creates a VirtualMachineConfiguration pool", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "pool": { - "id": "pool2", - "vmSize": "standard_a1", - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "0001-com-ubuntu-server-focal", - "sku": "20_04-lts" - }, - "nodeAgentSKUId": "batch.node.ubuntu 20.04" - }, - "resizeTimeout": "PT15M", - "targetDedicatedNodes": 5, - "targetLowPriorityNodes": 0, - "taskSlotsPerNode": 3, - "taskSchedulingPolicy": { - "nodeFillType": "spread" - }, - "enableAutoScale": false, - "enableInterNodeCommunication": true, - "metadata": [ - { - "name": "myproperty", - "value": "myvalue" - } - ] - } - }, - "responses": { - "201": { - "request-id": "00000000-0000-0000-0000-000000000000", - "ETag": "0x8D45765A6A2DC04", - "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolCreate_VirtualMachineConfigurationWithContainers.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolCreate_VirtualMachineConfigurationWithContainers.json deleted file mode 100644 index 8cb6d94a1988..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolCreate_VirtualMachineConfigurationWithContainers.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "operationId": "Batch_CreatePool", - "title": "Creates a VirtualMachineConfiguration pool with containers", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "pool": { - "id": "pool2", - "vmSize": "standard_a1", - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "0001-com-ubuntu-server-focal", - "sku": "120_04-lts" - }, - "nodeAgentSKUId": "batch.node.ubuntu 20.04", - "containerConfiguration": { - "type": "dockerCompatible", - "containerImageNames": [ - "busybox" - ] - } - }, - "resizeTimeout": "PT15M", - "targetDedicatedNodes": 5, - "targetLowPriorityNodes": 0, - "taskSlotsPerNode": 3, - "taskSchedulingPolicy": { - "nodeFillType": "spread" - }, - "enableAutoScale": false - } - }, - "responses": { - "201": { - "request-id": "00000000-0000-0000-0000-000000000000", - "ETag": "0x8D45765A6A2DC04", - "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolCreate_VirtualMachineConfigurationWithExtensions.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolCreate_VirtualMachineConfigurationWithExtensions.json deleted file mode 100644 index 7b4e76b3e190..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolCreate_VirtualMachineConfigurationWithExtensions.json +++ /dev/null @@ -1,59 +0,0 @@ -{ - "operationId": "Batch_CreatePool", - "title": "Creates a VirtualMachineConfiguration pool with extensions", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "pool": { - "id": "pool2", - "vmSize": "standard_a1", - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "0001-com-ubuntu-server-focal", - "sku": "20_04-lts" - }, - "nodeAgentSKUId": "batch.node.ubuntu 20.04", - "extensions": [ - { - "name": "batchextension1", - "type": "KeyVaultForLinux", - "publisher": "Microsoft.Azure.KeyVault", - "typeHandlerVersion": "2.0", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": { - "secretsManagementSettingsKey": "secretsManagementSettingsValue", - "authenticationSettingsKey": "authenticationSettingsValue" - } - } - ] - }, - "resizeTimeout": "PT15M", - "targetDedicatedNodes": 5, - "targetLowPriorityNodes": 0, - "taskSlotsPerNode": 3, - "taskSchedulingPolicy": { - "nodeFillType": "spread" - }, - "enableAutoScale": false, - "enableInterNodeCommunication": true, - "metadata": [ - { - "name": "myproperty", - "value": "myvalue" - } - ], - "targetNodeCommunicationMode": "simplified" - } - }, - "responses": { - "201": { - "request-id": "00000000-0000-0000-0000-000000000000", - "ETag": "0x8D45765A6A2DC04", - "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolCreate_VirtualMachineConfigurationWithServiceArtifactReference.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolCreate_VirtualMachineConfigurationWithServiceArtifactReference.json deleted file mode 100644 index e69d99c87eaa..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolCreate_VirtualMachineConfigurationWithServiceArtifactReference.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "operationId": "Batch_CreatePool", - "title": "Creates a VirtualMachineConfiguration pool with ServiceArtifactReference", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Thu, 11 May 2023 08:03:01 GMT", - "pool": { - "id": "mypool002", - "vmSize": "Standard_A1_v2", - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "MicrosoftWindowsServer", - "offer": "WindowsServer", - "sku": "2016-datacenter-smalldisk", - "version": "latest" - }, - "windowsConfiguration": { - "enableAutomaticUpdates": false - }, - "serviceArtifactReference": { - "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile" - }, - "nodeAgentSKUId": "batch.node.windows amd64" - }, - "targetDedicatedNodes": 2 - } - }, - "responses": { - "201": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolDelete.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolDelete.json deleted file mode 100644 index 884f8b3d2c8f..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolDelete.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "operationId": "Batch_DeletePool", - "title": "Pool delete", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "202": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolDisableAutoScale.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolDisableAutoScale.json deleted file mode 100644 index 9d5593339c6e..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolDisableAutoScale.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "operationId": "Batch_DisablePoolAutoScale", - "title": "Disable pool autoscale", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolEnableAutoscale.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolEnableAutoscale.json deleted file mode 100644 index 942a0ec50306..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolEnableAutoscale.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "operationId": "Batch_EnablePoolAutoScale", - "title": "Pool enable autoscale", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "content": { - "autoScaleFormula": "$TargetDedicated=0", - "autoScaleEvaluationInterval": "PT8M" - } - }, - "responses": { - "200": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolEvaluateAutoscale.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolEvaluateAutoscale.json deleted file mode 100644 index dd8d13fab35c..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolEvaluateAutoscale.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "operationId": "Batch_EvaluatePoolAutoScale", - "title": "Pool evaluate autoscale", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "content": { - "autoScaleFormula": "$TargetDedicated=1" - } - }, - "responses": { - "200": { - "body": { - "timestamp": "2016-11-22T19:39:28.5246331Z", - "results": "$TargetDedicated=1;$NodeDeallocationOption=requeue" - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolExists.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolExists.json deleted file mode 100644 index 4487a33b8a45..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolExists.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "operationId": "Batch_PoolExists", - "title": "Check Pool Exists", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": {}, - "404": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolGet_AcceleratedNetworking.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolGet_AcceleratedNetworking.json deleted file mode 100644 index 0521b88bec1b..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolGet_AcceleratedNetworking.json +++ /dev/null @@ -1,52 +0,0 @@ -{ - "operationId": "Batch_GetPool", - "title": "Get a pool with AcceleratedNetworking", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "pool", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 28 Apr 2023 02:43:01 GMT" - }, - "responses": { - "200": { - "body": { - "id": "pool", - "url": "https://account.region.batch.azure.com/pools/pool", - "eTag": "0x8DB4792BE8566A2", - "lastModified": "2023-04-28T02:46:19.0268066Z", - "creationTime": "2023-04-28T02:46:19.0268066Z", - "state": "active", - "stateTransitionTime": "2023-04-28T02:46:19.0268066Z", - "allocationState": "steady", - "allocationStateTransitionTime": "2023-04-28T02:47:17.9169655Z", - "vmSize": "standard_d1_v2", - "resizeTimeout": "PT15M", - "currentDedicatedNodes": 2, - "targetDedicatedNodes": 2, - "currentLowPriorityNodes": 0, - "targetLowPriorityNodes": 0, - "enableAutoScale": false, - "enableInterNodeCommunication": false, - "taskSlotsPerNode": 1, - "taskSchedulingPolicy": { - "nodeFillType": "spread" - }, - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "MicrosoftWindowsServer", - "offer": "WindowsServer", - "sku": "2016-datacenter-smalldisk", - "version": "latest" - }, - "nodeAgentSKUId": "batch.node.windows amd64" - }, - "networkConfiguration": { - "dynamicVNetAssignmentScope": "none", - "enableAcceleratedNetworking": true - }, - "currentNodeCommunicationMode": "classic" - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolGet_Basic.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolGet_Basic.json deleted file mode 100644 index b5eabfe3d4f9..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolGet_Basic.json +++ /dev/null @@ -1,58 +0,0 @@ -{ - "operationId": "Batch_GetPool", - "title": "Pool get", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "pool", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "id": "pool", - "url": "https://account.region.batch.azure.com/pools/pool", - "eTag": "0x8D413091E739A56", - "lastModified": "2016-11-22T18:55:25.2608598Z", - "creationTime": "2016-11-22T18:55:24.2632496Z", - "state": "active", - "stateTransitionTime": "2016-11-22T18:55:24.2632496Z", - "allocationState": "steady", - "allocationStateTransitionTime": "2016-11-22T18:55:24.8154041Z", - "vmSize": "standard_a1", - "resizeTimeout": "PT15M", - "currentDedicatedNodes": 0, - "currentLowPriorityNodes": 0, - "targetDedicatedNodes": 0, - "targetLowPriorityNodes": 0, - "enableAutoScale": false, - "enableInterNodeCommunication": false, - "startTask": { - "commandLine": "/bin/bash -c 'echo start task'", - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "nonadmin" - } - }, - "maxTaskRetryCount": 0, - "waitForSuccess": false - }, - "taskSlotsPerNode": 1, - "taskSchedulingPolicy": { - "nodeFillType": "spread" - }, - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "0001-com-ubuntu-server-focal", - "sku": "20_04-lts", - "version": "latest" - }, - "nodeAgentSKUId": "batch.node.ubuntu 20.04" - } - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolGet_SecurityProfile.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolGet_SecurityProfile.json deleted file mode 100644 index 2b27085e3ec0..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolGet_SecurityProfile.json +++ /dev/null @@ -1,55 +0,0 @@ -{ - "operationId": "Batch_GetPool", - "title": "Get a VirtualMachineConfiguration pool with SecurityProfile", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "mypool001", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Wed, 14 Jun 2023 06:39:01 GMT" - }, - "responses": { - "200": { - "body": { - "id": "mypool001", - "url": "https://account.region.batch.azure.com/pools/pool", - "eTag": "0x8DB6CA2DFF530D1", - "lastModified": "2023-06-14T06:45:00.0946897Z", - "creationTime": "2023-06-14T06:45:00.0946897Z", - "state": "active", - "stateTransitionTime": "2023-06-14T06:45:00.0946897Z", - "allocationState": "steady", - "allocationStateTransitionTime": "2023-06-14T06:45:59.4770341Z", - "vmSize": "standard_dc2s_v2", - "resizeTimeout": "PT15M", - "currentDedicatedNodes": 1, - "targetDedicatedNodes": 1, - "currentLowPriorityNodes": 0, - "targetLowPriorityNodes": 0, - "enableAutoScale": false, - "enableInterNodeCommunication": false, - "taskSlotsPerNode": 1, - "taskSchedulingPolicy": { - "nodeFillType": "spread" - }, - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "UbuntuServer", - "sku": "18_04-lts-gen2", - "version": "latest" - }, - "nodeAgentSKUId": "batch.node.ubuntu 18.04", - "securityProfile": { - "securityType": "trustedLaunch", - "encryptionAtHost": true, - "uefiSettings": { - "secureBootEnabled": false - } - } - }, - "currentNodeCommunicationMode": "classic" - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolGet_VirtualMachineConfigurationWithExtensions.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolGet_VirtualMachineConfigurationWithExtensions.json deleted file mode 100644 index a4ee35317597..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolGet_VirtualMachineConfigurationWithExtensions.json +++ /dev/null @@ -1,74 +0,0 @@ -{ - "operationId": "Batch_GetPool", - "title": "Get a VirtualMachineConfiguration pool with extensions", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "pool", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "id": "pool", - "url": "https://account.region.batch.azure.com/pools/pool", - "eTag": "0x8D413091E739A56", - "lastModified": "2016-11-22T18:55:25.2608598Z", - "creationTime": "2016-11-22T18:55:24.2632496Z", - "state": "active", - "stateTransitionTime": "2016-11-22T18:55:24.2632496Z", - "allocationState": "steady", - "allocationStateTransitionTime": "2016-11-22T18:55:24.8154041Z", - "vmSize": "standard_a1", - "resizeTimeout": "PT15M", - "currentDedicatedNodes": 0, - "currentLowPriorityNodes": 0, - "targetDedicatedNodes": 0, - "targetLowPriorityNodes": 0, - "enableAutoScale": false, - "enableInterNodeCommunication": false, - "startTask": { - "commandLine": "/bin/bash -c 'echo start task'", - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "nonadmin" - } - }, - "maxTaskRetryCount": 0, - "waitForSuccess": false - }, - "taskSlotsPerNode": 1, - "taskSchedulingPolicy": { - "nodeFillType": "spread" - }, - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "0001-com-ubuntu-server-focal", - "sku": "20_04-lts", - "version": "latest" - }, - "nodeAgentSKUId": "batch.node.ubuntu 20.04", - "extensions": [ - { - "name": "batchextension1", - "type": "KeyVaultForLinux", - "publisher": "Microsoft.Azure.KeyVault", - "typeHandlerVersion": "2.0", - "autoUpgradeMinorVersion": true, - "enableAutomaticUpgrade": true, - "settings": { - "secretsManagementSettingsKey": "secretsManagementSettingsValue", - "authenticationSettingsKey": "authenticationSettingsValue" - } - } - ] - }, - "targetNodeCommunicationMode": "classic", - "currentNodeCommunicationMode": "classic" - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolGet_VirtualMachineConfigurationWithOSDisk.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolGet_VirtualMachineConfigurationWithOSDisk.json deleted file mode 100644 index d53e77fae752..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolGet_VirtualMachineConfigurationWithOSDisk.json +++ /dev/null @@ -1,58 +0,0 @@ -{ - "operationId": "Batch_GetPool", - "title": "Add a VirtualMachineConfiguration pool with OS disk", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "mypool001", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Wed, 23 Aug 2023 08:42:01 GMT" - }, - "responses": { - "200": { - "body": { - "id": "mypool001", - "url": "http://localhost:20302/testaccount1tls/pools/mypool001", - "eTag": "0x8DBA3B4E91CD7B7", - "lastModified": "2023-08-23T08:42:40.3479479Z", - "creationTime": "2023-08-23T08:42:40.3479479Z", - "state": "active", - "stateTransitionTime": "2023-08-23T08:42:40.3479479Z", - "allocationState": "steady", - "allocationStateTransitionTime": "2023-08-23T08:42:53.8587829Z", - "vmSize": "standard_d2s_v3", - "resizeTimeout": "PT15M", - "currentDedicatedNodes": 1, - "targetDedicatedNodes": 1, - "currentLowPriorityNodes": 0, - "targetLowPriorityNodes": 0, - "enableAutoScale": false, - "enableInterNodeCommunication": false, - "taskSlotsPerNode": 1, - "taskSchedulingPolicy": { - "nodeFillType": "spread" - }, - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "0001-com-ubuntu-server-focal", - "sku": "20_04-lts", - "version": "latest" - }, - "osDisk": { - "ephemeralOSDiskSettings": { - "placement": "cachedisk" - }, - "managedDisk": { - "storageAccountType": "standardssd_lrs" - }, - "diskSizeGB": 100, - "caching": "readwrite" - }, - "nodeAgentSKUId": "batch.node.ubuntu 20.04" - }, - "currentNodeCommunicationMode": "classic" - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolGet_VirtualMachineConfigurationWithServiceArtifactReference.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolGet_VirtualMachineConfigurationWithServiceArtifactReference.json deleted file mode 100644 index 1f165f7a4423..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolGet_VirtualMachineConfigurationWithServiceArtifactReference.json +++ /dev/null @@ -1,54 +0,0 @@ -{ - "operationId": "Batch_GetPool", - "title": "Get a VirtualMachineConfiguration pool with ServiceArtifactReference", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "pool", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Thu, 11 May 2023 08:08:01 GMT" - }, - "responses": { - "200": { - "body": { - "id": "pool", - "url": "https://account.region.batch.azure.com/pools/pool", - "eTag": "0x8DB51F652DFC78F", - "lastModified": "2023-05-11T08:04:19.7259151Z", - "creationTime": "2023-05-11T08:04:19.7259151Z", - "state": "active", - "stateTransitionTime": "2023-05-11T08:04:19.7259151Z", - "allocationState": "steady", - "allocationStateTransitionTime": "2023-05-11T08:05:22.0020052Z", - "vmSize": "standard_a1_v2", - "resizeTimeout": "PT15M", - "currentDedicatedNodes": 2, - "targetDedicatedNodes": 2, - "currentLowPriorityNodes": 0, - "targetLowPriorityNodes": 0, - "enableAutoScale": false, - "enableInterNodeCommunication": false, - "taskSlotsPerNode": 1, - "taskSchedulingPolicy": { - "nodeFillType": "spread" - }, - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "MicrosoftWindowsServer", - "offer": "WindowsServer", - "sku": "2016-datacenter-smalldisk", - "version": "latest" - }, - "nodeAgentSKUId": "batch.node.windows amd64", - "windowsConfiguration": { - "enableAutomaticUpdates": false - }, - "serviceArtifactReference": { - "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile" - } - }, - "currentNodeCommunicationMode": "classic" - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolListUsageMetrics.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolListUsageMetrics.json deleted file mode 100644 index e89b5477c10e..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolListUsageMetrics.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "operationId": "Batch_ListPoolUsageMetrics", - "title": "Pool list usage metrics", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "startTime": "2013-04-01T00:00:00Z", - "endTime": "2013-04-01T00:30:00Z", - "poolId": "p1", - "vmSize": "a1", - "totalCoreHours": 39.384838 - }, - { - "startTime": "2013-04-01T00:30:00Z", - "endTime": "2013-04-01T01:00:00Z", - "poolId": "p2", - "vmSize": "a8", - "totalCoreHours": 3039.384838 - } - ] - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolList_Basic.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolList_Basic.json deleted file mode 100644 index e1937687c63e..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolList_Basic.json +++ /dev/null @@ -1,61 +0,0 @@ -{ - "operationId": "Batch_ListPools", - "title": "Pool list", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "testPool", - "url": "https://accountname.region.batch.azure.com/pools/testPool", - "eTag": "0x8D4123BEF87D233", - "lastModified": "2016-11-21T18:26:39.7108787Z", - "creationTime": "2016-11-21T18:26:39.7108787Z", - "state": "active", - "stateTransitionTime": "2016-11-21T18:26:39.7108787Z", - "allocationState": "steady", - "allocationStateTransitionTime": "2016-11-21T18:27:40.287803Z", - "vmSize": "Standard_D1_v2", - "resizeTimeout": "PT15M", - "currentDedicatedNodes": 3, - "currentLowPriorityNodes": 0, - "targetDedicatedNodes": 3, - "targetLowPriorityNodes": 0, - "enableAutoScale": false, - "enableInterNodeCommunication": false, - "startTask": { - "commandLine": "cmd /c echo hello", - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "nonadmin" - } - }, - "maxTaskRetryCount": 0, - "waitForSuccess": false - }, - "taskSlotsPerNode": 1, - "taskSchedulingPolicy": { - "nodeFillType": "spread" - }, - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "MicrosoftWindowsServer", - "offer": "WindowsServer", - "sku": "2016-datacenter-smalldisk", - "version": "latest" - }, - "nodeAgentSKUId": "batch.node.windows amd64" - } - } - ] - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolPatch.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolPatch.json deleted file mode 100644 index acd6b43a7165..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolPatch.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "operationId": "Batch_UpdatePool", - "title": "Patch the Pool", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "pool": { - "startTask": { - "commandLine": "/bin/bash -c 'echo start task'" - } - } - }, - "responses": { - "200": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolRemoveNodes.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolRemoveNodes.json deleted file mode 100644 index ec83c9b3d182..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolRemoveNodes.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "operationId": "Batch_RemoveNodes", - "title": "Pool remove nodes", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "content": { - "nodeList": [ - "tvm-1695681911_1-20161122t224741z", - "tvm-1695681911_2-20161122t224741z" - ] - } - }, - "responses": { - "202": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolResize.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolResize.json deleted file mode 100644 index 017bcaf9a6ec..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolResize.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "operationId": "Batch_ResizePool", - "title": "Pool resize", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "resizePool", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "content": { - "targetDedicatedNodes": 1, - "targetLowPriorityNodes": 0 - } - }, - "responses": { - "202": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolStopResize.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolStopResize.json deleted file mode 100644 index b4ac327f755d..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolStopResize.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "operationId": "Batch_StopPoolResize", - "title": "Pool stop resize", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "202": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolUpdate.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolUpdate.json deleted file mode 100644 index bc958ae9fc79..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/PoolUpdate.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "operationId": "Batch_ReplacePoolProperties", - "title": "Pool update", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "poolId": "poolId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "pool": { - "startTask": { - "commandLine": "/bin/bash -c 'echo start task'" - }, - "applicationPackageReferences": [], - "metadata": [] - } - }, - "responses": { - "204": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_CreatePool_AcceleratedNetworking.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_CreatePool_AcceleratedNetworking.json new file mode 100644 index 000000000000..51ce88f34fd3 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_CreatePool_AcceleratedNetworking.json @@ -0,0 +1,30 @@ +{ + "operationId": "Pools_CreatePool", + "title": "Creates a pool with accelerated networking", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Thu, 27 Apr 2023 05:31:01 GMT", + "pool": { + "id": "mypool01", + "vmSize": "Standard_D1_v2", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.windows amd64" + }, + "targetDedicatedNodes": 2, + "networkConfiguration": { + "enableAcceleratedNetworking": true + } + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_CreatePool_MountConfiguration.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_CreatePool_MountConfiguration.json new file mode 100644 index 000000000000..86c734c6f9ca --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_CreatePool_MountConfiguration.json @@ -0,0 +1,72 @@ +{ + "operationId": "Pools_CreatePool", + "title": "Creates a pool with mount drive specified", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-data": "Fri, 17 Feb 2017 00:00:00 GMT", + "pool": { + "id": "pool2", + "vmSize": "standard_a1", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "20_04-lts" + }, + "nodeAgentSKUId": "batch.node.ubuntu 20.04" + }, + "mountConfiguration": [ + { + "azureBlobFileSystemConfiguration": { + "accountName": "accountName", + "containerName": "blobContainerName", + "accountKey": "accountKey", + "relativeMountPath": "bfusepath" + } + }, + { + "azureFileShareConfiguration": { + "accountName": "accountName", + "azureFileUrl": "https://myaccount.file.core.windows.net/fileshare", + "accountKey": "accountKey", + "relativeMountPath": "filesharepath", + "mountOptions": "mount options ver=1.0" + } + }, + { + "nfsMountConfiguration": { + "source": "somesource nfs url", + "relativeMountPath": "mountpath", + "mountOptions": "mount options ver=1.0" + } + }, + { + "cifsMountConfiguration": { + "username": "accountName", + "password": "password", + "source": "//myaccount.file.core.windows.net/file", + "relativeMountPath": "mountpath", + "mountOptions": "mount options ver=1.0" + } + } + ], + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 5, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 3, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false + } + }, + "responses": { + "201": { + "request-id": "00000000-0000-0000-0000-000000000000", + "ETag": "0x8D45765A6A2DC04", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_CreatePool_OSDisk.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_CreatePool_OSDisk.json new file mode 100644 index 000000000000..f144330b8d1b --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_CreatePool_OSDisk.json @@ -0,0 +1,40 @@ +{ + "operationId": "Pools_CreatePool", + "title": "Creates a VirtualMachineConfiguration pool with OS disk", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Wed, 23 Aug 2023 08:40:02 GMT", + "pool": { + "id": "mypool001", + "vmSize": "standard_d2s_v3", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts" + }, + "osDisk": { + "diskSizeGB": 100, + "managedDisk": { + "storageAccountType": "standardssd_lrs" + }, + "caching": "readwrite", + "ephemeralOSDiskSettings": { + "placement": "cachedisk" + } + }, + "nodeAgentSKUId": "batch.node.ubuntu 20.04" + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 1, + "enableAutoScale": false + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_CreatePool_ResourceTags.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_CreatePool_ResourceTags.json new file mode 100644 index 000000000000..0457709ba9c5 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_CreatePool_ResourceTags.json @@ -0,0 +1,31 @@ +{ + "operationId": "Pools_CreatePool", + "title": "Creates a simple pool with resourceTags", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Wed, 14 Jun 2023 06:39:01 GMT", + "pool": { + "id": "mypool001", + "vmSize": "STANDARD_DC2s_V2", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "18_04-lts-gen2", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.ubuntu 18.04" + }, + "targetDedicatedNodes": 1, + "resourceTags": { + "TagName1": "TagValue1", + "TagName2": "TagValue2" + } + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_CreatePool_SecurityProfile.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_CreatePool_SecurityProfile.json new file mode 100644 index 000000000000..769bd5b7ceab --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_CreatePool_SecurityProfile.json @@ -0,0 +1,35 @@ +{ + "operationId": "Pools_CreatePool", + "title": "Creates a pool with SecurityProfile", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Wed, 14 Jun 2023 06:39:01 GMT", + "pool": { + "id": "mypool001", + "vmSize": "STANDARD_DC2s_V2", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "18_04-lts-gen2", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.ubuntu 18.04", + "securityProfile": { + "securityType": "trustedLaunch", + "encryptionAtHost": true, + "uefiSettings": { + "secureBootEnabled": false, + "vTpmEnabled": null + } + } + }, + "targetDedicatedNodes": 1 + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_CreatePool_VirtualMachineConfiguration.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_CreatePool_VirtualMachineConfiguration.json new file mode 100644 index 000000000000..fdda1fc4bd29 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_CreatePool_VirtualMachineConfiguration.json @@ -0,0 +1,44 @@ +{ + "operationId": "Pools_CreatePool", + "title": "Creates a VirtualMachineConfiguration pool", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "pool": { + "id": "pool2", + "vmSize": "standard_a1", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts" + }, + "nodeAgentSKUId": "batch.node.ubuntu 20.04" + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 5, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 3, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false, + "enableInterNodeCommunication": true, + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ] + } + }, + "responses": { + "201": { + "request-id": "00000000-0000-0000-0000-000000000000", + "ETag": "0x8D45765A6A2DC04", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_CreatePool_VirtualMachineConfigurationWithContainers.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_CreatePool_VirtualMachineConfigurationWithContainers.json new file mode 100644 index 000000000000..6c93e93aebf9 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_CreatePool_VirtualMachineConfigurationWithContainers.json @@ -0,0 +1,43 @@ +{ + "operationId": "Pools_CreatePool", + "title": "Creates a VirtualMachineConfiguration pool with containers", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "pool": { + "id": "pool2", + "vmSize": "standard_a1", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "120_04-lts" + }, + "nodeAgentSKUId": "batch.node.ubuntu 20.04", + "containerConfiguration": { + "type": "dockerCompatible", + "containerImageNames": [ + "busybox" + ] + } + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 5, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 3, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false + } + }, + "responses": { + "201": { + "request-id": "00000000-0000-0000-0000-000000000000", + "ETag": "0x8D45765A6A2DC04", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_CreatePool_VirtualMachineConfigurationWithExtensions.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_CreatePool_VirtualMachineConfigurationWithExtensions.json new file mode 100644 index 000000000000..ec470c8b9617 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_CreatePool_VirtualMachineConfigurationWithExtensions.json @@ -0,0 +1,59 @@ +{ + "operationId": "Pools_CreatePool", + "title": "Creates a VirtualMachineConfiguration pool with extensions", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "pool": { + "id": "pool2", + "vmSize": "standard_a1", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts" + }, + "nodeAgentSKUId": "batch.node.ubuntu 20.04", + "extensions": [ + { + "name": "batchextension1", + "type": "KeyVaultForLinux", + "publisher": "Microsoft.Azure.KeyVault", + "typeHandlerVersion": "2.0", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": { + "secretsManagementSettingsKey": "secretsManagementSettingsValue", + "authenticationSettingsKey": "authenticationSettingsValue" + } + } + ] + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 5, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 3, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false, + "enableInterNodeCommunication": true, + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ], + "targetNodeCommunicationMode": "simplified" + } + }, + "responses": { + "201": { + "request-id": "00000000-0000-0000-0000-000000000000", + "ETag": "0x8D45765A6A2DC04", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_CreatePool_VirtualMachineConfigurationWithServiceArtifactReference.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_CreatePool_VirtualMachineConfigurationWithServiceArtifactReference.json new file mode 100644 index 000000000000..28aa0e11bd67 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_CreatePool_VirtualMachineConfigurationWithServiceArtifactReference.json @@ -0,0 +1,33 @@ +{ + "operationId": "Pools_CreatePool", + "title": "Creates a VirtualMachineConfiguration pool with ServiceArtifactReference", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Thu, 11 May 2023 08:03:01 GMT", + "pool": { + "id": "mypool002", + "vmSize": "Standard_A1_v2", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "windowsConfiguration": { + "enableAutomaticUpdates": false + }, + "serviceArtifactReference": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile" + }, + "nodeAgentSKUId": "batch.node.windows amd64" + }, + "targetDedicatedNodes": 2 + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_DeletePool.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_DeletePool.json new file mode 100644 index 000000000000..88c53b1b46e2 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_DeletePool.json @@ -0,0 +1,14 @@ +{ + "operationId": "Pools_DeletePool", + "title": "Pool delete", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_DisablePoolAutoScale.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_DisablePoolAutoScale.json new file mode 100644 index 000000000000..ac34fc088182 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_DisablePoolAutoScale.json @@ -0,0 +1,14 @@ +{ + "operationId": "Pools_DisablePoolAutoScale", + "title": "Disable pool autoscale", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_EnablePoolAutoscale.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_EnablePoolAutoscale.json new file mode 100644 index 000000000000..e6a2627b9274 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_EnablePoolAutoscale.json @@ -0,0 +1,18 @@ +{ + "operationId": "Pools_EnablePoolAutoScale", + "title": "Pool enable autoscale", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "content": { + "autoScaleFormula": "$TargetDedicated=0", + "autoScaleEvaluationInterval": "PT8M" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_EvaluatePoolAutoscale.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_EvaluatePoolAutoscale.json new file mode 100644 index 000000000000..1c05283aab88 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_EvaluatePoolAutoscale.json @@ -0,0 +1,22 @@ +{ + "operationId": "Pools_EvaluatePoolAutoScale", + "title": "Pool evaluate autoscale", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "content": { + "autoScaleFormula": "$TargetDedicated=1" + } + }, + "responses": { + "200": { + "body": { + "timestamp": "2016-11-22T19:39:28.5246331Z", + "results": "$TargetDedicated=1;$NodeDeallocationOption=requeue" + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_GetPool_AcceleratedNetworking.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_GetPool_AcceleratedNetworking.json new file mode 100644 index 000000000000..fcb46bf1c1a2 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_GetPool_AcceleratedNetworking.json @@ -0,0 +1,52 @@ +{ + "operationId": "Pools_GetPool", + "title": "Get a pool with AcceleratedNetworking", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "pool", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 28 Apr 2023 02:43:01 GMT" + }, + "responses": { + "200": { + "body": { + "id": "pool", + "url": "https://account.region.batch.azure.com/pools/pool", + "eTag": "0x8DB4792BE8566A2", + "lastModified": "2023-04-28T02:46:19.0268066Z", + "creationTime": "2023-04-28T02:46:19.0268066Z", + "state": "active", + "stateTransitionTime": "2023-04-28T02:46:19.0268066Z", + "allocationState": "steady", + "allocationStateTransitionTime": "2023-04-28T02:47:17.9169655Z", + "vmSize": "standard_d1_v2", + "resizeTimeout": "PT15M", + "currentDedicatedNodes": 2, + "targetDedicatedNodes": 2, + "currentLowPriorityNodes": 0, + "targetLowPriorityNodes": 0, + "enableAutoScale": false, + "enableInterNodeCommunication": false, + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.windows amd64" + }, + "networkConfiguration": { + "dynamicVNetAssignmentScope": "none", + "enableAcceleratedNetworking": true + }, + "currentNodeCommunicationMode": "classic" + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_GetPool_Basic.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_GetPool_Basic.json new file mode 100644 index 000000000000..9bae3ce6828b --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_GetPool_Basic.json @@ -0,0 +1,58 @@ +{ + "operationId": "Pools_GetPool", + "title": "Pool get", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "pool", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "pool", + "url": "https://account.region.batch.azure.com/pools/pool", + "eTag": "0x8D413091E739A56", + "lastModified": "2016-11-22T18:55:25.2608598Z", + "creationTime": "2016-11-22T18:55:24.2632496Z", + "state": "active", + "stateTransitionTime": "2016-11-22T18:55:24.2632496Z", + "allocationState": "steady", + "allocationStateTransitionTime": "2016-11-22T18:55:24.8154041Z", + "vmSize": "standard_a1", + "resizeTimeout": "PT15M", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "targetDedicatedNodes": 0, + "targetLowPriorityNodes": 0, + "enableAutoScale": false, + "enableInterNodeCommunication": false, + "startTask": { + "commandLine": "/bin/bash -c 'echo start task'", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.ubuntu 20.04" + } + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_GetPool_SecurityProfile.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_GetPool_SecurityProfile.json new file mode 100644 index 000000000000..f020e3b32e0b --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_GetPool_SecurityProfile.json @@ -0,0 +1,55 @@ +{ + "operationId": "Pools_GetPool", + "title": "Get a VirtualMachineConfiguration pool with SecurityProfile", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "mypool001", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Wed, 14 Jun 2023 06:39:01 GMT" + }, + "responses": { + "200": { + "body": { + "id": "mypool001", + "url": "https://account.region.batch.azure.com/pools/pool", + "eTag": "0x8DB6CA2DFF530D1", + "lastModified": "2023-06-14T06:45:00.0946897Z", + "creationTime": "2023-06-14T06:45:00.0946897Z", + "state": "active", + "stateTransitionTime": "2023-06-14T06:45:00.0946897Z", + "allocationState": "steady", + "allocationStateTransitionTime": "2023-06-14T06:45:59.4770341Z", + "vmSize": "standard_dc2s_v2", + "resizeTimeout": "PT15M", + "currentDedicatedNodes": 1, + "targetDedicatedNodes": 1, + "currentLowPriorityNodes": 0, + "targetLowPriorityNodes": 0, + "enableAutoScale": false, + "enableInterNodeCommunication": false, + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "18_04-lts-gen2", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.ubuntu 18.04", + "securityProfile": { + "securityType": "trustedLaunch", + "encryptionAtHost": true, + "uefiSettings": { + "secureBootEnabled": false + } + } + }, + "currentNodeCommunicationMode": "classic" + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_GetPool_VirtualMachineConfigurationWithExtensions.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_GetPool_VirtualMachineConfigurationWithExtensions.json new file mode 100644 index 000000000000..82a7e7b9162e --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_GetPool_VirtualMachineConfigurationWithExtensions.json @@ -0,0 +1,74 @@ +{ + "operationId": "Pools_GetPool", + "title": "Get a VirtualMachineConfiguration pool with extensions", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "pool", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "pool", + "url": "https://account.region.batch.azure.com/pools/pool", + "eTag": "0x8D413091E739A56", + "lastModified": "2016-11-22T18:55:25.2608598Z", + "creationTime": "2016-11-22T18:55:24.2632496Z", + "state": "active", + "stateTransitionTime": "2016-11-22T18:55:24.2632496Z", + "allocationState": "steady", + "allocationStateTransitionTime": "2016-11-22T18:55:24.8154041Z", + "vmSize": "standard_a1", + "resizeTimeout": "PT15M", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "targetDedicatedNodes": 0, + "targetLowPriorityNodes": 0, + "enableAutoScale": false, + "enableInterNodeCommunication": false, + "startTask": { + "commandLine": "/bin/bash -c 'echo start task'", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.ubuntu 20.04", + "extensions": [ + { + "name": "batchextension1", + "type": "KeyVaultForLinux", + "publisher": "Microsoft.Azure.KeyVault", + "typeHandlerVersion": "2.0", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": { + "secretsManagementSettingsKey": "secretsManagementSettingsValue", + "authenticationSettingsKey": "authenticationSettingsValue" + } + } + ] + }, + "targetNodeCommunicationMode": "classic", + "currentNodeCommunicationMode": "classic" + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_GetPool_VirtualMachineConfigurationWithOSDisk.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_GetPool_VirtualMachineConfigurationWithOSDisk.json new file mode 100644 index 000000000000..6574e2cbb14a --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_GetPool_VirtualMachineConfigurationWithOSDisk.json @@ -0,0 +1,58 @@ +{ + "operationId": "Pools_GetPool", + "title": "Add a VirtualMachineConfiguration pool with OS disk", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "mypool001", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Wed, 23 Aug 2023 08:42:01 GMT" + }, + "responses": { + "200": { + "body": { + "id": "mypool001", + "url": "http://localhost:20302/testaccount1tls/pools/mypool001", + "eTag": "0x8DBA3B4E91CD7B7", + "lastModified": "2023-08-23T08:42:40.3479479Z", + "creationTime": "2023-08-23T08:42:40.3479479Z", + "state": "active", + "stateTransitionTime": "2023-08-23T08:42:40.3479479Z", + "allocationState": "steady", + "allocationStateTransitionTime": "2023-08-23T08:42:53.8587829Z", + "vmSize": "standard_d2s_v3", + "resizeTimeout": "PT15M", + "currentDedicatedNodes": 1, + "targetDedicatedNodes": 1, + "currentLowPriorityNodes": 0, + "targetLowPriorityNodes": 0, + "enableAutoScale": false, + "enableInterNodeCommunication": false, + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts", + "version": "latest" + }, + "osDisk": { + "ephemeralOSDiskSettings": { + "placement": "cachedisk" + }, + "managedDisk": { + "storageAccountType": "standardssd_lrs" + }, + "diskSizeGB": 100, + "caching": "readwrite" + }, + "nodeAgentSKUId": "batch.node.ubuntu 20.04" + }, + "currentNodeCommunicationMode": "classic" + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_GetPool_VirtualMachineConfigurationWithServiceArtifactReference.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_GetPool_VirtualMachineConfigurationWithServiceArtifactReference.json new file mode 100644 index 000000000000..7462de39af56 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_GetPool_VirtualMachineConfigurationWithServiceArtifactReference.json @@ -0,0 +1,54 @@ +{ + "operationId": "Pools_GetPool", + "title": "Get a VirtualMachineConfiguration pool with ServiceArtifactReference", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "pool", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Thu, 11 May 2023 08:08:01 GMT" + }, + "responses": { + "200": { + "body": { + "id": "pool", + "url": "https://account.region.batch.azure.com/pools/pool", + "eTag": "0x8DB51F652DFC78F", + "lastModified": "2023-05-11T08:04:19.7259151Z", + "creationTime": "2023-05-11T08:04:19.7259151Z", + "state": "active", + "stateTransitionTime": "2023-05-11T08:04:19.7259151Z", + "allocationState": "steady", + "allocationStateTransitionTime": "2023-05-11T08:05:22.0020052Z", + "vmSize": "standard_a1_v2", + "resizeTimeout": "PT15M", + "currentDedicatedNodes": 2, + "targetDedicatedNodes": 2, + "currentLowPriorityNodes": 0, + "targetLowPriorityNodes": 0, + "enableAutoScale": false, + "enableInterNodeCommunication": false, + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.windows amd64", + "windowsConfiguration": { + "enableAutomaticUpdates": false + }, + "serviceArtifactReference": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile" + } + }, + "currentNodeCommunicationMode": "classic" + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_ListPoolNodeCounts.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_ListPoolNodeCounts.json new file mode 100644 index 000000000000..d3cbbb642b61 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_ListPoolNodeCounts.json @@ -0,0 +1,129 @@ +{ + "operationId": "Pools_ListPoolNodeCounts", + "title": "NodeCountsPayload", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "poolId": "pool1", + "dedicated": { + "creating": 0, + "idle": 0, + "leavingPool": 0, + "offline": 0, + "preempted": 0, + "rebooting": 0, + "reimaging": 0, + "running": 0, + "starting": 0, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "upgradingOS": 0, + "total": 0 + }, + "lowPriority": { + "creating": 0, + "idle": 0, + "leavingPool": 0, + "offline": 0, + "preempted": 0, + "rebooting": 0, + "reimaging": 0, + "running": 2, + "starting": 1, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "upgradingOS": 0, + "total": 3 + } + }, + { + "poolId": "pool2", + "dedicated": { + "creating": 0, + "idle": 1, + "leavingPool": 0, + "offline": 3, + "preempted": 0, + "rebooting": 0, + "reimaging": 0, + "running": 0, + "starting": 0, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "upgradingOS": 0, + "total": 4 + }, + "lowPriority": { + "creating": 0, + "idle": 0, + "leavingPool": 0, + "offline": 0, + "preempted": 0, + "rebooting": 0, + "reimaging": 0, + "running": 0, + "starting": 0, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "upgradingOS": 0, + "total": 0 + } + }, + { + "poolId": "pool3", + "dedicated": { + "creating": 0, + "idle": 5, + "leavingPool": 0, + "offline": 0, + "preempted": 0, + "rebooting": 0, + "reimaging": 4, + "running": 0, + "starting": 0, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "upgradingOS": 0, + "total": 9 + }, + "lowPriority": { + "creating": 7, + "idle": 0, + "leavingPool": 0, + "offline": 0, + "preempted": 0, + "rebooting": 0, + "reimaging": 0, + "running": 4, + "starting": 0, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "upgradingOS": 0, + "total": 11 + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_ListPoolUsageMetrics.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_ListPoolUsageMetrics.json new file mode 100644 index 000000000000..82cbeab87d2b --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_ListPoolUsageMetrics.json @@ -0,0 +1,32 @@ +{ + "operationId": "Pools_ListPoolUsageMetrics", + "title": "Pool list usage metrics", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "startTime": "2013-04-01T00:00:00Z", + "endTime": "2013-04-01T00:30:00Z", + "poolId": "p1", + "vmSize": "a1", + "totalCoreHours": 39.384838 + }, + { + "startTime": "2013-04-01T00:30:00Z", + "endTime": "2013-04-01T01:00:00Z", + "poolId": "p2", + "vmSize": "a8", + "totalCoreHours": 3039.384838 + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_ListPools_Basic.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_ListPools_Basic.json new file mode 100644 index 000000000000..0883574a2b13 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_ListPools_Basic.json @@ -0,0 +1,61 @@ +{ + "operationId": "Pools_ListPools", + "title": "Pool list", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "testPool", + "url": "https://accountname.region.batch.azure.com/pools/testPool", + "eTag": "0x8D4123BEF87D233", + "lastModified": "2016-11-21T18:26:39.7108787Z", + "creationTime": "2016-11-21T18:26:39.7108787Z", + "state": "active", + "stateTransitionTime": "2016-11-21T18:26:39.7108787Z", + "allocationState": "steady", + "allocationStateTransitionTime": "2016-11-21T18:27:40.287803Z", + "vmSize": "Standard_D1_v2", + "resizeTimeout": "PT15M", + "currentDedicatedNodes": 3, + "currentLowPriorityNodes": 0, + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0, + "enableAutoScale": false, + "enableInterNodeCommunication": false, + "startTask": { + "commandLine": "cmd /c echo hello", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.windows amd64" + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_ListSupportedImages.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_ListSupportedImages.json new file mode 100644 index 000000000000..41c98e95f421 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_ListSupportedImages.json @@ -0,0 +1,78 @@ +{ + "operationId": "Pools_ListSupportedImages", + "title": "Account list node agent skus", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "nodeAgentSKUId": "batch.node.centos 7", + "imageReference": { + "publisher": "OpenLogic", + "offer": "CentOS", + "sku": "7.2", + "version": "latest" + }, + "verificationType": "verified", + "capabilities": [ + "DockerCompatible", + "NvidiaTeslaDriverInstalled" + ], + "osType": "linux" + }, + { + "nodeAgentSKUId": "batch.node.centos 7", + "imageReference": { + "publisher": "OpenLogic", + "offer": "CentOS", + "sku": "7.1", + "version": "latest" + }, + "verificationType": "unverified", + "osType": "linux", + "batchSupportEndOfLife": "2019-11-01T00:00:00.0Z" + }, + { + "nodeAgentSKUId": "batch.node.debian 8", + "imageReference": { + "publisher": "Credativ", + "offer": "Debian", + "sku": "8", + "version": "latest" + }, + "verificationType": "verified", + "osType": "linux" + }, + { + "nodeAgentSKUId": "batch.node.windows amd64", + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2012-R2-Datacenter", + "version": "latest" + }, + "verificationType": "verified", + "osType": "windows" + }, + { + "nodeAgentSKUId": "batch.node.windows amd64", + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2012-Datacenter", + "version": "latest" + }, + "verificationType": "verified", + "osType": "windows" + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_PoolExists.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_PoolExists.json new file mode 100644 index 000000000000..3b7076be3a60 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_PoolExists.json @@ -0,0 +1,15 @@ +{ + "operationId": "Pools_PoolExists", + "title": "Check Pool Exists", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": {}, + "404": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_RemoveNodes.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_RemoveNodes.json new file mode 100644 index 000000000000..94f6e1387660 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_RemoveNodes.json @@ -0,0 +1,20 @@ +{ + "operationId": "Pools_RemoveNodes", + "title": "Pool remove nodes", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "content": { + "nodeList": [ + "tvm-1695681911_1-20161122t224741z", + "tvm-1695681911_2-20161122t224741z" + ] + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_ReplacePoolProperties.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_ReplacePoolProperties.json new file mode 100644 index 000000000000..93cb8d88b580 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_ReplacePoolProperties.json @@ -0,0 +1,21 @@ +{ + "operationId": "Pools_ReplacePoolProperties", + "title": "Pool update", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "pool": { + "startTask": { + "commandLine": "/bin/bash -c 'echo start task'" + }, + "applicationPackageReferences": [], + "metadata": [] + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_ResizePool.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_ResizePool.json new file mode 100644 index 000000000000..fcfd1e063b38 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_ResizePool.json @@ -0,0 +1,18 @@ +{ + "operationId": "Pools_ResizePool", + "title": "Pool resize", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "resizePool", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "content": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_StopPoolResize.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_StopPoolResize.json new file mode 100644 index 000000000000..db1f0716dfed --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_StopPoolResize.json @@ -0,0 +1,14 @@ +{ + "operationId": "Pools_StopPoolResize", + "title": "Pool stop resize", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_UpdatePool.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_UpdatePool.json new file mode 100644 index 000000000000..1138f17ad957 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Pools_UpdatePool.json @@ -0,0 +1,19 @@ +{ + "operationId": "Pools_UpdatePool", + "title": "Patch the Pool", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "pool": { + "startTask": { + "commandLine": "/bin/bash -c 'echo start task'" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskCreateCollection_Basic.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskCreateCollection_Basic.json deleted file mode 100644 index bbb1ba53bea1..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskCreateCollection_Basic.json +++ /dev/null @@ -1,45 +0,0 @@ -{ - "operationId": "Batch_CreateTaskCollection", - "title": "Creates a basic collection of tasks", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "taskCollection": { - "value": [ - { - "id": "simple1", - "commandLine": "cmd /c dir /s" - }, - { - "id": "simple2", - "commandLine": "cmd /c dir /s" - } - ] - } - }, - "responses": { - "200": { - "body": { - "value": [ - { - "status": "success", - "taskId": "simple1", - "eTag": "0x8D3D623CD661246", - "lastModified": "2016-09-06T07:02:44.7589958Z", - "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple1" - }, - { - "status": "success", - "taskId": "simple2", - "eTag": "0x8D3D623CD7072CC", - "lastModified": "2016-09-06T07:02:44.8270028Z", - "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple2" - } - ] - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskCreateCollection_Complex.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskCreateCollection_Complex.json deleted file mode 100644 index 235c85a4dd10..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskCreateCollection_Complex.json +++ /dev/null @@ -1,80 +0,0 @@ -{ - "operationId": "Batch_CreateTaskCollection", - "title": "Creates a complex collection of tasks", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "taskCollection": { - "value": [ - { - "id": "complex1", - "commandLine": "cmd /c dir /s", - "resourceFiles": [ - { - "autoStorageContainerName": "containerName", - "filePath": "data" - } - ], - "environmentSettings": [ - { - "name": "env1", - "value": "value1" - }, - { - "name": "env2", - "value": "value2" - } - ], - "affinityInfo": { - "affinityId": "affinityId" - }, - "constraints": { - "maxWallClockTime": "P1D", - "retentionTime": "P2D", - "maxTaskRetryCount": 5 - }, - "requiredSlots": 2, - "multiInstanceSettings": { - "numberOfInstances": 3, - "coordinationCommandLine": "cmd /c echo coordinating", - "commonResourceFiles": [ - { - "httpUrl": "https://common.blob.core.windows.net/", - "filePath": "common.exe" - } - ] - } - }, - { - "id": "simple3", - "commandLine": "cmd /c dir /s" - } - ] - } - }, - "responses": { - "200": { - "body": { - "value": [ - { - "taskId": "simple3", - "status": "success", - "eTag": "0x8D3D623CE295629", - "lastModified": "2016-09-06T07:02:46.0386857Z", - "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple3" - }, - { - "taskId": "complex1", - "status": "success", - "eTag": "0x8D3D623CE29A412", - "lastModified": "2016-09-06T07:02:46.0406802Z", - "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/complex1" - } - ] - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskCreate_Basic.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskCreate_Basic.json deleted file mode 100644 index e15e32a3e996..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskCreate_Basic.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "operationId": "Batch_CreateTask", - "title": "Creates a basic task", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "task": { - "id": "task1", - "commandLine": "cmd /c echo task1" - } - }, - "responses": { - "201": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskCreate_ContainerSettings.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskCreate_ContainerSettings.json deleted file mode 100644 index eba78d2dd5b6..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskCreate_ContainerSettings.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "operationId": "Batch_CreateTask", - "title": "Creates a task with container settings", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "task": { - "id": "taskId", - "commandLine": "bash -c 'echo hello'", - "containerSettings": { - "imageName": "ubuntu", - "containerRunOptions": "--rm" - }, - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "nonadmin" - } - } - } - }, - "responses": { - "201": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskCreate_ExitConditions.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskCreate_ExitConditions.json deleted file mode 100644 index ad04eb33b757..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskCreate_ExitConditions.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "operationId": "Batch_CreateTask", - "title": "Creates a task with exit conditions", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "task": { - "id": "taskId", - "commandLine": "cmd /c exit 3", - "exitConditions": { - "exitCodeRanges": [ - { - "start": 2, - "end": 4, - "exitOptions": { - "jobAction": "terminate" - } - } - ] - }, - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "nonadmin" - } - } - } - }, - "responses": { - "201": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskCreate_RequiredSlots.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskCreate_RequiredSlots.json deleted file mode 100644 index 7912671c718c..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskCreate_RequiredSlots.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "operationId": "Batch_CreateTask", - "title": "Creates a task with extra slot requirement", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "task": { - "id": "task1", - "requiredSlots": 2, - "commandLine": "cmd /c echo task1" - } - }, - "responses": { - "201": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskDelete.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskDelete.json deleted file mode 100644 index ca488f1f0c76..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskDelete.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "operationId": "Batch_DeleteTask", - "title": "Task delete", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "taskId": "taskId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskGet.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskGet.json deleted file mode 100644 index aa2c816a7ae4..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskGet.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "operationId": "Batch_GetTask", - "title": "Task get", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "taskId": "taskId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "id": "testTask", - "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId", - "eTag": "0x8D3D62350711C55", - "creationTime": "2016-09-06T06:59:15.1161429Z", - "lastModified": "2016-09-06T06:59:15.1161429Z", - "state": "active", - "stateTransitionTime": "2016-09-06T06:59:15.1161429Z", - "commandLine": "cmd /c hostname", - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "nonadmin" - } - }, - "multiInstanceSettings": { - "numberOfInstances": 3, - "coordinationCommandLine": "cmd /c echo coordinating" - }, - "constraints": { - "maxWallClockTime": "P10675199DT2H48M5.4775807S", - "retentionTime": "P10675199DT2H48M5.4775807S", - "maxTaskRetryCount": 0 - }, - "requiredSlots": 2, - "executionInfo": { - "retryCount": 0, - "requeueCount": 0 - } - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskList.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskList.json deleted file mode 100644 index 507b92dc8bfb..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskList.json +++ /dev/null @@ -1,71 +0,0 @@ -{ - "operationId": "Batch_ListTasks", - "title": "Task list", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "task1", - "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/task1", - "eTag": "0x8D4125FD1A825A4", - "creationTime": "2016-11-21T22:43:31.4733476Z", - "lastModified": "2016-11-21T22:43:31.4733476Z", - "state": "active", - "stateTransitionTime": "2016-11-21T22:43:31.4733476Z", - "commandLine": "cmd /c echo task1", - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "nonadmin" - } - }, - "constraints": { - "maxWallClockTime": "P10675199DT2H48M5.4775807S", - "retentionTime": "P10675199DT2H48M5.4775807S", - "maxTaskRetryCount": 0 - }, - "requiredSlots": 2, - "executionInfo": { - "retryCount": 0, - "requeueCount": 0 - } - }, - { - "id": "task2", - "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/task2", - "eTag": "0x8D4125FD2153345", - "creationTime": "2016-11-21T22:43:31.6736345Z", - "lastModified": "2016-11-21T22:43:32.1880389Z", - "state": "active", - "stateTransitionTime": "2016-11-21T22:43:31.6736345Z", - "commandLine": "cmd /c echo task2", - "userIdentity": { - "autoUser": { - "scope": "task", - "elevationLevel": "nonadmin" - } - }, - "constraints": { - "maxWallClockTime": "P10675199DT2H48M5.4775807S", - "retentionTime": "P10675199DT2H48M5.4775807S", - "maxTaskRetryCount": 3 - }, - "requiredSlots": 2, - "executionInfo": { - "retryCount": 0, - "requeueCount": 0 - } - } - ] - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskListSubtasks.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskListSubtasks.json deleted file mode 100644 index 2ee550ff4a8e..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskListSubtasks.json +++ /dev/null @@ -1,52 +0,0 @@ -{ - "operationId": "Batch_ListSubTasks", - "title": "Task list subtasks", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "taskId": "taskId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": 1, - "startTime": "2016-09-06T06:59:16.3139271Z", - "endTime": "2016-09-06T06:59:20.0242024Z", - "state": "completed", - "stateTransitionTime": "2016-09-06T06:59:20.0242024Z", - "previousState": "running", - "previousStateTransitionTime": "2016-09-06T06:59:16.3139271Z", - "exitCode": 0, - "nodeInfo": { - "affinityId": "TVM:tvm-2544493925_3-20160905t051718z", - "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_3-20160905t051718z", - "poolId": "mpiPool", - "nodeId": "tvm-2544493925_3-20160905t051718z", - "taskRootDirectory": "\\workitems\\jobId\\job-1\\taskId\\1", - "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_3-20160905t051718z/files//workitems/jobId/job-1/taskId/1" - } - }, - { - "id": 2, - "startTime": "2016-09-06T06:59:16.9702844Z", - "state": "running", - "stateTransitionTime": "2016-09-06T06:59:16.9702844Z", - "nodeInfo": { - "affinityId": "TVM:tvm-2544493925_2-20160905t051718z", - "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_2-20160905t051718z", - "poolId": "mpiPool", - "nodeId": "tvm-2544493925_2-20160905t051718z", - "taskRootDirectory": "\\workitems\\jobId\\job-1\\taskId\\2", - "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_2-20160905t051718z/files//workitems/jobId/job-1/taskId/2" - } - } - ] - } - } - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskReactivate.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskReactivate.json deleted file mode 100644 index 3f2e368e983a..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskReactivate.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "operationId": "Batch_ReactivateTask", - "title": "Task reactivate", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "taskId": "taskId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "204": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskTerminate.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskTerminate.json deleted file mode 100644 index ad57365f11d8..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskTerminate.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "operationId": "Batch_TerminateTask", - "title": "Task terminate", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "taskId": "taskId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" - }, - "responses": { - "204": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskUpdate.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskUpdate.json deleted file mode 100644 index bf6c2eb4a5c9..000000000000 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/TaskUpdate.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "operationId": "Batch_ReplaceTask", - "title": "Task update", - "parameters": { - "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", - "jobId": "jobId", - "taskId": "taskId", - "client-request-id": "00000000-0000-0000-0000-000000000000", - "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", - "task": { - "constraints": { - "maxWallClockTime": "PT1H", - "maxTaskRetryCount": 3, - "retentionTime": "PT1H" - } - } - }, - "responses": { - "200": {} - } -} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_CreateTaskCollection_Basic.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_CreateTaskCollection_Basic.json new file mode 100644 index 000000000000..ef37e3605956 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_CreateTaskCollection_Basic.json @@ -0,0 +1,45 @@ +{ + "operationId": "Tasks_CreateTaskCollection", + "title": "Creates a basic collection of tasks", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "taskCollection": { + "value": [ + { + "id": "simple1", + "commandLine": "cmd /c dir /s" + }, + { + "id": "simple2", + "commandLine": "cmd /c dir /s" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "status": "success", + "taskId": "simple1", + "eTag": "0x8D3D623CD661246", + "lastModified": "2016-09-06T07:02:44.7589958Z", + "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple1" + }, + { + "status": "success", + "taskId": "simple2", + "eTag": "0x8D3D623CD7072CC", + "lastModified": "2016-09-06T07:02:44.8270028Z", + "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple2" + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_CreateTaskCollection_Complex.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_CreateTaskCollection_Complex.json new file mode 100644 index 000000000000..5d3ea8180cf6 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_CreateTaskCollection_Complex.json @@ -0,0 +1,80 @@ +{ + "operationId": "Tasks_CreateTaskCollection", + "title": "Creates a complex collection of tasks", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "taskCollection": { + "value": [ + { + "id": "complex1", + "commandLine": "cmd /c dir /s", + "resourceFiles": [ + { + "autoStorageContainerName": "containerName", + "filePath": "data" + } + ], + "environmentSettings": [ + { + "name": "env1", + "value": "value1" + }, + { + "name": "env2", + "value": "value2" + } + ], + "affinityInfo": { + "affinityId": "affinityId" + }, + "constraints": { + "maxWallClockTime": "P1D", + "retentionTime": "P2D", + "maxTaskRetryCount": 5 + }, + "requiredSlots": 2, + "multiInstanceSettings": { + "numberOfInstances": 3, + "coordinationCommandLine": "cmd /c echo coordinating", + "commonResourceFiles": [ + { + "httpUrl": "https://common.blob.core.windows.net/", + "filePath": "common.exe" + } + ] + } + }, + { + "id": "simple3", + "commandLine": "cmd /c dir /s" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "taskId": "simple3", + "status": "success", + "eTag": "0x8D3D623CE295629", + "lastModified": "2016-09-06T07:02:46.0386857Z", + "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple3" + }, + { + "taskId": "complex1", + "status": "success", + "eTag": "0x8D3D623CE29A412", + "lastModified": "2016-09-06T07:02:46.0406802Z", + "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/complex1" + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_CreateTask_Basic.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_CreateTask_Basic.json new file mode 100644 index 000000000000..9ac29f42ba78 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_CreateTask_Basic.json @@ -0,0 +1,18 @@ +{ + "operationId": "Tasks_CreateTask", + "title": "Creates a basic task", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "task": { + "id": "task1", + "commandLine": "cmd /c echo task1" + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_CreateTask_ContainerSettings.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_CreateTask_ContainerSettings.json new file mode 100644 index 000000000000..55bd01e12b65 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_CreateTask_ContainerSettings.json @@ -0,0 +1,28 @@ +{ + "operationId": "Tasks_CreateTask", + "title": "Creates a task with container settings", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "task": { + "id": "taskId", + "commandLine": "bash -c 'echo hello'", + "containerSettings": { + "imageName": "ubuntu", + "containerRunOptions": "--rm" + }, + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + } + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_CreateTask_ExitConditions.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_CreateTask_ExitConditions.json new file mode 100644 index 000000000000..4031c4a776cf --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_CreateTask_ExitConditions.json @@ -0,0 +1,35 @@ +{ + "operationId": "Tasks_CreateTask", + "title": "Creates a task with exit conditions", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "task": { + "id": "taskId", + "commandLine": "cmd /c exit 3", + "exitConditions": { + "exitCodeRanges": [ + { + "start": 2, + "end": 4, + "exitOptions": { + "jobAction": "terminate" + } + } + ] + }, + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + } + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_CreateTask_RequiredSlots.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_CreateTask_RequiredSlots.json new file mode 100644 index 000000000000..6b14c38c96ea --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_CreateTask_RequiredSlots.json @@ -0,0 +1,19 @@ +{ + "operationId": "Tasks_CreateTask", + "title": "Creates a task with extra slot requirement", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "task": { + "id": "task1", + "requiredSlots": 2, + "commandLine": "cmd /c echo task1" + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_DeleteTask.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_DeleteTask.json new file mode 100644 index 000000000000..0f7d404c37a5 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_DeleteTask.json @@ -0,0 +1,15 @@ +{ + "operationId": "Tasks_DeleteTask", + "title": "Task delete", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_DeleteTaskFile.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_DeleteTaskFile.json new file mode 100644 index 000000000000..0908b20f659a --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_DeleteTaskFile.json @@ -0,0 +1,17 @@ +{ + "operationId": "Tasks_DeleteTaskFile", + "title": "File delete from task", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "taskId": "task1", + "filePath": "wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "recursive": false + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_GetTask.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_GetTask.json new file mode 100644 index 000000000000..3e8e2daaf788 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_GetTask.json @@ -0,0 +1,46 @@ +{ + "operationId": "Tasks_GetTask", + "title": "Task get", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "testTask", + "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId", + "eTag": "0x8D3D62350711C55", + "creationTime": "2016-09-06T06:59:15.1161429Z", + "lastModified": "2016-09-06T06:59:15.1161429Z", + "state": "active", + "stateTransitionTime": "2016-09-06T06:59:15.1161429Z", + "commandLine": "cmd /c hostname", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "multiInstanceSettings": { + "numberOfInstances": 3, + "coordinationCommandLine": "cmd /c echo coordinating" + }, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "retentionTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "requiredSlots": 2, + "executionInfo": { + "retryCount": 0, + "requeueCount": 0 + } + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_GetTaskFile.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_GetTaskFile.json new file mode 100644 index 000000000000..14df3ed4f5ef --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_GetTaskFile.json @@ -0,0 +1,23 @@ +{ + "operationId": "Tasks_GetTaskFile", + "title": "Get File From Task", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "taskId": "task1", + "filePath": "wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", + "ocp-batch-file-isdirectory": "false", + "Content-Length": "17", + "Content-Type": "application/octet-stream", + "body": "This is actually a byte stream. This request/response is being presented as a string for readability in the example" + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_GetTaskFileProperties.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_GetTaskFileProperties.json new file mode 100644 index 000000000000..a4b6bb55369e --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_GetTaskFileProperties.json @@ -0,0 +1,22 @@ +{ + "operationId": "Tasks_GetTaskFileProperties", + "title": "File get properties from task", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "taskId": "taskId", + "filePath": "wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", + "ocp-batch-file-isdirectory": "false", + "Content-Length": "17", + "Content-Type": "application/octet-stream" + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_ListSubTasks.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_ListSubTasks.json new file mode 100644 index 000000000000..cf4efa6d84c0 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_ListSubTasks.json @@ -0,0 +1,52 @@ +{ + "operationId": "Tasks_ListSubTasks", + "title": "Task list subtasks", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": 1, + "startTime": "2016-09-06T06:59:16.3139271Z", + "endTime": "2016-09-06T06:59:20.0242024Z", + "state": "completed", + "stateTransitionTime": "2016-09-06T06:59:20.0242024Z", + "previousState": "running", + "previousStateTransitionTime": "2016-09-06T06:59:16.3139271Z", + "exitCode": 0, + "nodeInfo": { + "affinityId": "TVM:tvm-2544493925_3-20160905t051718z", + "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_3-20160905t051718z", + "poolId": "mpiPool", + "nodeId": "tvm-2544493925_3-20160905t051718z", + "taskRootDirectory": "\\workitems\\jobId\\job-1\\taskId\\1", + "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_3-20160905t051718z/files//workitems/jobId/job-1/taskId/1" + } + }, + { + "id": 2, + "startTime": "2016-09-06T06:59:16.9702844Z", + "state": "running", + "stateTransitionTime": "2016-09-06T06:59:16.9702844Z", + "nodeInfo": { + "affinityId": "TVM:tvm-2544493925_2-20160905t051718z", + "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_2-20160905t051718z", + "poolId": "mpiPool", + "nodeId": "tvm-2544493925_2-20160905t051718z", + "taskRootDirectory": "\\workitems\\jobId\\job-1\\taskId\\2", + "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_2-20160905t051718z/files//workitems/jobId/job-1/taskId/2" + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_ListTaskFiles.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_ListTaskFiles.json new file mode 100644 index 000000000000..9d3e580e4afb --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_ListTaskFiles.json @@ -0,0 +1,43 @@ +{ + "operationId": "Tasks_ListTaskFiles", + "title": "File list from task", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "recursive": false + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "startup\\ProcessEnv.cmd", + "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId/files/startup\\ProcessEnv.cmd", + "isDirectory": false, + "properties": { + "creationTime": "2014-09-19T21:56:17.679195Z", + "lastModified": "2014-09-19T21:56:17.679195Z", + "contentLength": "1813", + "contentType": "application/octet-stream" + } + }, + { + "name": "startup\\stderr.txt", + "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId/files/startup\\stderr.txt", + "isDirectory": false, + "properties": { + "creationTime": "2014-09-19T21:56:17.5590855Z", + "lastModified": "2014-09-19T21:56:17.5590855Z", + "contentLength": "0", + "contentType": "application/octet-stream" + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_ListTasks.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_ListTasks.json new file mode 100644 index 000000000000..e0fe12da8340 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_ListTasks.json @@ -0,0 +1,71 @@ +{ + "operationId": "Tasks_ListTasks", + "title": "Task list", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "task1", + "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/task1", + "eTag": "0x8D4125FD1A825A4", + "creationTime": "2016-11-21T22:43:31.4733476Z", + "lastModified": "2016-11-21T22:43:31.4733476Z", + "state": "active", + "stateTransitionTime": "2016-11-21T22:43:31.4733476Z", + "commandLine": "cmd /c echo task1", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "retentionTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "requiredSlots": 2, + "executionInfo": { + "retryCount": 0, + "requeueCount": 0 + } + }, + { + "id": "task2", + "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/task2", + "eTag": "0x8D4125FD2153345", + "creationTime": "2016-11-21T22:43:31.6736345Z", + "lastModified": "2016-11-21T22:43:32.1880389Z", + "state": "active", + "stateTransitionTime": "2016-11-21T22:43:31.6736345Z", + "commandLine": "cmd /c echo task2", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "retentionTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 3 + }, + "requiredSlots": 2, + "executionInfo": { + "retryCount": 0, + "requeueCount": 0 + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_ReactivateTask.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_ReactivateTask.json new file mode 100644 index 000000000000..12a5ad7b37a7 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_ReactivateTask.json @@ -0,0 +1,15 @@ +{ + "operationId": "Tasks_ReactivateTask", + "title": "Task reactivate", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "204": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_ReplaceTask.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_ReplaceTask.json new file mode 100644 index 000000000000..eb8822a9b419 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_ReplaceTask.json @@ -0,0 +1,22 @@ +{ + "operationId": "Tasks_ReplaceTask", + "title": "Task update", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "task": { + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": 3, + "retentionTime": "PT1H" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_TerminateTask.json b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_TerminateTask.json new file mode 100644 index 000000000000..823bfe3c92dc --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-02-01.19.0/examples/Tasks_TerminateTask.json @@ -0,0 +1,15 @@ +{ + "operationId": "Tasks_TerminateTask", + "title": "Task terminate", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-02-01.19.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "204": {} + } +} diff --git a/specification/batch/data-plane/readme.md b/specification/batch/data-plane/readme.md index bc963fd10ba0..e865c73d7998 100644 --- a/specification/batch/data-plane/readme.md +++ b/specification/batch/data-plane/readme.md @@ -316,6 +316,12 @@ directive: - $.paths["/jobs/{jobId}/tasks/{taskId}"].delete.responses - $.paths["/pools/{poolId}/nodes/{nodeId}/users/{userName}"].delete.responses reason: These delete operations have the required responses. Looks like a bug with the validator. + +suppressions: + - code: OperationIdNounVerb + from: BatchService.json + reason: This rule is an ARM specific API validation rule and does not apply to data plane API validation. + ``` ### Tag: package-2017-05.5.0 diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2023-09-15-preview/botservice.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2023-09-15-preview/botservice.json index 85d4ff731c3d..fce9212914b8 100644 --- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2023-09-15-preview/botservice.json +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2023-09-15-preview/botservice.json @@ -2412,7 +2412,7 @@ "deploymentEnvironment": { "type": "string", "description": "Deployment environment for Microsoft Teams channel calls", - "default": "FallbackDeploymentEnvironment" + "default": "CommercialDeployment" }, "acceptedTerms": { "type": "boolean", diff --git a/specification/codesigning/CodeSigning.Management/tspconfig.yaml b/specification/codesigning/CodeSigning.Management/tspconfig.yaml index 536cbbf0464c..45181e899887 100644 --- a/specification/codesigning/CodeSigning.Management/tspconfig.yaml +++ b/specification/codesigning/CodeSigning.Management/tspconfig.yaml @@ -5,6 +5,9 @@ options: use-read-only-status-schema: true emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/codeSigningAccount.json" examples-directory: "{project-root}/examples" linter: diff --git a/specification/cognitiveservices/OpenAI.Inference/client.tsp b/specification/cognitiveservices/OpenAI.Inference/client.tsp index d890f79c304f..247acdd775c8 100644 --- a/specification/cognitiveservices/OpenAI.Inference/client.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/client.tsp @@ -42,3 +42,29 @@ interface OpenAIClient { getEmbeddings is Azure.OpenAI.getEmbeddings; } + +@@clientName(Azure.OpenAI.GenerateSpeechFromTextBody.body, + "speechGenerationOptions", + "java" +); +@@clientName(Azure.OpenAI.GetAudioTranscriptionBody.body, + "audioTranscriptionOptions", + "java" +); +@@clientName(Azure.OpenAI.GetAudioTranslationBody.body, + "audioTranslationOptions", + "java" +); +@@clientName(Azure.OpenAI.GetChatCompletionsBody.body, + "chatCompletionsOptions", + "java" +); +@@clientName(Azure.OpenAI.GetCompletionsBody.body, + "completionsOptions", + "java" +); +@@clientName(Azure.OpenAI.GetEmbeddingsBody.body, "embeddingsOptions", "java"); +@@clientName(Azure.OpenAI.GetImageGenerationsBody.body, + "imageGenerationOptions", + "java" +); diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/audio_transcription_object.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/audio_transcription_object.json new file mode 100644 index 000000000000..def8b3046bfc --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/audio_transcription_object.json @@ -0,0 +1,16 @@ +{ + "operationId": "GetAudioTranscriptionAsResponseObject", + "title": "Gets transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-01", + "deploymentId": "" + }, + "responses": { + "200": { + "body": { + "text": "A structured object when requesting json or verbose_json" + } + } + } +} diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/audio_transcription_text.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/audio_transcription_text.json new file mode 100644 index 000000000000..a8c1fd1723ca --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/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": "2024-02-01", + "deploymentId": "", + "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/OpenAI.Inference/examples/2024-02-01/audio_translation_object.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/audio_translation_object.json new file mode 100644 index 000000000000..ab8062b737dd --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/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": "2024-02-01", + "deploymentId": "", + "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/OpenAI.Inference/examples/2024-02-01/audio_translation_text.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/audio_translation_text.json new file mode 100644 index 000000000000..b26310538fce --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/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": "2024-02-01", + "deploymentId": "", + "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/OpenAI.Inference/examples/2024-02-01/extensions_chat_completions_aml_index.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/extensions_chat_completions_aml_index.json new file mode 100644 index 000000000000..b4a11ee3158b --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/extensions_chat_completions_aml_index.json @@ -0,0 +1,58 @@ +{ + "operationId": "GetChatCompletionsWithAzureExtensions", + "title": "Creates a completion for the provided AML index. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-01", + "deploymentId": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "dataSources": [ + { + "type": "AzureMLIndex", + "parameters": { + "projectResourceId": "/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": { + "messages": [ + { + "role": "tool", + "content": "extension specific payload here" + } + ] + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/extensions_chat_completions_azure_search_advanced.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/extensions_chat_completions_azure_search_advanced.json new file mode 100644 index 000000000000..ddb6e2a5eb36 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/extensions_chat_completions_azure_search_advanced.json @@ -0,0 +1,82 @@ +{ + "operationId": "GetChatCompletionsWithAzureExtensions", + "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": "2024-02-01", + "deploymentId": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "dataSources": [ + { + "type": "AzureCognitiveSearch", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "authentication": { + "type": "UserAssignedManagedIdentity", + "managedIdentityResourceId": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}" + }, + "indexName": "{index name}", + "queryType": "vector", + "embeddingDependency": { + "type": "DeploymentName", + "deploymentName": "{embedding deployment name}" + }, + "inScope": true, + "topNDocuments": 5, + "strictness": 3, + "roleInformation": "You are an AI assistant that helps people find information.", + "fieldsMapping": { + "contentFieldsSeparator": "\\n", + "contentFields": [ + "content" + ], + "filepathField": "filepath", + "titleField": "title", + "urlField": "url", + "vectorFields": [ + "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": { + "messages": [ + { + "role": "tool", + "content": "extension specific payload here" + } + ] + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/extensions_chat_completions_azure_search_image_vector.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/extensions_chat_completions_azure_search_image_vector.json new file mode 100644 index 000000000000..7a6d3576a733 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/extensions_chat_completions_azure_search_image_vector.json @@ -0,0 +1,63 @@ +{ + "operationId": "GetChatCompletionsWithAzureExtensions", + "title": "Creates a completion based on Azure Cognitive Services image vector data. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-01", + "deploymentId": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "dataSources": [ + { + "type": "AzureCognitiveSearch", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "indexName": "{index name}", + "queryType": "vector", + "fieldsMapping": { + "imageVectorFields": [ + "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": { + "messages": [ + { + "role": "tool", + "content": "extension specific payload here" + } + ] + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/extensions_chat_completions_azure_search_minimum.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/extensions_chat_completions_azure_search_minimum.json new file mode 100644 index 000000000000..ec14ea1965ac --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/extensions_chat_completions_azure_search_minimum.json @@ -0,0 +1,57 @@ +{ + "operationId": "GetChatCompletionsWithAzureExtensions", + "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": "2024-02-01", + "deploymentId": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "dataSources": [ + { + "type": "AzureCognitiveSearch", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "indexName": "{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": { + "messages": [ + { + "role": "tool", + "content": "extension specific payload here" + } + ] + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/extensions_chat_completions_cosmos_db.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/extensions_chat_completions_cosmos_db.json new file mode 100644 index 000000000000..f84447958a1c --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/extensions_chat_completions_cosmos_db.json @@ -0,0 +1,74 @@ +{ + "operationId": "GetChatCompletionsWithAzureExtensions", + "title": "Creates a completion for the provided Azure Cosmos DB. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-01", + "deploymentId": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "dataSources": [ + { + "type": "AzureCosmosDB", + "parameters": { + "authentication": { + "type": "ConnectionString", + "connectionString": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000" + }, + "databaseName": "vectordb", + "containerName": "azuredocs", + "indexName": "azuredocindex", + "embeddingDependency": { + "type": "DeploymentName", + "deploymentName": "{embedding deployment name}" + }, + "fieldsMapping": { + "contentFields": [ + "content" + ], + "vectorFields": [ + "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": { + "messages": [ + { + "role": "tool", + "content": "extension specific payload here" + } + ] + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/extensions_chat_completions_elasticsearch.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/extensions_chat_completions_elasticsearch.json new file mode 100644 index 000000000000..e29a180e033e --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/extensions_chat_completions_elasticsearch.json @@ -0,0 +1,62 @@ +{ + "operationId": "GetChatCompletionsWithAzureExtensions", + "title": "Creates a completion for the provided Elasticsearch. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-01", + "deploymentId": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "dataSources": [ + { + "type": "Elasticsearch", + "parameters": { + "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io", + "indexName": "{index name}", + "authentication": { + "type": "KeyAndKeyId", + "key": "{key}", + "keyId": "{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": { + "messages": [ + { + "role": "tool", + "content": "extension specific payload here" + } + ] + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/extensions_chat_completions_pinecone.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/extensions_chat_completions_pinecone.json new file mode 100644 index 000000000000..f35d88699997 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/extensions_chat_completions_pinecone.json @@ -0,0 +1,74 @@ +{ + "operationId": "GetChatCompletionsWithAzureExtensions", + "title": "Creates a completion for the provided Pinecone resource. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-01", + "deploymentId": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "dataSources": [ + { + "type": "Pinecone", + "parameters": { + "authentication": { + "type": "APIKey", + "key": "{api key}" + }, + "environment": "{environment name}", + "indexName": "{index name}", + "embeddingDependency": { + "type": "DeploymentName", + "deploymentName": "{embedding deployment name}" + }, + "fieldsMapping": { + "titleField": "title", + "urlField": "url", + "filepathField": "filepath", + "contentFields": [ + "content" + ], + "contentFieldsSeparator": "\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": { + "messages": [ + { + "role": "tool", + "content": "extension specific payload here" + } + ] + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/generated_chat_completions.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/generated_chat_completions.json new file mode 100644 index 000000000000..f67ab3db1801 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/generated_chat_completions.json @@ -0,0 +1,44 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion for the provided prompt, parameters and chosen model.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-01", + "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!" + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/generated_completions.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/generated_completions.json new file mode 100644 index 000000000000..ca9f1f5d1d7b --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/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": "2024-02-01", + "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/OpenAI.Inference/examples/2024-02-01/generated_embeddings.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/generated_embeddings.json new file mode 100644 index 000000000000..382f01845635 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/generated_embeddings.json @@ -0,0 +1,1567 @@ +{ + "operationId": "GetEmbeddings", + "title": "Return the embeddings for a given prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-01", + "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/OpenAI.Inference/examples/2024-02-01/get_image_operation_status.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/get_image_operation_status.json new file mode 100644 index 000000000000..f71332bb9392 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/get_image_operation_status.json @@ -0,0 +1,27 @@ +{ + "operationId": "GetAzureBatchImageGenerationOperationStatus", + "title": "Returns the status of the images operation", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-01", + "operationId": "" + }, + "responses": { + "200": { + "body": { + "created": 1686676595, + "expires": 1686762999, + "id": "", + "result": { + "created": 1686676595, + "data": [ + { + "url": "https://image/path" + } + ] + }, + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/image_generation.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/image_generation.json new file mode 100644 index 000000000000..e1b11066af8d --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/image_generation.json @@ -0,0 +1,31 @@ +{ + "operationId": "GetImageGenerations", + "title": "Creates images given a prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-01", + "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/OpenAI.Inference/examples/2024-02-01/start_generate_image.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/start_generate_image.json new file mode 100644 index 000000000000..63df54082486 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-02-01/start_generate_image.json @@ -0,0 +1,25 @@ +{ + "operationId": "BeginAzureBatchImageGeneration", + "title": "Starts the generation of a batch of images from a text caption", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-01", + "body": { + "prompt": "a monkey eating a banana", + "size": "256x256", + "n": 1 + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{endpoint}/openai/operations/images/?api-version=2023-06-01-preview" + }, + "body": { + "id": "", + "status": "notRunning", + "created": 0 + } + } + } +} diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/generated_audio_speech.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/generated_audio_speech.json new file mode 100644 index 000000000000..b350710a1477 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/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": "2024-06-01", + "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/OpenAI.Inference/examples/2024-06-01/generated_audio_transcription_object.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/generated_audio_transcription_object.json new file mode 100644 index 000000000000..08e457b4fd9d --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/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": "2024-06-01", + "deploymentId": "", + "file": "U3dhZ2dlciByb2Nrcw==" + }, + "responses": { + "200": { + "body": { + "text": "A structured object when requesting json or verbose_json" + } + } + } +} diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/generated_audio_transcription_text.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/generated_audio_transcription_text.json new file mode 100644 index 000000000000..7c49a6558ca1 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/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": "2024-06-01", + "deploymentId": "", + "file": "U3dhZ2dlciByb2Nrcw==" + }, + "responses": { + "200": { + "type": "string", + "body": "plain text when requesting text, srt, or vtt" + } + } +} diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/generated_audio_translation_object.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/generated_audio_translation_object.json new file mode 100644 index 000000000000..29a402e4a6a6 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/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": "2024-06-01", + "deploymentId": "", + "file": "U3dhZ2dlciByb2Nrcw==" + }, + "responses": { + "200": { + "body": { + "text": "A structured object when requesting json or verbose_json" + } + } + } +} diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/generated_audio_translation_text.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/generated_audio_translation_text.json new file mode 100644 index 000000000000..1f9c2e224fc4 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/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": "2024-06-01", + "deploymentId": "", + "file": "U3dhZ2dlciByb2Nrcw==" + }, + "responses": { + "200": { + "type": "string", + "body": "plain text when requesting text, srt, or vtt" + } + } +} diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/generated_chat_completions.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/generated_chat_completions.json new file mode 100644 index 000000000000..c4bdb0088d78 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/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": "2024-06-01", + "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/OpenAI.Inference/examples/2024-06-01/generated_completions.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/generated_completions.json new file mode 100644 index 000000000000..d0d5be75a90e --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/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": "2024-06-01", + "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/OpenAI.Inference/examples/2024-06-01/generated_embeddings.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/generated_embeddings.json new file mode 100644 index 000000000000..7336f5f1db30 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/generated_embeddings.json @@ -0,0 +1,1567 @@ +{ + "operationId": "GetEmbeddings", + "title": "Return the embeddings for a given prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-06-01", + "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/OpenAI.Inference/examples/2024-06-01/generated_extensions_chat_completions_aml_index.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/generated_extensions_chat_completions_aml_index.json new file mode 100644 index 000000000000..a3a79dc2b0d1 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/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": "2024-06-01", + "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/OpenAI.Inference/examples/2024-06-01/generated_extensions_chat_completions_azure_search_advanced.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/generated_extensions_chat_completions_azure_search_advanced.json new file mode 100644 index 000000000000..712a0c68a98f --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/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": "2024-06-01", + "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/OpenAI.Inference/examples/2024-06-01/generated_extensions_chat_completions_azure_search_image_vector.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/generated_extensions_chat_completions_azure_search_image_vector.json new file mode 100644 index 000000000000..0d0f1428eba0 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/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": "2024-06-01", + "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/OpenAI.Inference/examples/2024-06-01/generated_extensions_chat_completions_azure_search_minimum.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/generated_extensions_chat_completions_azure_search_minimum.json new file mode 100644 index 000000000000..9aa79a24b6fe --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/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": "2024-06-01", + "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/OpenAI.Inference/examples/2024-06-01/generated_extensions_chat_completions_cosmos_db.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/generated_extensions_chat_completions_cosmos_db.json new file mode 100644 index 000000000000..c0e3253c53f4 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/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": "2024-06-01", + "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/OpenAI.Inference/examples/2024-06-01/generated_extensions_chat_completions_elasticsearch.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/generated_extensions_chat_completions_elasticsearch.json new file mode 100644 index 000000000000..277097b148bf --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/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": "2024-06-01", + "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/OpenAI.Inference/examples/2024-06-01/generated_extensions_chat_completions_pinecone.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/generated_extensions_chat_completions_pinecone.json new file mode 100644 index 000000000000..26968f4f6d1b --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/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": "2024-06-01", + "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/OpenAI.Inference/examples/2024-06-01/generated_image_generation.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/generated_image_generation.json new file mode 100644 index 000000000000..9dfbcb9b87d5 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/generated_image_generation.json @@ -0,0 +1,31 @@ +{ + "operationId": "GetImageGenerations", + "title": "Creates images given a prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-06-01", + "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/OpenAI.Inference/examples/2024-06-01/get_image_operation_status.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/get_image_operation_status.json new file mode 100644 index 000000000000..05fafd1e482d --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/get_image_operation_status.json @@ -0,0 +1,27 @@ +{ + "operationId": "GetAzureBatchImageGenerationOperationStatus", + "title": "Returns the status of the images operation", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-06-01", + "operationId": "" + }, + "responses": { + "200": { + "body": { + "created": 1686676595, + "expires": 1686762999, + "id": "", + "result": { + "created": 1686676595, + "data": [ + { + "url": "https://image/path" + } + ] + }, + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/start_generate_image.json b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/start_generate_image.json new file mode 100644 index 000000000000..38194a3da58f --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2024-06-01/start_generate_image.json @@ -0,0 +1,25 @@ +{ + "operationId": "BeginAzureBatchImageGeneration", + "title": "Starts the generation of a batch of images from a text caption", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-06-01", + "body": { + "prompt": "a monkey eating a banana", + "size": "256x256", + "n": 1 + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{endpoint}/openai/operations/images/?api-version=2023-06-01-preview" + }, + "body": { + "id": "", + "status": "notRunning", + "created": 0 + } + } + } +} diff --git a/specification/cognitiveservices/OpenAI.Inference/main.tsp b/specification/cognitiveservices/OpenAI.Inference/main.tsp index 8ab85d3186ad..9dd9303c68bf 100644 --- a/specification/cognitiveservices/OpenAI.Inference/main.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/main.tsp @@ -53,6 +53,9 @@ enum ServiceApiVersions { @useDependency(Azure.Core.Versions.v1_0_Preview_1) v2023_07_01_Preview: "2023-07-01-preview", + @useDependency(Azure.Core.Versions.v1_0_Preview_1) + v2024_02_01: "2024-02-01", + @useDependency(Azure.Core.Versions.v1_0_Preview_1) v2024_02_15_Preview: "2024-02-15-preview", @@ -64,4 +67,7 @@ enum ServiceApiVersions { @useDependency(Azure.Core.Versions.v1_0_Preview_1) v2024_05_01_Preview: "2024-05-01-preview", + + @useDependency(Azure.Core.Versions.v1_0_Preview_1) + v2024_06_01: "2024-06-01", } diff --git a/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_speech.tsp b/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_speech.tsp index ffd791b045f6..14a4deb4cb0f 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_speech.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_speech.tsp @@ -98,3 +98,15 @@ model SpeechGenerationResponse { @bodyRoot audio: bytes; } + +/** + * Get generate speech from text body. + */ +@added(ServiceApiVersions.v2024_02_15_Preview) +model GenerateSpeechFromTextBody { + /** + * A representation of the request options that control the behavior of a text-to-speech operation. + */ + @bodyRoot + body: SpeechGenerationOptions; +} diff --git a/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_transcription.tsp b/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_transcription.tsp index 97b7963aa9ff..cdc429e24250 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_transcription.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_transcription.tsp @@ -4,6 +4,7 @@ import "./common.tsp"; namespace Azure.OpenAI; +using TypeSpec.Http; using TypeSpec.Versioning; using Azure.ClientGenerator.Core; @@ -215,3 +216,15 @@ model AudioTranscription { @added(ServiceApiVersions.v2024_04_01_Preview) words?: AudioTranscriptionWord[]; } + +/** + * Get audio transcription body. + */ +@added(ServiceApiVersions.v2024_02_15_Preview) +model GetAudioTranscriptionBody { + /** + * The configuration information for an audio transcription request. + */ + @body + body: AudioTranscriptionOptions; +} diff --git a/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_translation.tsp b/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_translation.tsp index 9c9733e9135d..45073fcfa038 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_translation.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_translation.tsp @@ -4,6 +4,7 @@ import "./common.tsp"; namespace Azure.OpenAI; +using TypeSpec.Http; using TypeSpec.Versioning; using Azure.ClientGenerator.Core; @@ -157,3 +158,15 @@ model AudioTranslation { """) segments?: AudioTranslationSegment[]; } + +/** + * Get audio translation body. + */ +@added(ServiceApiVersions.v2024_02_15_Preview) +model GetAudioTranslationBody { + /** + * The configuration information for an audio translation request. + */ + @body + body: AudioTranslationOptions; +} diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/chat_completions.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/chat_completions.tsp index e13ed63929d4..7a0adb81a445 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/chat_completions.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/chat_completions.tsp @@ -401,3 +401,17 @@ model ChatTokenLogProbabilityInfo { """) bytes: int32[] | null; } + +/** + * Get chat completions request body. + */ +@added(ServiceApiVersions.v2023_05_15) +model GetChatCompletionsBody { + /** + * The configuration information for a chat completions request. + * Completions support a wide variety of tasks and generate text that continues from or "completes" + * provided prompt data. + */ + @bodyRoot + body: ChatCompletionsOptions; +} diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/completions_create.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/completions_create.tsp index 0fba24798f4a..6245bdb81bda 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/completions_create.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/completions_create.tsp @@ -239,3 +239,16 @@ model CompletionsLogProbabilityModel { @clientName("textOffsets", "java") textOffset: int32[]; } + +/** + * Get completions request body. + */ +model GetCompletionsBody { + /** + * The configuration information for a completions request. + * Completions support a wide variety of tasks and generate text that continues from or "completes" + * provided prompt data. + */ + @bodyRoot + body: CompletionsOptions; +} diff --git a/specification/cognitiveservices/OpenAI.Inference/models/embeddings_create.tsp b/specification/cognitiveservices/OpenAI.Inference/models/embeddings_create.tsp index e698a2f1d70f..1f98e84a3e06 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/embeddings_create.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/embeddings_create.tsp @@ -103,13 +103,15 @@ model EmbeddingsUsage { totalTokens: int32; } -alias BodyParameter< - T, - TName extends valueof string = "body", - TDoc extends valueof string = "Body parameter." -> = { - @doc(TDoc) - @friendlyName(TName) +/** + * Get embeddings request body. + */ +model GetEmbeddingsBody { + /** + * The configuration information for an embeddings request. + * Embeddings measure the relatedness of text strings and are commonly used for search, clustering, + * recommendations, and other similar scenarios. + */ @bodyRoot - body: T; -}; + body: EmbeddingsOptions; +} diff --git a/specification/cognitiveservices/OpenAI.Inference/models/images/images.tsp b/specification/cognitiveservices/OpenAI.Inference/models/images/images.tsp index b0619f8b0f5e..ea51a02b9d92 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/images/images.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/images/images.tsp @@ -291,3 +291,15 @@ model BatchImageGenerationOperationResponse { @doc("The error if the operation failed.") error?: Foundations.Error; } + +/** + * Get image generation body. + */ +@added(ServiceApiVersions.v2023_06_01_Preview) +model GetImageGenerationsBody { + /** + * Represents the request data used to generate images. + */ + @bodyRoot + body: ImageGenerationOptions; +} diff --git a/specification/cognitiveservices/OpenAI.Inference/routes/audio_speech.tsp b/specification/cognitiveservices/OpenAI.Inference/routes/audio_speech.tsp index 0d456088cd1f..46b30cac7d33 100644 --- a/specification/cognitiveservices/OpenAI.Inference/routes/audio_speech.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/routes/audio_speech.tsp @@ -20,6 +20,6 @@ namespace Azure.OpenAI; @actionSeparator("/") op generateSpeechFromText is ResourceAction< Deployment, - SpeechGenerationOptions, + GenerateSpeechFromTextBody, SpeechGenerationResponse >; diff --git a/specification/cognitiveservices/OpenAI.Inference/routes/audio_transcription.tsp b/specification/cognitiveservices/OpenAI.Inference/routes/audio_transcription.tsp index 265ba7cedba0..7745646bdd74 100644 --- a/specification/cognitiveservices/OpenAI.Inference/routes/audio_transcription.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/routes/audio_transcription.tsp @@ -28,7 +28,7 @@ namespace Azure.OpenAI; @sharedRoute op getAudioTranscriptionAsPlainText is Azure.Core.ResourceAction< Deployment, - BodyParameter, + GetAudioTranscriptionBody, // response_format must be one of: text, srt, vtt AudioTextResponse, MultipartFormDataRequestHeadersTraits & TextPlainResponseHeadersTraits >; @@ -44,7 +44,7 @@ op getAudioTranscriptionAsPlainText is Azure.Core.ResourceAction< @sharedRoute op getAudioTranscriptionAsResponseObject is Azure.Core.ResourceAction< Deployment, - BodyParameter, // response_format must be unspecified (json) or one of: json, verbose_json + GetAudioTranscriptionBody, // response_format must be unspecified (json) or one of: json, verbose_json AudioTranscription, MultipartFormDataRequestHeadersTraits >; diff --git a/specification/cognitiveservices/OpenAI.Inference/routes/audio_translation.tsp b/specification/cognitiveservices/OpenAI.Inference/routes/audio_translation.tsp index 18cf4a1d1c11..e1a058e29ae6 100644 --- a/specification/cognitiveservices/OpenAI.Inference/routes/audio_translation.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/routes/audio_translation.tsp @@ -27,7 +27,7 @@ namespace Azure.OpenAI; @sharedRoute op getAudioTranslationAsPlainText is Azure.Core.ResourceAction< Deployment, - BodyParameter, + GetAudioTranslationBody, // response_format must be one of: text, srt, vtt AudioTextResponse, MultipartFormDataRequestHeadersTraits & TextPlainResponseHeadersTraits >; @@ -42,7 +42,7 @@ op getAudioTranslationAsPlainText is Azure.Core.ResourceAction< @sharedRoute op getAudioTranslationAsResponseObject is Azure.Core.ResourceAction< Deployment, - BodyParameter, // response_format must be unspecified (json) or one of: json, verbose_json + GetAudioTranslationBody, // response_format must be unspecified (json) or one of: json, verbose_json AudioTranslation, MultipartFormDataRequestHeadersTraits >; diff --git a/specification/cognitiveservices/OpenAI.Inference/routes/completions.tsp b/specification/cognitiveservices/OpenAI.Inference/routes/completions.tsp index 3b138d588587..ee30995435ff 100644 --- a/specification/cognitiveservices/OpenAI.Inference/routes/completions.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/routes/completions.tsp @@ -23,7 +23,7 @@ namespace Azure.OpenAI; @action("completions") //@convenientAPI(true) op getCompletions is Azure.Core.ResourceAction< Deployment, - BodyParameter, + GetCompletionsBody, Completions >; @@ -37,6 +37,6 @@ op getCompletions is Azure.Core.ResourceAction< @action("chat/completions") //@convenientAPI(true) op getChatCompletions is ResourceAction< Deployment, - ChatCompletionsOptions, + GetChatCompletionsBody, ChatCompletions >; diff --git a/specification/cognitiveservices/OpenAI.Inference/routes/embeddings.tsp b/specification/cognitiveservices/OpenAI.Inference/routes/embeddings.tsp index ecb49b09e4b1..a9b23b38186a 100644 --- a/specification/cognitiveservices/OpenAI.Inference/routes/embeddings.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/routes/embeddings.tsp @@ -18,6 +18,6 @@ namespace Azure.OpenAI; @action("embeddings") //@convenientAPI(true) op getEmbeddings is Azure.Core.ResourceAction< Deployment, - BodyParameter, + GetEmbeddingsBody, Embeddings >; diff --git a/specification/cognitiveservices/OpenAI.Inference/routes/images.tsp b/specification/cognitiveservices/OpenAI.Inference/routes/images.tsp index b0fcec522f40..db448d387b36 100644 --- a/specification/cognitiveservices/OpenAI.Inference/routes/images.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/routes/images.tsp @@ -20,7 +20,7 @@ namespace Azure.OpenAI; @action("images/generations") op getImageGenerations is Azure.Core.ResourceAction< Deployment, - BodyParameter, + GetImageGenerationsBody, ImageGenerations >; @@ -54,7 +54,7 @@ op getAzureBatchImageGenerationOperationStatus is RpcOperation< } ) op beginAzureBatchImageGeneration is OaiLongRunningRpcOperation< - BodyParameter, + GetImageGenerationsBody, BatchImageGenerationOperationResponse, BatchImageGenerationOperationResponse >; diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-06-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-06-01-preview/generated.json index 08007691cc3a..80ad47ec677a 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-06-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-06-01-preview/generated.json @@ -75,12 +75,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ChatCompletionsOptions" - } + "$ref": "#/parameters/GetChatCompletionsBody" } ], "responses": { @@ -126,13 +121,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "description": "Body parameter.", - "required": true, - "schema": { - "$ref": "#/definitions/CompletionsOptions" - } + "$ref": "#/parameters/GetCompletionsBody" } ], "responses": { @@ -178,13 +167,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "description": "Body parameter.", - "required": true, - "schema": { - "$ref": "#/definitions/EmbeddingsOptions" - } + "$ref": "#/parameters/GetEmbeddingsBody" } ], "responses": { @@ -223,13 +206,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "body", - "in": "body", - "description": "Body parameter.", - "required": true, - "schema": { - "$ref": "#/definitions/ImageGenerationOptions" - } + "$ref": "#/parameters/GetImageGenerationsBody" } ], "responses": { @@ -1383,6 +1360,46 @@ "minLength": 1, "x-ms-parameter-location": "method", "x-ms-client-name": "apiVersion" + }, + "GetChatCompletionsBody": { + "name": "body", + "in": "body", + "description": "The configuration information for a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "required": true, + "schema": { + "$ref": "#/definitions/ChatCompletionsOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetCompletionsBody": { + "name": "body", + "in": "body", + "description": "The configuration information for a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "required": true, + "schema": { + "$ref": "#/definitions/CompletionsOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetEmbeddingsBody": { + "name": "body", + "in": "body", + "description": "The configuration information for an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", + "required": true, + "schema": { + "$ref": "#/definitions/EmbeddingsOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetImageGenerationsBody": { + "name": "body", + "in": "body", + "description": "Represents the request data used to generate images.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageGenerationOptions" + }, + "x-ms-parameter-location": "method" } } } diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-07-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-07-01-preview/generated.json index dfd0dcdce0b0..5a9d2881f642 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-07-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-07-01-preview/generated.json @@ -75,12 +75,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ChatCompletionsOptions" - } + "$ref": "#/parameters/GetChatCompletionsBody" } ], "responses": { @@ -126,13 +121,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "description": "Body parameter.", - "required": true, - "schema": { - "$ref": "#/definitions/CompletionsOptions" - } + "$ref": "#/parameters/GetCompletionsBody" } ], "responses": { @@ -178,13 +167,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "description": "Body parameter.", - "required": true, - "schema": { - "$ref": "#/definitions/EmbeddingsOptions" - } + "$ref": "#/parameters/GetEmbeddingsBody" } ], "responses": { @@ -223,13 +206,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "body", - "in": "body", - "description": "Body parameter.", - "required": true, - "schema": { - "$ref": "#/definitions/ImageGenerationOptions" - } + "$ref": "#/parameters/GetImageGenerationsBody" } ], "responses": { @@ -1480,6 +1457,46 @@ "minLength": 1, "x-ms-parameter-location": "method", "x-ms-client-name": "apiVersion" + }, + "GetChatCompletionsBody": { + "name": "body", + "in": "body", + "description": "The configuration information for a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "required": true, + "schema": { + "$ref": "#/definitions/ChatCompletionsOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetCompletionsBody": { + "name": "body", + "in": "body", + "description": "The configuration information for a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "required": true, + "schema": { + "$ref": "#/definitions/CompletionsOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetEmbeddingsBody": { + "name": "body", + "in": "body", + "description": "The configuration information for an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", + "required": true, + "schema": { + "$ref": "#/definitions/EmbeddingsOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetImageGenerationsBody": { + "name": "body", + "in": "body", + "description": "Represents the request data used to generate images.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageGenerationOptions" + }, + "x-ms-parameter-location": "method" } } } diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/generated.json index 0fb1618e5c07..4100ca08b327 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/generated.json @@ -79,12 +79,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SpeechGenerationOptions" - } + "$ref": "#/parameters/GenerateSpeechFromTextBody" } ], "responses": { @@ -401,12 +396,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ChatCompletionsOptions" - } + "$ref": "#/parameters/GetChatCompletionsBody" } ], "responses": { @@ -473,13 +463,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "description": "Body parameter.", - "required": true, - "schema": { - "$ref": "#/definitions/CompletionsOptions" - } + "$ref": "#/parameters/GetCompletionsBody" } ], "responses": { @@ -525,13 +509,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "description": "Body parameter.", - "required": true, - "schema": { - "$ref": "#/definitions/EmbeddingsOptions" - } + "$ref": "#/parameters/GetEmbeddingsBody" } ], "responses": { @@ -577,13 +555,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "description": "Body parameter.", - "required": true, - "schema": { - "$ref": "#/definitions/ImageGenerationOptions" - } + "$ref": "#/parameters/GetImageGenerationsBody" } ], "responses": { @@ -4290,6 +4262,56 @@ "minLength": 1, "x-ms-parameter-location": "method", "x-ms-client-name": "apiVersion" + }, + "GenerateSpeechFromTextBody": { + "name": "body", + "in": "body", + "description": "A representation of the request options that control the behavior of a text-to-speech operation.", + "required": true, + "schema": { + "$ref": "#/definitions/SpeechGenerationOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetChatCompletionsBody": { + "name": "body", + "in": "body", + "description": "The configuration information for a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "required": true, + "schema": { + "$ref": "#/definitions/ChatCompletionsOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetCompletionsBody": { + "name": "body", + "in": "body", + "description": "The configuration information for a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "required": true, + "schema": { + "$ref": "#/definitions/CompletionsOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetEmbeddingsBody": { + "name": "body", + "in": "body", + "description": "The configuration information for an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", + "required": true, + "schema": { + "$ref": "#/definitions/EmbeddingsOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetImageGenerationsBody": { + "name": "body", + "in": "body", + "description": "Represents the request data used to generate images.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageGenerationOptions" + }, + "x-ms-parameter-location": "method" } } } diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-03-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-03-01-preview/generated.json index 50544e3dc1fc..9cbe5a8b34aa 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-03-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-03-01-preview/generated.json @@ -79,12 +79,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SpeechGenerationOptions" - } + "$ref": "#/parameters/GenerateSpeechFromTextBody" } ], "responses": { @@ -401,12 +396,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ChatCompletionsOptions" - } + "$ref": "#/parameters/GetChatCompletionsBody" } ], "responses": { @@ -473,13 +463,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "description": "Body parameter.", - "required": true, - "schema": { - "$ref": "#/definitions/CompletionsOptions" - } + "$ref": "#/parameters/GetCompletionsBody" } ], "responses": { @@ -525,13 +509,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "description": "Body parameter.", - "required": true, - "schema": { - "$ref": "#/definitions/EmbeddingsOptions" - } + "$ref": "#/parameters/GetEmbeddingsBody" } ], "responses": { @@ -577,13 +555,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "description": "Body parameter.", - "required": true, - "schema": { - "$ref": "#/definitions/ImageGenerationOptions" - } + "$ref": "#/parameters/GetImageGenerationsBody" } ], "responses": { @@ -4321,6 +4293,56 @@ "minLength": 1, "x-ms-parameter-location": "method", "x-ms-client-name": "apiVersion" + }, + "GenerateSpeechFromTextBody": { + "name": "body", + "in": "body", + "description": "A representation of the request options that control the behavior of a text-to-speech operation.", + "required": true, + "schema": { + "$ref": "#/definitions/SpeechGenerationOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetChatCompletionsBody": { + "name": "body", + "in": "body", + "description": "The configuration information for a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "required": true, + "schema": { + "$ref": "#/definitions/ChatCompletionsOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetCompletionsBody": { + "name": "body", + "in": "body", + "description": "The configuration information for a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "required": true, + "schema": { + "$ref": "#/definitions/CompletionsOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetEmbeddingsBody": { + "name": "body", + "in": "body", + "description": "The configuration information for an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", + "required": true, + "schema": { + "$ref": "#/definitions/EmbeddingsOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetImageGenerationsBody": { + "name": "body", + "in": "body", + "description": "Represents the request data used to generate images.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageGenerationOptions" + }, + "x-ms-parameter-location": "method" } } } diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/generated.json index 1e2249218c04..cca5dd586ba7 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/generated.json @@ -79,12 +79,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SpeechGenerationOptions" - } + "$ref": "#/parameters/GenerateSpeechFromTextBody" } ], "responses": { @@ -435,12 +430,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ChatCompletionsOptions" - } + "$ref": "#/parameters/GetChatCompletionsBody" } ], "responses": { @@ -507,13 +497,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "description": "Body parameter.", - "required": true, - "schema": { - "$ref": "#/definitions/CompletionsOptions" - } + "$ref": "#/parameters/GetCompletionsBody" } ], "responses": { @@ -559,13 +543,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "description": "Body parameter.", - "required": true, - "schema": { - "$ref": "#/definitions/EmbeddingsOptions" - } + "$ref": "#/parameters/GetEmbeddingsBody" } ], "responses": { @@ -611,13 +589,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "description": "Body parameter.", - "required": true, - "schema": { - "$ref": "#/definitions/ImageGenerationOptions" - } + "$ref": "#/parameters/GetImageGenerationsBody" } ], "responses": { @@ -4489,6 +4461,56 @@ "minLength": 1, "x-ms-parameter-location": "method", "x-ms-client-name": "apiVersion" + }, + "GenerateSpeechFromTextBody": { + "name": "body", + "in": "body", + "description": "A representation of the request options that control the behavior of a text-to-speech operation.", + "required": true, + "schema": { + "$ref": "#/definitions/SpeechGenerationOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetChatCompletionsBody": { + "name": "body", + "in": "body", + "description": "The configuration information for a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "required": true, + "schema": { + "$ref": "#/definitions/ChatCompletionsOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetCompletionsBody": { + "name": "body", + "in": "body", + "description": "The configuration information for a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "required": true, + "schema": { + "$ref": "#/definitions/CompletionsOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetEmbeddingsBody": { + "name": "body", + "in": "body", + "description": "The configuration information for an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", + "required": true, + "schema": { + "$ref": "#/definitions/EmbeddingsOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetImageGenerationsBody": { + "name": "body", + "in": "body", + "description": "Represents the request data used to generate images.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageGenerationOptions" + }, + "x-ms-parameter-location": "method" } } } diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/generated.json index 8557c34830a2..bdcd2c2140ec 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/generated.json @@ -79,12 +79,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SpeechGenerationOptions" - } + "$ref": "#/parameters/GenerateSpeechFromTextBody" } ], "responses": { @@ -435,12 +430,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ChatCompletionsOptions" - } + "$ref": "#/parameters/GetChatCompletionsBody" } ], "responses": { @@ -507,13 +497,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "description": "Body parameter.", - "required": true, - "schema": { - "$ref": "#/definitions/CompletionsOptions" - } + "$ref": "#/parameters/GetCompletionsBody" } ], "responses": { @@ -559,13 +543,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "description": "Body parameter.", - "required": true, - "schema": { - "$ref": "#/definitions/EmbeddingsOptions" - } + "$ref": "#/parameters/GetEmbeddingsBody" } ], "responses": { @@ -611,13 +589,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "description": "Body parameter.", - "required": true, - "schema": { - "$ref": "#/definitions/ImageGenerationOptions" - } + "$ref": "#/parameters/GetImageGenerationsBody" } ], "responses": { @@ -4806,6 +4778,56 @@ "minLength": 1, "x-ms-parameter-location": "method", "x-ms-client-name": "apiVersion" + }, + "GenerateSpeechFromTextBody": { + "name": "body", + "in": "body", + "description": "A representation of the request options that control the behavior of a text-to-speech operation.", + "required": true, + "schema": { + "$ref": "#/definitions/SpeechGenerationOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetChatCompletionsBody": { + "name": "body", + "in": "body", + "description": "The configuration information for a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "required": true, + "schema": { + "$ref": "#/definitions/ChatCompletionsOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetCompletionsBody": { + "name": "body", + "in": "body", + "description": "The configuration information for a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "required": true, + "schema": { + "$ref": "#/definitions/CompletionsOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetEmbeddingsBody": { + "name": "body", + "in": "body", + "description": "The configuration information for an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", + "required": true, + "schema": { + "$ref": "#/definitions/EmbeddingsOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetImageGenerationsBody": { + "name": "body", + "in": "body", + "description": "Represents the request data used to generate images.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageGenerationOptions" + }, + "x-ms-parameter-location": "method" } } } diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md index ef5984cec041..abf168a00143 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md @@ -176,6 +176,20 @@ directive: reason: Parameter is read only ``` +## AzureOpenAI 2024-02-01 +These settings apply only when `--tag=release_2024_02_01` is specified on the command line. + +``` yaml $(tag) == 'release_2024_02_01' +input-file: stable/2024-02-01/inference.json +``` + +## AzureOpenAI 2024-02-01 (generated) +These settings apply only when `--tag=release_2024_02_01_autogen` is specified on the command line. + +``` yaml $(tag) == 'release_2024_02_01_autogen' +input-file: stable/2024-02-01/generated.json +``` + ## AzureOpenAI 2024-02-15-preview (generated) These settings apply only when `--tag=release_2024_02_15_preview_autogen` is specified on the command line. @@ -217,3 +231,10 @@ These settings apply only when `--tag=release_2024_06_01` is specified on the co ``` yaml $(tag) == 'release_2024_06_01' input-file: stable/2024-06-01/inference.json ``` + +## AzureOpenAI 2024-06-01 (generated) +These settings apply only when `--tag=release_2024_06_01_autogen` is specified on the command line. + +``` yaml $(tag) == 'release_2024_06_01_autogen' +input-file: stable/2024-06-01/generated.json +``` diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2022-12-01/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2022-12-01/generated.json index 39a5f276c4a8..67d61372b4ff 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2022-12-01/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2022-12-01/generated.json @@ -75,13 +75,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "description": "Body parameter.", - "required": true, - "schema": { - "$ref": "#/definitions/CompletionsOptions" - } + "$ref": "#/parameters/GetCompletionsBody" } ], "responses": { @@ -127,13 +121,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "description": "Body parameter.", - "required": true, - "schema": { - "$ref": "#/definitions/EmbeddingsOptions" - } + "$ref": "#/parameters/GetEmbeddingsBody" } ], "responses": { @@ -606,6 +594,26 @@ "minLength": 1, "x-ms-parameter-location": "method", "x-ms-client-name": "apiVersion" + }, + "GetCompletionsBody": { + "name": "body", + "in": "body", + "description": "The configuration information for a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "required": true, + "schema": { + "$ref": "#/definitions/CompletionsOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetEmbeddingsBody": { + "name": "body", + "in": "body", + "description": "The configuration information for an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", + "required": true, + "schema": { + "$ref": "#/definitions/EmbeddingsOptions" + }, + "x-ms-parameter-location": "method" } } } diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2023-05-15/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2023-05-15/generated.json index bf3f9152ea8b..2b0040733354 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2023-05-15/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2023-05-15/generated.json @@ -75,12 +75,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ChatCompletionsOptions" - } + "$ref": "#/parameters/GetChatCompletionsBody" } ], "responses": { @@ -126,13 +121,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "description": "Body parameter.", - "required": true, - "schema": { - "$ref": "#/definitions/CompletionsOptions" - } + "$ref": "#/parameters/GetCompletionsBody" } ], "responses": { @@ -178,13 +167,7 @@ "type": "string" }, { - "name": "body", - "in": "body", - "description": "Body parameter.", - "required": true, - "schema": { - "$ref": "#/definitions/EmbeddingsOptions" - } + "$ref": "#/parameters/GetEmbeddingsBody" } ], "responses": { @@ -934,6 +917,36 @@ "minLength": 1, "x-ms-parameter-location": "method", "x-ms-client-name": "apiVersion" + }, + "GetChatCompletionsBody": { + "name": "body", + "in": "body", + "description": "The configuration information for a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "required": true, + "schema": { + "$ref": "#/definitions/ChatCompletionsOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetCompletionsBody": { + "name": "body", + "in": "body", + "description": "The configuration information for a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "required": true, + "schema": { + "$ref": "#/definitions/CompletionsOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetEmbeddingsBody": { + "name": "body", + "in": "body", + "description": "The configuration information for an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", + "required": true, + "schema": { + "$ref": "#/definitions/EmbeddingsOptions" + }, + "x-ms-parameter-location": "method" } } } diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-02-01/examples/generated_chat_completions.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-02-01/examples/generated_chat_completions.json new file mode 100644 index 000000000000..f67ab3db1801 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-02-01/examples/generated_chat_completions.json @@ -0,0 +1,44 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion for the provided prompt, parameters and chosen model.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-01", + "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!" + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-02-01/examples/generated_completions.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-02-01/examples/generated_completions.json new file mode 100644 index 000000000000..ca9f1f5d1d7b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-02-01/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": "2024-02-01", + "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/stable/2024-02-01/examples/generated_embeddings.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-02-01/examples/generated_embeddings.json new file mode 100644 index 000000000000..382f01845635 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-02-01/examples/generated_embeddings.json @@ -0,0 +1,1567 @@ +{ + "operationId": "GetEmbeddings", + "title": "Return the embeddings for a given prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-01", + "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/stable/2024-02-01/examples/get_image_operation_status.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-02-01/examples/get_image_operation_status.json new file mode 100644 index 000000000000..f71332bb9392 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-02-01/examples/get_image_operation_status.json @@ -0,0 +1,27 @@ +{ + "operationId": "GetAzureBatchImageGenerationOperationStatus", + "title": "Returns the status of the images operation", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-01", + "operationId": "" + }, + "responses": { + "200": { + "body": { + "created": 1686676595, + "expires": 1686762999, + "id": "", + "result": { + "created": 1686676595, + "data": [ + { + "url": "https://image/path" + } + ] + }, + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-02-01/examples/start_generate_image.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-02-01/examples/start_generate_image.json new file mode 100644 index 000000000000..63df54082486 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-02-01/examples/start_generate_image.json @@ -0,0 +1,25 @@ +{ + "operationId": "BeginAzureBatchImageGeneration", + "title": "Starts the generation of a batch of images from a text caption", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-01", + "body": { + "prompt": "a monkey eating a banana", + "size": "256x256", + "n": 1 + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{endpoint}/openai/operations/images/?api-version=2023-06-01-preview" + }, + "body": { + "id": "", + "status": "notRunning", + "created": 0 + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-02-01/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-02-01/generated.json new file mode 100644 index 000000000000..1b6d32c87a54 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-02-01/generated.json @@ -0,0 +1,1502 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure OpenAI API", + "version": "2024-02-01", + "description": "Azure OpenAI APIs for completions and search", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/openai", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example:\nhttps://westus.api.cognitive.microsoft.com).", + "required": true, + "type": "string" + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "ApiKeyAuth": [] + }, + { + "OAuth2Auth": [ + "https://cognitiveservices.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "api-key", + "in": "header" + }, + "OAuth2Auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", + "scopes": { + "https://cognitiveservices.azure.com/.default": "" + } + } + }, + "tags": [], + "paths": { + "/deployments/{deploymentId}/chat/completions": { + "post": { + "operationId": "GetChatCompletions", + "description": "Gets chat completions for the provided chat messages.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "deploymentId", + "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/GetChatCompletionsBody" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ChatCompletions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Creates a completion for the provided prompt, parameters and chosen model.": { + "$ref": "./examples/generated_chat_completions.json" + } + } + } + }, + "/deployments/{deploymentId}/completions": { + "post": { + "operationId": "GetCompletions", + "description": "Gets completions for the provided input prompts.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "deploymentId", + "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/GetCompletionsBody" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Completions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Creates a completion for the provided prompt, parameters and chosen model.": { + "$ref": "./examples/generated_completions.json" + } + } + } + }, + "/deployments/{deploymentId}/embeddings": { + "post": { + "operationId": "GetEmbeddings", + "description": "Return the embeddings for a given prompt.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "deploymentId", + "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/GetEmbeddingsBody" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Embeddings" + } + }, + "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": { + "Return the embeddings for a given prompt.": { + "$ref": "./examples/generated_embeddings.json" + } + } + } + }, + "/images/generations:submit": { + "post": { + "operationId": "BeginAzureBatchImageGeneration", + "description": "Starts the generation of a batch of images from a text caption", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/GetImageGenerationsBody" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/BatchImageGenerationOperationResponse" + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Starts the generation of a batch of images from a text caption": { + "$ref": "./examples/start_generate_image.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/operations/images/{operationId}": { + "get": { + "operationId": "GetAzureBatchImageGenerationOperationStatus", + "description": "Returns the status of the images operation", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "operationId", + "in": "path", + "description": ".", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BatchImageGenerationOperationResponse" + } + }, + "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": { + "Returns the status of the images operation": { + "$ref": "./examples/get_image_operation_status.json" + } + } + } + } + }, + "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." + } + } + }, + "AzureOpenAIOperationState": { + "type": "string", + "description": "The state of a job or item.", + "enum": [ + "notRunning", + "running", + "succeeded", + "canceled", + "failed" + ], + "x-ms-enum": { + "name": "AzureOpenAIOperationState", + "modelAsString": true, + "values": [ + { + "name": "notRunning", + "value": "notRunning", + "description": "The operation was created and is queued to be processed in the future." + }, + { + "name": "running", + "value": "running", + "description": "The operation has started to be processed." + }, + { + "name": "succeeded", + "value": "succeeded", + "description": "The operation has successfully be processed and is ready for consumption." + }, + { + "name": "canceled", + "value": "canceled", + "description": "The operation has been canceled and is incomplete." + }, + { + "name": "failed", + "value": "failed", + "description": "The operation has completed processing with a failure and cannot be further consumed." + } + ] + } + }, + "BatchImageGenerationOperationResponse": { + "type": "object", + "description": "A polling status update or final response payload for an image operation.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the operation." + }, + "created": { + "type": "integer", + "format": "unixtime", + "description": "A timestamp when this job or item was created (in unix epochs)." + }, + "expires": { + "type": "integer", + "format": "int64", + "description": "A timestamp when this operation and its associated images expire and will be deleted (in unix epochs)." + }, + "result": { + "$ref": "#/definitions/ImageGenerations", + "description": "The result of the operation if the operation succeeded." + }, + "status": { + "$ref": "#/definitions/AzureOpenAIOperationState", + "description": "The status of the operation" + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "The error if the operation failed." + } + }, + "required": [ + "id", + "created", + "status" + ] + }, + "ChatChoice": { + "type": "object", + "description": "The representation of a single prompt completion as part of an overall chat completions request.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", + "properties": { + "message": { + "$ref": "#/definitions/ChatResponseMessage", + "description": "The chat message for a given chat completions prompt." + }, + "index": { + "type": "integer", + "format": "int32", + "description": "The ordered index associated with this chat completions choice." + }, + "finish_reason": { + "$ref": "#/definitions/CompletionsFinishReason", + "description": "The reason that this chat completions choice completed its generated.", + "x-nullable": true, + "x-ms-client-name": "finishReason" + }, + "delta": { + "$ref": "#/definitions/ChatResponseMessage", + "description": "The delta message content for a streaming response." + }, + "content_filter_results": { + "$ref": "#/definitions/ContentFilterResultsForChoice", + "description": "Information about the content filtering category (hate, sexual, violence, self_harm), if it\nhas been detected, as well as the severity level (very_low, low, medium, high-scale that\ndetermines the intensity and risk level of harmful content) and if it has been filtered or not.", + "x-ms-client-name": "contentFilterResults" + } + }, + "required": [ + "index", + "finish_reason" + ] + }, + "ChatCompletions": { + "type": "object", + "description": "Representation of the response data from a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "properties": { + "id": { + "type": "string", + "description": "A unique identifier associated with this chat completions response." + }, + "created": { + "type": "integer", + "format": "unixtime", + "description": "The first timestamp associated with generation activity for this completions response,\nrepresented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970." + }, + "choices": { + "type": "array", + "description": "The collection of completions choices associated with this completions response.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", + "items": { + "$ref": "#/definitions/ChatChoice" + }, + "x-ms-identifiers": [] + }, + "model": { + "type": "string", + "description": "The model name used for this completions request." + }, + "prompt_filter_results": { + "type": "array", + "description": "Content filtering results for zero or more prompts in the request. In a streaming request,\nresults for different prompts may arrive at different times or in different orders.", + "items": { + "$ref": "#/definitions/ContentFilterResultsForPrompt" + }, + "x-ms-client-name": "promptFilterResults", + "x-ms-identifiers": [] + }, + "usage": { + "$ref": "#/definitions/CompletionsUsage", + "description": "Usage information for tokens processed and generated as part of this completions operation." + } + }, + "required": [ + "id", + "created", + "choices", + "usage" + ] + }, + "ChatCompletionsOptions": { + "type": "object", + "description": "The configuration information for a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "properties": { + "messages": { + "type": "array", + "description": "The collection of context messages associated with this chat completions request.\nTypical usage begins with a chat message for the System role that provides instructions for\nthe behavior of the assistant, followed by alternating messages between the User and\nAssistant roles.", + "items": { + "$ref": "#/definitions/ChatRequestMessage" + }, + "x-ms-identifiers": [] + }, + "functions": { + "type": "array", + "description": "A list of functions the model may generate JSON inputs for.", + "items": { + "$ref": "#/definitions/FunctionDefinition" + }, + "x-ms-identifiers": [] + }, + "function_call": { + "description": "Controls how the model responds to function calls. \"none\" means the model does not call a function,\nand responds to the end-user. \"auto\" means the model can pick between an end-user or calling a function.\n Specifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function.\n \"none\" is the default when no functions are present. \"auto\" is the default if functions are present.", + "x-ms-client-name": "functionCall" + }, + "max_tokens": { + "type": "integer", + "format": "int32", + "description": "The maximum number of tokens to generate.", + "x-ms-client-name": "maxTokens" + }, + "temperature": { + "type": "number", + "format": "float", + "description": "The sampling temperature to use that controls the apparent creativity of generated completions.\nHigher values will make output more random while lower values will make results more focused\nand deterministic.\nIt is not recommended to modify temperature and top_p for the same completions request as the\ninteraction of these two settings is difficult to predict." + }, + "top_p": { + "type": "number", + "format": "float", + "description": "An alternative to sampling with temperature called nucleus sampling. This value causes the\nmodel to consider the results of tokens with the provided probability mass. As an example, a\nvalue of 0.15 will cause only the tokens comprising the top 15% of probability mass to be\nconsidered.\nIt is not recommended to modify temperature and top_p for the same completions request as the\ninteraction of these two settings is difficult to predict.", + "x-ms-client-name": "topP" + }, + "logit_bias": { + "type": "object", + "description": "A map between GPT token IDs and bias scores that influences the probability of specific tokens\nappearing in a completions response. Token IDs are computed via external tokenizer tools, while\nbias scores reside in the range of -100 to 100 with minimum and maximum values corresponding to\na full ban or exclusive selection of a token, respectively. The exact behavior of a given bias\nscore varies by model.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "x-ms-client-name": "logitBias" + }, + "user": { + "type": "string", + "description": "An identifier for the caller or end user of the operation. This may be used for tracking\nor rate-limiting purposes." + }, + "n": { + "type": "integer", + "format": "int32", + "description": "The number of chat completions choices that should be generated for a chat completions\nresponse.\nBecause this setting can generate many completions, it may quickly consume your token quota.\nUse carefully and ensure reasonable settings for max_tokens and stop." + }, + "stop": { + "type": "array", + "description": "A collection of textual sequences that will end completions generation.", + "items": { + "type": "string" + } + }, + "presence_penalty": { + "type": "number", + "format": "float", + "description": "A value that influences the probability of generated tokens appearing based on their existing\npresence in generated text.\nPositive values will make tokens less likely to appear when they already exist and increase the\nmodel's likelihood to output new topics.", + "x-ms-client-name": "presencePenalty" + }, + "frequency_penalty": { + "type": "number", + "format": "float", + "description": "A value that influences the probability of generated tokens appearing based on their cumulative\nfrequency in generated text.\nPositive values will make tokens less likely to appear as their frequency increases and\ndecrease the likelihood of the model repeating the same statements verbatim.", + "x-ms-client-name": "frequencyPenalty" + }, + "stream": { + "type": "boolean", + "description": "A value indicating whether chat completions should be streamed for this request." + }, + "model": { + "type": "string", + "description": "The model name to provide as part of this completions request.\nNot applicable to Azure OpenAI, where deployment information should be included in the Azure\nresource URI that's connected to." + } + }, + "required": [ + "messages" + ] + }, + "ChatRequestAssistantMessage": { + "type": "object", + "description": "A request chat message representing response or action from the assistant.", + "properties": { + "content": { + "type": "string", + "description": "The content of the message.", + "x-nullable": true + }, + "name": { + "type": "string", + "description": "An optional name for the participant." + }, + "function_call": { + "$ref": "#/definitions/FunctionCall", + "description": "The function call that must be resolved and have its output appended to subsequent input messages for the chat\ncompletions request to resolve as configured.", + "x-ms-client-name": "functionCall" + } + }, + "required": [ + "content" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatRequestMessage" + } + ], + "x-ms-discriminator-value": "assistant" + }, + "ChatRequestFunctionMessage": { + "type": "object", + "description": "A request chat message representing requested output from a configured function.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function that was called to produce output." + }, + "content": { + "type": "string", + "description": "The output of the function as requested by the function call.", + "x-nullable": true + } + }, + "required": [ + "name", + "content" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatRequestMessage" + } + ], + "x-ms-discriminator-value": "function" + }, + "ChatRequestMessage": { + "type": "object", + "description": "An abstract representation of a chat message as provided in a request.", + "properties": { + "role": { + "$ref": "#/definitions/ChatRole", + "description": "The chat role associated with this message." + } + }, + "discriminator": "role", + "required": [ + "role" + ] + }, + "ChatRequestSystemMessage": { + "type": "object", + "description": "A request chat message containing system instructions that influence how the model will generate a chat completions\nresponse.", + "properties": { + "content": { + "type": "string", + "description": "The contents of the system message." + }, + "name": { + "type": "string", + "description": "An optional name for the participant." + } + }, + "required": [ + "content" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatRequestMessage" + } + ], + "x-ms-discriminator-value": "system" + }, + "ChatRequestUserMessage": { + "type": "object", + "description": "A request chat message representing user input to the assistant.", + "properties": { + "content": { + "description": "The contents of the user message, with available input types varying by selected model." + }, + "name": { + "type": "string", + "description": "An optional name for the participant." + } + }, + "required": [ + "content" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatRequestMessage" + } + ], + "x-ms-discriminator-value": "user" + }, + "ChatResponseMessage": { + "type": "object", + "description": "A representation of a chat message as received in a response.", + "properties": { + "role": { + "$ref": "#/definitions/ChatRole", + "description": "The chat role associated with the message." + }, + "content": { + "type": "string", + "description": "The content of the message.", + "x-nullable": true + }, + "function_call": { + "$ref": "#/definitions/FunctionCall", + "description": "The function call that must be resolved and have its output appended to subsequent input messages for the chat\ncompletions request to resolve as configured.", + "x-ms-client-name": "functionCall" + } + }, + "required": [ + "role", + "content" + ] + }, + "ChatRole": { + "type": "string", + "description": "A description of the intended purpose of a message within a chat completions interaction.", + "enum": [ + "system", + "assistant", + "user", + "function" + ], + "x-ms-enum": { + "name": "ChatRole", + "modelAsString": true, + "values": [ + { + "name": "system", + "value": "system", + "description": "The role that instructs or sets the behavior of the assistant." + }, + { + "name": "assistant", + "value": "assistant", + "description": "The role that provides responses to system-instructed, user-prompted input." + }, + { + "name": "user", + "value": "user", + "description": "The role that provides input for chat completions." + }, + { + "name": "function", + "value": "function", + "description": "The role that provides function results for chat completions." + } + ] + } + }, + "Choice": { + "type": "object", + "description": "The representation of a single prompt completion as part of an overall completions request.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", + "properties": { + "text": { + "type": "string", + "description": "The generated text for a given completions prompt." + }, + "index": { + "type": "integer", + "format": "int32", + "description": "The ordered index associated with this completions choice." + }, + "content_filter_results": { + "$ref": "#/definitions/ContentFilterResultsForChoice", + "description": "Information about the content filtering category (hate, sexual, violence, self_harm), if it\nhas been detected, as well as the severity level (very_low, low, medium, high-scale that\ndetermines the intensity and risk level of harmful content) and if it has been filtered or not.", + "x-ms-client-name": "contentFilterResults" + }, + "logprobs": { + "type": "object", + "description": "The log probabilities model for tokens associated with this completions choice.", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/CompletionsLogProbabilityModel" + } + ] + }, + "finish_reason": { + "$ref": "#/definitions/CompletionsFinishReason", + "description": "Reason for finishing", + "x-nullable": true, + "x-ms-client-name": "finishReason" + } + }, + "required": [ + "text", + "index", + "logprobs", + "finish_reason" + ] + }, + "Completions": { + "type": "object", + "description": "Representation of the response data from a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "properties": { + "id": { + "type": "string", + "description": "A unique identifier associated with this completions response." + }, + "created": { + "type": "integer", + "format": "unixtime", + "description": "The first timestamp associated with generation activity for this completions response,\nrepresented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970." + }, + "prompt_filter_results": { + "type": "array", + "description": "Content filtering results for zero or more prompts in the request. In a streaming request,\nresults for different prompts may arrive at different times or in different orders.", + "items": { + "$ref": "#/definitions/ContentFilterResultsForPrompt" + }, + "x-ms-client-name": "promptFilterResults", + "x-ms-identifiers": [] + }, + "choices": { + "type": "array", + "description": "The collection of completions choices associated with this completions response.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", + "items": { + "$ref": "#/definitions/Choice" + }, + "x-ms-identifiers": [] + }, + "usage": { + "$ref": "#/definitions/CompletionsUsage", + "description": "Usage information for tokens processed and generated as part of this completions operation." + } + }, + "required": [ + "id", + "created", + "choices", + "usage" + ] + }, + "CompletionsFinishReason": { + "type": "string", + "description": "Representation of the manner in which a completions response concluded.", + "enum": [ + "stop", + "length", + "content_filter", + "function_call" + ], + "x-ms-enum": { + "name": "CompletionsFinishReason", + "modelAsString": true, + "values": [ + { + "name": "stopped", + "value": "stop", + "description": "Completions ended normally and reached its end of token generation." + }, + { + "name": "tokenLimitReached", + "value": "length", + "description": "Completions exhausted available token limits before generation could complete." + }, + { + "name": "contentFiltered", + "value": "content_filter", + "description": "Completions generated a response that was identified as potentially sensitive per content\nmoderation policies." + }, + { + "name": "functionCall", + "value": "function_call", + "description": "Completion ended normally, with the model requesting a function to be called." + } + ] + } + }, + "CompletionsLogProbabilityModel": { + "type": "object", + "description": "Representation of a log probabilities model for a completions generation.", + "properties": { + "tokens": { + "type": "array", + "description": "The textual forms of tokens evaluated in this probability model.", + "items": { + "type": "string" + } + }, + "token_logprobs": { + "type": "array", + "description": "A collection of log probability values for the tokens in this completions data.", + "items": { + "type": "number", + "format": "float", + "x-nullable": true + }, + "x-ms-client-name": "tokenLogprobs" + }, + "top_logprobs": { + "type": "array", + "description": "A mapping of tokens to maximum log probability values in this completions data.", + "items": { + "type": "object", + "additionalProperties": { + "format": "float", + "type": "number", + "x-nullable": true + } + }, + "x-ms-client-name": "topLogprobs", + "x-ms-identifiers": [] + }, + "text_offset": { + "type": "array", + "description": "The text offsets associated with tokens in this completions data.", + "items": { + "type": "integer", + "format": "int32" + }, + "x-ms-client-name": "textOffset" + } + }, + "required": [ + "tokens", + "token_logprobs", + "top_logprobs", + "text_offset" + ] + }, + "CompletionsOptions": { + "type": "object", + "description": "The configuration information for a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "properties": { + "prompt": { + "type": "array", + "description": "The prompts to generate completions from.", + "items": { + "type": "string" + } + }, + "max_tokens": { + "type": "integer", + "format": "int32", + "description": "The maximum number of tokens to generate.", + "x-ms-client-name": "maxTokens" + }, + "temperature": { + "type": "number", + "format": "float", + "description": "The sampling temperature to use that controls the apparent creativity of generated completions.\nHigher values will make output more random while lower values will make results more focused\nand deterministic.\nIt is not recommended to modify temperature and top_p for the same completions request as the\ninteraction of these two settings is difficult to predict." + }, + "top_p": { + "type": "number", + "format": "float", + "description": "An alternative to sampling with temperature called nucleus sampling. This value causes the\nmodel to consider the results of tokens with the provided probability mass. As an example, a\nvalue of 0.15 will cause only the tokens comprising the top 15% of probability mass to be\nconsidered.\nIt is not recommended to modify temperature and top_p for the same completions request as the\ninteraction of these two settings is difficult to predict.", + "x-ms-client-name": "topP" + }, + "logit_bias": { + "type": "object", + "description": "A map between GPT token IDs and bias scores that influences the probability of specific tokens\nappearing in a completions response. Token IDs are computed via external tokenizer tools, while\nbias scores reside in the range of -100 to 100 with minimum and maximum values corresponding to\na full ban or exclusive selection of a token, respectively. The exact behavior of a given bias\nscore varies by model.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "x-ms-client-name": "logitBias" + }, + "user": { + "type": "string", + "description": "An identifier for the caller or end user of the operation. This may be used for tracking\nor rate-limiting purposes." + }, + "n": { + "type": "integer", + "format": "int32", + "description": "The number of completions choices that should be generated per provided prompt as part of an\noverall completions response.\nBecause this setting can generate many completions, it may quickly consume your token quota.\nUse carefully and ensure reasonable settings for max_tokens and stop." + }, + "logprobs": { + "type": "integer", + "format": "int32", + "description": "A value that controls the emission of log probabilities for the provided number of most likely\ntokens within a completions response." + }, + "suffix": { + "type": "string", + "description": "The suffix that comes after a completion of inserted text" + }, + "echo": { + "type": "boolean", + "description": "A value specifying whether completions responses should include input prompts as prefixes to\ntheir generated output." + }, + "stop": { + "type": "array", + "description": "A collection of textual sequences that will end completions generation.", + "items": { + "type": "string" + } + }, + "presence_penalty": { + "type": "number", + "format": "float", + "description": "A value that influences the probability of generated tokens appearing based on their existing\npresence in generated text.\nPositive values will make tokens less likely to appear when they already exist and increase the\nmodel's likelihood to output new topics.", + "x-ms-client-name": "presencePenalty" + }, + "frequency_penalty": { + "type": "number", + "format": "float", + "description": "A value that influences the probability of generated tokens appearing based on their cumulative\nfrequency in generated text.\nPositive values will make tokens less likely to appear as their frequency increases and\ndecrease the likelihood of the model repeating the same statements verbatim.", + "x-ms-client-name": "frequencyPenalty" + }, + "best_of": { + "type": "integer", + "format": "int32", + "description": "A value that controls how many completions will be internally generated prior to response\nformulation.\nWhen used together with n, best_of controls the number of candidate completions and must be\ngreater than n.\nBecause this setting can generate many completions, it may quickly consume your token quota.\nUse carefully and ensure reasonable settings for max_tokens and stop.", + "x-ms-client-name": "bestOf" + }, + "stream": { + "type": "boolean", + "description": "A value indicating whether chat completions should be streamed for this request." + }, + "model": { + "type": "string", + "description": "The model name to provide as part of this completions request.\nNot applicable to Azure OpenAI, where deployment information should be included in the Azure\nresource URI that's connected to." + } + }, + "required": [ + "prompt" + ] + }, + "CompletionsUsage": { + "type": "object", + "description": "Representation of the token counts processed for a completions request.\nCounts consider all tokens across prompts, choices, choice alternates, best_of generations, and\nother consumers.", + "properties": { + "completion_tokens": { + "type": "integer", + "format": "int32", + "description": "The number of tokens generated across all completions emissions.", + "x-ms-client-name": "completionTokens" + }, + "prompt_tokens": { + "type": "integer", + "format": "int32", + "description": "The number of tokens in the provided prompts for the completions request.", + "x-ms-client-name": "promptTokens" + }, + "total_tokens": { + "type": "integer", + "format": "int32", + "description": "The total number of tokens processed for the completions request and response.", + "x-ms-client-name": "totalTokens" + } + }, + "required": [ + "completion_tokens", + "prompt_tokens", + "total_tokens" + ] + }, + "ContentFilterResult": { + "type": "object", + "description": "Information about filtered content severity level and if it has been filtered or not.", + "properties": { + "filtered": { + "type": "boolean", + "description": "A value indicating whether or not the content has been filtered." + }, + "severity": { + "$ref": "#/definitions/ContentFilterSeverity", + "description": "Ratings for the intensity and risk level of filtered content." + } + }, + "required": [ + "filtered", + "severity" + ] + }, + "ContentFilterResultDetailsForPrompt": { + "type": "object", + "description": "Information about content filtering evaluated against input data to Azure OpenAI.", + "properties": { + "sexual": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to anatomical organs and genitals, romantic relationships,\n acts portrayed in erotic or affectionate terms, physical sexual acts, including\n those portrayed as an assault or a forced sexual violent act against one’s will,\n prostitution, pornography, and abuse." + }, + "violence": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to physical actions intended to hurt, injure, damage, or\nkill someone or something; describes weapons, etc." + }, + "hate": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language attacks or uses that include pejorative or discriminatory language\nwith reference to a person or identity group on the basis of certain differentiating\nattributes of these groups including but not limited to race, ethnicity, nationality,\ngender identity and expression, sexual orientation, religion, immigration status, ability\nstatus, personal appearance, and body size." + }, + "self_harm": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to physical actions intended to purposely hurt, injure,\nor damage one’s body, or kill oneself.", + "x-ms-client-name": "selfHarm" + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Describes an error returned if the content filtering system is\ndown or otherwise unable to complete the operation in time." + } + } + }, + "ContentFilterResultsForChoice": { + "type": "object", + "description": "Information about content filtering evaluated against generated model output.", + "properties": { + "sexual": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to anatomical organs and genitals, romantic relationships,\n acts portrayed in erotic or affectionate terms, physical sexual acts, including\n those portrayed as an assault or a forced sexual violent act against one’s will,\n prostitution, pornography, and abuse." + }, + "violence": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to physical actions intended to hurt, injure, damage, or\nkill someone or something; describes weapons, etc." + }, + "hate": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language attacks or uses that include pejorative or discriminatory language\nwith reference to a person or identity group on the basis of certain differentiating\nattributes of these groups including but not limited to race, ethnicity, nationality,\ngender identity and expression, sexual orientation, religion, immigration status, ability\nstatus, personal appearance, and body size." + }, + "self_harm": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to physical actions intended to purposely hurt, injure,\nor damage one’s body, or kill oneself.", + "x-ms-client-name": "selfHarm" + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Describes an error returned if the content filtering system is\ndown or otherwise unable to complete the operation in time." + } + } + }, + "ContentFilterResultsForPrompt": { + "type": "object", + "description": "Content filtering results for a single prompt in the request.", + "properties": { + "prompt_index": { + "type": "integer", + "format": "int32", + "description": "The index of this prompt in the set of prompt results", + "x-ms-client-name": "promptIndex" + }, + "content_filter_results": { + "$ref": "#/definitions/ContentFilterResultDetailsForPrompt", + "description": "Content filtering results for this prompt", + "x-ms-client-name": "contentFilterResults" + } + }, + "required": [ + "prompt_index", + "content_filter_results" + ] + }, + "ContentFilterSeverity": { + "type": "string", + "description": "Ratings for the intensity and risk level of harmful content.", + "enum": [ + "safe", + "low", + "medium", + "high" + ], + "x-ms-enum": { + "name": "ContentFilterSeverity", + "modelAsString": true, + "values": [ + { + "name": "safe", + "value": "safe", + "description": "Content may be related to violence, self-harm, sexual, or hate categories but the terms\nare used in general, journalistic, scientific, medical, and similar professional contexts,\nwhich are appropriate for most audiences." + }, + { + "name": "low", + "value": "low", + "description": "Content that expresses prejudiced, judgmental, or opinionated views, includes offensive\nuse of language, stereotyping, use cases exploring a fictional world (for example, gaming,\nliterature) and depictions at low intensity." + }, + { + "name": "medium", + "value": "medium", + "description": "Content that uses offensive, insulting, mocking, intimidating, or demeaning language\ntowards specific identity groups, includes depictions of seeking and executing harmful\ninstructions, fantasies, glorification, promotion of harm at medium intensity." + }, + { + "name": "high", + "value": "high", + "description": "Content that displays explicit and severe harmful instructions, actions,\ndamage, or abuse; includes endorsement, glorification, or promotion of severe\nharmful acts, extreme or illegal forms of harm, radicalization, or non-consensual\npower exchange or abuse." + } + ] + } + }, + "EmbeddingItem": { + "type": "object", + "description": "Representation of a single embeddings relatedness comparison.", + "properties": { + "embedding": { + "type": "array", + "description": "List of embeddings value for the input prompt. These represent a measurement of the\nvector-based relatedness of the provided input.", + "items": { + "type": "number", + "format": "float" + } + }, + "index": { + "type": "integer", + "format": "int32", + "description": "Index of the prompt to which the EmbeddingItem corresponds." + } + }, + "required": [ + "embedding", + "index" + ] + }, + "Embeddings": { + "type": "object", + "description": "Representation of the response data from an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", + "properties": { + "data": { + "type": "array", + "description": "Embedding values for the prompts submitted in the request.", + "items": { + "$ref": "#/definitions/EmbeddingItem" + }, + "x-ms-identifiers": [] + }, + "usage": { + "$ref": "#/definitions/EmbeddingsUsage", + "description": "Usage counts for tokens input using the embeddings API." + } + }, + "required": [ + "data", + "usage" + ] + }, + "EmbeddingsOptions": { + "type": "object", + "description": "The configuration information for an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", + "properties": { + "user": { + "type": "string", + "description": "An identifier for the caller or end user of the operation. This may be used for tracking\nor rate-limiting purposes." + }, + "model": { + "type": "string", + "description": "The model name to provide as part of this embeddings request.\nNot applicable to Azure OpenAI, where deployment information should be included in the Azure\nresource URI that's connected to." + }, + "input": { + "type": "array", + "description": "Input texts to get embeddings for, encoded as a an array of strings.\nEach input must not exceed 2048 tokens in length.\n\nUnless you are embedding code, we suggest replacing newlines (\\n) in your input with a single space,\nas we have observed inferior results when newlines are present.", + "items": { + "type": "string" + } + } + }, + "required": [ + "input" + ] + }, + "EmbeddingsUsage": { + "type": "object", + "description": "Measurement of the amount of tokens used in this request and response.", + "properties": { + "prompt_tokens": { + "type": "integer", + "format": "int32", + "description": "Number of tokens sent in the original request.", + "x-ms-client-name": "promptTokens" + }, + "total_tokens": { + "type": "integer", + "format": "int32", + "description": "Total number of tokens transacted in this request/response.", + "x-ms-client-name": "totalTokens" + } + }, + "required": [ + "prompt_tokens", + "total_tokens" + ] + }, + "FunctionCall": { + "type": "object", + "description": "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.\nNote that the model does not always generate valid JSON, and may hallucinate parameters\nnot defined by your function schema. Validate the arguments in your code before calling\nyour function." + } + }, + "required": [ + "name", + "arguments" + ] + }, + "FunctionDefinition": { + "type": "object", + "description": "The definition of a caller-specified function that chat completions may invoke in response to matching user input.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to be called." + }, + "description": { + "type": "string", + "description": "A description of what the function does. The model will use this description when selecting the function and\ninterpreting its parameters." + }, + "parameters": { + "description": "The parameters the function accepts, described as a JSON Schema object." + } + }, + "required": [ + "name" + ] + }, + "ImageGenerationData": { + "type": "object", + "description": "A representation of a single generated image, provided as either base64-encoded data or as a URL from which the image\nmay be retrieved.", + "properties": { + "url": { + "type": "string", + "format": "uri", + "description": "The URL that provides temporary access to download the generated image." + }, + "b64_json": { + "type": "string", + "description": "The complete data for an image, represented as a base64-encoded string.", + "x-ms-client-name": "base64Data" + } + } + }, + "ImageGenerationOptions": { + "type": "object", + "description": "Represents the request data used to generate images.", + "properties": { + "model": { + "type": "string", + "description": "The model name or Azure OpenAI model deployment name to use for image generation. If not specified, dall-e-2 will be\ninferred as a default." + }, + "prompt": { + "type": "string", + "description": "A description of the desired images." + }, + "n": { + "type": "integer", + "format": "int32", + "description": "The number of images to generate.\nDall-e-2 models support values between 1 and 10.\nDall-e-3 models only support a value of 1.", + "default": 1 + }, + "size": { + "type": "string", + "description": "The desired dimensions for generated images.\nDall-e-2 models support 256x256, 512x512, or 1024x1024.\nDall-e-3 models support 1024x1024, 1792x1024, or 1024x1792.", + "default": "1024x1024", + "enum": [ + "256x256", + "512x512" + ], + "x-ms-enum": { + "name": "ImageSize", + "modelAsString": true, + "values": [ + { + "name": "size256x256", + "value": "256x256", + "description": "Very small image size of 256x256 pixels.\nOnly supported with dall-e-2 models." + }, + { + "name": "size512x512", + "value": "512x512", + "description": "A smaller image size of 512x512 pixels.\nOnly supported with dall-e-2 models." + } + ] + } + }, + "response_format": { + "type": "string", + "description": "The format in which image generation response items should be presented.", + "default": "url", + "enum": [ + "url", + "b64_json" + ], + "x-ms-enum": { + "name": "ImageGenerationResponseFormat", + "modelAsString": true, + "values": [ + { + "name": "url", + "value": "url", + "description": "Image generation response items should provide a URL from which the image may be retrieved." + }, + { + "name": "base64", + "value": "b64_json", + "description": "Image generation response items should provide image data as a base64-encoded string." + } + ] + }, + "x-ms-client-name": "responseFormat" + }, + "user": { + "type": "string", + "description": "A unique identifier representing your end-user, which can help to monitor and detect abuse." + } + }, + "required": [ + "prompt" + ] + }, + "ImageGenerations": { + "type": "object", + "description": "The result of a successful image generation operation.", + "properties": { + "created": { + "type": "integer", + "format": "unixtime", + "description": "A timestamp representing when this operation was started.\nExpressed in seconds since the Unix epoch of 1970-01-01T00:00:00+0000." + }, + "data": { + "type": "array", + "description": "The images generated by the operation.", + "items": { + "$ref": "#/definitions/ImageGenerationData" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "created", + "data" + ] + } + }, + "parameters": { + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + }, + "GetChatCompletionsBody": { + "name": "body", + "in": "body", + "description": "The configuration information for a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "required": true, + "schema": { + "$ref": "#/definitions/ChatCompletionsOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetCompletionsBody": { + "name": "body", + "in": "body", + "description": "The configuration information for a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "required": true, + "schema": { + "$ref": "#/definitions/CompletionsOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetEmbeddingsBody": { + "name": "body", + "in": "body", + "description": "The configuration information for an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", + "required": true, + "schema": { + "$ref": "#/definitions/EmbeddingsOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetImageGenerationsBody": { + "name": "body", + "in": "body", + "description": "Represents the request data used to generate images.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageGenerationOptions" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/generated_audio_speech.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/generated_audio_speech.json new file mode 100644 index 000000000000..b350710a1477 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/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": "2024-06-01", + "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/stable/2024-06-01/examples/generated_audio_transcription_object.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/generated_audio_transcription_object.json new file mode 100644 index 000000000000..08e457b4fd9d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/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": "2024-06-01", + "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/stable/2024-06-01/examples/generated_audio_transcription_text.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/generated_audio_transcription_text.json new file mode 100644 index 000000000000..7c49a6558ca1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/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": "2024-06-01", + "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/stable/2024-06-01/examples/generated_audio_translation_object.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/generated_audio_translation_object.json new file mode 100644 index 000000000000..29a402e4a6a6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/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": "2024-06-01", + "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/stable/2024-06-01/examples/generated_audio_translation_text.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/generated_audio_translation_text.json new file mode 100644 index 000000000000..1f9c2e224fc4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/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": "2024-06-01", + "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/stable/2024-06-01/examples/generated_chat_completions.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/generated_chat_completions.json new file mode 100644 index 000000000000..c4bdb0088d78 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/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": "2024-06-01", + "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/stable/2024-06-01/examples/generated_completions.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/generated_completions.json new file mode 100644 index 000000000000..d0d5be75a90e --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/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": "2024-06-01", + "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/stable/2024-06-01/examples/generated_embeddings.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/generated_embeddings.json new file mode 100644 index 000000000000..7336f5f1db30 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/generated_embeddings.json @@ -0,0 +1,1567 @@ +{ + "operationId": "GetEmbeddings", + "title": "Return the embeddings for a given prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-06-01", + "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/stable/2024-06-01/examples/generated_extensions_chat_completions_aml_index.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/generated_extensions_chat_completions_aml_index.json new file mode 100644 index 000000000000..a3a79dc2b0d1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/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": "2024-06-01", + "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/stable/2024-06-01/examples/generated_extensions_chat_completions_azure_search_advanced.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/generated_extensions_chat_completions_azure_search_advanced.json new file mode 100644 index 000000000000..712a0c68a98f --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/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": "2024-06-01", + "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/stable/2024-06-01/examples/generated_extensions_chat_completions_azure_search_image_vector.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/generated_extensions_chat_completions_azure_search_image_vector.json new file mode 100644 index 000000000000..0d0f1428eba0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/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": "2024-06-01", + "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/stable/2024-06-01/examples/generated_extensions_chat_completions_azure_search_minimum.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/generated_extensions_chat_completions_azure_search_minimum.json new file mode 100644 index 000000000000..9aa79a24b6fe --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/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": "2024-06-01", + "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/stable/2024-06-01/examples/generated_extensions_chat_completions_cosmos_db.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/generated_extensions_chat_completions_cosmos_db.json new file mode 100644 index 000000000000..c0e3253c53f4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/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": "2024-06-01", + "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/stable/2024-06-01/examples/generated_extensions_chat_completions_elasticsearch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/generated_extensions_chat_completions_elasticsearch.json new file mode 100644 index 000000000000..277097b148bf --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/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": "2024-06-01", + "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/stable/2024-06-01/examples/generated_extensions_chat_completions_pinecone.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/generated_extensions_chat_completions_pinecone.json new file mode 100644 index 000000000000..26968f4f6d1b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/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": "2024-06-01", + "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/stable/2024-06-01/examples/generated_image_generation.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/generated_image_generation.json new file mode 100644 index 000000000000..9dfbcb9b87d5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/examples/generated_image_generation.json @@ -0,0 +1,31 @@ +{ + "operationId": "GetImageGenerations", + "title": "Creates images given a prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-06-01", + "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/stable/2024-06-01/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/generated.json new file mode 100644 index 000000000000..51d3ce51fba1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/generated.json @@ -0,0 +1,4833 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure OpenAI API", + "version": "2024-06-01", + "description": "Azure OpenAI APIs for completions and search", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/openai", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example:\nhttps://westus.api.cognitive.microsoft.com).", + "required": true, + "type": "string" + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "ApiKeyAuth": [] + }, + { + "OAuth2Auth": [ + "https://cognitiveservices.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "api-key", + "in": "header" + }, + "OAuth2Auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", + "scopes": { + "https://cognitiveservices.azure.com/.default": "" + } + } + }, + "tags": [], + "paths": { + "/deployments/{deploymentId}/audio/speech": { + "post": { + "operationId": "GenerateSpeechFromText", + "description": "Generates text-to-speech audio from the input text.", + "produces": [ + "application/octet-stream", + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "deploymentId", + "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/GenerateSpeechFromTextBody" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "file" + } + }, + "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": { + "Generates text-to-speech audio from the input text.": { + "$ref": "./examples/generated_audio_speech.json" + } + } + } + }, + "/deployments/{deploymentId}/audio/transcriptions": { + "post": { + "operationId": "GetAudioTranscriptionAsPlainText", + "description": "Gets transcribed text and associated metadata from provided spoken audio data. Audio will be transcribed in the\nwritten language corresponding to the language it was spoken in.", + "produces": [ + "text/plain", + "application/json" + ], + "consumes": [ + "multipart/form-data" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "deploymentId", + "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", + "required": true, + "type": "string" + }, + { + "name": "file", + "in": "formData", + "description": "The audio data to transcribe. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.", + "required": true, + "type": "file" + }, + { + "name": "filename", + "in": "formData", + "description": "The optional filename or descriptive identifier to associate with with the audio data.", + "required": false, + "type": "string" + }, + { + "name": "response_format", + "in": "formData", + "description": "The requested format of the transcription response data, which will influence the content and detail of the result.", + "required": false, + "type": "string", + "enum": [ + "json", + "verbose_json", + "text", + "srt", + "vtt" + ], + "x-ms-enum": { + "name": "AudioTranscriptionFormat", + "modelAsString": true, + "values": [ + { + "name": "json", + "value": "json", + "description": "Use a response body that is a JSON object containing a single 'text' field for the transcription." + }, + { + "name": "verbose_json", + "value": "verbose_json", + "description": "Use a response body that is a JSON object containing transcription text along with timing, segments, and other\nmetadata." + }, + { + "name": "text", + "value": "text", + "description": "Use a response body that is plain text containing the raw, unannotated transcription." + }, + { + "name": "srt", + "value": "srt", + "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." + }, + { + "name": "vtt", + "value": "vtt", + "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." + } + ] + }, + "x-ms-client-name": "responseFormat" + }, + { + "name": "language", + "in": "formData", + "description": "The primary spoken language of the audio data to be transcribed, supplied as a two-letter ISO-639-1 language code\nsuch as 'en' or 'fr'.\nProviding this known input language is optional but may improve the accuracy and/or latency of transcription.", + "required": false, + "type": "string" + }, + { + "name": "prompt", + "in": "formData", + "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data.", + "required": false, + "type": "string" + }, + { + "name": "temperature", + "in": "formData", + "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.", + "required": false, + "type": "number", + "format": "float" + }, + { + "name": "timestamp_granularities", + "in": "formData", + "description": "The timestamp granularities to populate for this transcription.\n`response_format` must be set `verbose_json` to use timestamp granularities.\nEither or both of these options are supported: `word`, or `segment`.\nNote: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency.", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "word", + "segment" + ], + "x-ms-enum": { + "name": "AudioTranscriptionTimestampGranularity", + "modelAsString": true, + "values": [ + { + "name": "word", + "value": "word", + "description": "Indicates that responses should include timing information about each transcribed word. Note that generating word\ntimestamp information will incur additional response latency." + }, + { + "name": "segment", + "value": "segment", + "description": "Indicates that responses should include timing and other information about each transcribed audio segment. Audio\nsegment timestamp information does not incur any additional latency." + } + ] + } + }, + "default": [ + "segment" + ], + "x-ms-client-name": "timestampGranularities" + }, + { + "name": "model", + "in": "formData", + "description": "The model to use for this transcription request.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets transcribed text and associated metadata from provided spoken audio data.": { + "$ref": "./examples/generated_audio_transcription_text.json" + } + } + } + }, + "/deployments/{deploymentId}/audio/translations": { + "post": { + "operationId": "GetAudioTranslationAsPlainText", + "description": "Gets English language transcribed text and associated metadata from provided spoken audio data.", + "produces": [ + "text/plain", + "application/json" + ], + "consumes": [ + "multipart/form-data" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "deploymentId", + "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", + "required": true, + "type": "string" + }, + { + "name": "file", + "in": "formData", + "description": "The audio data to translate. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.", + "required": true, + "type": "file" + }, + { + "name": "filename", + "in": "formData", + "description": "The optional filename or descriptive identifier to associate with with the audio data.", + "required": false, + "type": "string" + }, + { + "name": "response_format", + "in": "formData", + "description": "The requested format of the translation response data, which will influence the content and detail of the result.", + "required": false, + "type": "string", + "enum": [ + "json", + "verbose_json", + "text", + "srt", + "vtt" + ], + "x-ms-enum": { + "name": "AudioTranslationFormat", + "modelAsString": true, + "values": [ + { + "name": "json", + "value": "json", + "description": "Use a response body that is a JSON object containing a single 'text' field for the translation." + }, + { + "name": "verbose_json", + "value": "verbose_json", + "description": "Use a response body that is a JSON object containing translation text along with timing, segments, and other\nmetadata." + }, + { + "name": "text", + "value": "text", + "description": "Use a response body that is plain text containing the raw, unannotated translation." + }, + { + "name": "srt", + "value": "srt", + "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." + }, + { + "name": "vtt", + "value": "vtt", + "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." + } + ] + }, + "x-ms-client-name": "responseFormat" + }, + { + "name": "prompt", + "in": "formData", + "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data.", + "required": false, + "type": "string" + }, + { + "name": "temperature", + "in": "formData", + "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.", + "required": false, + "type": "number", + "format": "float" + }, + { + "name": "model", + "in": "formData", + "description": "The model to use for this translation request.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets English language transcribed text and associated metadata from provided spoken audio data.": { + "$ref": "./examples/generated_audio_translation_text.json" + } + } + } + }, + "/deployments/{deploymentId}/chat/completions": { + "post": { + "operationId": "GetChatCompletions", + "description": "Gets chat completions for the provided chat messages.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "deploymentId", + "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/GetChatCompletionsBody" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ChatCompletions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Creates a completion based on Azure Cognitive Services data and system-assigned managed identity. Uses Azure OpenAI chat extensions.": { + "$ref": "./examples/generated_extensions_chat_completions_azure_search_minimum.json" + }, + "Creates a completion based on Azure Cognitive Services image vector data. Uses Azure OpenAI chat extensions.": { + "$ref": "./examples/generated_extensions_chat_completions_azure_search_image_vector.json" + }, + "Creates a completion based on Azure Cognitive Services vector data and user-assigned managed identity. Uses Azure OpenAI chat extensions.": { + "$ref": "./examples/generated_extensions_chat_completions_azure_search_advanced.json" + }, + "Creates a completion for the provided AML index. Uses Azure OpenAI chat extensions.": { + "$ref": "./examples/generated_extensions_chat_completions_aml_index.json" + }, + "Creates a completion for the provided Azure Cosmos DB. Uses Azure OpenAI chat extensions.": { + "$ref": "./examples/generated_extensions_chat_completions_cosmos_db.json" + }, + "Creates a completion for the provided Elasticsearch. Uses Azure OpenAI chat extensions.": { + "$ref": "./examples/generated_extensions_chat_completions_elasticsearch.json" + }, + "Creates a completion for the provided Pinecone resource. Uses Azure OpenAI chat extensions.": { + "$ref": "./examples/generated_extensions_chat_completions_pinecone.json" + }, + "Creates a completion for the provided prompt, parameters and chosen model.": { + "$ref": "./examples/generated_chat_completions.json" + } + } + } + }, + "/deployments/{deploymentId}/completions": { + "post": { + "operationId": "GetCompletions", + "description": "Gets completions for the provided input prompts.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "deploymentId", + "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/GetCompletionsBody" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Completions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Creates a completion for the provided prompt, parameters and chosen model.": { + "$ref": "./examples/generated_completions.json" + } + } + } + }, + "/deployments/{deploymentId}/embeddings": { + "post": { + "operationId": "GetEmbeddings", + "description": "Return the embeddings for a given prompt.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "deploymentId", + "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/GetEmbeddingsBody" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Embeddings" + } + }, + "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": { + "Return the embeddings for a given prompt.": { + "$ref": "./examples/generated_embeddings.json" + } + } + } + }, + "/deployments/{deploymentId}/images/generations": { + "post": { + "operationId": "GetImageGenerations", + "description": "Creates an image given a prompt.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "deploymentId", + "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/GetImageGenerationsBody" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageGenerations" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Creates images given a prompt.": { + "$ref": "./examples/generated_image_generation.json" + } + } + } + } + }, + "x-ms-paths": { + "/deployments/{deploymentId}/audio/transcriptions?_overload=getAudioTranscriptionAsResponseObject": { + "post": { + "operationId": "GetAudioTranscriptionAsResponseObject", + "description": "Gets transcribed text and associated metadata from provided spoken audio data. Audio will be transcribed in the\nwritten language corresponding to the language it was spoken in.", + "consumes": [ + "multipart/form-data" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "deploymentId", + "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", + "required": true, + "type": "string" + }, + { + "name": "file", + "in": "formData", + "description": "The audio data to transcribe. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.", + "required": true, + "type": "file" + }, + { + "name": "filename", + "in": "formData", + "description": "The optional filename or descriptive identifier to associate with with the audio data.", + "required": false, + "type": "string" + }, + { + "name": "response_format", + "in": "formData", + "description": "The requested format of the transcription response data, which will influence the content and detail of the result.", + "required": false, + "type": "string", + "enum": [ + "json", + "verbose_json", + "text", + "srt", + "vtt" + ], + "x-ms-enum": { + "name": "AudioTranscriptionFormat", + "modelAsString": true, + "values": [ + { + "name": "json", + "value": "json", + "description": "Use a response body that is a JSON object containing a single 'text' field for the transcription." + }, + { + "name": "verbose_json", + "value": "verbose_json", + "description": "Use a response body that is a JSON object containing transcription text along with timing, segments, and other\nmetadata." + }, + { + "name": "text", + "value": "text", + "description": "Use a response body that is plain text containing the raw, unannotated transcription." + }, + { + "name": "srt", + "value": "srt", + "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." + }, + { + "name": "vtt", + "value": "vtt", + "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." + } + ] + }, + "x-ms-client-name": "responseFormat" + }, + { + "name": "language", + "in": "formData", + "description": "The primary spoken language of the audio data to be transcribed, supplied as a two-letter ISO-639-1 language code\nsuch as 'en' or 'fr'.\nProviding this known input language is optional but may improve the accuracy and/or latency of transcription.", + "required": false, + "type": "string" + }, + { + "name": "prompt", + "in": "formData", + "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data.", + "required": false, + "type": "string" + }, + { + "name": "temperature", + "in": "formData", + "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.", + "required": false, + "type": "number", + "format": "float" + }, + { + "name": "timestamp_granularities", + "in": "formData", + "description": "The timestamp granularities to populate for this transcription.\n`response_format` must be set `verbose_json` to use timestamp granularities.\nEither or both of these options are supported: `word`, or `segment`.\nNote: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency.", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "word", + "segment" + ], + "x-ms-enum": { + "name": "AudioTranscriptionTimestampGranularity", + "modelAsString": true, + "values": [ + { + "name": "word", + "value": "word", + "description": "Indicates that responses should include timing information about each transcribed word. Note that generating word\ntimestamp information will incur additional response latency." + }, + { + "name": "segment", + "value": "segment", + "description": "Indicates that responses should include timing and other information about each transcribed audio segment. Audio\nsegment timestamp information does not incur any additional latency." + } + ] + } + }, + "default": [ + "segment" + ], + "x-ms-client-name": "timestampGranularities" + }, + { + "name": "model", + "in": "formData", + "description": "The model to use for this transcription request.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AudioTranscription" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets transcribed text and associated metadata from provided spoken audio data.": { + "$ref": "./examples/generated_audio_transcription_object.json" + } + } + } + }, + "/deployments/{deploymentId}/audio/translations?_overload=getAudioTranslationAsResponseObject": { + "post": { + "operationId": "GetAudioTranslationAsResponseObject", + "description": "Gets English language transcribed text and associated metadata from provided spoken audio data.", + "consumes": [ + "multipart/form-data" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "deploymentId", + "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", + "required": true, + "type": "string" + }, + { + "name": "file", + "in": "formData", + "description": "The audio data to translate. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.", + "required": true, + "type": "file" + }, + { + "name": "filename", + "in": "formData", + "description": "The optional filename or descriptive identifier to associate with with the audio data.", + "required": false, + "type": "string" + }, + { + "name": "response_format", + "in": "formData", + "description": "The requested format of the translation response data, which will influence the content and detail of the result.", + "required": false, + "type": "string", + "enum": [ + "json", + "verbose_json", + "text", + "srt", + "vtt" + ], + "x-ms-enum": { + "name": "AudioTranslationFormat", + "modelAsString": true, + "values": [ + { + "name": "json", + "value": "json", + "description": "Use a response body that is a JSON object containing a single 'text' field for the translation." + }, + { + "name": "verbose_json", + "value": "verbose_json", + "description": "Use a response body that is a JSON object containing translation text along with timing, segments, and other\nmetadata." + }, + { + "name": "text", + "value": "text", + "description": "Use a response body that is plain text containing the raw, unannotated translation." + }, + { + "name": "srt", + "value": "srt", + "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." + }, + { + "name": "vtt", + "value": "vtt", + "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." + } + ] + }, + "x-ms-client-name": "responseFormat" + }, + { + "name": "prompt", + "in": "formData", + "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data.", + "required": false, + "type": "string" + }, + { + "name": "temperature", + "in": "formData", + "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.", + "required": false, + "type": "number", + "format": "float" + }, + { + "name": "model", + "in": "formData", + "description": "The model to use for this translation request.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AudioTranslation" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets English language transcribed text and associated metadata from provided spoken audio data.": { + "$ref": "./examples/generated_audio_translation_object.json" + } + } + } + } + }, + "definitions": { + "AudioTaskLabel": { + "type": "string", + "description": "Defines the possible descriptors for available audio operation responses.", + "enum": [ + "transcribe", + "translate" + ], + "x-ms-enum": { + "name": "AudioTaskLabel", + "modelAsString": true, + "values": [ + { + "name": "transcribe", + "value": "transcribe", + "description": "Accompanying response data resulted from an audio transcription task." + }, + { + "name": "translate", + "value": "translate", + "description": "Accompanying response data resulted from an audio translation task." + } + ] + } + }, + "AudioTranscription": { + "type": "object", + "description": "Result information for an operation that transcribed spoken audio into written text.", + "properties": { + "text": { + "type": "string", + "description": "The transcribed text for the provided audio data." + }, + "task": { + "$ref": "#/definitions/AudioTaskLabel", + "description": "The label that describes which operation type generated the accompanying response data." + }, + "language": { + "type": "string", + "description": "The spoken language that was detected in the transcribed audio data.\nThis is expressed as a two-letter ISO-639-1 language code like 'en' or 'fr'." + }, + "duration": { + "type": "number", + "format": "float", + "description": "The total duration of the audio processed to produce accompanying transcription information." + }, + "segments": { + "type": "array", + "description": "A collection of information about the timing, probabilities, and other detail of each processed audio segment.", + "items": { + "$ref": "#/definitions/AudioTranscriptionSegment" + } + }, + "words": { + "type": "array", + "description": "A collection of information about the timing of each processed word.", + "items": { + "$ref": "#/definitions/AudioTranscriptionWord" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "text" + ] + }, + "AudioTranscriptionFormat": { + "type": "string", + "description": "Defines available options for the underlying response format of output transcription information.", + "enum": [ + "json", + "verbose_json", + "text", + "srt", + "vtt" + ], + "x-ms-enum": { + "name": "AudioTranscriptionFormat", + "modelAsString": true, + "values": [ + { + "name": "json", + "value": "json", + "description": "Use a response body that is a JSON object containing a single 'text' field for the transcription." + }, + { + "name": "verbose_json", + "value": "verbose_json", + "description": "Use a response body that is a JSON object containing transcription text along with timing, segments, and other\nmetadata." + }, + { + "name": "text", + "value": "text", + "description": "Use a response body that is plain text containing the raw, unannotated transcription." + }, + { + "name": "srt", + "value": "srt", + "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." + }, + { + "name": "vtt", + "value": "vtt", + "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." + } + ] + } + }, + "AudioTranscriptionOptions": { + "type": "object", + "description": "The configuration information for an audio transcription request.", + "properties": { + "file": { + "type": "string", + "format": "byte", + "description": "The audio data to transcribe. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm." + }, + "filename": { + "type": "string", + "description": "The optional filename or descriptive identifier to associate with with the audio data." + }, + "response_format": { + "$ref": "#/definitions/AudioTranscriptionFormat", + "description": "The requested format of the transcription response data, which will influence the content and detail of the result.", + "x-ms-client-name": "responseFormat" + }, + "language": { + "type": "string", + "description": "The primary spoken language of the audio data to be transcribed, supplied as a two-letter ISO-639-1 language code\nsuch as 'en' or 'fr'.\nProviding this known input language is optional but may improve the accuracy and/or latency of transcription." + }, + "prompt": { + "type": "string", + "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data." + }, + "temperature": { + "type": "number", + "format": "float", + "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit." + }, + "timestamp_granularities": { + "type": "array", + "description": "The timestamp granularities to populate for this transcription.\n`response_format` must be set `verbose_json` to use timestamp granularities.\nEither or both of these options are supported: `word`, or `segment`.\nNote: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency.", + "default": [ + "segment" + ], + "items": { + "$ref": "#/definitions/AudioTranscriptionTimestampGranularity" + }, + "x-ms-client-name": "timestampGranularities" + }, + "model": { + "type": "string", + "description": "The model to use for this transcription request." + } + }, + "required": [ + "file" + ] + }, + "AudioTranscriptionSegment": { + "type": "object", + "description": "Extended information about a single segment of transcribed audio data.\nSegments generally represent roughly 5-10 seconds of speech. Segment boundaries typically occur between words but not\nnecessarily sentences.", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "The 0-based index of this segment within a transcription." + }, + "start": { + "type": "number", + "format": "float", + "description": "The time at which this segment started relative to the beginning of the transcribed audio." + }, + "end": { + "type": "number", + "format": "float", + "description": "The time at which this segment ended relative to the beginning of the transcribed audio." + }, + "text": { + "type": "string", + "description": "The transcribed text that was part of this audio segment." + }, + "temperature": { + "type": "number", + "format": "float", + "description": "The temperature score associated with this audio segment." + }, + "avg_logprob": { + "type": "number", + "format": "float", + "description": "The average log probability associated with this audio segment.", + "x-ms-client-name": "avgLogprob" + }, + "compression_ratio": { + "type": "number", + "format": "float", + "description": "The compression ratio of this audio segment.", + "x-ms-client-name": "compressionRatio" + }, + "no_speech_prob": { + "type": "number", + "format": "float", + "description": "The probability of no speech detection within this audio segment.", + "x-ms-client-name": "noSpeechProb" + }, + "tokens": { + "type": "array", + "description": "The token IDs matching the transcribed text in this audio segment.", + "items": { + "type": "integer", + "format": "int32" + } + }, + "seek": { + "type": "integer", + "format": "int32", + "description": "The seek position associated with the processing of this audio segment.\nSeek positions are expressed as hundredths of seconds.\nThe model may process several segments from a single seek position, so while the seek position will never represent\na later time than the segment's start, the segment's start may represent a significantly later time than the\nsegment's associated seek position." + } + }, + "required": [ + "id", + "start", + "end", + "text", + "temperature", + "avg_logprob", + "compression_ratio", + "no_speech_prob", + "tokens", + "seek" + ] + }, + "AudioTranscriptionTimestampGranularity": { + "type": "string", + "description": "Defines the timestamp granularities that can be requested on a verbose transcription response.", + "enum": [ + "word", + "segment" + ], + "x-ms-enum": { + "name": "AudioTranscriptionTimestampGranularity", + "modelAsString": true, + "values": [ + { + "name": "word", + "value": "word", + "description": "Indicates that responses should include timing information about each transcribed word. Note that generating word\ntimestamp information will incur additional response latency." + }, + { + "name": "segment", + "value": "segment", + "description": "Indicates that responses should include timing and other information about each transcribed audio segment. Audio\nsegment timestamp information does not incur any additional latency." + } + ] + } + }, + "AudioTranscriptionWord": { + "type": "object", + "description": "Extended information about a single transcribed word, as provided on responses when the 'word' timestamp granularity is provided.", + "properties": { + "word": { + "type": "string", + "description": "The textual content of the word." + }, + "start": { + "type": "number", + "format": "float", + "description": "The start time of the word relative to the beginning of the audio, expressed in seconds." + }, + "end": { + "type": "number", + "format": "float", + "description": "The end time of the word relative to the beginning of the audio, expressed in seconds." + } + }, + "required": [ + "word", + "start", + "end" + ] + }, + "AudioTranslation": { + "type": "object", + "description": "Result information for an operation that translated spoken audio into written text.", + "properties": { + "text": { + "type": "string", + "description": "The translated text for the provided audio data." + }, + "task": { + "$ref": "#/definitions/AudioTaskLabel", + "description": "The label that describes which operation type generated the accompanying response data." + }, + "language": { + "type": "string", + "description": "The spoken language that was detected in the translated audio data.\nThis is expressed as a two-letter ISO-639-1 language code like 'en' or 'fr'." + }, + "duration": { + "type": "number", + "format": "float", + "description": "The total duration of the audio processed to produce accompanying translation information." + }, + "segments": { + "type": "array", + "description": "A collection of information about the timing, probabilities, and other detail of each processed audio segment.", + "items": { + "$ref": "#/definitions/AudioTranslationSegment" + } + } + }, + "required": [ + "text" + ] + }, + "AudioTranslationFormat": { + "type": "string", + "description": "Defines available options for the underlying response format of output translation information.", + "enum": [ + "json", + "verbose_json", + "text", + "srt", + "vtt" + ], + "x-ms-enum": { + "name": "AudioTranslationFormat", + "modelAsString": true, + "values": [ + { + "name": "json", + "value": "json", + "description": "Use a response body that is a JSON object containing a single 'text' field for the translation." + }, + { + "name": "verbose_json", + "value": "verbose_json", + "description": "Use a response body that is a JSON object containing translation text along with timing, segments, and other\nmetadata." + }, + { + "name": "text", + "value": "text", + "description": "Use a response body that is plain text containing the raw, unannotated translation." + }, + { + "name": "srt", + "value": "srt", + "description": "Use a response body that is plain text in SubRip (SRT) format that also includes timing information." + }, + { + "name": "vtt", + "value": "vtt", + "description": "Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information." + } + ] + } + }, + "AudioTranslationOptions": { + "type": "object", + "description": "The configuration information for an audio translation request.", + "properties": { + "file": { + "type": "string", + "format": "byte", + "description": "The audio data to translate. This must be the binary content of a file in one of the supported media formats:\n flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm." + }, + "filename": { + "type": "string", + "description": "The optional filename or descriptive identifier to associate with with the audio data." + }, + "response_format": { + "$ref": "#/definitions/AudioTranslationFormat", + "description": "The requested format of the translation response data, which will influence the content and detail of the result.", + "x-ms-client-name": "responseFormat" + }, + "prompt": { + "type": "string", + "description": "An optional hint to guide the model's style or continue from a prior audio segment. The written language of the\nprompt should match the primary spoken language of the audio data." + }, + "temperature": { + "type": "number", + "format": "float", + "description": "The sampling temperature, between 0 and 1.\nHigher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nIf set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit." + }, + "model": { + "type": "string", + "description": "The model to use for this translation request." + } + }, + "required": [ + "file" + ] + }, + "AudioTranslationSegment": { + "type": "object", + "description": "Extended information about a single segment of translated audio data.\nSegments generally represent roughly 5-10 seconds of speech. Segment boundaries typically occur between words but not\nnecessarily sentences.", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "The 0-based index of this segment within a translation." + }, + "start": { + "type": "number", + "format": "float", + "description": "The time at which this segment started relative to the beginning of the translated audio." + }, + "end": { + "type": "number", + "format": "float", + "description": "The time at which this segment ended relative to the beginning of the translated audio." + }, + "text": { + "type": "string", + "description": "The translated text that was part of this audio segment." + }, + "temperature": { + "type": "number", + "format": "float", + "description": "The temperature score associated with this audio segment." + }, + "avg_logprob": { + "type": "number", + "format": "float", + "description": "The average log probability associated with this audio segment.", + "x-ms-client-name": "avgLogprob" + }, + "compression_ratio": { + "type": "number", + "format": "float", + "description": "The compression ratio of this audio segment.", + "x-ms-client-name": "compressionRatio" + }, + "no_speech_prob": { + "type": "number", + "format": "float", + "description": "The probability of no speech detection within this audio segment.", + "x-ms-client-name": "noSpeechProb" + }, + "tokens": { + "type": "array", + "description": "The token IDs matching the translated text in this audio segment.", + "items": { + "type": "integer", + "format": "int32" + } + }, + "seek": { + "type": "integer", + "format": "int32", + "description": "The seek position associated with the processing of this audio segment.\nSeek positions are expressed as hundredths of seconds.\nThe model may process several segments from a single seek position, so while the seek position will never represent\na later time than the segment's start, the segment's start may represent a significantly later time than the\nsegment's associated seek position." + } + }, + "required": [ + "id", + "start", + "end", + "text", + "temperature", + "avg_logprob", + "compression_ratio", + "no_speech_prob", + "tokens", + "seek" + ] + }, + "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." + } + } + }, + "AzureChatEnhancementConfiguration": { + "type": "object", + "description": "A representation of the available Azure OpenAI enhancement configurations.", + "properties": { + "grounding": { + "$ref": "#/definitions/AzureChatGroundingEnhancementConfiguration", + "description": "A representation of the available options for the Azure OpenAI grounding enhancement." + }, + "ocr": { + "$ref": "#/definitions/AzureChatOCREnhancementConfiguration", + "description": "A representation of the available options for the Azure OpenAI optical character recognition (OCR) enhancement." + } + } + }, + "AzureChatEnhancements": { + "type": "object", + "description": "Represents the output results of Azure enhancements to chat completions, as configured via the matching input provided\nin the request.", + "properties": { + "grounding": { + "$ref": "#/definitions/AzureGroundingEnhancement", + "description": "The grounding enhancement that returns the bounding box of the objects detected in the image." + } + } + }, + "AzureChatExtensionConfiguration": { + "type": "object", + "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.", + "properties": { + "type": { + "$ref": "#/definitions/AzureChatExtensionType", + "description": " The label for the type of an Azure chat extension. This typically corresponds to a matching Azure resource.\n Azure chat extensions are only compatible with Azure OpenAI." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "AzureChatExtensionDataSourceResponseCitation": { + "type": "object", + "description": "A single instance of additional context information available when Azure OpenAI chat extensions are involved\nin the generation of a corresponding chat completions response. This context information is only populated when\nusing an Azure OpenAI request configured to use a matching extension.", + "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." + } + }, + "required": [ + "content" + ] + }, + "AzureChatExtensionRetrieveDocumentFilterReason": { + "type": "string", + "description": "The reason for filtering the retrieved document.", + "enum": [ + "score", + "rerank" + ], + "x-ms-enum": { + "name": "AzureChatExtensionRetrieveDocumentFilterReason", + "modelAsString": false, + "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." + } + ] + } + }, + "AzureChatExtensionRetrievedDocument": { + "type": "object", + "description": "The retrieved document.", + "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." + }, + "search_queries": { + "type": "array", + "description": "The search queries used to retrieve the document.", + "items": { + "type": "string" + }, + "x-ms-client-name": "searchQueries" + }, + "data_source_index": { + "type": "integer", + "format": "int32", + "description": "The index of the data source.", + "x-ms-client-name": "dataSourceIndex" + }, + "original_search_score": { + "type": "number", + "format": "double", + "description": "The original search score of the retrieved document.", + "x-ms-client-name": "originalSearchScore" + }, + "rerank_score": { + "type": "number", + "format": "double", + "description": "The rerank score of the retrieved document.", + "x-ms-client-name": "rerankScore" + }, + "filter_reason": { + "$ref": "#/definitions/AzureChatExtensionRetrieveDocumentFilterReason", + "description": "Represents the rationale for filtering the document. If the document does not undergo filtering,\nthis field will remain unset.", + "x-ms-client-name": "filterReason" + } + }, + "required": [ + "content", + "search_queries", + "data_source_index" + ] + }, + "AzureChatExtensionType": { + "type": "string", + "description": " A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat\n completions request that should use Azure OpenAI chat extensions to augment the response behavior.\n The use of this configuration is compatible only with Azure OpenAI.", + "enum": [ + "azure_search", + "azure_ml_index", + "azure_cosmos_db", + "elasticsearch", + "pinecone" + ], + "x-ms-enum": { + "name": "AzureChatExtensionType", + "modelAsString": true, + "values": [ + { + "name": "azureSearch", + "value": "azure_search", + "description": "Represents the use of Azure AI Search as an Azure OpenAI chat extension." + }, + { + "name": "azureMachineLearningIndex", + "value": "azure_ml_index", + "description": "Represents the use of Azure Machine Learning index as an Azure OpenAI chat extension." + }, + { + "name": "azureCosmosDB", + "value": "azure_cosmos_db", + "description": "Represents the use of Azure Cosmos DB as an Azure OpenAI chat extension." + }, + { + "name": "elasticsearch", + "value": "elasticsearch", + "description": "Represents the use of Elasticsearch® index as an Azure OpenAI chat extension." + }, + { + "name": "pinecone", + "value": "pinecone", + "description": "Represents the use of Pinecone index as an Azure OpenAI chat extension." + } + ] + } + }, + "AzureChatExtensionsMessageContext": { + "type": "object", + "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.", + "properties": { + "citations": { + "type": "array", + "description": " The contextual information associated with the Azure chat extensions used for a chat completions request.\n These messages describe the data source retrievals, plugin invocations, and other intermediate steps taken in the\n course of generating a chat completions response that was augmented by capabilities from Azure OpenAI chat\n extensions.", + "items": { + "$ref": "#/definitions/AzureChatExtensionDataSourceResponseCitation" + }, + "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": "#/definitions/AzureChatExtensionRetrievedDocument" + }, + "x-ms-client-name": "allRetrievedDocuments", + "x-ms-identifiers": [] + } + } + }, + "AzureChatGroundingEnhancementConfiguration": { + "type": "object", + "description": "A representation of the available options for the Azure OpenAI grounding enhancement.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Specifies whether the enhancement is enabled." + } + }, + "required": [ + "enabled" + ] + }, + "AzureChatOCREnhancementConfiguration": { + "type": "object", + "description": "A representation of the available options for the Azure OpenAI optical character recognition (OCR) enhancement.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Specifies whether the enhancement is enabled." + } + }, + "required": [ + "enabled" + ] + }, + "AzureCosmosDBChatExtensionConfiguration": { + "type": "object", + "description": "A specific representation of configurable options for Azure Cosmos DB when using it as an Azure OpenAI chat\nextension.", + "properties": { + "parameters": { + "$ref": "#/definitions/AzureCosmosDBChatExtensionParameters", + "description": "The parameters to use when configuring Azure OpenAI CosmosDB chat extensions." + } + }, + "required": [ + "parameters" + ], + "allOf": [ + { + "$ref": "#/definitions/AzureChatExtensionConfiguration" + } + ], + "x-ms-discriminator-value": "azure_cosmos_db" + }, + "AzureCosmosDBChatExtensionParameters": { + "type": "object", + "description": "Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Azure Cosmos DB for\nMongoDB vCore. The supported authentication type is ConnectionString.", + "properties": { + "authentication": { + "$ref": "#/definitions/OnYourDataAuthenticationOptions", + "description": "The authentication method to use when accessing the defined data source.\nEach data source type supports a specific set of available authentication methods; please see the documentation of\nthe data source for supported mechanisms.\nIf not otherwise provided, On Your Data will attempt to use System Managed Identity (default credential)\nauthentication." + }, + "top_n_documents": { + "type": "integer", + "format": "int32", + "description": "The configured top number of documents to feature for the configured query.", + "x-ms-client-name": "topNDocuments" + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data.", + "x-ms-client-name": "inScope" + }, + "strictness": { + "type": "integer", + "format": "int32", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "minimum": 1, + "maximum": 5 + }, + "role_information": { + "type": "string", + "description": "Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit.", + "x-ms-client-name": "roleInformation" + }, + "max_search_queries": { + "type": "integer", + "format": "int32", + "description": "The max number of rewritten queries should be send to search provider for one user message. If not specified,\nthe system will decide the number of queries to send.", + "x-ms-client-name": "maxSearchQueries" + }, + "allow_partial_result": { + "type": "boolean", + "description": "If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail.\nIf not specified, or specified as false, the request will fail if any search query fails.", + "default": false, + "x-ms-client-name": "allowPartialResult" + }, + "include_contexts": { + "type": "array", + "description": "The included properties of the output context. If not specified, the default value is `citations` and `intent`.", + "items": { + "$ref": "#/definitions/OnYourDataContextProperty" + }, + "x-ms-client-name": "includeContexts" + }, + "database_name": { + "type": "string", + "description": "The MongoDB vCore database name to use with Azure Cosmos DB.", + "x-ms-client-name": "databaseName" + }, + "container_name": { + "type": "string", + "description": "The name of the Azure Cosmos DB resource container.", + "x-ms-client-name": "containerName" + }, + "index_name": { + "type": "string", + "description": "The MongoDB vCore index name to use with Azure Cosmos DB.", + "x-ms-client-name": "indexName" + }, + "fields_mapping": { + "$ref": "#/definitions/AzureCosmosDBFieldMappingOptions", + "description": "Customized field mapping behavior to use when interacting with the search index.", + "x-ms-client-name": "fieldsMapping" + }, + "embedding_dependency": { + "$ref": "#/definitions/OnYourDataVectorizationSource", + "description": "The embedding dependency for vector search.", + "x-ms-client-name": "embeddingDependency" + } + }, + "required": [ + "database_name", + "container_name", + "index_name", + "fields_mapping", + "embedding_dependency" + ] + }, + "AzureCosmosDBFieldMappingOptions": { + "type": "object", + "description": "Optional settings to control how fields are processed when using a configured Azure Cosmos DB resource.", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title.", + "x-ms-client-name": "titleField" + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL.", + "x-ms-client-name": "urlField" + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath.", + "x-ms-client-name": "filepathField" + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + }, + "x-ms-client-name": "contentFields" + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use.", + "x-ms-client-name": "contentFieldsSeparator" + }, + "vector_fields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + }, + "x-ms-client-name": "vectorFields" + } + }, + "required": [ + "content_fields", + "vector_fields" + ] + }, + "AzureGroundingEnhancement": { + "type": "object", + "description": "The grounding enhancement that returns the bounding box of the objects detected in the image.", + "properties": { + "lines": { + "type": "array", + "description": "The lines of text detected by the grounding enhancement.", + "items": { + "$ref": "#/definitions/AzureGroundingEnhancementLine" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "lines" + ] + }, + "AzureGroundingEnhancementCoordinatePoint": { + "type": "object", + "description": "A representation of a single polygon point as used by the Azure grounding enhancement.", + "properties": { + "x": { + "type": "number", + "format": "float", + "description": "The x-coordinate (horizontal axis) of the point." + }, + "y": { + "type": "number", + "format": "float", + "description": "The y-coordinate (vertical axis) of the point." + } + }, + "required": [ + "x", + "y" + ] + }, + "AzureGroundingEnhancementLine": { + "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", + "description": "The text within the line." + }, + "spans": { + "type": "array", + "description": "An array of spans that represent detected objects and its bounding box information.", + "items": { + "$ref": "#/definitions/AzureGroundingEnhancementLineSpan" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "text", + "spans" + ] + }, + "AzureGroundingEnhancementLineSpan": { + "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", + "format": "int32", + "description": "The character offset within the text where the span begins. This offset is defined as the position of the first\ncharacter of the span, counting from the start of the text as Unicode codepoints." + }, + "length": { + "type": "integer", + "format": "int32", + "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": { + "$ref": "#/definitions/AzureGroundingEnhancementCoordinatePoint" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "text", + "offset", + "length", + "polygon" + ] + }, + "AzureMachineLearningIndexChatExtensionConfiguration": { + "type": "object", + "description": "A specific representation of configurable options for Azure Machine Learning vector index when using it as an Azure\nOpenAI chat extension.", + "properties": { + "parameters": { + "$ref": "#/definitions/AzureMachineLearningIndexChatExtensionParameters", + "description": "The parameters for the Azure Machine Learning vector index chat extension." + } + }, + "required": [ + "parameters" + ], + "allOf": [ + { + "$ref": "#/definitions/AzureChatExtensionConfiguration" + } + ], + "x-ms-discriminator-value": "azure_ml_index" + }, + "AzureMachineLearningIndexChatExtensionParameters": { + "type": "object", + "description": "Parameters for the Azure Machine Learning vector index chat extension. The supported authentication types are AccessToken, SystemAssignedManagedIdentity and UserAssignedManagedIdentity.", + "properties": { + "authentication": { + "$ref": "#/definitions/OnYourDataAuthenticationOptions", + "description": "The authentication method to use when accessing the defined data source.\nEach data source type supports a specific set of available authentication methods; please see the documentation of\nthe data source for supported mechanisms.\nIf not otherwise provided, On Your Data will attempt to use System Managed Identity (default credential)\nauthentication." + }, + "top_n_documents": { + "type": "integer", + "format": "int32", + "description": "The configured top number of documents to feature for the configured query.", + "x-ms-client-name": "topNDocuments" + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data.", + "x-ms-client-name": "inScope" + }, + "strictness": { + "type": "integer", + "format": "int32", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "minimum": 1, + "maximum": 5 + }, + "role_information": { + "type": "string", + "description": "Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit.", + "x-ms-client-name": "roleInformation" + }, + "max_search_queries": { + "type": "integer", + "format": "int32", + "description": "The max number of rewritten queries should be send to search provider for one user message. If not specified,\nthe system will decide the number of queries to send.", + "x-ms-client-name": "maxSearchQueries" + }, + "allow_partial_result": { + "type": "boolean", + "description": "If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail.\nIf not specified, or specified as false, the request will fail if any search query fails.", + "default": false, + "x-ms-client-name": "allowPartialResult" + }, + "include_contexts": { + "type": "array", + "description": "The included properties of the output context. If not specified, the default value is `citations` and `intent`.", + "items": { + "$ref": "#/definitions/OnYourDataContextProperty" + }, + "x-ms-client-name": "includeContexts" + }, + "project_resource_id": { + "type": "string", + "description": "The resource ID of the Azure Machine Learning project.", + "x-ms-client-name": "projectResourceId" + }, + "name": { + "type": "string", + "description": "The Azure Machine Learning vector index name." + }, + "version": { + "type": "string", + "description": "The version of the Azure Machine Learning vector index." + }, + "filter": { + "type": "string", + "description": "Search filter. Only supported if the Azure Machine Learning vector index is of type AzureSearch." + } + }, + "required": [ + "project_resource_id", + "name", + "version" + ] + }, + "AzureSearchChatExtensionConfiguration": { + "type": "object", + "description": "A specific representation of configurable options for Azure Search when using it as an Azure OpenAI chat\nextension.", + "properties": { + "parameters": { + "$ref": "#/definitions/AzureSearchChatExtensionParameters", + "description": "The parameters to use when configuring Azure Search." + } + }, + "required": [ + "parameters" + ], + "allOf": [ + { + "$ref": "#/definitions/AzureChatExtensionConfiguration" + } + ], + "x-ms-discriminator-value": "azure_search" + }, + "AzureSearchChatExtensionParameters": { + "type": "object", + "description": "Parameters for Azure Cognitive Search when used as an Azure OpenAI chat extension. The supported authentication types are APIKey, SystemAssignedManagedIdentity and UserAssignedManagedIdentity.", + "properties": { + "authentication": { + "$ref": "#/definitions/OnYourDataAuthenticationOptions", + "description": "The authentication method to use when accessing the defined data source.\nEach data source type supports a specific set of available authentication methods; please see the documentation of\nthe data source for supported mechanisms.\nIf not otherwise provided, On Your Data will attempt to use System Managed Identity (default credential)\nauthentication." + }, + "top_n_documents": { + "type": "integer", + "format": "int32", + "description": "The configured top number of documents to feature for the configured query.", + "x-ms-client-name": "topNDocuments" + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data.", + "x-ms-client-name": "inScope" + }, + "strictness": { + "type": "integer", + "format": "int32", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "minimum": 1, + "maximum": 5 + }, + "role_information": { + "type": "string", + "description": "Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit.", + "x-ms-client-name": "roleInformation" + }, + "max_search_queries": { + "type": "integer", + "format": "int32", + "description": "The max number of rewritten queries should be send to search provider for one user message. If not specified,\nthe system will decide the number of queries to send.", + "x-ms-client-name": "maxSearchQueries" + }, + "allow_partial_result": { + "type": "boolean", + "description": "If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail.\nIf not specified, or specified as false, the request will fail if any search query fails.", + "default": false, + "x-ms-client-name": "allowPartialResult" + }, + "include_contexts": { + "type": "array", + "description": "The included properties of the output context. If not specified, the default value is `citations` and `intent`.", + "items": { + "$ref": "#/definitions/OnYourDataContextProperty" + }, + "x-ms-client-name": "includeContexts" + }, + "endpoint": { + "type": "string", + "format": "uri", + "description": "The absolute endpoint path for the Azure Cognitive Search resource to use." + }, + "index_name": { + "type": "string", + "description": "The name of the index to use as available in the referenced Azure Cognitive Search resource.", + "x-ms-client-name": "indexName" + }, + "fields_mapping": { + "$ref": "#/definitions/AzureSearchIndexFieldMappingOptions", + "description": "Customized field mapping behavior to use when interacting with the search index.", + "x-ms-client-name": "fieldsMapping" + }, + "query_type": { + "$ref": "#/definitions/AzureSearchQueryType", + "description": "The query type to use with Azure Cognitive Search.", + "x-ms-client-name": "queryType" + }, + "semantic_configuration": { + "type": "string", + "description": "The additional semantic configuration for the query.", + "x-ms-client-name": "semanticConfiguration" + }, + "filter": { + "type": "string", + "description": "Search filter." + }, + "embedding_dependency": { + "$ref": "#/definitions/OnYourDataVectorizationSource", + "description": "The embedding dependency for vector search.", + "x-ms-client-name": "embeddingDependency" + } + }, + "required": [ + "endpoint", + "index_name" + ] + }, + "AzureSearchIndexFieldMappingOptions": { + "type": "object", + "description": "Optional settings to control how fields are processed when using a configured Azure Search resource.", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title.", + "x-ms-client-name": "titleField" + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL.", + "x-ms-client-name": "urlField" + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath.", + "x-ms-client-name": "filepathField" + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + }, + "x-ms-client-name": "contentFields" + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use.", + "x-ms-client-name": "contentFieldsSeparator" + }, + "vector_fields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + }, + "x-ms-client-name": "vectorFields" + }, + "image_vector_fields": { + "type": "array", + "description": "The names of fields that represent image vector data.", + "items": { + "type": "string" + }, + "x-ms-client-name": "imageVectorFields" + } + } + }, + "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." + } + ] + } + }, + "ChatChoice": { + "type": "object", + "description": "The representation of a single prompt completion as part of an overall chat completions request.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", + "properties": { + "message": { + "$ref": "#/definitions/ChatResponseMessage", + "description": "The chat message for a given chat completions prompt." + }, + "logprobs": { + "type": "object", + "description": "The log probability information for this choice, as enabled via the 'logprobs' request option.", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/ChatChoiceLogProbabilityInfo" + } + ] + }, + "index": { + "type": "integer", + "format": "int32", + "description": "The ordered index associated with this chat completions choice." + }, + "finish_reason": { + "$ref": "#/definitions/CompletionsFinishReason", + "description": "The reason that this chat completions choice completed its generated.", + "x-nullable": true, + "x-ms-client-name": "finishReason" + }, + "finish_details": { + "$ref": "#/definitions/ChatFinishDetails", + "description": "The reason the model stopped generating tokens, together with any applicable details.\nThis structured representation replaces 'finish_reason' for some models.", + "x-ms-client-name": "finishDetails" + }, + "delta": { + "$ref": "#/definitions/ChatResponseMessage", + "description": "The delta message content for a streaming response." + }, + "content_filter_results": { + "$ref": "#/definitions/ContentFilterResultsForChoice", + "description": "Information about the content filtering category (hate, sexual, violence, self_harm), if it\nhas been detected, as well as the severity level (very_low, low, medium, high-scale that\ndetermines the intensity and risk level of harmful content) and if it has been filtered or not.", + "x-ms-client-name": "contentFilterResults" + }, + "enhancements": { + "$ref": "#/definitions/AzureChatEnhancements", + "description": "Represents the output results of Azure OpenAI enhancements to chat completions, as configured via the matching input\nprovided in the request. This supplementary information is only available when using Azure OpenAI and only when the\nrequest is configured to use enhancements." + } + }, + "required": [ + "logprobs", + "index", + "finish_reason" + ] + }, + "ChatChoiceLogProbabilityInfo": { + "type": "object", + "description": "Log probability information for a choice, as requested via 'logprobs' and 'top_logprobs'.", + "properties": { + "content": { + "type": "array", + "description": "The list of log probability information entries for the choice's message content tokens, as requested via the 'logprobs' option.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/ChatTokenLogProbabilityResult" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "content" + ] + }, + "ChatCompletions": { + "type": "object", + "description": "Representation of the response data from a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "properties": { + "id": { + "type": "string", + "description": "A unique identifier associated with this chat completions response." + }, + "created": { + "type": "integer", + "format": "unixtime", + "description": "The first timestamp associated with generation activity for this completions response,\nrepresented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970." + }, + "choices": { + "type": "array", + "description": "The collection of completions choices associated with this completions response.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", + "items": { + "$ref": "#/definitions/ChatChoice" + }, + "x-ms-identifiers": [] + }, + "model": { + "type": "string", + "description": "The model name used for this completions request." + }, + "prompt_filter_results": { + "type": "array", + "description": "Content filtering results for zero or more prompts in the request. In a streaming request,\nresults for different prompts may arrive at different times or in different orders.", + "items": { + "$ref": "#/definitions/ContentFilterResultsForPrompt" + }, + "x-ms-client-name": "promptFilterResults", + "x-ms-identifiers": [] + }, + "system_fingerprint": { + "type": "string", + "description": "Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that\nmight impact determinism.", + "x-ms-client-name": "systemFingerprint" + }, + "usage": { + "$ref": "#/definitions/CompletionsUsage", + "description": "Usage information for tokens processed and generated as part of this completions operation." + } + }, + "required": [ + "id", + "created", + "choices", + "usage" + ] + }, + "ChatCompletionsFunctionToolCall": { + "type": "object", + "description": "A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents\na function invocation needed for a subsequent chat completions request to resolve.", + "properties": { + "function": { + "$ref": "#/definitions/FunctionCall", + "description": "The details of the function invocation requested by the tool call." + } + }, + "required": [ + "function" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatCompletionsToolCall" + } + ], + "x-ms-discriminator-value": "function" + }, + "ChatCompletionsFunctionToolDefinition": { + "type": "object", + "description": "The definition information for a chat completions function tool that can call a function in response to a tool call.", + "properties": { + "function": { + "$ref": "#/definitions/FunctionDefinition", + "description": "The function definition details for the function tool." + } + }, + "required": [ + "function" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatCompletionsToolDefinition" + } + ], + "x-ms-discriminator-value": "function" + }, + "ChatCompletionsJsonResponseFormat": { + "type": "object", + "description": "A response format for Chat Completions that restricts responses to emitting valid JSON objects.", + "allOf": [ + { + "$ref": "#/definitions/ChatCompletionsResponseFormat" + } + ], + "x-ms-discriminator-value": "json_object" + }, + "ChatCompletionsOptions": { + "type": "object", + "description": "The configuration information for a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "properties": { + "messages": { + "type": "array", + "description": "The collection of context messages associated with this chat completions request.\nTypical usage begins with a chat message for the System role that provides instructions for\nthe behavior of the assistant, followed by alternating messages between the User and\nAssistant roles.", + "items": { + "$ref": "#/definitions/ChatRequestMessage" + }, + "x-ms-identifiers": [] + }, + "functions": { + "type": "array", + "description": "A list of functions the model may generate JSON inputs for.", + "items": { + "$ref": "#/definitions/FunctionDefinition" + }, + "x-ms-identifiers": [] + }, + "function_call": { + "description": "Controls how the model responds to function calls. \"none\" means the model does not call a function,\nand responds to the end-user. \"auto\" means the model can pick between an end-user or calling a function.\n Specifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function.\n \"none\" is the default when no functions are present. \"auto\" is the default if functions are present.", + "x-ms-client-name": "functionCall" + }, + "max_tokens": { + "type": "integer", + "format": "int32", + "description": "The maximum number of tokens to generate.", + "x-ms-client-name": "maxTokens" + }, + "temperature": { + "type": "number", + "format": "float", + "description": "The sampling temperature to use that controls the apparent creativity of generated completions.\nHigher values will make output more random while lower values will make results more focused\nand deterministic.\nIt is not recommended to modify temperature and top_p for the same completions request as the\ninteraction of these two settings is difficult to predict." + }, + "top_p": { + "type": "number", + "format": "float", + "description": "An alternative to sampling with temperature called nucleus sampling. This value causes the\nmodel to consider the results of tokens with the provided probability mass. As an example, a\nvalue of 0.15 will cause only the tokens comprising the top 15% of probability mass to be\nconsidered.\nIt is not recommended to modify temperature and top_p for the same completions request as the\ninteraction of these two settings is difficult to predict.", + "x-ms-client-name": "topP" + }, + "logit_bias": { + "type": "object", + "description": "A map between GPT token IDs and bias scores that influences the probability of specific tokens\nappearing in a completions response. Token IDs are computed via external tokenizer tools, while\nbias scores reside in the range of -100 to 100 with minimum and maximum values corresponding to\na full ban or exclusive selection of a token, respectively. The exact behavior of a given bias\nscore varies by model.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "x-ms-client-name": "logitBias" + }, + "user": { + "type": "string", + "description": "An identifier for the caller or end user of the operation. This may be used for tracking\nor rate-limiting purposes." + }, + "n": { + "type": "integer", + "format": "int32", + "description": "The number of chat completions choices that should be generated for a chat completions\nresponse.\nBecause this setting can generate many completions, it may quickly consume your token quota.\nUse carefully and ensure reasonable settings for max_tokens and stop." + }, + "stop": { + "type": "array", + "description": "A collection of textual sequences that will end completions generation.", + "items": { + "type": "string" + } + }, + "presence_penalty": { + "type": "number", + "format": "float", + "description": "A value that influences the probability of generated tokens appearing based on their existing\npresence in generated text.\nPositive values will make tokens less likely to appear when they already exist and increase the\nmodel's likelihood to output new topics.", + "x-ms-client-name": "presencePenalty" + }, + "frequency_penalty": { + "type": "number", + "format": "float", + "description": "A value that influences the probability of generated tokens appearing based on their cumulative\nfrequency in generated text.\nPositive values will make tokens less likely to appear as their frequency increases and\ndecrease the likelihood of the model repeating the same statements verbatim.", + "x-ms-client-name": "frequencyPenalty" + }, + "stream": { + "type": "boolean", + "description": "A value indicating whether chat completions should be streamed for this request." + }, + "model": { + "type": "string", + "description": "The model name to provide as part of this completions request.\nNot applicable to Azure OpenAI, where deployment information should be included in the Azure\nresource URI that's connected to." + }, + "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": "#/definitions/AzureChatExtensionConfiguration" + }, + "x-ms-client-name": "dataSources", + "x-ms-identifiers": [] + }, + "enhancements": { + "$ref": "#/definitions/AzureChatEnhancementConfiguration", + "description": "If provided, the configuration options for available Azure OpenAI chat enhancements." + }, + "seed": { + "type": "integer", + "format": "int64", + "description": "If specified, the system will make a best effort to sample deterministically such that repeated requests with the\nsame seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the\nsystem_fingerprint response parameter to monitor changes in the backend.\"" + }, + "logprobs": { + "type": "boolean", + "description": "Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the `content` of `message`. This option is currently not available on the `gpt-4-vision-preview` model.", + "default": false, + "x-nullable": true + }, + "top_logprobs": { + "type": "integer", + "format": "int32", + "description": "An integer between 0 and 5 specifying the number of most likely tokens to return at each token position, each with an associated log probability. `logprobs` must be set to `true` if this parameter is used.", + "x-nullable": true + }, + "response_format": { + "$ref": "#/definitions/ChatCompletionsResponseFormat", + "description": "An object specifying the format that the model must output. Used to enable JSON mode.", + "x-ms-client-name": "responseFormat" + }, + "tools": { + "type": "array", + "description": "The available tool definitions that the chat completions request can use, including caller-defined functions.", + "items": { + "$ref": "#/definitions/ChatCompletionsToolDefinition" + }, + "x-ms-identifiers": [] + }, + "tool_choice": { + "description": "If specified, the model will configure which of the provided tools it can use for the chat completions response.", + "x-ms-client-name": "toolChoice" + } + }, + "required": [ + "messages" + ] + }, + "ChatCompletionsResponseFormat": { + "type": "object", + "description": "An abstract representation of a response format configuration usable by Chat Completions. Can be used to enable JSON\nmode.", + "properties": { + "type": { + "type": "string", + "description": "The discriminated type for the response format." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "ChatCompletionsTextResponseFormat": { + "type": "object", + "description": "The standard Chat Completions response format that can freely generate text and is not guaranteed to produce response\ncontent that adheres to a specific schema.", + "allOf": [ + { + "$ref": "#/definitions/ChatCompletionsResponseFormat" + } + ], + "x-ms-discriminator-value": "text" + }, + "ChatCompletionsToolCall": { + "type": "object", + "description": "An abstract representation of a tool call that must be resolved in a subsequent request to perform the requested\nchat completion.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + }, + "id": { + "type": "string", + "description": "The ID of the tool call." + } + }, + "discriminator": "type", + "required": [ + "type", + "id" + ] + }, + "ChatCompletionsToolDefinition": { + "type": "object", + "description": "An abstract representation of a tool that can be used by the model to improve a chat completions response.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "ChatFinishDetails": { + "type": "object", + "description": "An abstract representation of structured information about why a chat completions response terminated.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "ChatRequestAssistantMessage": { + "type": "object", + "description": "A request chat message representing response or action from the assistant.", + "properties": { + "content": { + "type": "string", + "description": "The content of the message.", + "x-nullable": true + }, + "name": { + "type": "string", + "description": "An optional name for the participant." + }, + "tool_calls": { + "type": "array", + "description": "The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat\ncompletions request to resolve as configured.", + "items": { + "$ref": "#/definitions/ChatCompletionsToolCall" + }, + "x-ms-client-name": "toolCalls" + }, + "function_call": { + "$ref": "#/definitions/FunctionCall", + "description": "The function call that must be resolved and have its output appended to subsequent input messages for the chat\ncompletions request to resolve as configured.", + "x-ms-client-name": "functionCall" + } + }, + "required": [ + "content" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatRequestMessage" + } + ], + "x-ms-discriminator-value": "assistant" + }, + "ChatRequestFunctionMessage": { + "type": "object", + "description": "A request chat message representing requested output from a configured function.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function that was called to produce output." + }, + "content": { + "type": "string", + "description": "The output of the function as requested by the function call.", + "x-nullable": true + } + }, + "required": [ + "name", + "content" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatRequestMessage" + } + ], + "x-ms-discriminator-value": "function" + }, + "ChatRequestMessage": { + "type": "object", + "description": "An abstract representation of a chat message as provided in a request.", + "properties": { + "role": { + "$ref": "#/definitions/ChatRole", + "description": "The chat role associated with this message." + } + }, + "discriminator": "role", + "required": [ + "role" + ] + }, + "ChatRequestSystemMessage": { + "type": "object", + "description": "A request chat message containing system instructions that influence how the model will generate a chat completions\nresponse.", + "properties": { + "content": { + "type": "string", + "description": "The contents of the system message." + }, + "name": { + "type": "string", + "description": "An optional name for the participant." + } + }, + "required": [ + "content" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatRequestMessage" + } + ], + "x-ms-discriminator-value": "system" + }, + "ChatRequestToolMessage": { + "type": "object", + "description": "A request chat message representing requested output from a configured tool.", + "properties": { + "content": { + "type": "string", + "description": "The content of the message.", + "x-nullable": true + }, + "tool_call_id": { + "type": "string", + "description": "The ID of the tool call resolved by the provided content.", + "x-ms-client-name": "toolCallId" + } + }, + "required": [ + "content", + "tool_call_id" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatRequestMessage" + } + ], + "x-ms-discriminator-value": "tool" + }, + "ChatRequestUserMessage": { + "type": "object", + "description": "A request chat message representing user input to the assistant.", + "properties": { + "content": { + "description": "The contents of the user message, with available input types varying by selected model." + }, + "name": { + "type": "string", + "description": "An optional name for the participant." + } + }, + "required": [ + "content" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatRequestMessage" + } + ], + "x-ms-discriminator-value": "user" + }, + "ChatResponseMessage": { + "type": "object", + "description": "A representation of a chat message as received in a response.", + "properties": { + "role": { + "$ref": "#/definitions/ChatRole", + "description": "The chat role associated with the message." + }, + "content": { + "type": "string", + "description": "The content of the message.", + "x-nullable": true + }, + "tool_calls": { + "type": "array", + "description": "The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat\ncompletions request to resolve as configured.", + "items": { + "$ref": "#/definitions/ChatCompletionsToolCall" + }, + "x-ms-client-name": "toolCalls" + }, + "function_call": { + "$ref": "#/definitions/FunctionCall", + "description": "The function call that must be resolved and have its output appended to subsequent input messages for the chat\ncompletions request to resolve as configured.", + "x-ms-client-name": "functionCall" + }, + "context": { + "$ref": "#/definitions/AzureChatExtensionsMessageContext", + "description": "If Azure OpenAI chat extensions are configured, this array represents the incremental steps performed by those\nextensions while processing the chat completions request." + } + }, + "required": [ + "role", + "content" + ] + }, + "ChatRole": { + "type": "string", + "description": "A description of the intended purpose of a message within a chat completions interaction.", + "enum": [ + "system", + "assistant", + "user", + "function", + "tool" + ], + "x-ms-enum": { + "name": "ChatRole", + "modelAsString": true, + "values": [ + { + "name": "system", + "value": "system", + "description": "The role that instructs or sets the behavior of the assistant." + }, + { + "name": "assistant", + "value": "assistant", + "description": "The role that provides responses to system-instructed, user-prompted input." + }, + { + "name": "user", + "value": "user", + "description": "The role that provides input for chat completions." + }, + { + "name": "function", + "value": "function", + "description": "The role that provides function results for chat completions." + }, + { + "name": "tool", + "value": "tool", + "description": "The role that represents extension tool activity within a chat completions operation." + } + ] + } + }, + "ChatTokenLogProbabilityInfo": { + "type": "object", + "description": "A representation of the log probability information for a single message content token.", + "properties": { + "token": { + "type": "string", + "description": "The message content token." + }, + "logprob": { + "type": "number", + "format": "float", + "description": "The log probability of the message content token." + }, + "bytes": { + "type": "array", + "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.", + "x-nullable": true, + "items": { + "type": "integer", + "format": "int32" + } + } + }, + "required": [ + "token", + "logprob", + "bytes" + ] + }, + "ChatTokenLogProbabilityResult": { + "type": "object", + "description": "A representation of the log probability information for a single content token, including a list of most likely tokens if 'top_logprobs' were requested.", + "properties": { + "token": { + "type": "string", + "description": "The message content token." + }, + "logprob": { + "type": "number", + "format": "float", + "description": "The log probability of the message content token." + }, + "bytes": { + "type": "array", + "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.", + "x-nullable": true, + "items": { + "type": "integer", + "format": "int32" + } + }, + "top_logprobs": { + "type": "array", + "description": "The list of most likely tokens and their log probability information, as requested via 'top_logprobs'.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/ChatTokenLogProbabilityInfo" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "token", + "logprob", + "bytes", + "top_logprobs" + ] + }, + "Choice": { + "type": "object", + "description": "The representation of a single prompt completion as part of an overall completions request.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", + "properties": { + "text": { + "type": "string", + "description": "The generated text for a given completions prompt." + }, + "index": { + "type": "integer", + "format": "int32", + "description": "The ordered index associated with this completions choice." + }, + "content_filter_results": { + "$ref": "#/definitions/ContentFilterResultsForChoice", + "description": "Information about the content filtering category (hate, sexual, violence, self_harm), if it\nhas been detected, as well as the severity level (very_low, low, medium, high-scale that\ndetermines the intensity and risk level of harmful content) and if it has been filtered or not.", + "x-ms-client-name": "contentFilterResults" + }, + "logprobs": { + "type": "object", + "description": "The log probabilities model for tokens associated with this completions choice.", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/CompletionsLogProbabilityModel" + } + ] + }, + "finish_reason": { + "$ref": "#/definitions/CompletionsFinishReason", + "description": "Reason for finishing", + "x-nullable": true, + "x-ms-client-name": "finishReason" + } + }, + "required": [ + "text", + "index", + "logprobs", + "finish_reason" + ] + }, + "Completions": { + "type": "object", + "description": "Representation of the response data from a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "properties": { + "id": { + "type": "string", + "description": "A unique identifier associated with this completions response." + }, + "created": { + "type": "integer", + "format": "unixtime", + "description": "The first timestamp associated with generation activity for this completions response,\nrepresented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970." + }, + "prompt_filter_results": { + "type": "array", + "description": "Content filtering results for zero or more prompts in the request. In a streaming request,\nresults for different prompts may arrive at different times or in different orders.", + "items": { + "$ref": "#/definitions/ContentFilterResultsForPrompt" + }, + "x-ms-client-name": "promptFilterResults", + "x-ms-identifiers": [] + }, + "choices": { + "type": "array", + "description": "The collection of completions choices associated with this completions response.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", + "items": { + "$ref": "#/definitions/Choice" + }, + "x-ms-identifiers": [] + }, + "usage": { + "$ref": "#/definitions/CompletionsUsage", + "description": "Usage information for tokens processed and generated as part of this completions operation." + } + }, + "required": [ + "id", + "created", + "choices", + "usage" + ] + }, + "CompletionsFinishReason": { + "type": "string", + "description": "Representation of the manner in which a completions response concluded.", + "enum": [ + "stop", + "length", + "content_filter", + "function_call", + "tool_calls" + ], + "x-ms-enum": { + "name": "CompletionsFinishReason", + "modelAsString": true, + "values": [ + { + "name": "stopped", + "value": "stop", + "description": "Completions ended normally and reached its end of token generation." + }, + { + "name": "tokenLimitReached", + "value": "length", + "description": "Completions exhausted available token limits before generation could complete." + }, + { + "name": "contentFiltered", + "value": "content_filter", + "description": "Completions generated a response that was identified as potentially sensitive per content\nmoderation policies." + }, + { + "name": "functionCall", + "value": "function_call", + "description": "Completion ended normally, with the model requesting a function to be called." + }, + { + "name": "toolCalls", + "value": "tool_calls", + "description": "Completion ended with the model calling a provided tool for output." + } + ] + } + }, + "CompletionsLogProbabilityModel": { + "type": "object", + "description": "Representation of a log probabilities model for a completions generation.", + "properties": { + "tokens": { + "type": "array", + "description": "The textual forms of tokens evaluated in this probability model.", + "items": { + "type": "string" + } + }, + "token_logprobs": { + "type": "array", + "description": "A collection of log probability values for the tokens in this completions data.", + "items": { + "type": "number", + "format": "float", + "x-nullable": true + }, + "x-ms-client-name": "tokenLogprobs" + }, + "top_logprobs": { + "type": "array", + "description": "A mapping of tokens to maximum log probability values in this completions data.", + "items": { + "type": "object", + "additionalProperties": { + "format": "float", + "type": "number", + "x-nullable": true + } + }, + "x-ms-client-name": "topLogprobs", + "x-ms-identifiers": [] + }, + "text_offset": { + "type": "array", + "description": "The text offsets associated with tokens in this completions data.", + "items": { + "type": "integer", + "format": "int32" + }, + "x-ms-client-name": "textOffset" + } + }, + "required": [ + "tokens", + "token_logprobs", + "top_logprobs", + "text_offset" + ] + }, + "CompletionsOptions": { + "type": "object", + "description": "The configuration information for a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "properties": { + "prompt": { + "type": "array", + "description": "The prompts to generate completions from.", + "items": { + "type": "string" + } + }, + "max_tokens": { + "type": "integer", + "format": "int32", + "description": "The maximum number of tokens to generate.", + "x-ms-client-name": "maxTokens" + }, + "temperature": { + "type": "number", + "format": "float", + "description": "The sampling temperature to use that controls the apparent creativity of generated completions.\nHigher values will make output more random while lower values will make results more focused\nand deterministic.\nIt is not recommended to modify temperature and top_p for the same completions request as the\ninteraction of these two settings is difficult to predict." + }, + "top_p": { + "type": "number", + "format": "float", + "description": "An alternative to sampling with temperature called nucleus sampling. This value causes the\nmodel to consider the results of tokens with the provided probability mass. As an example, a\nvalue of 0.15 will cause only the tokens comprising the top 15% of probability mass to be\nconsidered.\nIt is not recommended to modify temperature and top_p for the same completions request as the\ninteraction of these two settings is difficult to predict.", + "x-ms-client-name": "topP" + }, + "logit_bias": { + "type": "object", + "description": "A map between GPT token IDs and bias scores that influences the probability of specific tokens\nappearing in a completions response. Token IDs are computed via external tokenizer tools, while\nbias scores reside in the range of -100 to 100 with minimum and maximum values corresponding to\na full ban or exclusive selection of a token, respectively. The exact behavior of a given bias\nscore varies by model.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "x-ms-client-name": "logitBias" + }, + "user": { + "type": "string", + "description": "An identifier for the caller or end user of the operation. This may be used for tracking\nor rate-limiting purposes." + }, + "n": { + "type": "integer", + "format": "int32", + "description": "The number of completions choices that should be generated per provided prompt as part of an\noverall completions response.\nBecause this setting can generate many completions, it may quickly consume your token quota.\nUse carefully and ensure reasonable settings for max_tokens and stop." + }, + "logprobs": { + "type": "integer", + "format": "int32", + "description": "A value that controls the emission of log probabilities for the provided number of most likely\ntokens within a completions response." + }, + "suffix": { + "type": "string", + "description": "The suffix that comes after a completion of inserted text" + }, + "echo": { + "type": "boolean", + "description": "A value specifying whether completions responses should include input prompts as prefixes to\ntheir generated output." + }, + "stop": { + "type": "array", + "description": "A collection of textual sequences that will end completions generation.", + "items": { + "type": "string" + } + }, + "presence_penalty": { + "type": "number", + "format": "float", + "description": "A value that influences the probability of generated tokens appearing based on their existing\npresence in generated text.\nPositive values will make tokens less likely to appear when they already exist and increase the\nmodel's likelihood to output new topics.", + "x-ms-client-name": "presencePenalty" + }, + "frequency_penalty": { + "type": "number", + "format": "float", + "description": "A value that influences the probability of generated tokens appearing based on their cumulative\nfrequency in generated text.\nPositive values will make tokens less likely to appear as their frequency increases and\ndecrease the likelihood of the model repeating the same statements verbatim.", + "x-ms-client-name": "frequencyPenalty" + }, + "best_of": { + "type": "integer", + "format": "int32", + "description": "A value that controls how many completions will be internally generated prior to response\nformulation.\nWhen used together with n, best_of controls the number of candidate completions and must be\ngreater than n.\nBecause this setting can generate many completions, it may quickly consume your token quota.\nUse carefully and ensure reasonable settings for max_tokens and stop.", + "x-ms-client-name": "bestOf" + }, + "stream": { + "type": "boolean", + "description": "A value indicating whether chat completions should be streamed for this request." + }, + "model": { + "type": "string", + "description": "The model name to provide as part of this completions request.\nNot applicable to Azure OpenAI, where deployment information should be included in the Azure\nresource URI that's connected to." + } + }, + "required": [ + "prompt" + ] + }, + "CompletionsUsage": { + "type": "object", + "description": "Representation of the token counts processed for a completions request.\nCounts consider all tokens across prompts, choices, choice alternates, best_of generations, and\nother consumers.", + "properties": { + "completion_tokens": { + "type": "integer", + "format": "int32", + "description": "The number of tokens generated across all completions emissions.", + "x-ms-client-name": "completionTokens" + }, + "prompt_tokens": { + "type": "integer", + "format": "int32", + "description": "The number of tokens in the provided prompts for the completions request.", + "x-ms-client-name": "promptTokens" + }, + "total_tokens": { + "type": "integer", + "format": "int32", + "description": "The total number of tokens processed for the completions request and response.", + "x-ms-client-name": "totalTokens" + } + }, + "required": [ + "completion_tokens", + "prompt_tokens", + "total_tokens" + ] + }, + "ContentFilterBlocklistIdResult": { + "type": "object", + "description": "Represents the outcome of an evaluation against a custom blocklist as performed by content filtering.", + "properties": { + "filtered": { + "type": "boolean", + "description": "A value indicating whether or not the content has been filtered." + }, + "id": { + "type": "string", + "description": "The ID of the custom blocklist evaluated." + } + }, + "required": [ + "filtered", + "id" + ] + }, + "ContentFilterCitedDetectionResult": { + "type": "object", + "description": "Represents the outcome of a detection operation against protected resources as performed by content filtering.", + "properties": { + "filtered": { + "type": "boolean", + "description": "A value indicating whether or not the content has been filtered." + }, + "detected": { + "type": "boolean", + "description": "A value indicating whether detection occurred, irrespective of severity or whether the content was filtered." + }, + "URL": { + "type": "string", + "format": "uri", + "description": "The internet location associated with the detection.", + "x-ms-client-name": "url" + }, + "license": { + "type": "string", + "description": "The license description associated with the detection." + } + }, + "required": [ + "filtered", + "detected", + "license" + ] + }, + "ContentFilterDetailedResults": { + "type": "object", + "description": "Represents a structured collection of result details for content filtering.", + "properties": { + "filtered": { + "type": "boolean", + "description": "A value indicating whether or not the content has been filtered." + }, + "details": { + "type": "array", + "description": "The collection of detailed blocklist result information.", + "items": { + "$ref": "#/definitions/ContentFilterBlocklistIdResult" + } + } + }, + "required": [ + "filtered", + "details" + ] + }, + "ContentFilterDetectionResult": { + "type": "object", + "description": "Represents the outcome of a detection operation performed by content filtering.", + "properties": { + "filtered": { + "type": "boolean", + "description": "A value indicating whether or not the content has been filtered." + }, + "detected": { + "type": "boolean", + "description": "A value indicating whether detection occurred, irrespective of severity or whether the content was filtered." + } + }, + "required": [ + "filtered", + "detected" + ] + }, + "ContentFilterResult": { + "type": "object", + "description": "Information about filtered content severity level and if it has been filtered or not.", + "properties": { + "filtered": { + "type": "boolean", + "description": "A value indicating whether or not the content has been filtered." + }, + "severity": { + "$ref": "#/definitions/ContentFilterSeverity", + "description": "Ratings for the intensity and risk level of filtered content." + } + }, + "required": [ + "filtered", + "severity" + ] + }, + "ContentFilterResultDetailsForPrompt": { + "type": "object", + "description": "Information about content filtering evaluated against input data to Azure OpenAI.", + "properties": { + "sexual": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to anatomical organs and genitals, romantic relationships,\n acts portrayed in erotic or affectionate terms, physical sexual acts, including\n those portrayed as an assault or a forced sexual violent act against one’s will,\n prostitution, pornography, and abuse." + }, + "violence": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to physical actions intended to hurt, injure, damage, or\nkill someone or something; describes weapons, etc." + }, + "hate": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language attacks or uses that include pejorative or discriminatory language\nwith reference to a person or identity group on the basis of certain differentiating\nattributes of these groups including but not limited to race, ethnicity, nationality,\ngender identity and expression, sexual orientation, religion, immigration status, ability\nstatus, personal appearance, and body size." + }, + "self_harm": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to physical actions intended to purposely hurt, injure,\nor damage one’s body, or kill oneself.", + "x-ms-client-name": "selfHarm" + }, + "profanity": { + "$ref": "#/definitions/ContentFilterDetectionResult", + "description": "Describes whether profanity was detected." + }, + "custom_blocklists": { + "$ref": "#/definitions/ContentFilterDetailedResults", + "description": "Describes detection results against configured custom blocklists.", + "x-ms-client-name": "customBlocklists" + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Describes an error returned if the content filtering system is\ndown or otherwise unable to complete the operation in time." + }, + "jailbreak": { + "$ref": "#/definitions/ContentFilterDetectionResult", + "description": "Whether a jailbreak attempt was detected in the prompt." + }, + "indirect_attack": { + "$ref": "#/definitions/ContentFilterDetectionResult", + "description": "Whether an indirect attack was detected in the prompt.", + "x-ms-client-name": "indirectAttack" + } + } + }, + "ContentFilterResultsForChoice": { + "type": "object", + "description": "Information about content filtering evaluated against generated model output.", + "properties": { + "sexual": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to anatomical organs and genitals, romantic relationships,\n acts portrayed in erotic or affectionate terms, physical sexual acts, including\n those portrayed as an assault or a forced sexual violent act against one’s will,\n prostitution, pornography, and abuse." + }, + "violence": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to physical actions intended to hurt, injure, damage, or\nkill someone or something; describes weapons, etc." + }, + "hate": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language attacks or uses that include pejorative or discriminatory language\nwith reference to a person or identity group on the basis of certain differentiating\nattributes of these groups including but not limited to race, ethnicity, nationality,\ngender identity and expression, sexual orientation, religion, immigration status, ability\nstatus, personal appearance, and body size." + }, + "self_harm": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to physical actions intended to purposely hurt, injure,\nor damage one’s body, or kill oneself.", + "x-ms-client-name": "selfHarm" + }, + "profanity": { + "$ref": "#/definitions/ContentFilterDetectionResult", + "description": "Describes whether profanity was detected." + }, + "custom_blocklists": { + "$ref": "#/definitions/ContentFilterDetailedResults", + "description": "Describes detection results against configured custom blocklists.", + "x-ms-client-name": "customBlocklists" + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Describes an error returned if the content filtering system is\ndown or otherwise unable to complete the operation in time." + }, + "protected_material_text": { + "$ref": "#/definitions/ContentFilterDetectionResult", + "description": "Information about detection of protected text material.", + "x-ms-client-name": "protectedMaterialText" + }, + "protected_material_code": { + "$ref": "#/definitions/ContentFilterCitedDetectionResult", + "description": "Information about detection of protected code material.", + "x-ms-client-name": "protectedMaterialCode" + } + } + }, + "ContentFilterResultsForPrompt": { + "type": "object", + "description": "Content filtering results for a single prompt in the request.", + "properties": { + "prompt_index": { + "type": "integer", + "format": "int32", + "description": "The index of this prompt in the set of prompt results", + "x-ms-client-name": "promptIndex" + }, + "content_filter_results": { + "$ref": "#/definitions/ContentFilterResultDetailsForPrompt", + "description": "Content filtering results for this prompt", + "x-ms-client-name": "contentFilterResults" + } + }, + "required": [ + "prompt_index", + "content_filter_results" + ] + }, + "ContentFilterSeverity": { + "type": "string", + "description": "Ratings for the intensity and risk level of harmful content.", + "enum": [ + "safe", + "low", + "medium", + "high" + ], + "x-ms-enum": { + "name": "ContentFilterSeverity", + "modelAsString": true, + "values": [ + { + "name": "safe", + "value": "safe", + "description": "Content may be related to violence, self-harm, sexual, or hate categories but the terms\nare used in general, journalistic, scientific, medical, and similar professional contexts,\nwhich are appropriate for most audiences." + }, + { + "name": "low", + "value": "low", + "description": "Content that expresses prejudiced, judgmental, or opinionated views, includes offensive\nuse of language, stereotyping, use cases exploring a fictional world (for example, gaming,\nliterature) and depictions at low intensity." + }, + { + "name": "medium", + "value": "medium", + "description": "Content that uses offensive, insulting, mocking, intimidating, or demeaning language\ntowards specific identity groups, includes depictions of seeking and executing harmful\ninstructions, fantasies, glorification, promotion of harm at medium intensity." + }, + { + "name": "high", + "value": "high", + "description": "Content that displays explicit and severe harmful instructions, actions,\ndamage, or abuse; includes endorsement, glorification, or promotion of severe\nharmful acts, extreme or illegal forms of harm, radicalization, or non-consensual\npower exchange or abuse." + } + ] + } + }, + "ElasticsearchChatExtensionConfiguration": { + "type": "object", + "description": "A specific representation of configurable options for Elasticsearch when using it as an Azure OpenAI chat\nextension.", + "properties": { + "parameters": { + "$ref": "#/definitions/ElasticsearchChatExtensionParameters", + "description": "The parameters to use when configuring Elasticsearch®." + } + }, + "required": [ + "parameters" + ], + "allOf": [ + { + "$ref": "#/definitions/AzureChatExtensionConfiguration" + } + ], + "x-ms-discriminator-value": "elasticsearch" + }, + "ElasticsearchChatExtensionParameters": { + "type": "object", + "description": "Parameters to use when configuring Elasticsearch® as an Azure OpenAI chat extension. The supported authentication types are KeyAndKeyId and EncodedAPIKey.", + "properties": { + "authentication": { + "$ref": "#/definitions/OnYourDataAuthenticationOptions", + "description": "The authentication method to use when accessing the defined data source.\nEach data source type supports a specific set of available authentication methods; please see the documentation of\nthe data source for supported mechanisms.\nIf not otherwise provided, On Your Data will attempt to use System Managed Identity (default credential)\nauthentication." + }, + "top_n_documents": { + "type": "integer", + "format": "int32", + "description": "The configured top number of documents to feature for the configured query.", + "x-ms-client-name": "topNDocuments" + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data.", + "x-ms-client-name": "inScope" + }, + "strictness": { + "type": "integer", + "format": "int32", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "minimum": 1, + "maximum": 5 + }, + "role_information": { + "type": "string", + "description": "Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit.", + "x-ms-client-name": "roleInformation" + }, + "max_search_queries": { + "type": "integer", + "format": "int32", + "description": "The max number of rewritten queries should be send to search provider for one user message. If not specified,\nthe system will decide the number of queries to send.", + "x-ms-client-name": "maxSearchQueries" + }, + "allow_partial_result": { + "type": "boolean", + "description": "If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail.\nIf not specified, or specified as false, the request will fail if any search query fails.", + "default": false, + "x-ms-client-name": "allowPartialResult" + }, + "include_contexts": { + "type": "array", + "description": "The included properties of the output context. If not specified, the default value is `citations` and `intent`.", + "items": { + "$ref": "#/definitions/OnYourDataContextProperty" + }, + "x-ms-client-name": "includeContexts" + }, + "endpoint": { + "type": "string", + "format": "uri", + "description": "The endpoint of Elasticsearch®." + }, + "index_name": { + "type": "string", + "description": "The index name of Elasticsearch®.", + "x-ms-client-name": "indexName" + }, + "fields_mapping": { + "$ref": "#/definitions/ElasticsearchIndexFieldMappingOptions", + "description": "The index field mapping options of Elasticsearch®.", + "x-ms-client-name": "fieldsMapping" + }, + "query_type": { + "$ref": "#/definitions/ElasticsearchQueryType", + "description": "The query type of Elasticsearch®.", + "x-ms-client-name": "queryType" + }, + "embedding_dependency": { + "$ref": "#/definitions/OnYourDataVectorizationSource", + "description": "The embedding dependency for vector search.", + "x-ms-client-name": "embeddingDependency" + } + }, + "required": [ + "endpoint", + "index_name" + ] + }, + "ElasticsearchIndexFieldMappingOptions": { + "type": "object", + "description": "Optional settings to control how fields are processed when using a configured Elasticsearch® resource.", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title.", + "x-ms-client-name": "titleField" + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL.", + "x-ms-client-name": "urlField" + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath.", + "x-ms-client-name": "filepathField" + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + }, + "x-ms-client-name": "contentFields" + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use.", + "x-ms-client-name": "contentFieldsSeparator" + }, + "vector_fields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + }, + "x-ms-client-name": "vectorFields" + } + } + }, + "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." + } + ] + } + }, + "EmbeddingItem": { + "type": "object", + "description": "Representation of a single embeddings relatedness comparison.", + "properties": { + "embedding": { + "type": "array", + "description": "List of embeddings value for the input prompt. These represent a measurement of the\nvector-based relatedness of the provided input.", + "items": { + "type": "number", + "format": "float" + } + }, + "index": { + "type": "integer", + "format": "int32", + "description": "Index of the prompt to which the EmbeddingItem corresponds." + } + }, + "required": [ + "embedding", + "index" + ] + }, + "Embeddings": { + "type": "object", + "description": "Representation of the response data from an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", + "properties": { + "data": { + "type": "array", + "description": "Embedding values for the prompts submitted in the request.", + "items": { + "$ref": "#/definitions/EmbeddingItem" + }, + "x-ms-identifiers": [] + }, + "usage": { + "$ref": "#/definitions/EmbeddingsUsage", + "description": "Usage counts for tokens input using the embeddings API." + } + }, + "required": [ + "data", + "usage" + ] + }, + "EmbeddingsOptions": { + "type": "object", + "description": "The configuration information for an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", + "properties": { + "user": { + "type": "string", + "description": "An identifier for the caller or end user of the operation. This may be used for tracking\nor rate-limiting purposes." + }, + "model": { + "type": "string", + "description": "The model name to provide as part of this embeddings request.\nNot applicable to Azure OpenAI, where deployment information should be included in the Azure\nresource URI that's connected to." + }, + "input": { + "type": "array", + "description": "Input texts to get embeddings for, encoded as a an array of strings.\nEach input must not exceed 2048 tokens in length.\n\nUnless you are embedding code, we suggest replacing newlines (\\n) in your input with a single space,\nas we have observed inferior results when newlines are present.", + "items": { + "type": "string" + } + }, + "encoding_format": { + "type": "string", + "description": "The response encoding format to use for embedding data.", + "default": "float", + "enum": [ + "float", + "base64" + ], + "x-ms-enum": { + "name": "EmbeddingEncodingFormat", + "modelAsString": true, + "values": [ + { + "name": "float", + "value": "float", + "description": "Specifies that responses should provide arrays of floats for each embedding." + }, + { + "name": "base64", + "value": "base64", + "description": "Specifies that responses should provide a base64-encoded string for each embedding." + } + ] + }, + "x-ms-client-name": "encodingFormat" + }, + "dimensions": { + "type": "integer", + "format": "int32", + "description": "The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models." + }, + "input_type": { + "type": "string", + "description": "When using Azure OpenAI, specifies the input type to use for embedding search.", + "x-ms-client-name": "inputType" + } + }, + "required": [ + "input" + ] + }, + "EmbeddingsUsage": { + "type": "object", + "description": "Measurement of the amount of tokens used in this request and response.", + "properties": { + "prompt_tokens": { + "type": "integer", + "format": "int32", + "description": "Number of tokens sent in the original request.", + "x-ms-client-name": "promptTokens" + }, + "total_tokens": { + "type": "integer", + "format": "int32", + "description": "Total number of tokens transacted in this request/response.", + "x-ms-client-name": "totalTokens" + } + }, + "required": [ + "prompt_tokens", + "total_tokens" + ] + }, + "FunctionCall": { + "type": "object", + "description": "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.\nNote that the model does not always generate valid JSON, and may hallucinate parameters\nnot defined by your function schema. Validate the arguments in your code before calling\nyour function." + } + }, + "required": [ + "name", + "arguments" + ] + }, + "FunctionDefinition": { + "type": "object", + "description": "The definition of a caller-specified function that chat completions may invoke in response to matching user input.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to be called." + }, + "description": { + "type": "string", + "description": "A description of what the function does. The model will use this description when selecting the function and\ninterpreting its parameters." + }, + "parameters": { + "description": "The parameters the function accepts, described as a JSON Schema object." + } + }, + "required": [ + "name" + ] + }, + "ImageGenerationContentFilterResults": { + "type": "object", + "description": "Describes the content filtering result for the image generation request.", + "properties": { + "sexual": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to anatomical organs and genitals, romantic relationships,\n acts portrayed in erotic or affectionate terms, physical sexual acts, including\n those portrayed as an assault or a forced sexual violent act against one’s will,\n prostitution, pornography, and abuse." + }, + "violence": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to physical actions intended to hurt, injure, damage, or\nkill someone or something; describes weapons, etc." + }, + "hate": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language attacks or uses that include pejorative or discriminatory language\nwith reference to a person or identity group on the basis of certain differentiating\nattributes of these groups including but not limited to race, ethnicity, nationality,\ngender identity and expression, sexual orientation, religion, immigration status, ability\nstatus, personal appearance, and body size." + }, + "self_harm": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to physical actions intended to purposely hurt, injure,\nor damage one’s body, or kill oneself.", + "x-ms-client-name": "selfHarm" + } + } + }, + "ImageGenerationData": { + "type": "object", + "description": "A representation of a single generated image, provided as either base64-encoded data or as a URL from which the image\nmay be retrieved.", + "properties": { + "url": { + "type": "string", + "format": "uri", + "description": "The URL that provides temporary access to download the generated image." + }, + "b64_json": { + "type": "string", + "description": "The complete data for an image, represented as a base64-encoded string.", + "x-ms-client-name": "base64Data" + }, + "content_filter_results": { + "$ref": "#/definitions/ImageGenerationContentFilterResults", + "description": "Information about the content filtering results.", + "x-ms-client-name": "contentFilterResults" + }, + "revised_prompt": { + "type": "string", + "description": "The final prompt used by the model to generate the image.\nOnly provided with dall-3-models and only when revisions were made to the prompt.", + "x-ms-client-name": "revisedPrompt" + }, + "prompt_filter_results": { + "$ref": "#/definitions/ImageGenerationPromptFilterResults", + "description": "Information about the content filtering category (hate, sexual, violence, self_harm), if\nit has been detected, as well as the severity level (very_low, low, medium, high-scale\nthat determines the intensity and risk level of harmful content) and if it has been\nfiltered or not. Information about jailbreak content and profanity, if it has been detected,\nand if it has been filtered or not. And information about customer block list, if it has\nbeen filtered and its id.", + "x-ms-client-name": "promptFilterResults" + } + } + }, + "ImageGenerationOptions": { + "type": "object", + "description": "Represents the request data used to generate images.", + "properties": { + "model": { + "type": "string", + "description": "The model name or Azure OpenAI model deployment name to use for image generation. If not specified, dall-e-2 will be\ninferred as a default." + }, + "prompt": { + "type": "string", + "description": "A description of the desired images." + }, + "n": { + "type": "integer", + "format": "int32", + "description": "The number of images to generate.\nDall-e-2 models support values between 1 and 10.\nDall-e-3 models only support a value of 1.", + "default": 1 + }, + "size": { + "type": "string", + "description": "The desired dimensions for generated images.\nDall-e-2 models support 256x256, 512x512, or 1024x1024.\nDall-e-3 models support 1024x1024, 1792x1024, or 1024x1792.", + "default": "1024x1024", + "enum": [ + "256x256", + "512x512", + "1024x1024", + "1792x1024", + "1024x1792" + ], + "x-ms-enum": { + "name": "ImageSize", + "modelAsString": true, + "values": [ + { + "name": "size256x256", + "value": "256x256", + "description": "Very small image size of 256x256 pixels.\nOnly supported with dall-e-2 models." + }, + { + "name": "size512x512", + "value": "512x512", + "description": "A smaller image size of 512x512 pixels.\nOnly supported with dall-e-2 models." + }, + { + "name": "size1024x1024", + "value": "1024x1024", + "description": "A standard, square image size of 1024x1024 pixels.\nSupported by both dall-e-2 and dall-e-3 models." + }, + { + "name": "size1792x1024", + "value": "1792x1024", + "description": "A wider image size of 1024x1792 pixels.\nOnly supported with dall-e-3 models." + }, + { + "name": "size1024x1792", + "value": "1024x1792", + "description": "A taller image size of 1792x1024 pixels.\nOnly supported with dall-e-3 models." + } + ] + } + }, + "response_format": { + "type": "string", + "description": "The format in which image generation response items should be presented.", + "default": "url", + "enum": [ + "url", + "b64_json" + ], + "x-ms-enum": { + "name": "ImageGenerationResponseFormat", + "modelAsString": true, + "values": [ + { + "name": "url", + "value": "url", + "description": "Image generation response items should provide a URL from which the image may be retrieved." + }, + { + "name": "base64", + "value": "b64_json", + "description": "Image generation response items should provide image data as a base64-encoded string." + } + ] + }, + "x-ms-client-name": "responseFormat" + }, + "quality": { + "type": "string", + "description": "The desired image generation quality level to use.\nOnly configurable with dall-e-3 models.", + "default": "standard", + "enum": [ + "standard", + "hd" + ], + "x-ms-enum": { + "name": "ImageGenerationQuality", + "modelAsString": true, + "values": [ + { + "name": "standard", + "value": "standard", + "description": "Requests image generation with standard, balanced characteristics of quality, cost, and speed." + }, + { + "name": "hd", + "value": "hd", + "description": "Requests image generation with higher quality, higher cost and lower speed relative to standard." + } + ] + } + }, + "style": { + "type": "string", + "description": "The desired image generation style to use.\nOnly configurable with dall-e-3 models.", + "default": "vivid", + "enum": [ + "natural", + "vivid" + ], + "x-ms-enum": { + "name": "ImageGenerationStyle", + "modelAsString": true, + "values": [ + { + "name": "natural", + "value": "natural", + "description": "Requests image generation in a natural style with less preference for dramatic and hyper-realistic characteristics." + }, + { + "name": "vivid", + "value": "vivid", + "description": "Requests image generation in a vivid style with a higher preference for dramatic and hyper-realistic\ncharacteristics." + } + ] + } + }, + "user": { + "type": "string", + "description": "A unique identifier representing your end-user, which can help to monitor and detect abuse." + } + }, + "required": [ + "prompt" + ] + }, + "ImageGenerationPromptFilterResults": { + "type": "object", + "description": "Describes the content filtering results for the prompt of a image generation request.", + "properties": { + "sexual": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to anatomical organs and genitals, romantic relationships,\n acts portrayed in erotic or affectionate terms, physical sexual acts, including\n those portrayed as an assault or a forced sexual violent act against one’s will,\n prostitution, pornography, and abuse." + }, + "violence": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to physical actions intended to hurt, injure, damage, or\nkill someone or something; describes weapons, etc." + }, + "hate": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language attacks or uses that include pejorative or discriminatory language\nwith reference to a person or identity group on the basis of certain differentiating\nattributes of these groups including but not limited to race, ethnicity, nationality,\ngender identity and expression, sexual orientation, religion, immigration status, ability\nstatus, personal appearance, and body size." + }, + "self_harm": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to physical actions intended to purposely hurt, injure,\nor damage one’s body, or kill oneself.", + "x-ms-client-name": "selfHarm" + }, + "profanity": { + "$ref": "#/definitions/ContentFilterDetectionResult", + "description": "Describes whether profanity was detected." + }, + "jailbreak": { + "$ref": "#/definitions/ContentFilterDetectionResult", + "description": "Whether a jailbreak attempt was detected in the prompt." + }, + "custom_blocklists": { + "$ref": "#/definitions/ContentFilterDetailedResults", + "description": "Information about customer block lists and if something was detected the associated list ID.", + "x-ms-client-name": "customBlocklists" + } + } + }, + "ImageGenerations": { + "type": "object", + "description": "The result of a successful image generation operation.", + "properties": { + "created": { + "type": "integer", + "format": "unixtime", + "description": "A timestamp representing when this operation was started.\nExpressed in seconds since the Unix epoch of 1970-01-01T00:00:00+0000." + }, + "data": { + "type": "array", + "description": "The images generated by the operation.", + "items": { + "$ref": "#/definitions/ImageGenerationData" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "created", + "data" + ] + }, + "MaxTokensFinishDetails": { + "type": "object", + "description": "A structured representation of a stop reason that signifies a token limit was reached before the model could naturally\ncomplete.", + "allOf": [ + { + "$ref": "#/definitions/ChatFinishDetails" + } + ], + "x-ms-discriminator-value": "max_tokens" + }, + "OnYourDataAccessTokenAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using access token.", + "properties": { + "access_token": { + "type": "string", + "description": "The access token to use for authentication.", + "x-ms-client-name": "accessToken" + } + }, + "required": [ + "access_token" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "access_token" + }, + "OnYourDataApiKeyAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using an API key.", + "properties": { + "key": { + "type": "string", + "description": "The API key to use for authentication." + } + }, + "required": [ + "key" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "api_key" + }, + "OnYourDataAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data.", + "properties": { + "type": { + "$ref": "#/definitions/OnYourDataAuthenticationType", + "description": "The authentication type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "OnYourDataAuthenticationType": { + "type": "string", + "description": "The authentication types supported with Azure OpenAI On Your Data.", + "enum": [ + "api_key", + "connection_string", + "key_and_key_id", + "encoded_api_key", + "access_token", + "system_assigned_managed_identity", + "user_assigned_managed_identity" + ], + "x-ms-enum": { + "name": "OnYourDataAuthenticationType", + "modelAsString": true, + "values": [ + { + "name": "apiKey", + "value": "api_key", + "description": "Authentication via API key." + }, + { + "name": "connectionString", + "value": "connection_string", + "description": "Authentication via connection string." + }, + { + "name": "keyAndKeyId", + "value": "key_and_key_id", + "description": "Authentication via key and key ID pair." + }, + { + "name": "encodedApiKey", + "value": "encoded_api_key", + "description": "Authentication via encoded API key." + }, + { + "name": "accessToken", + "value": "access_token", + "description": "Authentication via access token." + }, + { + "name": "systemAssignedManagedIdentity", + "value": "system_assigned_managed_identity", + "description": "Authentication via system-assigned managed identity." + }, + { + "name": "userAssignedManagedIdentity", + "value": "user_assigned_managed_identity", + "description": "Authentication via user-assigned managed identity." + } + ] + } + }, + "OnYourDataConnectionStringAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using a connection string.", + "properties": { + "connection_string": { + "type": "string", + "description": "The connection string to use for authentication.", + "x-ms-client-name": "connectionString" + } + }, + "required": [ + "connection_string" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "connection_string" + }, + "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." + } + ] + } + }, + "OnYourDataDeploymentNameVectorizationSource": { + "type": "object", + "description": "The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based\non an internal embeddings model deployment name in the same Azure OpenAI resource.", + "properties": { + "deployment_name": { + "type": "string", + "description": "The embedding model deployment name within the same Azure OpenAI resource. This enables you to use vector search without Azure OpenAI api-key and without Azure OpenAI public network access.", + "x-ms-client-name": "deploymentName" + }, + "dimensions": { + "type": "integer", + "format": "int32", + "description": "The number of dimensions the embeddings should have. Only supported in `text-embedding-3` and later models." + } + }, + "required": [ + "deployment_name" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataVectorizationSource" + } + ], + "x-ms-discriminator-value": "deployment_name" + }, + "OnYourDataEncodedApiKeyAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using an Elasticsearch encoded API key.", + "properties": { + "encoded_api_key": { + "type": "string", + "description": "The encoded API key to use for authentication.", + "x-ms-client-name": "encodedApiKey" + } + }, + "required": [ + "encoded_api_key" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "encoded_api_key" + }, + "OnYourDataEndpointVectorizationSource": { + "type": "object", + "description": "The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based\non a public Azure OpenAI endpoint call for embeddings.", + "properties": { + "endpoint": { + "type": "string", + "format": "uri", + "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." + }, + "authentication": { + "$ref": "#/definitions/OnYourDataVectorSearchAuthenticationOptions", + "description": "Specifies the authentication options to use when retrieving embeddings from the specified endpoint." + } + }, + "required": [ + "endpoint", + "authentication" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataVectorizationSource" + } + ], + "x-ms-discriminator-value": "endpoint" + }, + "OnYourDataKeyAndKeyIdAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using an Elasticsearch key and key ID pair.", + "properties": { + "key": { + "type": "string", + "description": "The key to use for authentication." + }, + "key_id": { + "type": "string", + "description": "The key ID to use for authentication.", + "x-ms-client-name": "keyId" + } + }, + "required": [ + "key", + "key_id" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "key_and_key_id" + }, + "OnYourDataModelIdVectorizationSource": { + "type": "object", + "description": "The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based\non a search service model ID. Currently only supported by Elasticsearch®.", + "properties": { + "model_id": { + "type": "string", + "description": "The embedding model ID build inside the search service. Currently only supported by Elasticsearch®.", + "x-ms-client-name": "modelId" + } + }, + "required": [ + "model_id" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataVectorizationSource" + } + ], + "x-ms-discriminator-value": "model_id" + }, + "OnYourDataSystemAssignedManagedIdentityAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity.", + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "system_assigned_managed_identity" + }, + "OnYourDataUserAssignedManagedIdentityAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity.", + "properties": { + "managed_identity_resource_id": { + "type": "string", + "description": "The resource ID of the user-assigned managed identity to use for authentication.", + "x-ms-client-name": "managedIdentityResourceId" + } + }, + "required": [ + "managed_identity_resource_id" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "user_assigned_managed_identity" + }, + "OnYourDataVectorSearchAccessTokenAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data vector search when using access token.", + "properties": { + "access_token": { + "type": "string", + "description": "The access token to use for authentication.", + "x-ms-client-name": "accessToken" + } + }, + "required": [ + "access_token" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataVectorSearchAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "access_token" + }, + "OnYourDataVectorSearchApiKeyAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using an API key.", + "properties": { + "key": { + "type": "string", + "description": "The API key to use for authentication." + } + }, + "required": [ + "key" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataVectorSearchAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "api_key" + }, + "OnYourDataVectorSearchAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data vector search.", + "properties": { + "type": { + "$ref": "#/definitions/OnYourDataVectorSearchAuthenticationType", + "description": "The type of authentication to use." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "OnYourDataVectorSearchAuthenticationType": { + "type": "string", + "description": "The authentication types supported with Azure OpenAI On Your Data vector search.", + "enum": [ + "api_key", + "access_token" + ], + "x-ms-enum": { + "name": "OnYourDataVectorSearchAuthenticationType", + "modelAsString": true, + "values": [ + { + "name": "apiKey", + "value": "api_key", + "description": "Authentication via API key." + }, + { + "name": "accessToken", + "value": "access_token", + "description": "Authentication via access token." + } + ] + } + }, + "OnYourDataVectorizationSource": { + "type": "object", + "description": "An abstract representation of a vectorization source for Azure OpenAI On Your Data with vector search.", + "properties": { + "type": { + "$ref": "#/definitions/OnYourDataVectorizationSourceType", + "description": "The type of vectorization source to use." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "OnYourDataVectorizationSourceType": { + "type": "string", + "description": "Represents the available sources Azure OpenAI On Your Data can use to configure vectorization of data for use with\nvector search.", + "enum": [ + "endpoint", + "deployment_name", + "model_id" + ], + "x-ms-enum": { + "name": "OnYourDataVectorizationSourceType", + "modelAsString": true, + "values": [ + { + "name": "endpoint", + "value": "endpoint", + "description": "Represents vectorization performed by public service calls to an Azure OpenAI embedding model." + }, + { + "name": "deploymentName", + "value": "deployment_name", + "description": "Represents an Ada model deployment name to use. This model deployment must be in the same Azure OpenAI resource, but\nOn Your Data will use this model deployment via an internal call rather than a public one, which enables vector\nsearch even in private networks." + }, + { + "name": "modelId", + "value": "model_id", + "description": "Represents a specific embedding model ID as defined in the search service.\nCurrently only supported by Elasticsearch®." + } + ] + } + }, + "PineconeChatExtensionConfiguration": { + "type": "object", + "description": "A specific representation of configurable options for Pinecone when using it as an Azure OpenAI chat\nextension.", + "properties": { + "parameters": { + "$ref": "#/definitions/PineconeChatExtensionParameters", + "description": "The parameters to use when configuring Azure OpenAI chat extensions." + } + }, + "required": [ + "parameters" + ], + "allOf": [ + { + "$ref": "#/definitions/AzureChatExtensionConfiguration" + } + ], + "x-ms-discriminator-value": "pinecone" + }, + "PineconeChatExtensionParameters": { + "type": "object", + "description": "Parameters for configuring Azure OpenAI Pinecone chat extensions. The supported authentication type is APIKey.", + "properties": { + "authentication": { + "$ref": "#/definitions/OnYourDataAuthenticationOptions", + "description": "The authentication method to use when accessing the defined data source.\nEach data source type supports a specific set of available authentication methods; please see the documentation of\nthe data source for supported mechanisms.\nIf not otherwise provided, On Your Data will attempt to use System Managed Identity (default credential)\nauthentication." + }, + "top_n_documents": { + "type": "integer", + "format": "int32", + "description": "The configured top number of documents to feature for the configured query.", + "x-ms-client-name": "topNDocuments" + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data.", + "x-ms-client-name": "inScope" + }, + "strictness": { + "type": "integer", + "format": "int32", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "minimum": 1, + "maximum": 5 + }, + "role_information": { + "type": "string", + "description": "Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit.", + "x-ms-client-name": "roleInformation" + }, + "max_search_queries": { + "type": "integer", + "format": "int32", + "description": "The max number of rewritten queries should be send to search provider for one user message. If not specified,\nthe system will decide the number of queries to send.", + "x-ms-client-name": "maxSearchQueries" + }, + "allow_partial_result": { + "type": "boolean", + "description": "If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail.\nIf not specified, or specified as false, the request will fail if any search query fails.", + "default": false, + "x-ms-client-name": "allowPartialResult" + }, + "include_contexts": { + "type": "array", + "description": "The included properties of the output context. If not specified, the default value is `citations` and `intent`.", + "items": { + "$ref": "#/definitions/OnYourDataContextProperty" + }, + "x-ms-client-name": "includeContexts" + }, + "environment": { + "type": "string", + "description": "The environment name of Pinecone." + }, + "index_name": { + "type": "string", + "description": "The name of the Pinecone database index.", + "x-ms-client-name": "indexName" + }, + "fields_mapping": { + "$ref": "#/definitions/PineconeFieldMappingOptions", + "description": "Customized field mapping behavior to use when interacting with the search index.", + "x-ms-client-name": "fieldsMapping" + }, + "embedding_dependency": { + "$ref": "#/definitions/OnYourDataVectorizationSource", + "description": "The embedding dependency for vector search.", + "x-ms-client-name": "embeddingDependency" + } + }, + "required": [ + "environment", + "index_name", + "fields_mapping", + "embedding_dependency" + ] + }, + "PineconeFieldMappingOptions": { + "type": "object", + "description": "Optional settings to control how fields are processed when using a configured Pinecone resource.", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title.", + "x-ms-client-name": "titleField" + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL.", + "x-ms-client-name": "urlField" + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath.", + "x-ms-client-name": "filepathField" + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + }, + "x-ms-client-name": "contentFields" + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use.", + "x-ms-client-name": "contentFieldsSeparator" + } + }, + "required": [ + "content_fields" + ] + }, + "SpeechGenerationOptions": { + "type": "object", + "description": "A representation of the request options that control the behavior of a text-to-speech operation.", + "properties": { + "input": { + "type": "string", + "description": "The text to generate audio for. The maximum length is 4096 characters.", + "maxLength": 4096 + }, + "voice": { + "$ref": "#/definitions/SpeechVoice", + "description": "The voice to use for text-to-speech." + }, + "response_format": { + "type": "string", + "description": "The audio output format for the spoken text. By default, the MP3 format will be used.", + "default": "mp3", + "enum": [ + "mp3", + "opus", + "aac", + "flac", + "wav", + "pcm" + ], + "x-ms-enum": { + "name": "SpeechGenerationResponseFormat", + "modelAsString": true, + "values": [ + { + "name": "mp3", + "value": "mp3", + "description": "Use MP3 as the audio output format. MP3 is the default, general-purpose format." + }, + { + "name": "opus", + "value": "opus", + "description": "Use Opus as the audio output format. Opus is optimized for internet streaming and low latency." + }, + { + "name": "aac", + "value": "aac", + "description": "Use AAC as the audio output format. AAC is optimized for digital audio compression and is preferred by YouTube, Android, and iOS." + }, + { + "name": "flac", + "value": "flac", + "description": "Use FLAC as the audio output format. FLAC is a fully lossless format optimized for maximum quality at the expense of size." + }, + { + "name": "wav", + "value": "wav", + "description": "Use uncompressed WAV as the audio output format, suitable for low-latency applications to avoid decoding overhead." + }, + { + "name": "pcm", + "value": "pcm", + "description": "Use uncompressed PCM as the audio output format, which is similar to WAV but contains raw samples in 24kHz (16-bit signed, low-endian), without the header." + } + ] + }, + "x-ms-client-name": "responseFormat" + }, + "speed": { + "type": "number", + "format": "float", + "description": "The speed of speech for generated audio. Values are valid in the range from 0.25 to 4.0, with 1.0 the default and higher values corresponding to faster speech.", + "default": 1, + "minimum": 0.25, + "maximum": 4 + }, + "model": { + "type": "string", + "description": "The model to use for this text-to-speech request." + } + }, + "required": [ + "input", + "voice" + ] + }, + "SpeechVoice": { + "type": "string", + "description": "The available voices for text-to-speech.", + "enum": [ + "alloy", + "echo", + "fable", + "onyx", + "nova", + "shimmer" + ], + "x-ms-enum": { + "name": "SpeechVoice", + "modelAsString": true, + "values": [ + { + "name": "alloy", + "value": "alloy", + "description": "The Alloy voice." + }, + { + "name": "echo", + "value": "echo", + "description": "The Echo voice." + }, + { + "name": "fable", + "value": "fable", + "description": "The Fable voice." + }, + { + "name": "onyx", + "value": "onyx", + "description": "The Onyx voice." + }, + { + "name": "nova", + "value": "nova", + "description": "The Nova voice." + }, + { + "name": "shimmer", + "value": "shimmer", + "description": "The Shimmer voice." + } + ] + } + }, + "StopFinishDetails": { + "type": "object", + "description": "A structured representation of a stop reason that signifies natural termination by the model.", + "properties": { + "stop": { + "type": "string", + "description": "The token sequence that the model terminated with." + } + }, + "required": [ + "stop" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatFinishDetails" + } + ], + "x-ms-discriminator-value": "stop" + } + }, + "parameters": { + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + }, + "GenerateSpeechFromTextBody": { + "name": "body", + "in": "body", + "description": "A representation of the request options that control the behavior of a text-to-speech operation.", + "required": true, + "schema": { + "$ref": "#/definitions/SpeechGenerationOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetChatCompletionsBody": { + "name": "body", + "in": "body", + "description": "The configuration information for a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "required": true, + "schema": { + "$ref": "#/definitions/ChatCompletionsOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetCompletionsBody": { + "name": "body", + "in": "body", + "description": "The configuration information for a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", + "required": true, + "schema": { + "$ref": "#/definitions/CompletionsOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetEmbeddingsBody": { + "name": "body", + "in": "body", + "description": "The configuration information for an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", + "required": true, + "schema": { + "$ref": "#/definitions/EmbeddingsOptions" + }, + "x-ms-parameter-location": "method" + }, + "GetImageGenerationsBody": { + "name": "body", + "in": "body", + "description": "Represents the request data used to generate images.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageGenerationOptions" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/commit_block_list.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/commit_block_list.json new file mode 100644 index 000000000000..00d23c4a02a8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/commit_block_list.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "blockList": [ + { + "kind": "Uncommitted", + "id": "AAA=" + }, + { + "kind": "Uncommitted", + "id": "AAE=" + }, + { + "kind": "Uncommitted", + "id": "AAI=" + } + ] + }, + "responses": { + "200": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/copy_model_with_authorization.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/copy_model_with_authorization.json new file mode 100644 index 000000000000..d2d60144ecee --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/copy_model_with_authorization.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "modelCopyAuthorization": { + "targetResourceRegion": "westus2", + "targetResourceId": "/subscriptions/targetSubscriptionId/resourceGroups/targetResourceGroupName/providers/Microsoft.CognitiveServices/accounts/targetSpeechResourceName", + "targetResourceEndpoint": "https://westus.api.cognitive.microsoft.com/speechtotext/models?api-version=2024-05-15-preview", + "sourceResourceId": "/subscriptions/sourceSubscriptionId/resourceGroups/sourceResourceGroupName/providers/Microsoft.CognitiveServices/accounts/sourceSpeechResourceName", + "expirationDateTime": "2019-01-07T11:34:12Z", + "id": "d61573c6-788b-4eff-b3f5-38a1c7a9585b" + }, + "Content-Type": "application/json" + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "https://westus.api.cognitive.microsoft.com/speechtotext/operations/models/copy/E30F6A27-82BE-4CCA-9258-0399C70489FF?api-version=2024-05-15-preview" + }, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/operations/models/copy/E30F6A27-82BE-4CCA-9258-0399C70489FF?api-version=2024-05-15-preview", + "createdDateTime": "2019-01-07T11:34:12Z", + "lastActionDateTime": "2019-01-07T11:34:12Z", + "status": "NotStarted", + "id": "e30f6a27-82be-4cca-9258-0399c70489ff" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_container_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_container_transcription.json new file mode 100644 index 000000000000..af95823b4214 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_container_transcription.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "transcription": { + "contentContainerUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/audiofiles/", + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "timeToLive": "P2D" + }, + "locale": "en-US", + "displayName": "Transcription of storage container using default model for en-US" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview" + }, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-05-15-preview" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S", + "timeToLive": "P2D" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_copy_model_authorization.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_copy_model_authorization.json new file mode 100644 index 000000000000..5fdf322b084b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_copy_model_authorization.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "modelCopyAuthorizationDefinition": { + "sourceResourceId": "/subscriptions/sourceSubscriptionId/resourceGroups/sourceResourceGroupName/providers/Microsoft.CognitiveServices/accounts/sourceSpeechResourceName" + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "targetResourceRegion": "westus2", + "targetResourceId": "/subscriptions/targetSubscriptionId/resourceGroups/targetResourceGroupName/providers/Microsoft.CognitiveServices/accounts/targetSpeechResourceName", + "targetResourceEndpoint": "https://westus.api.cognitive.microsoft.com/speechtotext/models?api-version=2024-05-15-preview", + "sourceResourceId": "/subscriptions/sourceSubscriptionId/resourceGroups/sourceResourceGroupName/providers/Microsoft.CognitiveServices/accounts/sourceSpeechResourceName", + "expirationDateTime": "2019-01-07T11:34:12Z", + "id": "d61573c6-788b-4eff-b3f5-38a1c7a9585b" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_dataset_with_blocks.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_dataset_with_blocks.json new file mode 100644 index 000000000000..0ddcf0da45c6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_dataset_with_blocks.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "dataset": { + "kind": "Acoustic", + "locale": "en-US", + "displayName": "My speech dataset name", + "description": "My speech dataset description" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview", + "kind": "Acoustic", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview/files?api-version=2024-05-15-preview", + "commitBlocks": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview/blocks:commit?api-version=2024-05-15-preview", + "listBlocks": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview/blocks?api-version=2024-05-15-preview", + "uploadBlocks": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview/blocks?api-version=2024-05-15-preview" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "NotStarted", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_dataset_with_content_url.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_dataset_with_content_url.json new file mode 100644 index 000000000000..70e1ec609790 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_dataset_with_content_url.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "dataset": { + "kind": "Acoustic", + "contentUrl": "https://contoso.com/location", + "locale": "en-US", + "displayName": "My speech dataset name", + "description": "My speech dataset description" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" + }, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview", + "kind": "Acoustic", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?api-version=2024-05-15-preview" + }, + "properties": { + "textNormalizationKind": "Default", + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_endpoint.json new file mode 100644 index 000000000000..ef20de32e487 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_endpoint.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "endpoint": { + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "properties": { + "loggingEnabled": true + }, + "locale": "en-US", + "displayName": "Speech endpoint definition", + "description": "This is a speech endpoint" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6?api-version=2024-05-15-preview" + }, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs?api-version=2024-05-15-preview", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": true + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_evaluation.json new file mode 100644 index 000000000000..9295d8d65946 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_evaluation.json @@ -0,0 +1,117 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "evaluation": { + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" + }, + "locale": "en-US", + "displayName": "My new evaluation", + "description": "The description of the evaluation" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6?api-version=2024-05-15-preview" + }, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6?api-version=2024-05-15-preview", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f?api-version=2024-05-15-preview" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/00000000-0000-0000-0000-000000000000/files?api-version=2024-05-15-preview" + }, + "properties": { + "wordErrorRate1": 0.065, + "sentenceErrorRate1": 0.375, + "tokenErrorRate1": 0.125, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0, + "tokenCount1": 48, + "correctTokenCount1": 42, + "tokenSubstitutionCount1": 6, + "tokenDeletionCount1": 0, + "tokenInsertionCount1": 0, + "tokenErrors1": { + "punctuation": { + "numberOfEdits": 2, + "percentageOfAllEdits": 0.66 + }, + "capitalization": { + "numberOfEdits": 1, + "percentageOfAllEdits": 0.33 + } + }, + "wordErrorRate2": 0.065, + "sentenceErrorRate2": 0.375, + "tokenErrorRate2": 0.125, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "tokenCount2": 48, + "correctTokenCount2": 42, + "tokenSubstitutionCount2": 6, + "tokenDeletionCount2": 0, + "tokenInsertionCount2": 0, + "tokenErrors2": { + "punctuation": { + "numberOfEdits": 208, + "percentageOfAllEdits": 1.22 + }, + "capitalization": { + "numberOfEdits": 126, + "percentageOfAllEdits": 0.74 + }, + "inverseTextNormalization": { + "numberOfEdits": 409, + "percentageOfAllEdits": 2.4 + }, + "lexical": { + "numberOfEdits": 16284, + "percentageOfAllEdits": 95.41 + }, + "others": { + "numberOfEdits": 41, + "percentageOfAllEdits": 0.24 + } + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_lid_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_lid_transcription.json new file mode 100644 index 000000000000..d7648b4cdb2c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_lid_transcription.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "transcription": { + "contentUrls": [ + "https://contoso.com/mystoragelocation" + ], + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "timeToLive": "P2D", + "languageIdentification": { + "mode": "Single", + "candidateLocales": [ + "fr-FR", + "nl-NL", + "el-GR" + ], + "speechModelMapping": { + "nl-NL": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + } + } + } + }, + "locale": "fr-FR", + "displayName": "Transcription using language identification with three candidate languages, 'fr-FR' as fallback locale and a custom model for transcribing utterances that were classified as 'nl-NL' locale." + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-05-15-preview" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S", + "timeToLive": "P2D", + "languageIdentification": { + "mode": "Single", + "candidateLocales": [ + "fr-FR", + "nl-NL", + "el-GR" + ], + "speechModelMapping": { + "nl-NL": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + } + } + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "fr-FR", + "displayName": "Transcription using language identification with three candidate languages, 'fr-FR' as fallback locale and a custom model for transcribing utterances that were classified as 'nl-NL' locale.", + "customProperties": { + "key": "value" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_model.json new file mode 100644 index 000000000000..b405143d0c10 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_model.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "model": { + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-05-15-preview" + } + ], + "locale": "en-US", + "displayName": "Model with acoustic and language datasets" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-05-15-preview" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b:copy?api-version=2024-05-15-preview", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/files?api-version=2024-05-15-preview" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 30, + "features": { + "supportsTranscriptionsSubmit": true, + "supportsTranscriptionsTranscribe": false, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_model_with_weight.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_model_with_weight.json new file mode 100644 index 000000000000..cd8e5e89aa6e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_model_with_weight.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "model": { + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-05-15-preview" + } + ], + "properties": { + "customModelWeightPercent": 42 + }, + "locale": "en-US", + "displayName": "Model with acoustic and language datasets" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-05-15-preview" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b:copy?api-version=2024-05-15-preview", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/files?api-version=2024-05-15-preview" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 42, + "features": { + "supportsTranscriptionsSubmit": true, + "supportsTranscriptionsTranscribe": false, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_multispeaker_diarization_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_multispeaker_diarization_transcription.json new file mode 100644 index 000000000000..dfa866cd350a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_multispeaker_diarization_transcription.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "transcription": { + "contentUrls": [ + "https://contoso.com/mystoragelocation" + ], + "properties": { + "diarizationEnabled": true, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "timeToLive": "P2D", + "diarization": { + "speakers": { + "minCount": 3, + "maxCount": 5 + } + } + }, + "locale": "en-US", + "displayName": "Transcription using diarization for audio that is known to contain speech from 3-5 speakers" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-05-15-preview" + }, + "properties": { + "diarizationEnabled": true, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S", + "timeToLive": "P2D", + "diarization": { + "speakers": { + "minCount": 3, + "maxCount": 5 + } + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using diarization for audio that is known to contain speech from 3-5 speakers", + "customProperties": { + "key": "value" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_project.json new file mode 100644 index 000000000000..0b9163a1b064 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_project.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "project": { + "locale": "en-US", + "displayName": "My speech project" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0?api-version=2024-05-15-preview", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations?api-version=2024-05-15-preview", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets?api-version=2024-05-15-preview", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/models?api-version=2024-05-15-preview", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints?api-version=2024-05-15-preview", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions?api-version=2024-05-15-preview" + }, + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_simple_diarization_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_simple_diarization_transcription.json new file mode 100644 index 000000000000..2b361a53245a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_simple_diarization_transcription.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "transcription": { + "contentUrls": [ + "https://contoso.com/mystoragelocation" + ], + "properties": { + "diarizationEnabled": true, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "timeToLive": "P2D" + }, + "locale": "en-US", + "displayName": "Transcription using basic two-speaker diarization" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-05-15-preview" + }, + "properties": { + "diarizationEnabled": true, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S", + "timeToLive": "P2D" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using basic two-speaker diarization", + "customProperties": { + "key": "value" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_uri_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_uri_transcription.json new file mode 100644 index 000000000000..bde98d3572a3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_uri_transcription.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "transcription": { + "contentUrls": [ + "https://contoso.com/mystoragelocation", + "https://contoso.com/myotherstoragelocation" + ], + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "timeToLive": "P2D" + }, + "locale": "en-US", + "displayName": "Transcription using default model for en-US" + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-05-15-preview" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S", + "timeToLive": "P2D" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_web_hook.json new file mode 100644 index 000000000000..a659a5318140 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/create_web_hook.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "webHook": { + "displayName": "TranscriptionCompletionWebHook", + "properties": { + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription." + }, + "Content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d?api-version=2024-05-15-preview" + }, + "body": { + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d?api-version=2024-05-15-preview", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test?api-version=2024-05-15-preview", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping?api-version=2024-05-15-preview" + }, + "properties": { + "apiVersion": "v2024-05-15-preview", + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2018-11-11T00:00:00Z", + "lastActionDateTime": "2018-11-28T00:00:00Z", + "status": "NotStarted" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_base_model_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_base_model_log.json new file mode 100644 index 000000000000..53c17dc2f5c9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_base_model_log.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "locale": "Acoustic", + "logId": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_base_model_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_base_model_logs.json new file mode 100644 index 000000000000..c021d89b9c6f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_base_model_logs.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "locale": "Acoustic", + "endDate": "2019-01-01" + }, + "responses": { + "202": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_dataset.json new file mode 100644 index 000000000000..49c0c55a3239 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_dataset.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_endpoint.json new file mode 100644 index 000000000000..bce9b23586c7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_endpoint.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_endpoint_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_endpoint_log.json new file mode 100644 index 000000000000..a65662272748 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_endpoint_log.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6", + "logId": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_endpoint_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_endpoint_logs.json new file mode 100644 index 000000000000..95172a3ab6b9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_endpoint_logs.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6", + "endDate": "2019-01-01" + }, + "responses": { + "202": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_evaluation.json new file mode 100644 index 000000000000..94a60fdb220c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_evaluation.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "1c50ce42-6ab7-454f-8c39-54a752d1a5b6" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_model.json new file mode 100644 index 000000000000..de1d640a1c18 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_model.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "827712a5-f942-4997-91c3-7c6cde35600b" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_project.json new file mode 100644 index 000000000000..707d84f3e38c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_project.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "abc46f33-90b8-443d-adad-4870517356e0" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_transcription.json new file mode 100644 index 000000000000..cedd7a357901 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_transcription.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_web_hook.json new file mode 100644 index 000000000000..d8d31c16d729 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/delete_web_hook.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "2e856efe-ef53-465a-a632-6a084c1d349d" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_acoustic_datasets.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_acoustic_datasets.json new file mode 100644 index 000000000000..c0e66a6e2c59 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_acoustic_datasets.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "skip": 0, + "top": 10, + "filter": "kind%20eq%20'Acoustic'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview", + "kind": "Acoustic", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?api-version=2024-05-15-preview" + }, + "properties": { + "textNormalizationKind": "Default", + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_base_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_base_model.json new file mode 100644 index 000000000000..b401a44b7abe --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_base_model.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "827712a5-f942-4997-91c3-7c6cde35600b" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "properties": { + "deprecationDates": { + "adaptationDateTime": "2022-11-04T00:00:00Z", + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "features": { + "supportsTranscriptionsSubmit": true, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": true, + "supportsTranscriptionsTranscribe": true, + "supportsAdaptationsWith": [ + "Language", + "Acoustic" + ], + "supportedOutputFormats": [ + "Display", + "Lexical" + ] + }, + "chargeForAdaptation": true + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "en-US Base model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_base_model_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_base_model_log.json new file mode 100644 index 000000000000..f089e53562a0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_base_model_log.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "locale": "Acoustic", + "logId": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "sasValidityInSeconds": 120 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?api-version=2024-05-15-preview", + "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "kind": "Audio", + "properties": { + "size": 12345 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_base_model_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_base_model_logs.json new file mode 100644 index 000000000000..cfcd64bcfb28 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_base_model_logs.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "locale": "Acoustic", + "sasValidityInSeconds": 120, + "skipToken": "2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--", + "top": 2 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?api-version=2024-05-15-preview", + "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "kind": "Audio", + "properties": { + "size": 12345 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json?api-version=2024-05-15-preview", + "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json", + "kind": "Transcription", + "properties": { + "size": 12345 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/base/en-us/files/logs?top=2&skipToken=2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_base_model_manifest.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_base_model_manifest.json new file mode 100644 index 000000000000..ef8ca901e0f8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_base_model_manifest.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "sasValidityInSeconds": 120 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/02231df2-012f-45d4-9af0-8a3e4ccc877c?api-version=2024-05-15-preview" + }, + "modelFiles": [ + { + "name": "0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe", + "contentUrl": "https://https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "0_EN_US_V4.14_UNI/graphV2/base.lms", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/graphV2/base.lms?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.lms", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.lms?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.hclg", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.hclg?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.lms", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.lms?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + } + ], + "properties": { + "IN_FESpec": "audio(%MODELSPATH%0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe,8kHz16kHzLFB80EnergyMLPVADRuntime)", + "IN_DNNSpec": "dnn_spec(%MODELSPATH%0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am,40,20),allValidInUtt(1),frameCopyCount(1),resetOnSegmentation(1)", + "IN_HCLGSpecBase": "interpolated_lm_base(%MODELSPATH%0_EN_US_V4.14_UNI/graphV2/base.lms)", + "IN_HCLGSpec": "interpolated_lm_custom(0.9,%MODELSPATH%fc4fecb3-791a-4c47-88c0-043be3d4967e/graphV2/custom.i1.hclg,%MODELSPATH%fc4fecb3-791a-4c47-88c0-043be3d4967e/graphV2/custom.i1.lms,%MODELSPATH%fc4fecb3-791a-4c47-88c0-043be3d4967e/graphV2/custom.lms)", + "IN_BeamSize": 5000, + "IN_BeamThreshold": 190, + "IN_NBestBeamSize": 1 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset.json new file mode 100644 index 000000000000..1e20e8692c8d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview", + "kind": "Acoustic", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?api-version=2024-05-15-preview" + }, + "properties": { + "textNormalizationKind": "Default", + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset_blocks.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset_blocks.json new file mode 100644 index 000000000000..cc6da66cabd6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset_blocks.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "uncommittedBlocks": [ + { + "name": "AAA=", + "size": 123 + }, + { + "name": "AAE=", + "size": 234 + }, + { + "name": "AAI=", + "size": 345 + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset_file.json new file mode 100644 index 000000000000..c859f9d8320e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset_file.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "fileId": "ee4733cd-b1a7-4813-87e2-00d582c28a29", + "sasValidityInSeconds": 120 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2", + "name": "report.json", + "kind": "DatasetReport", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset_files.json new file mode 100644 index 000000000000..552a39033c38 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset_files.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "sasValidityInSeconds": 120, + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2", + "name": "report.json", + "kind": "DatasetReport", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/f035cf2d-4051-4131-85e7-97e3a7349c86?api-version=3.2", + "name": "language_data.txt", + "kind": "LanguageData", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/language_data.txt?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset_report_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset_report_files.json new file mode 100644 index 000000000000..741febb04a8e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_dataset_report_files.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "sasValidityInSeconds": 120, + "skip": 0, + "top": 10, + "filter": "kind%20eq%20'DatasetReport'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2", + "name": "report.json", + "kind": "DatasetReport", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_datasets.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_datasets.json new file mode 100644 index 000000000000..5274a36a5e6e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_datasets.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview", + "kind": "Acoustic", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?api-version=2024-05-15-preview" + }, + "properties": { + "textNormalizationKind": "Default", + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-05-15-preview", + "kind": "Language", + "contentUrl": "https://www.contoso.com/LanguageData/SourceLocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files?api-version=2024-05-15-preview" + }, + "properties": { + "textNormalizationKind": "Default", + "acceptedLineCount": 11, + "rejectedLineCount": 2 + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language dataset" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_endpoint.json new file mode 100644 index 000000000000..8c75cd382f0e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_endpoint.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs?api-version=2024-05-15-preview", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": true + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_endpoint_log.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_endpoint_log.json new file mode 100644 index 000000000000..39d496ab35fe --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_endpoint_log.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6", + "logId": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "sasValidityInSeconds": 120 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?api-version=2024-05-15-preview", + "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "kind": "Audio", + "properties": { + "size": 12345 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_endpoint_logs.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_endpoint_logs.json new file mode 100644 index 000000000000..9ea3cf31a554 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_endpoint_logs.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6", + "sasValidityInSeconds": 120, + "skipToken": "2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--", + "top": 2 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?api-version=2024-05-15-preview", + "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav", + "kind": "Audio", + "properties": { + "size": 12345 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json?api-version=2024-05-15-preview", + "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json", + "kind": "Transcription", + "properties": { + "size": 12345 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs?top=2&skipToken=2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_endpoints.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_endpoints.json new file mode 100644 index 000000000000..c0d53eb87926 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_endpoints.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs?api-version=2024-05-15-preview", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": true + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-05-15-preview" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs?api-version=2024-05-15-preview", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": false + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "NotStarted", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_english_base_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_english_base_models.json new file mode 100644 index 000000000000..b64a8a24e947 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_english_base_models.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "skip": 0, + "top": 2, + "filter": "locale%20eq%20'en-US'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "properties": { + "deprecationDates": { + "adaptationDateTime": "2022-11-04T00:00:00Z", + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "features": { + "supportsTranscriptionsSubmit": true, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": true, + "supportsTranscriptionsTranscribe": true, + "supportsAdaptationsWith": [ + "Language", + "Acoustic" + ], + "supportedOutputFormats": [ + "Display", + "Lexical" + ] + }, + "chargeForAdaptation": true + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "en-US Base model" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluation.json new file mode 100644 index 000000000000..5427c38552e8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluation.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "1c50ce42-6ab7-454f-8c39-54a752d1a5b6" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6?api-version=2024-05-15-preview", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f?api-version=2024-05-15-preview" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/00000000-0000-0000-0000-000000000000/files?api-version=2024-05-15-preview" + }, + "properties": { + "wordErrorRate1": 0.065, + "sentenceErrorRate1": 0.375, + "tokenErrorRate1": 0.125, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0, + "tokenCount1": 48, + "correctTokenCount1": 42, + "tokenSubstitutionCount1": 6, + "tokenDeletionCount1": 0, + "tokenInsertionCount1": 0, + "tokenErrors1": { + "punctuation": { + "numberOfEdits": 2, + "percentageOfAllEdits": 0.66 + }, + "capitalization": { + "numberOfEdits": 1, + "percentageOfAllEdits": 0.33 + } + }, + "wordErrorRate2": 0.065, + "sentenceErrorRate2": 0.375, + "tokenErrorRate2": 0.125, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "tokenCount2": 48, + "correctTokenCount2": 42, + "tokenSubstitutionCount2": 6, + "tokenDeletionCount2": 0, + "tokenInsertionCount2": 0, + "tokenErrors2": { + "punctuation": { + "numberOfEdits": 208, + "percentageOfAllEdits": 1.22 + }, + "capitalization": { + "numberOfEdits": 126, + "percentageOfAllEdits": 0.74 + }, + "inverseTextNormalization": { + "numberOfEdits": 409, + "percentageOfAllEdits": 2.4 + }, + "lexical": { + "numberOfEdits": 16284, + "percentageOfAllEdits": 95.41 + }, + "others": { + "numberOfEdits": 41, + "percentageOfAllEdits": 0.24 + } + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluation_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluation_file.json new file mode 100644 index 000000000000..19e994381bd0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluation_file.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "1c50ce42-6ab7-454f-8c39-54a752d1a5b6", + "fileId": "ee4733cd-b1a7-4813-87e2-00d582c28a29", + "sasValidityInSeconds": 120 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2", + "name": "mywavefile1.wav.model2_score.json", + "kind": "EvaluationDetails", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.model2_score.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluation_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluation_files.json new file mode 100644 index 000000000000..1f6a92654a21 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluation_files.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "1c50ce42-6ab7-454f-8c39-54a752d1a5b6", + "sasValidityInSeconds": 120, + "skip": 0, + "top": 2 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files/8ad6c551-9d6e-43f7-9649-94680899e77a?api-version=3.2", + "name": "mywavefile1.wav.model1_score.json", + "kind": "EvaluationDetails", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.model1_score.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2", + "name": "mywavefile1.wav.model2_score.json", + "kind": "EvaluationDetails", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.model2_score.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files?skip=2&top=2&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluations.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluations.json new file mode 100644 index 000000000000..68bfe7dc3950 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluations.json @@ -0,0 +1,195 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "skip": 0, + "top": 2 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/a55a327b-c866-40b3-a08d-9c0945738633?api-version=2024-05-15-preview", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f?api-version=2024-05-15-preview" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/00000000-0000-0000-0000-000000000000/files?api-version=2024-05-15-preview" + }, + "properties": { + "wordErrorRate1": 0.065, + "sentenceErrorRate1": 0.375, + "tokenErrorRate1": 0.125, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0, + "tokenCount1": 48, + "correctTokenCount1": 42, + "tokenSubstitutionCount1": 6, + "tokenDeletionCount1": 0, + "tokenInsertionCount1": 0, + "tokenErrors1": { + "punctuation": { + "numberOfEdits": 2, + "percentageOfAllEdits": 0.66 + }, + "capitalization": { + "numberOfEdits": 1, + "percentageOfAllEdits": 0.33 + } + }, + "wordErrorRate2": 0.065, + "sentenceErrorRate2": 0.375, + "tokenErrorRate2": 0.125, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "tokenCount2": 48, + "correctTokenCount2": 42, + "tokenSubstitutionCount2": 6, + "tokenDeletionCount2": 0, + "tokenInsertionCount2": 0, + "tokenErrors2": { + "punctuation": { + "numberOfEdits": 208, + "percentageOfAllEdits": 1.22 + }, + "capitalization": { + "numberOfEdits": 126, + "percentageOfAllEdits": 0.74 + }, + "inverseTextNormalization": { + "numberOfEdits": 409, + "percentageOfAllEdits": 2.4 + }, + "lexical": { + "numberOfEdits": 16284, + "percentageOfAllEdits": 95.41 + }, + "others": { + "numberOfEdits": 41, + "percentageOfAllEdits": 0.24 + } + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/daaa45a7-38f0-4918-87d2-bf55fec32ac5?api-version=2024-05-15-preview", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f?api-version=2024-05-15-preview" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/00000000-0000-0000-0000-000000000000/files?api-version=2024-05-15-preview" + }, + "properties": { + "wordErrorRate1": 0.065, + "sentenceErrorRate1": 0.375, + "tokenErrorRate1": 0.125, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0, + "tokenCount1": 48, + "correctTokenCount1": 42, + "tokenSubstitutionCount1": 6, + "tokenDeletionCount1": 0, + "tokenInsertionCount1": 0, + "tokenErrors1": { + "punctuation": { + "numberOfEdits": 2, + "percentageOfAllEdits": 0.66 + }, + "capitalization": { + "numberOfEdits": 1, + "percentageOfAllEdits": 0.33 + } + }, + "wordErrorRate2": 0.065, + "sentenceErrorRate2": 0.375, + "tokenErrorRate2": 0.125, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "tokenCount2": 48, + "correctTokenCount2": 42, + "tokenSubstitutionCount2": 6, + "tokenDeletionCount2": 0, + "tokenInsertionCount2": 0, + "tokenErrors2": { + "punctuation": { + "numberOfEdits": 208, + "percentageOfAllEdits": 1.22 + }, + "capitalization": { + "numberOfEdits": 126, + "percentageOfAllEdits": 0.74 + }, + "inverseTextNormalization": { + "numberOfEdits": 409, + "percentageOfAllEdits": 2.4 + }, + "lexical": { + "numberOfEdits": 16284, + "percentageOfAllEdits": 95.41 + }, + "others": { + "numberOfEdits": 41, + "percentageOfAllEdits": 0.24 + } + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files?skip=2&top=2&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluations_with_status_running.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluations_with_status_running.json new file mode 100644 index 000000000000..ece2ab500746 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_evaluations_with_status_running.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "skip": 0, + "top": 2, + "filter": "status%20eq%20'Running'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/f85a328c-c866-40b3-a08d-9c0945738633?api-version=2024-05-15-preview", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f?api-version=2024-05-15-preview" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/00000000-0000-0000-0000-000000000000/files?api-version=2024-05-15-preview" + }, + "properties": { + "wordErrorRate1": 0.89, + "sentenceErrorRate1": 0.375, + "tokenErrorRate1": 0.125, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0, + "tokenCount1": 48, + "correctTokenCount1": 42, + "tokenSubstitutionCount1": 6, + "tokenDeletionCount1": 0, + "tokenInsertionCount1": 0, + "wordErrorRate2": 0.98, + "sentenceErrorRate2": 0.375, + "tokenErrorRate2": 0.125, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "tokenCount2": 48, + "correctTokenCount2": 42, + "tokenSubstitutionCount2": 6, + "tokenDeletionCount2": 0, + "tokenInsertionCount2": 0 + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_failed_transcriptions.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_failed_transcriptions.json new file mode 100644 index 000000000000..6c868e16eb8a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_failed_transcriptions.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "skip": 0, + "top": 2, + "filter": "status%20eq%20'Failed'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview", + "contentUrls": [ + "https://contoso.com/", + "https://contoso2.com/" + ], + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-05-15-preview" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": true, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S", + "timeToLive": "P2D" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Failed", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model.json new file mode 100644 index 000000000000..664bca28f1aa --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "827712a5-f942-4997-91c3-7c6cde35600b" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-05-15-preview" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b:copy?api-version=2024-05-15-preview", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/files?api-version=2024-05-15-preview" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 30, + "features": { + "supportsTranscriptionsSubmit": true, + "supportsTranscriptionsTranscribe": false, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model_file.json new file mode 100644 index 000000000000..e6171a0c9892 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model_file.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "fileId": "ee4733cd-b1a7-4813-87e2-00d582c28a29", + "sasValidityInSeconds": 120 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2", + "name": "report.json", + "kind": "ModelReport", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model_files.json new file mode 100644 index 000000000000..9e401dbebb6b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model_files.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "sasValidityInSeconds": 120, + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2", + "name": "report.json", + "kind": "ModelReport", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/files?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model_manifest.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model_manifest.json new file mode 100644 index 000000000000..ef8ca901e0f8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model_manifest.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "sasValidityInSeconds": 120 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/02231df2-012f-45d4-9af0-8a3e4ccc877c?api-version=2024-05-15-preview" + }, + "modelFiles": [ + { + "name": "0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe", + "contentUrl": "https://https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "0_EN_US_V4.14_UNI/graphV2/base.lms", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/graphV2/base.lms?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.lms", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.lms?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.hclg", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.hclg?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.lms", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/02231df2-012f-45d4-9af0-8a3e4ccc877c/graphV2/custom.i1.lms?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + }, + { + "name": "0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am", + "contentUrl": "https://customspeech-usw.blob.core.windows.net/models/0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am?sv=2017-04-17&sr=b&sig=*****%3D&st=2019-01-09T15:56:05Z&se=2019-01-16T16:01:05Z&sp=rl" + } + ], + "properties": { + "IN_FESpec": "audio(%MODELSPATH%0_EN_US_V4.14_UNI/adaptedPrepAM/model.fe,8kHz16kHzLFB80EnergyMLPVADRuntime)", + "IN_DNNSpec": "dnn_spec(%MODELSPATH%0_EN_US_V4.14_UNI/adaptedPrepAM/model.dbn.am,40,20),allValidInUtt(1),frameCopyCount(1),resetOnSegmentation(1)", + "IN_HCLGSpecBase": "interpolated_lm_base(%MODELSPATH%0_EN_US_V4.14_UNI/graphV2/base.lms)", + "IN_HCLGSpec": "interpolated_lm_custom(0.9,%MODELSPATH%fc4fecb3-791a-4c47-88c0-043be3d4967e/graphV2/custom.i1.hclg,%MODELSPATH%fc4fecb3-791a-4c47-88c0-043be3d4967e/graphV2/custom.i1.lms,%MODELSPATH%fc4fecb3-791a-4c47-88c0-043be3d4967e/graphV2/custom.lms)", + "IN_BeamSize": 5000, + "IN_BeamThreshold": 190, + "IN_NBestBeamSize": 1 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model_with_weight.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model_with_weight.json new file mode 100644 index 000000000000..043f3e0c7672 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_model_with_weight.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "827712a5-f942-4997-91c3-7c6cde35600b" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-05-15-preview" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b:copy?api-version=2024-05-15-preview", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/files?api-version=2024-05-15-preview" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 42, + "features": { + "supportsTranscriptionsSubmit": true, + "supportsTranscriptionsTranscribe": false, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_not_started_endpoints.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_not_started_endpoints.json new file mode 100644 index 000000000000..aad5a685a3bf --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_not_started_endpoints.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "skip": 0, + "top": 2, + "filter": "status%20eq%20'NotStarted'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-05-15-preview" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs?api-version=2024-05-15-preview", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": false + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "NotStarted", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_operation_copy_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_operation_copy_model.json new file mode 100644 index 000000000000..3c4549dc69e8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_operation_copy_model.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "e30f6a27-82be-4cca-9258-0399c70489ff" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/operations/models/copy/e30f6a27-82be-4cca-9258-0399c70489ff?api-version=2024-05-15-preview", + "createdDateTime": "2019-01-07T11:34:12Z", + "lastActionDateTime": "2019-01-07T11:34:12Z", + "status": "Succeeded", + "id": "e30f6a27-82be-4cca-9258-0399c70489ff", + "result": { + "link": "https://westus.api.cognitive.microsoft.com/speechtotext/models/be640db7-c44b-47f2-bf6c-47e431d23d63?api-version=2024-05-15-preview" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_operation_copy_model_pending.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_operation_copy_model_pending.json new file mode 100644 index 000000000000..f8ca0c712939 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_operation_copy_model_pending.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "e30f6a27-82be-4cca-9258-0399c70489ff" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/operations/models/copy/E30F6A27-82BE-4CCA-9258-0399C70489FF?api-version=2024-05-15-preview", + "createdDateTime": "2019-01-07T11:34:12Z", + "lastActionDateTime": "2019-01-07T11:34:12Z", + "status": "NotStarted", + "id": "e30f6a27-82be-4cca-9258-0399c70489ff" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project.json new file mode 100644 index 000000000000..058dc3554926 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "abc46f33-90b8-443d-adad-4870517356e0" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0?api-version=2024-05-15-preview", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations?api-version=2024-05-15-preview", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets?api-version=2024-05-15-preview", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/models?api-version=2024-05-15-preview", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints?api-version=2024-05-15-preview", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions?api-version=2024-05-15-preview" + }, + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_datasets.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_datasets.json new file mode 100644 index 000000000000..fa6392fe86f0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_datasets.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview", + "kind": "Acoustic", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?api-version=2024-05-15-preview" + }, + "properties": { + "textNormalizationKind": "Default", + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-05-15-preview", + "kind": "Language", + "contentUrl": "https://www.contoso.com/LanguageData/SourceLocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files?api-version=2024-05-15-preview" + }, + "properties": { + "textNormalizationKind": "Default", + "acceptedLineCount": 11, + "rejectedLineCount": 2 + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language dataset" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_endpoints.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_endpoints.json new file mode 100644 index 000000000000..572dde67f24f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_endpoints.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs?api-version=2024-05-15-preview", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": true + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-05-15-preview" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs?api-version=2024-05-15-preview", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": false + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "NotStarted", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_evaluations.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_evaluations.json new file mode 100644 index 000000000000..ffae4c1862fd --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_evaluations.json @@ -0,0 +1,196 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "skip": 0, + "top": 2 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/a55a327b-c866-40b3-a08d-9c0945738633?api-version=2024-05-15-preview", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f?api-version=2024-05-15-preview" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/00000000-0000-0000-0000-000000000000/files?api-version=2024-05-15-preview" + }, + "properties": { + "wordErrorRate1": 0.065, + "sentenceErrorRate1": 0.375, + "tokenErrorRate1": 0.125, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0, + "tokenCount1": 48, + "correctTokenCount1": 42, + "tokenSubstitutionCount1": 6, + "tokenDeletionCount1": 0, + "tokenInsertionCount1": 0, + "tokenErrors1": { + "punctuation": { + "numberOfEdits": 2, + "percentageOfAllEdits": 0.66 + }, + "capitalization": { + "numberOfEdits": 1, + "percentageOfAllEdits": 0.33 + } + }, + "wordErrorRate2": 0.065, + "sentenceErrorRate2": 0.375, + "tokenErrorRate2": 0.125, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "tokenCount2": 48, + "correctTokenCount2": 42, + "tokenSubstitutionCount2": 6, + "tokenDeletionCount2": 0, + "tokenInsertionCount2": 0, + "tokenErrors2": { + "punctuation": { + "numberOfEdits": 208, + "percentageOfAllEdits": 1.22 + }, + "capitalization": { + "numberOfEdits": 126, + "percentageOfAllEdits": 0.74 + }, + "inverseTextNormalization": { + "numberOfEdits": 409, + "percentageOfAllEdits": 2.4 + }, + "lexical": { + "numberOfEdits": 16284, + "percentageOfAllEdits": 95.41 + }, + "others": { + "numberOfEdits": 41, + "percentageOfAllEdits": 0.24 + } + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/daaa45a7-38f0-4918-87d2-bf55fec32ac5?api-version=2024-05-15-preview", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f?api-version=2024-05-15-preview" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/00000000-0000-0000-0000-000000000000/files?api-version=2024-05-15-preview" + }, + "properties": { + "wordErrorRate1": 0.065, + "sentenceErrorRate1": 0.375, + "tokenErrorRate1": 0.125, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0, + "tokenCount1": 48, + "correctTokenCount1": 42, + "tokenSubstitutionCount1": 6, + "tokenDeletionCount1": 0, + "tokenInsertionCount1": 0, + "tokenErrors1": { + "punctuation": { + "numberOfEdits": 2, + "percentageOfAllEdits": 0.66 + }, + "capitalization": { + "numberOfEdits": 1, + "percentageOfAllEdits": 0.33 + } + }, + "wordErrorRate2": 0.065, + "sentenceErrorRate2": 0.375, + "tokenErrorRate2": 0.125, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "tokenCount2": 48, + "correctTokenCount2": 42, + "tokenSubstitutionCount2": 6, + "tokenDeletionCount2": 0, + "tokenInsertionCount2": 0, + "tokenErrors2": { + "punctuation": { + "numberOfEdits": 208, + "percentageOfAllEdits": 1.22 + }, + "capitalization": { + "numberOfEdits": 126, + "percentageOfAllEdits": 0.74 + }, + "inverseTextNormalization": { + "numberOfEdits": 409, + "percentageOfAllEdits": 2.4 + }, + "lexical": { + "numberOfEdits": 16284, + "percentageOfAllEdits": 95.41 + }, + "others": { + "numberOfEdits": 41, + "percentageOfAllEdits": 0.24 + } + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files?skip=2&top=2&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_models.json new file mode 100644 index 000000000000..2a9d18b00dbc --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_models.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "skip": 0, + "top": 2, + "filter": "status%20eq%20'Running'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-05-15-preview" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b:copy?api-version=2024-05-15-preview", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/files?api-version=2024-05-15-preview" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 30, + "features": { + "supportsTranscriptionsSubmit": true, + "supportsTranscriptionsTranscribe": false, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b?api-version=2024-05-15-preview", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/manifest/a04e77e6-2009-462c-8d1c-65d718ee4b7b?api-version=2024-05-15-preview", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b:copy?api-version=2024-05-15-preview", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b/files?api-version=2024-05-15-preview" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 30, + "features": { + "supportsTranscriptionsSubmit": true, + "supportsTranscriptionsTranscribe": false, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic model", + "description": "Example for an acoustic model" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/models?skip=2&top=2&filter=status%20eq%20'Running'&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_transcriptions.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_transcriptions.json new file mode 100644 index 000000000000..f90e489fb53a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_project_transcriptions.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-05-15-preview" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S", + "timeToLive": "P2D" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview", + "contentUrls": [ + "https://contoso.com/", + "https://contoso2.com/" + ], + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-05-15-preview" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": true, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S", + "timeToLive": "P2D" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Failed", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_projects.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_projects.json new file mode 100644 index 000000000000..1290dbd56dce --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_projects.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "skip": 0, + "top": 3 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0?api-version=2024-05-15-preview", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations?api-version=2024-05-15-preview", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets?api-version=2024-05-15-preview", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/models?api-version=2024-05-15-preview", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints?api-version=2024-05-15-preview", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions?api-version=2024-05-15-preview" + }, + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0?api-version=2024-05-15-preview", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations?api-version=2024-05-15-preview", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets?api-version=2024-05-15-preview", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/models?api-version=2024-05-15-preview", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints?api-version=2024-05-15-preview", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions?api-version=2024-05-15-preview" + }, + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0?api-version=2024-05-15-preview", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations?api-version=2024-05-15-preview", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets?api-version=2024-05-15-preview", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/models?api-version=2024-05-15-preview", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints?api-version=2024-05-15-preview", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions?api-version=2024-05-15-preview" + }, + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/projects?skip=3&top=3&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_projects_from_2018_and_2019.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_projects_from_2018_and_2019.json new file mode 100644 index 000000000000..f3a579e7ff7a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_projects_from_2018_and_2019.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "skip": 0, + "top": 3, + "filter": "createdDateTime%20ge%202018-01-01T00:00:00Z%20and%20createdDateTime%20lt%202020-01-01T00:00:00Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0?api-version=2024-05-15-preview", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations?api-version=2024-05-15-preview", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets?api-version=2024-05-15-preview", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/models?api-version=2024-05-15-preview", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints?api-version=2024-05-15-preview", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions?api-version=2024-05-15-preview" + }, + "createdDateTime": "2018-03-03T12:45:27Z", + "locale": "en-US", + "displayName": "My speech project" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0?api-version=2024-05-15-preview", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations?api-version=2024-05-15-preview", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets?api-version=2024-05-15-preview", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/models?api-version=2024-05-15-preview", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints?api-version=2024-05-15-preview", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions?api-version=2024-05-15-preview" + }, + "createdDateTime": "2018-12-19T17:54:57Z", + "locale": "en-US", + "displayName": "My speech project" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0?api-version=2024-05-15-preview", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations?api-version=2024-05-15-preview", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets?api-version=2024-05-15-preview", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/models?api-version=2024-05-15-preview", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints?api-version=2024-05-15-preview", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions?api-version=2024-05-15-preview" + }, + "createdDateTime": "2019-02-01T00:45:27Z", + "locale": "en-US", + "displayName": "My speech project" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/projects?skip=6&top=3&filter=createdDateTime%20ge%202018-01-01T00:00:00Z%20and%20createdDateTime%20lt%202020-01-01T00:00:00Z&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_running_models.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_running_models.json new file mode 100644 index 000000000000..8b9ea33fa89e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_running_models.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "skip": 0, + "top": 2, + "filter": "status%20eq%20'Running'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-05-15-preview" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b:copy?api-version=2024-05-15-preview", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/files?api-version=2024-05-15-preview" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 30, + "features": { + "supportsTranscriptionsSubmit": true, + "supportsTranscriptionsTranscribe": false, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b?api-version=2024-05-15-preview", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/manifest/a04e77e6-2009-462c-8d1c-65d718ee4b7b?api-version=2024-05-15-preview", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b:copy?api-version=2024-05-15-preview", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b/files?api-version=2024-05-15-preview" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 30, + "features": { + "supportsTranscriptionsSubmit": true, + "supportsTranscriptionsTranscribe": false, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic model", + "description": "Example for an acoustic model" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/models?skip=2&top=2&filter=status%20eq%20'Running'&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_dataset_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_dataset_locales.json new file mode 100644 index 000000000000..cb54a558a4f6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_dataset_locales.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "Acoustic": [ + "en-US", + "de-DE" + ], + "Language": [ + "en-US", + "de-DE" + ], + "Pronunciation": [ + "en-US" + ], + "AudioFiles": [ + "en-US", + "de-DE" + ], + "LanguageMarkdown": [ + "en-US" + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_endpoint_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_endpoint_locales.json new file mode 100644 index 000000000000..3cd62009d0a2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_endpoint_locales.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_evaluations_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_evaluations_locales.json new file mode 100644 index 000000000000..3cd62009d0a2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_evaluations_locales.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_model_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_model_locales.json new file mode 100644 index 000000000000..3cd62009d0a2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_model_locales.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_project_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_project_locales.json new file mode 100644 index 000000000000..3cd62009d0a2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_project_locales.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "en-US", + "de-DE" + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_transcription_locales.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_transcription_locales.json new file mode 100644 index 000000000000..6e26ea1d79d4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_supported_transcription_locales.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "Transcribe": [ + "en-US", + "de-DE" + ], + "Submit": [ + "en-US", + "de-DE", + "es-ES" + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcription.json new file mode 100644 index 000000000000..59397a438f0e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcription.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-05-15-preview" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S", + "timeToLive": "P2D" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcription_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcription_file.json new file mode 100644 index 000000000000..575da6b81ca5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcription_file.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683", + "sasValidityInSeconds": 120, + "fileId": "ee4733cd-b1a7-4813-87e2-00d582c28a29" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2", + "name": "mywavefile1.wav.json", + "kind": "Transcription", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcription_files.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcription_files.json new file mode 100644 index 000000000000..50c291161724 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcription_files.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683", + "sasValidityInSeconds": 120, + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2", + "name": "mywavefile1.wav.json", + "kind": "Transcription", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/28bc946b-c251-4a86-84f6-ea0f0a2373ef?api-version=3.2", + "name": "mywavefile2.wav.json", + "kind": "Transcription", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile2.wav.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?skip=2&top=2&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcription_files_filtered_by_name.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcription_files_filtered_by_name.json new file mode 100644 index 000000000000..c33851a9225c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcription_files_filtered_by_name.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683", + "sasValidityInSeconds": 120, + "skip": 0, + "top": 10, + "filter": "name%20eq%20'mywavefile1.wav.json'" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2", + "name": "mywavefile1.wav.json", + "kind": "Transcription", + "properties": { + "size": 200 + }, + "createdDateTime": "2020-01-13T08:00:00Z", + "links": { + "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcriptions.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcriptions.json new file mode 100644 index 000000000000..e0d6cf8df7e6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_transcriptions.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-05-15-preview" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S", + "timeToLive": "P2D" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + }, + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview", + "contentUrls": [ + "https://contoso.com/", + "https://contoso2.com/" + ], + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-05-15-preview" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": true, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S", + "timeToLive": "P2D" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Failed", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_web_hook.json new file mode 100644 index 000000000000..07fc723cea53 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_web_hook.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "2e856efe-ef53-465a-a632-6a084c1d349d" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d?api-version=2024-05-15-preview", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test?api-version=2024-05-15-preview", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping?api-version=2024-05-15-preview" + }, + "properties": { + "apiVersion": "v2024-05-15-preview", + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2018-11-11T00:00:00Z", + "lastActionDateTime": "2018-11-28T00:00:00Z", + "status": "Succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_web_hooks.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_web_hooks.json new file mode 100644 index 000000000000..c4df85cdadd1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_web_hooks.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202018-01-24T09:54:39Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/aff13a6e-17c4-4247-862f-70e99469c553?api-version=2024-05-15-preview", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test?api-version=2024-05-15-preview", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping?api-version=2024-05-15-preview" + }, + "properties": { + "apiVersion": "v2024-05-15-preview", + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2019-02-11T00:00:00Z", + "lastActionDateTime": "2019-02-28T00:00:00Z", + "status": "Succeeded" + }, + { + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/9db10a08-189e-4de4-b31a-38b39d993b37?api-version=2024-05-15-preview", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test?api-version=2024-05-15-preview", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping?api-version=2024-05-15-preview" + }, + "properties": { + "apiVersion": "v2024-05-15-preview", + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2018-11-11T00:00:00Z", + "lastActionDateTime": "2018-11-28T00:00:00Z", + "status": "Succeeded" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_web_hooks_from_march_2020.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_web_hooks_from_march_2020.json new file mode 100644 index 000000000000..d28d0b24e95a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/get_web_hooks_from_march_2020.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "skip": 0, + "top": 2, + "filter": "createdDateTime%20ge%202020-03-011T00:00:00Z%20and%20createdDateTime%20lt%202020-04-01T00:00:00Z" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "values": [ + { + "displayName": "A test web hook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/aff13a6e-17c4-4247-862f-70e99469c553?api-version=2024-05-15-preview", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test?api-version=2024-05-15-preview", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping?api-version=2024-05-15-preview" + }, + "properties": { + "apiVersion": "v2024-05-15-preview", + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2020-03-11T14:13:12Z", + "lastActionDateTime": "2020-03-11T14:13:12Z", + "status": "Succeeded" + }, + { + "displayName": "Beta version web hook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/9db10a08-189e-4de4-b31a-38b39d993b37?api-version=2024-05-15-preview", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test?api-version=2024-05-15-preview", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping?api-version=2024-05-15-preview" + }, + "properties": { + "apiVersion": "v2024-05-15-preview", + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2020-03-21T09:07:43Z", + "lastActionDateTime": "2020-03-21T09:07:43Z", + "status": "Succeeded" + } + ], + "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks?skip=2&top=2&filter=createdDateTime%20ge%202020-03-011T00:00:00Z%20and%20createdDateTime%20lt%202020-04-01T00:00:00Z&api-version=2024-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/ping_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/ping_web_hook.json new file mode 100644 index 000000000000..9ab0f36f99f2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/ping_web_hook.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "2e856efe-ef53-465a-a632-6a084c1d349d" + }, + "responses": { + "202": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/test_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/test_web_hook.json new file mode 100644 index 000000000000..6d6b5ccaf4d8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/test_web_hook.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "2e856efe-ef53-465a-a632-6a084c1d349d" + }, + "responses": { + "202": { + "headers": {} + }, + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/transcribe_file.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/transcribe_file.json new file mode 100644 index 000000000000..f7935ff37540 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/transcribe_file.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "Content-Type": "multipart/form-data", + "definition": "{ \"locales\": \"en-US\"] }", + "audio": "{binary}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "duration": 2000, + "combinedPhrases": [ + { + "text": "Weather" + } + ], + "phrases": [ + { + "offset": 40, + "duration": 240, + "text": "Weather", + "words": [ + { + "text": "Weather", + "offset": 40, + "duration": 240 + } + ], + "locale": "en-US", + "confidence": 0.7881154 + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_dataset.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_dataset.json new file mode 100644 index 000000000000..2bc5610f76ff --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_dataset.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "datasetUpdate": { + "displayName": "Updated dataset name", + "description": "Updated dataset description", + "customProperties": { + "key": "value" + } + }, + "Content-Type": "application/json", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview", + "kind": "Acoustic", + "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation", + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?api-version=2024-05-15-preview" + }, + "properties": { + "textNormalizationKind": "Default", + "acceptedLineCount": 11, + "rejectedLineCount": 2, + "duration": "PT4M12S" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Acoustic dataset" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_endpoint.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_endpoint.json new file mode 100644 index 000000000000..f23e8b879620 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_endpoint.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "afa0669c-a01e-4693-ae3a-93baf40f26d6", + "endpointUpdate": { + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "properties": { + "contentLoggingEnabled": true + }, + "displayName": "Updated endpoint with new model", + "customProperties": { + "key": "value" + } + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs?api-version=2024-05-15-preview", + "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6", + "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6" + }, + "properties": { + "timeToLive": "PT30M", + "loggingEnabled": true + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Speech endpoint", + "description": "Example for speech endpoint" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_evaluation.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_evaluation.json new file mode 100644 index 000000000000..971b439c0e78 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_evaluation.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "1c50ce42-6ab7-454f-8c39-54a752d1a5b6", + "evaluationUpdate": { + "displayName": "Updated evaluation", + "description": "Updated evaluation description" + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6?api-version=2024-05-15-preview", + "model1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "model2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "dataset": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview" + }, + "transcription2": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f?api-version=2024-05-15-preview" + }, + "transcription1": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/00000000-0000-0000-0000-000000000000/files?api-version=2024-05-15-preview" + }, + "properties": { + "wordErrorRate1": 0.065, + "sentenceErrorRate1": 0.375, + "tokenErrorRate1": 0.125, + "sentenceCount1": 8, + "wordCount1": 46, + "correctWordCount1": 43, + "wordSubstitutionCount1": 3, + "wordDeletionCount1": 0, + "wordInsertionCount1": 0, + "tokenCount1": 48, + "correctTokenCount1": 42, + "tokenSubstitutionCount1": 6, + "tokenDeletionCount1": 0, + "tokenInsertionCount1": 0, + "tokenErrors1": { + "punctuation": { + "numberOfEdits": 2, + "percentageOfAllEdits": 0.66 + }, + "capitalization": { + "numberOfEdits": 1, + "percentageOfAllEdits": 0.33 + } + }, + "wordErrorRate2": 0.065, + "sentenceErrorRate2": 0.375, + "tokenErrorRate2": 0.125, + "sentenceCount2": 8, + "wordCount2": 46, + "correctWordCount2": 43, + "wordSubstitutionCount2": 3, + "wordDeletionCount2": 0, + "wordInsertionCount2": 0, + "tokenCount2": 48, + "correctTokenCount2": 42, + "tokenSubstitutionCount2": 6, + "tokenDeletionCount2": 0, + "tokenInsertionCount2": 0, + "tokenErrors2": { + "punctuation": { + "numberOfEdits": 208, + "percentageOfAllEdits": 1.22 + }, + "capitalization": { + "numberOfEdits": 126, + "percentageOfAllEdits": 0.74 + }, + "inverseTextNormalization": { + "numberOfEdits": 409, + "percentageOfAllEdits": 2.4 + }, + "lexical": { + "numberOfEdits": 16284, + "percentageOfAllEdits": 95.41 + }, + "others": { + "numberOfEdits": 41, + "percentageOfAllEdits": 0.24 + } + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Evalution of one model against another model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_model.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_model.json new file mode 100644 index 000000000000..038b70171ba5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_model.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "827712a5-f942-4997-91c3-7c6cde35600b", + "modelUpdate": { + "displayName": "Language model update", + "description": "This is a language model update", + "customProperties": { + "key": "value" + } + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "baseModel": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview" + }, + "datasets": [ + { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-05-15-preview" + } + ], + "links": { + "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview", + "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b:copy?api-version=2024-05-15-preview", + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/files?api-version=2024-05-15-preview" + }, + "properties": { + "deprecationDates": { + "transcriptionDateTime": "2023-05-04T00:00:00Z" + }, + "customModelWeightPercent": 30, + "features": { + "supportsTranscriptionsSubmit": true, + "supportsTranscriptionsTranscribe": false, + "supportsEndpoints": true, + "supportsTranscriptionsOnSpeechContainers": false, + "supportedOutputFormats": [ + "Lexical", + "Display" + ] + } + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Running", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Language model", + "description": "This is a language model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_project.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_project.json new file mode 100644 index 000000000000..49b1a6469e22 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_project.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "abc46f33-90b8-443d-adad-4870517356e0", + "projectUpdate": { + "displayName": "My updated speech project", + "customProperties": { + "key": "value" + } + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0?api-version=2024-05-15-preview", + "links": { + "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations?api-version=2024-05-15-preview", + "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets?api-version=2024-05-15-preview", + "models": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/models?api-version=2024-05-15-preview", + "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints?api-version=2024-05-15-preview", + "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions?api-version=2024-05-15-preview" + }, + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "My speech project" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_transcription.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_transcription.json new file mode 100644 index 000000000000..41cbb221aa16 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_transcription.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "ba7ea6f5-3065-40b7-b49a-a90f48584683", + "transcriptionUpdate": { + "displayName": "Updated transcription name", + "description": "Updated transcription description", + "customProperties": { + "key": "value" + } + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview", + "model": { + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview" + }, + "links": { + "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-05-15-preview" + }, + "properties": { + "diarizationEnabled": false, + "wordLevelTimestampsEnabled": false, + "displayFormWordLevelTimestampsEnabled": false, + "channels": [ + 0, + 1 + ], + "punctuationMode": "DictatedAndAutomatic", + "profanityFilterMode": "Masked", + "duration": "PT42S", + "timeToLive": "P2D" + }, + "lastActionDateTime": "2019-01-07T11:36:07Z", + "status": "Succeeded", + "createdDateTime": "2019-01-07T11:34:12Z", + "locale": "en-US", + "displayName": "Transcription using adapted model en-US", + "customProperties": { + "key": "value" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_web_hook.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_web_hook.json new file mode 100644 index 000000000000..e5d63e5782f6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/update_web_hook.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "2e856efe-ef53-465a-a632-6a084c1d349d", + "webHookUpdate": { + "properties": { + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "events": { + "evaluationCreation": true, + "evaluationProcessing": true, + "evaluationCompletion": true, + "evaluationDeletion": true + }, + "webUrl": "https://contoso.com/call/me/back", + "displayName": "TranscriptionCompletionWebHook", + "description": "I registered this URL to get a POST request for each completed transcription.", + "customProperties": { + "key": "value" + } + }, + "Content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "displayName": "TranscriptionCompletionWebHook", + "self": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d?api-version=2024-05-15-preview", + "links": { + "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test?api-version=2024-05-15-preview", + "test": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping?api-version=2024-05-15-preview" + }, + "properties": { + "apiVersion": "v2024-05-15-preview", + "secret": "$CREDENTIAL_PLACEHOLDER$" + }, + "webUrl": "https://contoso.com/call/me/back", + "events": { + "transcriptionCompletion": true + }, + "description": "I registered this URL to get a POST request for each completed transcription.", + "createdDateTime": "2018-11-11T00:00:00Z", + "lastActionDateTime": "2018-11-28T00:00:00Z", + "status": "Succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/upload_block.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/upload_block.json new file mode 100644 index 000000000000..506ed695eec1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/examples/upload_block.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com/", + "Ocp-Apim-Subscription-Key": "{API Key}", + "api-version": "2024-05-15-preview", + "id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1", + "blockid": "AAE=", + "body": "{binary}" + }, + "responses": { + "201": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/speechtotext.json b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/speechtotext.json new file mode 100644 index 000000000000..1a9c5d16d842 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/preview/2024-05-15-preview/speechtotext.json @@ -0,0 +1,7179 @@ +{ + "swagger": "2.0", + "info": { + "title": "Speech Services API version 2024-05-15-preview", + "description": "Speech Services API version 2024-05-15-preview.", + "contact": { + "name": "Cognitive Services - Speech Services", + "url": "https://learn.microsoft.com/azure/cognitive-services/speech-service/support" + }, + "version": "2024-05-15-preview" + }, + "paths": { + "/datasets/locales": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets a list of supported locales for datasets.", + "operationId": "Datasets_ListSupportedLocales", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DatasetLocales" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get the supported locales": { + "$ref": "./examples/get_supported_dataset_locales.json" + } + } + } + }, + "/datasets": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets a list of datasets for the authenticated subscription.", + "operationId": "Datasets_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available datasets.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale, kind.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n -Example:\r\n filter=createdDateTime gt 2022-02-01T11:00:00Z and displayName eq 'My dataset'", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedDatasets" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all datasets": { + "$ref": "./examples/get_datasets.json" + }, + "Get all acoustic datasets": { + "$ref": "./examples/get_acoustic_datasets.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Uploads and creates a new dataset by getting the data from a specified URL or starts waiting for data blocks to be uploaded.", + "operationId": "Datasets_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "dataset", + "description": "Definition for the new dataset.", + "required": true, + "schema": { + "$ref": "#/definitions/Dataset" + } + } + ], + "responses": { + "201": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/Dataset" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create a dataset with content url": { + "$ref": "./examples/create_dataset_with_content_url.json" + }, + "Create dataset from data blocks": { + "$ref": "./examples/create_dataset_with_blocks.json" + } + } + } + }, + "/datasets/{id}": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets the dataset identified by the given ID.", + "operationId": "Datasets_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Dataset" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a dataset": { + "$ref": "./examples/get_dataset.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Updates the mutable details of the dataset identified by its ID.", + "operationId": "Datasets_Update", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "datasetUpdate", + "description": "The updated values for the dataset.", + "required": true, + "schema": { + "$ref": "#/definitions/DatasetUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Dataset" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Update a dataset": { + "$ref": "./examples/update_dataset.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Deletes the specified dataset.", + "operationId": "Datasets_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "204": { + "description": "The dataset was successfully deleted or did not exist." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete a dataset": { + "$ref": "./examples/delete_dataset.json" + } + } + } + }, + "/datasets/{id}/blocks": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets the list of uploaded blocks for this dataset.", + "operationId": "Datasets_GetBlocks", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UploadedBlocks" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get uploaded blocks for dataset": { + "$ref": "./examples/get_dataset_blocks.json" + } + } + }, + "put": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Upload a block of data for the dataset. The maximum size of the block is 8MiB.", + "operationId": "Datasets_UploadBlock", + "consumes": [ + "application/octet-stream" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "blockid", + "description": "A valid Base64 string value that identifies the block. Prior to encoding, the string must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified for the blockid parameter must be the same size for each block. Note that the Base64 string must be URL-encoded.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "body", + "required": true, + "schema": { + "format": "binary", + "type": "string" + } + } + ], + "responses": { + "201": { + "description": "The data block was uploaded successfully." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Upload a block for a dataset": { + "$ref": "./examples/upload_block.json" + } + } + } + }, + "/datasets/{id}/blocks:commit": { + "post": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Commit block list to complete the upload of the dataset.", + "operationId": "Datasets_CommitBlocks", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "blockList", + "description": "The list of blocks that compile the dataset.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/CommitBlocksEntry" + } + } + } + ], + "responses": { + "200": { + "description": "The block list is accepted and the data import process can continue." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Commit uploaded blocks to dataset": { + "$ref": "./examples/commit_block_list.json" + } + } + } + }, + "/datasets/{id}/files": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets the files of the dataset identified by the given ID.", + "operationId": "Datasets_ListFiles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available files.\r\n - Supported properties: name, createdDateTime, kind.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=name eq 'myaudio.wav' and kind eq 'Audio'", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedFiles" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all files": { + "$ref": "./examples/get_dataset_files.json" + }, + "Get all dataset report files": { + "$ref": "./examples/get_dataset_report_files.json" + } + } + } + }, + "/datasets/{id}/files/{fileId}": { + "get": { + "tags": [ + "Custom Speech datasets for model adaptation:" + ], + "summary": "Gets one specific file (identified with fileId) from a dataset (identified with id).", + "operationId": "Datasets_GetFile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the dataset.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "fileId", + "description": "The identifier of the file.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a file": { + "$ref": "./examples/get_dataset_file.json" + } + } + } + }, + "/endpoints/locales": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets a list of supported locales for endpoint creations.", + "operationId": "Endpoints_ListSupportedLocales", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get the supported locales": { + "$ref": "./examples/get_supported_endpoint_locales.json" + } + } + } + }, + "/endpoints": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets the list of endpoints for the authenticated subscription.", + "operationId": "Endpoints_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available endpoints.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=locale eq 'en-US'", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedEndpoints" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all endpoints": { + "$ref": "./examples/get_endpoints.json" + }, + "Get all queued endpoints.": { + "$ref": "./examples/get_not_started_endpoints.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Creates a new endpoint.", + "operationId": "Endpoints_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "endpoint", + "description": "The details of the endpoint.", + "required": true, + "schema": { + "$ref": "#/definitions/Endpoint" + } + } + ], + "responses": { + "201": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/Endpoint" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create an endpoint": { + "$ref": "./examples/create_endpoint.json" + } + } + } + }, + "/endpoints/{id}": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets the endpoint identified by the given ID.", + "operationId": "Endpoints_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Endpoint" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get an endpoint": { + "$ref": "./examples/get_endpoint.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes the endpoint identified by the given ID.", + "operationId": "Endpoints_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "204": { + "description": "The model endpoint was successfully deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete an endpoint": { + "$ref": "./examples/delete_endpoint.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Updates the metadata of the endpoint identified by the given ID.", + "operationId": "Endpoints_Update", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "endpointUpdate", + "description": "The updated values for the endpoint.", + "required": true, + "schema": { + "$ref": "#/definitions/EndpointUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Endpoint" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Update an endpoint": { + "$ref": "./examples/update_endpoint.json" + } + } + } + }, + "/endpoints/{id}/files/logs": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets the list of audio and transcription logs that have been stored for a given endpoint.", + "operationId": "Endpoints_ListLogs", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "in": "query", + "name": "skipToken", + "description": "Token to skip logs that were already retrieved in previous requests. Pagination starts from beginning when not defined.", + "type": "string" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedFiles" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all endpoint logs": { + "$ref": "./examples/get_endpoint_logs.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes the specified audio and transcription logs that have been stored for a given endpoint. It deletes all logs before (and including) a specific day.", + "description": "The deletion process is done asynchronously and can take up to one day depending on the amount of log files.", + "operationId": "Endpoints_DeleteLogs", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "endDate", + "description": "The end date of the audio logs deletion (specific day, UTC).\r\n Expected format: \"yyyy-mm-dd\". For instance, \"2023-03-15\" results in deleting all logs on March 15th, 2023 and before.\r\n Deletes all existing logs when date is not specified.", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "202": { + "description": "The logs will be deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete all endpoint logs": { + "$ref": "./examples/delete_endpoint_logs.json" + } + } + } + }, + "/endpoints/{id}/files/logs/{logId}": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets a specific audio or transcription log for a given endpoint.", + "operationId": "Endpoints_GetLog", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "logId", + "description": "The identifier of the log.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get an endpoint log": { + "$ref": "./examples/get_endpoint_log.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes one audio or transcription log that have been stored for a given endpoint.", + "operationId": "Endpoints_DeleteLog", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the endpoint.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "logId", + "description": "The identifier of the log.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "204": { + "description": "The log was successfully deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete an endpoint log": { + "$ref": "./examples/delete_endpoint_log.json" + } + } + } + }, + "/endpoints/base/{locale}/files/logs": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets the list of audio and transcription logs that have been stored when using the default base model of a given language.", + "operationId": "Endpoints_ListBaseModelLogs", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "locale", + "description": "The language used to select the default base model.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "in": "query", + "name": "skipToken", + "description": "Token to skip logs that were already retrieved in previous requests. Pagination starts from beginning when not defined.", + "type": "string" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedFiles" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all base model logs": { + "$ref": "./examples/get_base_model_logs.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes the specified audio and transcription logs that have been stored when using the default base model of a given language. It deletes all logs before (and including) a specific day.", + "description": "Deletion process is done asynchronously and can take up to one day depending on the amount of log files.", + "operationId": "Endpoints_DeleteBaseModelLogs", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "locale", + "description": "The language used to select the default base model.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "endDate", + "description": "The end date of the audio logs deletion (specific day, UTC).\r\n Expected format: \"yyyy-mm-dd\". For instance, \"2023-03-15\" results in deleting all logs on March 15th, 2023 and before.\r\n Deletes all existing logs when date is not specified.", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "202": { + "description": "The logs will be deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete all base model logs": { + "$ref": "./examples/delete_base_model_logs.json" + } + } + } + }, + "/endpoints/base/{locale}/files/logs/{logId}": { + "get": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Gets a specific audio or transcription log for the default base model in a given language.", + "operationId": "Endpoints_GetBaseModelLog", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "locale", + "description": "The language used to select the default base model.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "logId", + "description": "The identifier of the log.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a base model log": { + "$ref": "./examples/get_base_model_log.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech endpoints:" + ], + "summary": "Deletes one audio or transcription log that have been stored when using the default base model of a given language.", + "operationId": "Endpoints_DeleteBaseModelLog", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "locale", + "description": "The language used to select the default base model.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "logId", + "description": "The identifier of the log.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "204": { + "description": "The log was successfully deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete a base model log": { + "$ref": "./examples/delete_base_model_log.json" + } + } + } + }, + "/evaluations/locales": { + "get": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Gets a list of supported locales for evaluations.", + "operationId": "Evaluations_ListSupportedLocales", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get the supported locales": { + "$ref": "./examples/get_supported_evaluations_locales.json" + } + } + } + }, + "/evaluations": { + "get": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Gets the list of evaluations for the authenticated subscription.", + "operationId": "Evaluations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available evaluations.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status and locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=displayName eq 'My evaluation'", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedEvaluations" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all evaluations": { + "$ref": "./examples/get_evaluations.json" + }, + "Get all evaluations with where status is equal to 'Running'": { + "$ref": "./examples/get_evaluations_with_status_running.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Creates a new evaluation.", + "operationId": "Evaluations_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "evaluation", + "description": "The details of the new evaluation.", + "required": true, + "schema": { + "$ref": "#/definitions/Evaluation" + } + } + ], + "responses": { + "201": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/Evaluation" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create a evaluation": { + "$ref": "./examples/create_evaluation.json" + } + } + } + }, + "/evaluations/{id}/files": { + "get": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Gets the files of the evaluation identified by the given ID.", + "operationId": "Evaluations_ListFiles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the evaluation.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available files.\r\n - Supported properties: name, createdDateTime, kind.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=name eq 'myaudio.wav' and kind eq 'Audio'", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedFiles" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all files": { + "$ref": "./examples/get_evaluation_files.json" + } + } + } + }, + "/evaluations/{id}/files/{fileId}": { + "get": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Gets one specific file (identified with fileId) from an evaluation (identified with id).", + "operationId": "Evaluations_GetFile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the evaluation.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "fileId", + "description": "The identifier of the file.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a file": { + "$ref": "./examples/get_evaluation_file.json" + } + } + } + }, + "/evaluations/{id}": { + "get": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Gets the evaluation identified by the given ID.", + "operationId": "Evaluations_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the evaluation.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Evaluation" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a evaluation": { + "$ref": "./examples/get_evaluation.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Updates the mutable details of the evaluation identified by its id.", + "operationId": "Evaluations_Update", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the evaluation.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "evaluationUpdate", + "description": "The object containing the updated fields of the evaluation.", + "required": true, + "schema": { + "$ref": "#/definitions/EvaluationUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Evaluation" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Update a evaluation": { + "$ref": "./examples/update_evaluation.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech model evaluations:" + ], + "summary": "Deletes the evaluation identified by the given ID.", + "operationId": "Evaluations_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the evaluation.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "204": { + "description": "The evaluation was successfully deleted or did not exist." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete a evaluation": { + "$ref": "./examples/delete_evaluation.json" + } + } + } + }, + "/models/locales": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets a list of supported locales for model adaptation.", + "operationId": "Models_ListSupportedLocales", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get the supported locales": { + "$ref": "./examples/get_supported_model_locales.json" + } + } + } + }, + "/models": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the list of custom models for the authenticated subscription.", + "operationId": "Models_ListCustomModels", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available models.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=status eq 'NotStarted' or status eq 'Running'", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedCustomModels" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all models in state 'Running'": { + "$ref": "./examples/get_running_models.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Creates a new model.", + "operationId": "Models_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "model", + "description": "The details of the new model.", + "required": true, + "schema": { + "$ref": "#/definitions/CustomModel" + } + } + ], + "responses": { + "201": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/CustomModel" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create a model": { + "$ref": "./examples/create_model.json" + }, + "Create a model with custom model weight": { + "$ref": "./examples/create_model_with_weight.json" + } + } + } + }, + "/models/base": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the list of base models for the authenticated subscription.", + "operationId": "Models_ListBaseModels", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available base models.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=status eq 'NotStarted' or status eq 'Running'", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedBaseModels" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all english base models": { + "$ref": "./examples/get_english_base_models.json" + } + } + } + }, + "/models/{id}": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the model identified by the given ID.", + "operationId": "Models_GetCustomModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CustomModel" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a model": { + "$ref": "./examples/get_model.json" + }, + "Get a model with custom model weight": { + "$ref": "./examples/get_model_with_weight.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Updates the metadata of the model identified by the given ID.", + "operationId": "Models_Update", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "modelUpdate", + "description": "The updated values for the model.", + "required": true, + "schema": { + "$ref": "#/definitions/ModelUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CustomModel" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Update a model": { + "$ref": "./examples/update_model.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Deletes the model identified by the given ID.", + "operationId": "Models_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "204": { + "description": "The model was successfully deleted or did not exist." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete a model": { + "$ref": "./examples/delete_model.json" + } + } + } + }, + "/models/base/{id}": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the base model identified by the given ID.", + "operationId": "Models_GetBaseModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the base model.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BaseModel" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a base model": { + "$ref": "./examples/get_base_model.json" + } + } + } + }, + "/models/{id}:copy": { + "post": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Copies a model from one subscription to another.", + "description": "This method can be used to copy a model from this speech resource to a target one.\r\nThe authorization is obtained on the target speech resource.\r\nOnly custom models can be copied to another speech resource.", + "operationId": "Models_Copy", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model that will be copied.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "modelCopyAuthorization", + "description": "The body contains the authorization to copy to the target speech resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ModelCopyAuthorization" + } + } + ], + "responses": { + "202": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/Operation" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before accessing the resource created in this operation.", + "type": "integer", + "format": "int32" + }, + "Operation-Location": { + "description": "The location of the operation to track progress.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Copy a model from source resource to target resource": { + "$ref": "./examples/copy_model_with_authorization.json" + } + } + } + }, + "/models:authorizecopy": { + "post": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Allows another speech resource (source) to copy a model to this speech resource (target).", + "description": "This method can be used to allow copying a model from another speech resource.\r\nOnly custom models can be copied from another speech resource.", + "operationId": "Models_AuthorizeCopy", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "modelCopyAuthorizationDefinition", + "description": "The body contains the Azure Resource ID of the source speech resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ModelCopyAuthorizationDefinition" + } + } + ], + "responses": { + "200": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/ModelCopyAuthorization" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create a copy model authorization on target resource": { + "$ref": "./examples/create_copy_model_authorization.json" + } + } + } + }, + "/models/{id}/manifest": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Returns an manifest for this model which can be used in an on-premise container.", + "operationId": "Models_GetCustomModelManifest", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The ID of the model to generate a manifest for.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Successfully generated a model manifest.", + "schema": { + "$ref": "#/definitions/ModelManifest" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a model manifest": { + "$ref": "./examples/get_model_manifest.json" + } + } + } + }, + "/models/base/{id}/manifest": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Returns an manifest for this base model which can be used in an on-premise container.", + "operationId": "Models_GetBaseModelManifest", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The ID of the model to generate a manifest for.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Successfully generated a model manifest.", + "schema": { + "$ref": "#/definitions/ModelManifest" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a base model manifest": { + "$ref": "./examples/get_base_model_manifest.json" + } + } + } + }, + "/models/{id}/files": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets the files of the model identified by the given ID.", + "operationId": "Models_ListFiles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available files.\r\n - Supported properties: name, createdDateTime, kind.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=name eq 'myaudio.wav' and kind eq 'Audio'", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedFiles" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all files": { + "$ref": "./examples/get_model_files.json" + } + } + } + }, + "/models/{id}/files/{fileId}": { + "get": { + "tags": [ + "Custom Speech models:" + ], + "summary": "Gets one specific file (identified with fileId) from a model (identified with id).", + "operationId": "Models_GetFile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the model.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "fileId", + "description": "The identifier of the file.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a file": { + "$ref": "./examples/get_model_file.json" + } + } + } + }, + "/operations/models/copy/{id}": { + "get": { + "tags": [ + "Custom Speech operations:" + ], + "summary": "Gets the operation identified by the given ID.", + "operationId": "Operations_GetModelCopy", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the operation.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Operation" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get model copy operation pending": { + "$ref": "./examples/get_operation_copy_model_pending.json" + }, + "Get model copy operation": { + "$ref": "./examples/get_operation_copy_model.json" + } + } + } + }, + "/projects/locales": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of supported locales.", + "operationId": "Projects_ListSupportedLocales", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get the supported locales": { + "$ref": "./examples/get_supported_project_locales.json" + } + } + } + }, + "/projects": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of projects for the authenticated subscription.", + "operationId": "Projects_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available projects.\r\n - Supported properties: displayName, description, createdDateTime, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=displayName eq 'My test'", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedProjects" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all projects": { + "$ref": "./examples/get_projects.json" + }, + "Get all projects created in 2018 or 2019": { + "$ref": "./examples/get_projects_from_2018_and_2019.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Creates a new project.", + "operationId": "Projects_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "project", + "description": "The details of the project.", + "required": true, + "schema": { + "$ref": "#/definitions/Project" + } + } + ], + "responses": { + "201": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/Project" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create a project": { + "$ref": "./examples/create_project.json" + } + } + } + }, + "/projects/{id}": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the project identified by the given ID.", + "operationId": "Projects_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a project": { + "$ref": "./examples/get_project.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Updates the project identified by the given ID.", + "operationId": "Projects_Update", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "projectUpdate", + "description": "The updated values for the project.", + "required": true, + "schema": { + "$ref": "#/definitions/ProjectUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Update a project": { + "$ref": "./examples/update_project.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Deletes the project identified by the given ID.", + "operationId": "Projects_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "204": { + "description": "The project was successfully deleted or did not exist." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete a project": { + "$ref": "./examples/delete_project.json" + } + } + } + }, + "/projects/{id}/evaluations": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of evaluations for specified project.", + "operationId": "Projects_ListEvaluations", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available evaluations.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status and locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example\r\n filter=displayName eq 'My evaluation'", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedEvaluations" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all evaluations": { + "$ref": "./examples/get_project_evaluations.json" + } + } + } + }, + "/projects/{id}/datasets": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of datasets for specified project.", + "operationId": "Projects_ListDatasets", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available datasets.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale, kind.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=createdDateTime gt 2022-02-01T11:00:00Z", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedDatasets" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all datasets": { + "$ref": "./examples/get_project_datasets.json" + } + } + } + }, + "/projects/{id}/endpoints": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of endpoints for specified project.", + "operationId": "Projects_ListEndpoints", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available endpoints.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=locale eq 'en-US'", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedEndpoints" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all endpoints": { + "$ref": "./examples/get_project_endpoints.json" + } + } + } + }, + "/projects/{id}/models": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of models for specified project.", + "operationId": "Projects_ListModels", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available models.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=status eq 'NotStarted' or status eq 'Running'", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedCustomModels" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all models": { + "$ref": "./examples/get_project_models.json" + } + } + } + }, + "/projects/{id}/transcriptions": { + "get": { + "tags": [ + "Custom Speech projects:" + ], + "summary": "Gets the list of transcriptions for specified project.", + "operationId": "Projects_ListTranscriptions", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the project.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available transcriptions.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=createdDateTime gt 2022-02-01T11:00:00Z", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedTranscriptions" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all transcriptions": { + "$ref": "./examples/get_project_transcriptions.json" + } + } + } + }, + "/transcriptions/locales": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets a list of supported locales for offline transcriptions.", + "operationId": "Transcriptions_ListSupportedLocales", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TranscriptionLocales" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get the supported locales": { + "$ref": "./examples/get_supported_transcription_locales.json" + } + } + } + }, + "/transcriptions": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets a list of transcriptions for the authenticated subscription.", + "operationId": "Transcriptions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available transcriptions.\r\n - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=createdDateTime gt 2022-02-01T11:00:00Z", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedTranscriptions" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all transcriptions": { + "$ref": "./examples/get_transcriptions.json" + }, + "Get all failed transcriptions": { + "$ref": "./examples/get_failed_transcriptions.json" + } + } + } + }, + "/transcriptions/{id}": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets the transcription identified by the given ID.", + "operationId": "Transcriptions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Transcription" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a transcription": { + "$ref": "./examples/get_transcription.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Updates the mutable details of the transcription identified by its ID.", + "operationId": "Transcriptions_Update", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "transcriptionUpdate", + "description": "The updated values for the transcription.", + "required": true, + "schema": { + "$ref": "#/definitions/TranscriptionUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Transcription" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Update a transcription": { + "$ref": "./examples/update_transcription.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Deletes the specified transcription task.", + "operationId": "Transcriptions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "204": { + "description": "The transcription was successfully deleted or did not exist." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete a transcription": { + "$ref": "./examples/delete_transcription.json" + } + } + } + }, + "/transcriptions:submit": { + "post": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Submits a new transcription job.", + "operationId": "Transcriptions_Submit", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "transcription", + "description": "The details of the new transcription.", + "required": true, + "schema": { + "$ref": "#/definitions/Transcription" + } + } + ], + "responses": { + "201": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/Transcription" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create a transcription for URIs": { + "$ref": "./examples/create_uri_transcription.json" + }, + "Create a transcription with basic two-speaker diarization": { + "$ref": "./examples/create_simple_diarization_transcription.json" + }, + "Create a transcription with multispeaker diarization": { + "$ref": "./examples/create_multispeaker_diarization_transcription.json" + }, + "Create a transcription with language identification": { + "$ref": "./examples/create_lid_transcription.json" + }, + "Create a transcription from blob container": { + "$ref": "./examples/create_container_transcription.json" + } + } + } + }, + "/transcriptions/{id}/files": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets the files of the transcription identified by the given ID.", + "operationId": "Transcriptions_ListFiles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available files.\r\n - Supported properties: name, createdDateTime, kind.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=name eq 'myaudio.wav.json' and kind eq 'Transcription'", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedFiles" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all files": { + "$ref": "./examples/get_transcription_files.json" + }, + "Get all transcription files the name of which starts with the specified string": { + "$ref": "./examples/get_transcription_files_filtered_by_name.json" + } + } + } + }, + "/transcriptions/{id}/files/{fileId}": { + "get": { + "tags": [ + "Custom Speech transcriptions:" + ], + "summary": "Gets one specific file (identified with fileId) from a transcription (identified with id).", + "operationId": "Transcriptions_GetFile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the transcription.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "fileId", + "description": "The identifier of the file.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/sasValidityQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/File" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a file": { + "$ref": "./examples/get_transcription_file.json" + } + } + } + }, + "/webhooks": { + "get": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Gets the list of web hooks for the authenticated subscription.", + "operationId": "WebHooks_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/skipQueryParameter" + }, + { + "$ref": "#/parameters/topQueryParameter" + }, + { + "in": "query", + "name": "filter", + "description": "A filtering expression for selecting a subset of the available hooks.\r\n Supported properties: displayName, description, createdDateTime, lastActionDateTime, status and webUrl.\r\n - Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.\r\n - and, or, not are supported.\r\n - Example:\r\n filter=displayName eq 'test'", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedWebHooks" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "itemName": "values", + "nextLinkName": "@nextLink" + }, + "x-ms-examples": { + "Get all web hooks": { + "$ref": "./examples/get_web_hooks.json" + }, + "Get all web hooks created in 03/2020 ordered by their name": { + "$ref": "./examples/get_web_hooks_from_march_2020.json" + } + } + }, + "post": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Creates a new web hook.", + "description": "If the property secret in the configuration is present and contains a non-empty string, it will be used to create a SHA256 hash of the payload with\r\nthe secret as HMAC key. This hash will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL.\r\n \r\nWhen calling back into the registered URL, the request will contain a X-MicrosoftSpeechServices-Event header containing one of the registered event\r\ntypes. There will be one request per registered event type.\r\n \r\nAfter successfully registering the web hook, it will not be usable until a challenge/response is completed. To do this, a request with the event type\r\nchallenge will be made with a query parameter called validationToken. Respond to the challenge with a 200 OK containing the value of the validationToken\r\nquery parameter as the response body. When the challenge/response is successfully completed, the web hook will begin receiving events.", + "operationId": "WebHooks_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "webHook", + "description": "The details of the new web hook.", + "required": true, + "schema": { + "$ref": "#/definitions/WebHook" + } + } + ], + "responses": { + "201": { + "description": "The response contains information about the entity as payload and its location as header.", + "schema": { + "$ref": "#/definitions/WebHook" + }, + "headers": { + "Location": { + "description": "The location of the created resource.", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create a web hook": { + "$ref": "./examples/create_web_hook.json" + } + } + } + }, + "/webhooks/{id}": { + "get": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Gets the web hook identified by the given ID.", + "operationId": "WebHooks_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the web hook.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebHook" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get a web hook": { + "$ref": "./examples/get_web_hook.json" + } + } + }, + "patch": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Updates the web hook identified by the given ID.", + "description": "If the property secret in the configuration is omitted or contains an empty string, future callbacks won't contain X-MicrosoftSpeechServices-Signature\r\nheaders. If the property contains a non-empty string, it will be used to create a SHA256 hash of the payload with the secret as HMAC key. This hash\r\nwill be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL.\r\n \r\nIf the URL changes, the web hook will stop receiving events until a\r\nchallenge/response is completed. To do this, a request with the event type challenge will be made with a query parameter called validationToken.\r\nRespond to the challenge with a 200 OK containing the value of the validationToken query parameter as the response body. When the challenge/response\r\nis successfully completed, the web hook will begin receiving events.", + "operationId": "WebHooks_Update", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the web hook.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "webHookUpdate", + "description": "The updated values for the web hook.", + "required": true, + "schema": { + "$ref": "#/definitions/WebHookUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebHook" + }, + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait for a non terminal operation to complete.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Update a web hook": { + "$ref": "./examples/update_web_hook.json" + } + } + }, + "delete": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Deletes the web hook identified by the given ID.", + "operationId": "WebHooks_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the web hook.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "204": { + "description": "The web hook was successfully deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete a web hook": { + "$ref": "./examples/delete_web_hook.json" + } + } + } + }, + "/webhooks/{id}:ping": { + "post": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Sends a ping event to the registered URL.", + "description": "The request body of the POST request sent to the registered web hook URL is of the same shape as in the GET request for a specific hook.\r\nThe Swagger Schema ID of the model is WebHookV3.\r\n \r\nThe request will contain a X-MicrosoftSpeechServices-Event header with the value ping. If the web hook was registered with\r\na secret it will contain a X-MicrosoftSpeechServices-Signature header with an SHA256 hash of the payload with\r\nthe secret as HMAC key. The hash is base64 encoded.", + "operationId": "WebHooks_Ping", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the web hook to ping.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "202": { + "description": "Started trying to send a ping request to the web hook.", + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before accessing the resource created in this operation.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Ping a web hook": { + "$ref": "./examples/ping_web_hook.json" + } + } + } + }, + "/webhooks/{id}:test": { + "post": { + "tags": [ + "Custom Speech web hooks:" + ], + "summary": "Sends a request for each registered event type to the registered URL.", + "description": "The payload will be generated from the last entity that would have invoked the web hook. If no entity is present for none of the registered event types,\r\nthe POST will respond with 204. If a test request can be made, it will respond with 200.\r\nThe request will contain a X-MicrosoftSpeechServices-Event header with the respective registered event type.\r\nIf the web hook was registered with a secret it will contain a X-MicrosoftSpeechServices-Signature header with an SHA256 hash of the payload with\r\nthe secret as HMAC key. The hash is base64 encoded.", + "operationId": "WebHooks_Test", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The identifier of the web hook to ping.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "202": { + "description": "A test request with the last entity is sent to the registered web hook.", + "headers": { + "Retry-After": { + "description": "The minimum number of seconds to wait before accessing the resource created in this operation.", + "type": "integer", + "format": "int32" + } + } + }, + "204": { + "description": "No entity could be found for any event type, so no test request is sent to the registered web hook." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Test a web hook": { + "$ref": "./examples/test_web_hook.json" + } + } + } + }, + "/transcriptions:transcribe": { + "post": { + "tags": [ + "Transcribe" + ], + "summary": "Transcribes the provided audio stream.", + "operationId": "Transcriptions_Transcribe", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "formData", + "name": "definition", + "description": "Metadata for a fast transcription request. This field contains a JSON-serialized object of type `TranscribeDefinition`.", + "required": true, + "type": "string" + }, + { + "in": "formData", + "name": "audio", + "description": "The audio as a stream of bytes.", + "required": true, + "type": "file", + "format": "binary" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TranscribeResult" + } + } + }, + "x-ms-examples": { + "Transcribe an audio file": { + "$ref": "./examples/transcribe_file.json" + } + } + } + } + }, + "definitions": { + "BaseModel": { + "title": "BaseModel", + "required": [ + "displayName", + "locale" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SharedModel" + } + ], + "properties": { + "links": { + "$ref": "#/definitions/BaseModelLinks" + }, + "properties": { + "$ref": "#/definitions/BaseModelProperties" + } + } + }, + "BaseModelDeprecationDates": { + "title": "BaseModelDeprecationDates", + "type": "object", + "properties": { + "adaptationDateTime": { + "format": "date-time", + "description": "The date when adaptation becomes deprecated.", + "type": "string", + "readOnly": true + }, + "transcriptionDateTime": { + "format": "date-time", + "description": "The date when transcription becomes deprecated.", + "type": "string", + "readOnly": true + } + } + }, + "BaseModelFeatures": { + "title": "BaseModelFeatures", + "description": "Features supported by the model.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SharedModelFeatures" + } + ], + "properties": { + "supportsAdaptationsWith": { + "description": "Supported dataset kinds to adapt the model.", + "type": "array", + "items": { + "$ref": "#/definitions/DatasetKind" + }, + "readOnly": true + } + } + }, + "BaseModelLinks": { + "title": "BaseModelLinks", + "type": "object", + "properties": { + "manifest": { + "format": "uri", + "description": "The location to get a manifest for this model to be used in the on-prem container. See operation \"Models_GetCustomModelManifest\" for more details.", + "type": "string", + "readOnly": true + } + } + }, + "BaseModelProperties": { + "title": "BaseModelProperties", + "type": "object", + "properties": { + "deprecationDates": { + "$ref": "#/definitions/BaseModelDeprecationDates" + }, + "features": { + "$ref": "#/definitions/BaseModelFeatures" + }, + "chargeForAdaptation": { + "description": "A value indicating whether model adaptation is charged.", + "type": "boolean", + "readOnly": true + } + } + }, + "BlockKind": { + "title": "BlockKind", + "description": "Type of data block.", + "enum": [ + "Committed", + "Uncommitted", + "Latest" + ], + "type": "string", + "x-ms-enum": { + "name": "BlockKind", + "modelAsString": true, + "values": [ + { + "value": "Committed", + "description": "A data block from the committed block list." + }, + { + "value": "Uncommitted", + "description": "A data block from the uncommitted block list." + }, + { + "value": "Latest", + "description": "A data block from the uncommitted block list, if present, otherwise from the committed block list." + } + ] + } + }, + "CommitBlocksEntry": { + "title": "CommitBlocksEntry", + "description": "Entry of the commit block list.", + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/BlockKind" + }, + "id": { + "type": "string" + } + } + }, + "CustomModel": { + "title": "CustomModel", + "required": [ + "displayName", + "locale" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SharedModel" + } + ], + "properties": { + "links": { + "$ref": "#/definitions/CustomModelLinks" + }, + "properties": { + "$ref": "#/definitions/CustomModelProperties" + }, + "project": { + "$ref": "#/definitions/EntityReference" + }, + "text": { + "description": "The text used to adapt this language model.", + "type": "string" + }, + "baseModel": { + "$ref": "#/definitions/EntityReference" + }, + "datasets": { + "description": "Datasets used for adaptation.", + "type": "array", + "items": { + "$ref": "#/definitions/EntityReference" + } + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "CustomModelDeprecationDates": { + "title": "CustomModelDeprecationDates", + "type": "object", + "properties": { + "transcriptionDateTime": { + "format": "date-time", + "description": "The date when transcription becomes deprecated.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "CustomModelFeatures": { + "title": "CustomModelFeatures", + "description": "Features supported by the model.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SharedModelFeatures" + } + ], + "readOnly": true + }, + "CustomModelLinks": { + "title": "CustomModelLinks", + "type": "object", + "properties": { + "copy": { + "format": "uri", + "description": "The location to the model copy action. See operation \"Models_Copy\" for more details.", + "type": "string", + "readOnly": true + }, + "files": { + "format": "uri", + "description": "The location to get all files of this entity. See operation \"Models_ListFiles\" for more details.", + "type": "string", + "readOnly": true + }, + "manifest": { + "format": "uri", + "description": "The location to get a manifest for this model to be used in the on-prem container. See operation \"Models_GetCustomModelManifest\" for more details.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "CustomModelProperties": { + "title": "CustomModelProperties", + "type": "object", + "properties": { + "customModelWeightPercent": { + "format": "int32", + "description": "The weight of custom model between 1 (1% custom model and 99% base model) and 100 (100% custom model and 0% base model).\r\nWhen this property is not set, the service chooses a suitable value (get the model to retrieve the selected weight).\r\nStart without using this property. If needed, choose a larger (or smaller) weight to increase (or decrease) the impact of the custom model.", + "maximum": 100, + "minimum": 1, + "type": "integer" + }, + "deprecationDates": { + "$ref": "#/definitions/CustomModelDeprecationDates" + }, + "features": { + "$ref": "#/definitions/CustomModelFeatures" + }, + "email": { + "description": "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email.", + "type": "string" + }, + "error": { + "$ref": "#/definitions/EntityError" + } + } + }, + "Dataset": { + "title": "Dataset", + "required": [ + "displayName", + "kind", + "locale" + ], + "type": "object", + "properties": { + "links": { + "$ref": "#/definitions/DatasetLinks" + }, + "properties": { + "$ref": "#/definitions/DatasetProperties" + }, + "kind": { + "$ref": "#/definitions/DatasetKind" + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "minLength": 1, + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "contentUrl": { + "format": "uri", + "description": "The URL of the data for the dataset.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "locale": { + "description": "The locale of the contained data.", + "minLength": 1, + "type": "string" + }, + "project": { + "$ref": "#/definitions/EntityReference" + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Status" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + } + } + }, + "DatasetKind": { + "title": "DatasetKind", + "description": "Type of data import.", + "enum": [ + "Language", + "Acoustic", + "Pronunciation", + "AudioFiles", + "LanguageMarkdown", + "OutputFormatting" + ], + "type": "string", + "x-ms-enum": { + "name": "DatasetKind", + "modelAsString": true, + "values": [ + { + "value": "Language", + "description": "A language dataset." + }, + { + "value": "Acoustic", + "description": "An acoustic dataset." + }, + { + "value": "Pronunciation", + "description": "A pronunciation dataset." + }, + { + "value": "AudioFiles", + "description": "An audio files dataset." + }, + { + "value": "LanguageMarkdown", + "description": "A language markdown dataset." + }, + { + "value": "OutputFormatting", + "description": "Dataset that contains rules to customize inverse text normalization, capitalization, reformulation, profanity and also defines tests for dataset validation" + } + ] + } + }, + "DatasetLinks": { + "title": "DatasetLinks", + "type": "object", + "properties": { + "files": { + "format": "uri", + "description": "The location to get all files of this entity. See operation \"Datasets_ListFiles\" for more details.", + "type": "string", + "readOnly": true + }, + "commitBlocks": { + "format": "uri", + "description": "The location to commit the list of blocks when uploading a dataset using blocks. See operation \"Datasets_CommitBlocks\" for more details.", + "type": "string", + "readOnly": true + }, + "listBlocks": { + "format": "uri", + "description": "The location to list the already uploaded blocks of this entity when uploading a dataset using blocks. See operation \"Datasets_GetBlocks\" for more details.", + "type": "string", + "readOnly": true + }, + "uploadBlocks": { + "format": "uri", + "description": "The location to upload blocks to when uploading a dataset using blocks. See operation \"Datasets_UploadBlock\" for more details.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "DatasetLocales": { + "title": "DatasetLocales", + "type": "object", + "properties": { + "Language": { + "type": "array", + "items": { + "type": "string" + } + }, + "Acoustic": { + "type": "array", + "items": { + "type": "string" + } + }, + "Pronunciation": { + "type": "array", + "items": { + "type": "string" + } + }, + "AudioFiles": { + "type": "array", + "items": { + "type": "string" + } + }, + "LanguageMarkdown": { + "type": "array", + "items": { + "type": "string" + } + }, + "OutputFormatting": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DatasetProperties": { + "title": "DatasetProperties", + "type": "object", + "properties": { + "textNormalizationKind": { + "$ref": "#/definitions/TextNormalizationKind" + }, + "acceptedLineCount": { + "format": "int32", + "description": "The number of lines accepted for this data set.", + "type": "integer", + "readOnly": true + }, + "rejectedLineCount": { + "format": "int32", + "description": "The number of lines rejected for this data set.", + "type": "integer", + "readOnly": true + }, + "duration": { + "description": "The total duration of the datasets if it contains audio files. The duration is encoded as ISO 8601 duration\r\n(\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations).", + "type": "string", + "readOnly": true + }, + "email": { + "description": "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email.", + "type": "string" + }, + "error": { + "$ref": "#/definitions/EntityError" + } + } + }, + "DatasetUpdate": { + "title": "DatasetUpdate", + "type": "object", + "properties": { + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "project": { + "$ref": "#/definitions/EntityReference" + } + } + }, + "DetailedErrorCode": { + "title": "DetailedErrorCode", + "description": "Detailed error code enum.", + "enum": [ + "InvalidParameterValue", + "InvalidRequestBodyFormat", + "EmptyRequest", + "MissingInputRecords", + "InvalidDocument", + "ModelVersionIncorrect", + "InvalidDocumentBatch", + "UnsupportedLanguageCode", + "DataImportFailed", + "InUseViolation", + "InvalidLocale", + "InvalidBaseModel", + "InvalidAdaptationMapping", + "InvalidDataset", + "InvalidTest", + "FailedDataset", + "InvalidModel", + "InvalidTranscription", + "InvalidPayload", + "InvalidParameter", + "EndpointWithoutLogging", + "InvalidPermissions", + "InvalidPrerequisite", + "InvalidProductId", + "InvalidSubscription", + "InvalidProject", + "InvalidProjectKind", + "InvalidRecordingsUri", + "OnlyOneOfUrlsOrContainerOrDataset", + "ExceededNumberOfRecordingsUris", + "InvalidChannels", + "ModelMismatch", + "ProjectGenderMismatch", + "ModelDeprecated", + "ModelExists", + "ModelNotDeployable", + "EndpointNotUpdatable", + "SingleDefaultEndpoint", + "EndpointCannotBeDefault", + "InvalidModelUri", + "SubscriptionNotFound", + "QuotaViolation", + "UnsupportedDelta", + "UnsupportedFilter", + "UnsupportedPagination", + "UnsupportedDynamicConfiguration", + "UnsupportedOrderBy", + "NoUtf8WithBom", + "ModelDeploymentNotCompleteState", + "SkuLimitsExist", + "DeployingFailedModel", + "UnsupportedTimeRange", + "InvalidLogDate", + "InvalidLogId", + "InvalidLogStartTime", + "InvalidLogEndTime", + "InvalidTopForLogs", + "InvalidSkipTokenForLogs", + "DeleteNotAllowed", + "Forbidden", + "DeployNotAllowed", + "UnexpectedError", + "InvalidCollection", + "InvalidCallbackUri", + "InvalidSasValidityDuration", + "InaccessibleCustomerStorage", + "UnsupportedClassBasedAdaptation", + "InvalidWebHookEventKind", + "InvalidTimeToLive", + "InvalidSourceAzureResourceId", + "ModelCopyAuthorizationExpired" + ], + "type": "string", + "x-ms-enum": { + "name": "DetailedErrorCode", + "modelAsString": true, + "values": [ + { + "value": "InvalidParameterValue", + "description": "Invalid parameter value." + }, + { + "value": "InvalidRequestBodyFormat", + "description": "Invalid request body format." + }, + { + "value": "EmptyRequest", + "description": "Empty Request." + }, + { + "value": "MissingInputRecords", + "description": "Missing Input Records." + }, + { + "value": "InvalidDocument", + "description": "Invalid Document." + }, + { + "value": "ModelVersionIncorrect", + "description": "Model Version Incorrect." + }, + { + "value": "InvalidDocumentBatch", + "description": "Invalid Document Batch." + }, + { + "value": "UnsupportedLanguageCode", + "description": "Unsupported language code." + }, + { + "value": "DataImportFailed", + "description": "Data import failed." + }, + { + "value": "InUseViolation", + "description": "In use violation." + }, + { + "value": "InvalidLocale", + "description": "Invalid locale." + }, + { + "value": "InvalidBaseModel", + "description": "Invalid base model." + }, + { + "value": "InvalidAdaptationMapping", + "description": "Invalid adaptation mapping." + }, + { + "value": "InvalidDataset", + "description": "Invalid dataset." + }, + { + "value": "InvalidTest", + "description": "Invalid test." + }, + { + "value": "FailedDataset", + "description": "Failed dataset." + }, + { + "value": "InvalidModel", + "description": "Invalid model." + }, + { + "value": "InvalidTranscription", + "description": "Invalid transcription." + }, + { + "value": "InvalidPayload", + "description": "Invalid payload." + }, + { + "value": "InvalidParameter", + "description": "Invalid parameter." + }, + { + "value": "EndpointWithoutLogging", + "description": "Endpoint without logging." + }, + { + "value": "InvalidPermissions", + "description": "Invalid permissions." + }, + { + "value": "InvalidPrerequisite", + "description": "Invalid prerequisite." + }, + { + "value": "InvalidProductId", + "description": "Invalid product id." + }, + { + "value": "InvalidSubscription", + "description": "Invalid subscription." + }, + { + "value": "InvalidProject", + "description": "Invalid project." + }, + { + "value": "InvalidProjectKind", + "description": "Invalid project kind." + }, + { + "value": "InvalidRecordingsUri", + "description": "Invalid recordings uri." + }, + { + "value": "OnlyOneOfUrlsOrContainerOrDataset", + "description": "Only one of urls or container or dataset." + }, + { + "value": "ExceededNumberOfRecordingsUris", + "description": "Exceeded number of recordings uris." + }, + { + "value": "InvalidChannels", + "description": "Invalid channels." + }, + { + "value": "ModelMismatch", + "description": "Model mismatch." + }, + { + "value": "ProjectGenderMismatch", + "description": "Project gender mismatch." + }, + { + "value": "ModelDeprecated", + "description": "Model deprecated." + }, + { + "value": "ModelExists", + "description": "Model exists." + }, + { + "value": "ModelNotDeployable", + "description": "Model not deployable." + }, + { + "value": "EndpointNotUpdatable", + "description": "Endpoint not updatable." + }, + { + "value": "SingleDefaultEndpoint", + "description": "Single default endpoint." + }, + { + "value": "EndpointCannotBeDefault", + "description": "Endpoint cannot be default." + }, + { + "value": "InvalidModelUri", + "description": "Invalid model uri." + }, + { + "value": "SubscriptionNotFound", + "description": "Subscription not found." + }, + { + "value": "QuotaViolation", + "description": "Quota violation." + }, + { + "value": "UnsupportedDelta", + "description": "Unsupported delta." + }, + { + "value": "UnsupportedFilter", + "description": "Unsupported filter." + }, + { + "value": "UnsupportedPagination", + "description": "Unsupported pagination." + }, + { + "value": "UnsupportedDynamicConfiguration", + "description": "Unsupported dynamic configuration." + }, + { + "value": "UnsupportedOrderBy", + "description": "Unsupported order by." + }, + { + "value": "NoUtf8WithBom", + "description": "No utf8 with bom." + }, + { + "value": "ModelDeploymentNotCompleteState", + "description": "Model deployment not complete state." + }, + { + "value": "SkuLimitsExist", + "description": "Sku limits exist." + }, + { + "value": "DeployingFailedModel", + "description": "Deploying failed model." + }, + { + "value": "UnsupportedTimeRange", + "description": "Unsupported time range." + }, + { + "value": "InvalidLogDate", + "description": "Invalid log date." + }, + { + "value": "InvalidLogId", + "description": "Invalid log id." + }, + { + "value": "InvalidLogStartTime", + "description": "Invalid log start time." + }, + { + "value": "InvalidLogEndTime", + "description": "Invalid log end time." + }, + { + "value": "InvalidTopForLogs", + "description": "Invalid top for logs." + }, + { + "value": "InvalidSkipTokenForLogs", + "description": "Invalid skip token for logs." + }, + { + "value": "DeleteNotAllowed", + "description": "Delete not allowed." + }, + { + "value": "Forbidden", + "description": "Forbidden." + }, + { + "value": "DeployNotAllowed", + "description": "Deploy not allowed." + }, + { + "value": "UnexpectedError", + "description": "Unexpected error." + }, + { + "value": "InvalidCollection", + "description": "Invalid collection." + }, + { + "value": "InvalidCallbackUri", + "description": "Invalid callback uri." + }, + { + "value": "InvalidSasValidityDuration", + "description": "Invalid sas validity duration." + }, + { + "value": "InaccessibleCustomerStorage", + "description": "Inaccessible customer storage." + }, + { + "value": "UnsupportedClassBasedAdaptation", + "description": "Unsupported class based adaptation." + }, + { + "value": "InvalidWebHookEventKind", + "description": "Invalid web hook event kind." + }, + { + "value": "InvalidTimeToLive", + "description": "Invalid time to live." + }, + { + "value": "InvalidSourceAzureResourceId", + "description": "Invalid source Azure resource ID." + }, + { + "value": "ModelCopyAuthorizationExpired", + "description": "Expired ModelCopyAuthorization." + } + ] + } + }, + "DiarizationProperties": { + "title": "DiarizationProperties", + "required": [ + "speakers" + ], + "type": "object", + "properties": { + "speakers": { + "$ref": "#/definitions/DiarizationSpeakersProperties" + } + } + }, + "DiarizationSpeakersProperties": { + "title": "DiarizationSpeakersProperties", + "type": "object", + "properties": { + "minCount": { + "format": "int32", + "description": "A hint for the minimum number of speakers for diarization. Must be smaller than or equal to the maxSpeakers property.", + "minimum": 1, + "type": "integer" + }, + "maxCount": { + "format": "int32", + "description": "The maximum number of speakers for diarization. Must be less than 36 and larger than or equal to the minSpeakers property.", + "minimum": 1, + "type": "integer" + } + } + }, + "EditsSummary": { + "title": "EditsSummary", + "type": "object", + "properties": { + "numberOfEdits": { + "format": "int32", + "description": "The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription.", + "type": "integer", + "readOnly": true + }, + "percentageOfAllEdits": { + "format": "double", + "description": "The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription.", + "type": "number", + "readOnly": true + } + }, + "readOnly": true + }, + "Endpoint": { + "title": "Endpoint", + "required": [ + "displayName", + "locale" + ], + "type": "object", + "properties": { + "links": { + "$ref": "#/definitions/EndpointLinks" + }, + "properties": { + "$ref": "#/definitions/EndpointProperties" + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "minLength": 1, + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "text": { + "description": "The text used to adapt a language model for this endpoint.", + "type": "string" + }, + "model": { + "$ref": "#/definitions/EntityReference" + }, + "locale": { + "description": "The locale of the contained data.", + "minLength": 1, + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Status" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "project": { + "$ref": "#/definitions/EntityReference" + } + } + }, + "EndpointLinks": { + "title": "EndpointLinks", + "type": "object", + "properties": { + "restInteractive": { + "format": "uri", + "description": "The REST endpoint for short requests up to 15 seconds.", + "type": "string", + "readOnly": true + }, + "restConversation": { + "format": "uri", + "description": "The REST endpoint for requests up to 60 seconds.", + "type": "string", + "readOnly": true + }, + "restDictation": { + "format": "uri", + "description": "The REST endpoint for requests up to 60 seconds, supporting dictation of punctuation marks.", + "type": "string", + "readOnly": true + }, + "webSocketInteractive": { + "format": "uri", + "description": "The Speech SDK endpoint for short requests up to 15 seconds with a single final result.", + "type": "string", + "readOnly": true + }, + "webSocketConversation": { + "format": "uri", + "description": "The Speech SDK endpoint for long requests with multiple final results.", + "type": "string", + "readOnly": true + }, + "webSocketDictation": { + "format": "uri", + "description": "The Speech SDK endpoint for long requests with multiple final results, supporting dictation of\r\npunctuation marks.", + "type": "string", + "readOnly": true + }, + "logs": { + "format": "uri", + "description": "The audio and transcription logs for this endpoint. See operation \"Endpoints_ListLogs\" for more details.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "EndpointProperties": { + "title": "EndpointProperties", + "type": "object", + "properties": { + "loggingEnabled": { + "description": "A value indicating whether content logging (audio & transcriptions) is being used for a deployment.", + "type": "boolean" + }, + "timeToLive": { + "description": "How long the endpoint will be kept in the system. Once the endpoint reaches the time to live\r\nafter completion (successful or failed) it will be automatically deleted. Not setting this value or setting\r\nto 0 will disable automatic deletion. The longest supported duration is 31 days.\r\nThe duration is encoded as ISO 8601 duration (\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations).", + "type": "string" + }, + "email": { + "description": "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email.", + "type": "string" + }, + "error": { + "$ref": "#/definitions/EntityError" + } + } + }, + "EndpointPropertiesUpdate": { + "title": "EndpointPropertiesUpdate", + "type": "object", + "properties": { + "contentLoggingEnabled": { + "description": "A value indicating whether content logging (audio & transcriptions)\r\nis being used for a deployment.", + "type": "boolean" + } + } + }, + "EndpointUpdate": { + "title": "EndpointUpdate", + "type": "object", + "properties": { + "model": { + "$ref": "#/definitions/EntityReference" + }, + "properties": { + "$ref": "#/definitions/EndpointPropertiesUpdate" + }, + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "project": { + "$ref": "#/definitions/EntityReference" + } + } + }, + "EntityError": { + "title": "EntityError", + "type": "object", + "properties": { + "code": { + "description": "The code of this error.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The message for this error.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "EntityReference": { + "title": "EntityReference", + "required": [ + "self" + ], + "type": "object", + "properties": { + "self": { + "format": "uri", + "description": "The location of the referenced entity.", + "type": "string" + } + } + }, + "Error": { + "title": "Error", + "description": "New format which conforms to the new Cognitive Services API guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.\r\nThis contains an outer error with error code, message, details, target and an inner error with more descriptive details.", + "type": "object", + "properties": { + "code": { + "$ref": "#/definitions/ErrorCode" + }, + "details": { + "description": "Additional supportive details regarding the error and/or expected policies.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + }, + "message": { + "description": "High level error message.", + "type": "string" + }, + "target": { + "description": "The source of the error.\r\nFor example it would be \"documents\" or \"document id\" in case of invalid document.", + "type": "string" + }, + "innerError": { + "$ref": "#/definitions/InnerError" + } + } + }, + "ErrorCode": { + "title": "ErrorCode", + "description": "High level error codes.", + "enum": [ + "InvalidRequest", + "InvalidArgument", + "InternalServerError", + "ServiceUnavailable", + "NotFound", + "PipelineError", + "Conflict", + "InternalCommunicationFailed", + "Forbidden", + "NotAllowed", + "Unauthorized", + "UnsupportedMediaType", + "TooManyRequests", + "UnprocessableEntity" + ], + "type": "string", + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true, + "values": [ + { + "value": "InvalidRequest", + "description": "Representing the invalid request error code." + }, + { + "value": "InvalidArgument", + "description": "Representing the invalid argument error code." + }, + { + "value": "InternalServerError", + "description": "Representing the internal server error error code." + }, + { + "value": "ServiceUnavailable", + "description": "Representing the service unavailable error code." + }, + { + "value": "NotFound", + "description": "Representing the not found error code." + }, + { + "value": "PipelineError", + "description": "Representing the pipeline error error code." + }, + { + "value": "Conflict", + "description": "Representing the conflict error code." + }, + { + "value": "InternalCommunicationFailed", + "description": "Representing the internal communication failed error code." + }, + { + "value": "Forbidden", + "description": "Representing the forbidden error code." + }, + { + "value": "NotAllowed", + "description": "Representing the not allowed error code." + }, + { + "value": "Unauthorized", + "description": "Representing the unauthorized error code." + }, + { + "value": "UnsupportedMediaType", + "description": "Representing the unsupported media type error code." + }, + { + "value": "TooManyRequests", + "description": "Representing the too many requests error code." + }, + { + "value": "UnprocessableEntity", + "description": "Representing the unprocessable entity error code." + } + ] + } + }, + "Evaluation": { + "title": "Evaluation", + "required": [ + "dataset", + "displayName", + "locale", + "model1", + "model2" + ], + "type": "object", + "properties": { + "model1": { + "$ref": "#/definitions/EntityReference" + }, + "model2": { + "$ref": "#/definitions/EntityReference" + }, + "transcription1": { + "$ref": "#/definitions/EntityReference" + }, + "transcription2": { + "$ref": "#/definitions/EntityReference" + }, + "dataset": { + "$ref": "#/definitions/EntityReference" + }, + "links": { + "$ref": "#/definitions/EvaluationLinks" + }, + "properties": { + "$ref": "#/definitions/EvaluationProperties" + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Status" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "minLength": 1, + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "locale": { + "description": "The locale of the contained data.", + "minLength": 1, + "type": "string" + }, + "project": { + "$ref": "#/definitions/EntityReference" + } + } + }, + "EvaluationLinks": { + "title": "EvaluationLinks", + "type": "object", + "properties": { + "files": { + "format": "uri", + "description": "The location to get all files of this entity. See operation \"Evaluations_ListFiles\" for more details.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "EvaluationProperties": { + "title": "EvaluationProperties", + "type": "object", + "properties": { + "wordErrorRate1": { + "format": "double", + "description": "The word error rate of recognition with model1.", + "type": "number", + "readOnly": true + }, + "sentenceErrorRate1": { + "format": "double", + "description": "The sentence error rate of recognition with model1.", + "type": "number", + "readOnly": true + }, + "tokenErrorRate1": { + "format": "double", + "description": "The optional token error rate of recognition with model1.", + "type": "number", + "readOnly": true + }, + "sentenceCount1": { + "format": "int32", + "description": "The number of processed sentences by model1.", + "type": "integer", + "readOnly": true + }, + "wordCount1": { + "format": "int32", + "description": "The number of processed words by model1.", + "type": "integer", + "readOnly": true + }, + "correctWordCount1": { + "format": "int32", + "description": "The number of correctly recognized words by model1.", + "type": "integer", + "readOnly": true + }, + "wordSubstitutionCount1": { + "format": "int32", + "description": "The number of recognized words by model1, that are substitutions.", + "type": "integer", + "readOnly": true + }, + "wordDeletionCount1": { + "format": "int32", + "description": "The number of recognized words by model1, that are deletions.", + "type": "integer", + "readOnly": true + }, + "wordInsertionCount1": { + "format": "int32", + "description": "The number of recognized words by model1, that are insertions.", + "type": "integer", + "readOnly": true + }, + "tokenCount1": { + "format": "int32", + "description": "The optional number of processed tokens by model1.", + "type": "integer", + "readOnly": true + }, + "correctTokenCount1": { + "format": "int32", + "description": "The optional number of correctly recognized tokens by model1.", + "type": "integer", + "readOnly": true + }, + "tokenSubstitutionCount1": { + "format": "int32", + "description": "The optional number of recognized tokens by model1, that are substitutions.", + "type": "integer", + "readOnly": true + }, + "tokenDeletionCount1": { + "format": "int32", + "description": "The optional number of recognized tokens by model1, that are deletions.", + "type": "integer", + "readOnly": true + }, + "tokenInsertionCount1": { + "format": "int32", + "description": "The optional number of recognized tokens by model1, that are insertions.", + "type": "integer", + "readOnly": true + }, + "tokenErrors1": { + "$ref": "#/definitions/TokenErrorDetails" + }, + "wordErrorRate2": { + "format": "double", + "description": "The word error rate of recognition with model2.", + "type": "number", + "readOnly": true + }, + "sentenceErrorRate2": { + "format": "double", + "description": "The sentence error rate of recognition with model2.", + "type": "number", + "readOnly": true + }, + "tokenErrorRate2": { + "format": "double", + "description": "The optional token error rate of recognition with model2.", + "type": "number", + "readOnly": true + }, + "sentenceCount2": { + "format": "int32", + "description": "The number of processed sentences by model2.", + "type": "integer", + "readOnly": true + }, + "wordCount2": { + "format": "int32", + "description": "The number of processed words by model2.", + "type": "integer", + "readOnly": true + }, + "correctWordCount2": { + "format": "int32", + "description": "The number of correctly recognized words by model2.", + "type": "integer", + "readOnly": true + }, + "wordSubstitutionCount2": { + "format": "int32", + "description": "The number of recognized words by model2, that are substitutions.", + "type": "integer", + "readOnly": true + }, + "wordDeletionCount2": { + "format": "int32", + "description": "The number of recognized words by model2, that are deletions.", + "type": "integer", + "readOnly": true + }, + "wordInsertionCount2": { + "format": "int32", + "description": "The number of recognized words by model2, that are insertions.", + "type": "integer", + "readOnly": true + }, + "tokenCount2": { + "format": "int32", + "description": "The optional number of processed tokens by model2.", + "type": "integer", + "readOnly": true + }, + "correctTokenCount2": { + "format": "int32", + "description": "The optional number of correctly recognized tokens by model2.", + "type": "integer", + "readOnly": true + }, + "tokenSubstitutionCount2": { + "format": "int32", + "description": "The optional number of recognized tokens by model2, that are substitutions.", + "type": "integer", + "readOnly": true + }, + "tokenDeletionCount2": { + "format": "int32", + "description": "The optional number of recognized tokens by model2, that are deletions.", + "type": "integer", + "readOnly": true + }, + "tokenInsertionCount2": { + "format": "int32", + "description": "The optional number of recognized tokens by model2, that are insertions.", + "type": "integer", + "readOnly": true + }, + "tokenErrors2": { + "$ref": "#/definitions/TokenErrorDetails" + }, + "email": { + "description": "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email.", + "type": "string" + }, + "error": { + "$ref": "#/definitions/EntityError" + } + }, + "readOnly": true + }, + "EvaluationUpdate": { + "title": "EvaluationUpdate", + "type": "object", + "properties": { + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "project": { + "$ref": "#/definitions/EntityReference" + } + } + }, + "File": { + "title": "File", + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/FileKind" + }, + "links": { + "$ref": "#/definitions/FileLinks" + }, + "createdDateTime": { + "format": "date-time", + "description": "The creation time of this file.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/FileProperties" + }, + "name": { + "description": "The name of this file.", + "type": "string", + "readOnly": true + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + } + } + }, + "FileKind": { + "title": "FileKind", + "description": "Type of data.", + "enum": [ + "DatasetReport", + "Audio", + "LanguageData", + "PronunciationData", + "AcousticDataArchive", + "AcousticDataTranscriptionV2", + "Transcription", + "TranscriptionReport", + "EvaluationDetails", + "ModelReport", + "OutputFormattingData" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "FileKind", + "modelAsString": true, + "values": [ + { + "value": "DatasetReport", + "description": "Type of data is dataset report." + }, + { + "value": "Audio", + "description": "Type of data is audio." + }, + { + "value": "LanguageData", + "description": "Type of data is language data." + }, + { + "value": "PronunciationData", + "description": "Type of data is pronunciation data." + }, + { + "value": "AcousticDataArchive", + "description": "Type of data is acoustic data archive." + }, + { + "value": "AcousticDataTranscriptionV2", + "description": "Type of data is acoustic data transcription v2." + }, + { + "value": "Transcription", + "description": "Type of data is transcription." + }, + { + "value": "TranscriptionReport", + "description": "Type of data is transcription report." + }, + { + "value": "EvaluationDetails", + "description": "Type of data is evaluation details." + }, + { + "value": "ModelReport", + "description": "Type of data is model report." + }, + { + "value": "OutputFormattingData", + "description": "Type of data is output formatting input file." + } + ] + } + }, + "FileLinks": { + "title": "FileLinks", + "type": "object", + "properties": { + "contentUrl": { + "format": "uri", + "description": "The url to retrieve the content of this file.", + "type": "string", + "readOnly": true + } + } + }, + "FileProperties": { + "title": "FileProperties", + "type": "object", + "properties": { + "size": { + "format": "int64", + "description": "The size of the data in bytes.", + "type": "integer", + "readOnly": true + }, + "duration": { + "description": "The duration in case this file is an audio file. The duration is encoded as ISO 8601\r\nduration (\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations).", + "type": "string", + "readOnly": true + } + } + }, + "InnerError": { + "title": "InnerError", + "description": "New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.\r\nThis contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).", + "type": "object", + "properties": { + "code": { + "$ref": "#/definitions/DetailedErrorCode" + }, + "details": { + "description": "Additional supportive details regarding the error and/or expected policies.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "message": { + "description": "High level error message.", + "type": "string" + }, + "target": { + "description": "The source of the error.\r\nFor example it would be \"documents\" or \"document id\" in case of invalid document.", + "type": "string" + }, + "innerError": { + "$ref": "#/definitions/InnerError" + } + } + }, + "LanguageIdentificationMode": { + "title": "LanguageIdentificationMode", + "description": "The mode used for language identification.", + "default": "Continuous", + "enum": [ + "Continuous", + "Single" + ], + "type": "string", + "x-ms-enum": { + "name": "LanguageIdentificationMode", + "modelAsString": true, + "values": [ + { + "value": "Continuous", + "description": "Continuous language identification (Default)." + }, + { + "value": "Single", + "description": "Single language identification. If no language can be identified, the error code NoLanguageIdentified is returned to the user. If there is ambiguity between multiple languages, the error code MultipleLanguagesIdentified is returned to the user." + } + ] + } + }, + "LanguageIdentificationProperties": { + "title": "LanguageIdentificationProperties", + "required": [ + "candidateLocales" + ], + "type": "object", + "properties": { + "mode": { + "$ref": "#/definitions/LanguageIdentificationMode" + }, + "candidateLocales": { + "description": "The candidate locales for language identification (example [\"en-US\", \"de-DE\", \"es-ES\"]). A minimum of 2 and a maximum of 10 candidate locales, including the main locale for the transcription, is supported for continuous mode. For single language identification, the maximum number of candidate locales is unbounded.", + "type": "array", + "items": { + "type": "string" + } + }, + "speechModelMapping": { + "description": "An optional mapping of locales to speech model entities. If no model is given for a locale, the default base model is used.\r\nKeys must be locales contained in the candidate locales, values are entities for models of the respective locales.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/EntityReference" + } + } + } + }, + "ModelCopyAuthorization": { + "title": "ModelCopyAuthorization", + "required": [ + "expirationDateTime", + "id", + "sourceResourceId", + "targetResourceEndpoint", + "targetResourceId", + "targetResourceRegion" + ], + "type": "object", + "properties": { + "targetResourceRegion": { + "description": "The region (aka location) of the target speech resource (e.g., westus2).", + "minLength": 1, + "type": "string" + }, + "targetResourceId": { + "description": "The Azure Resource ID of the target speech resource.", + "minLength": 1, + "type": "string" + }, + "targetResourceEndpoint": { + "description": "The endpoint (base url) of the target resource (with custom domain name when it is used).", + "minLength": 1, + "type": "string" + }, + "sourceResourceId": { + "description": "The Azure Resource ID of the source speech resource.", + "minLength": 1, + "type": "string" + }, + "expirationDateTime": { + "format": "date-time", + "description": "The expiration date of this copy authorization.", + "type": "string" + }, + "id": { + "description": "The ID of this copy authorization.", + "minLength": 1, + "type": "string" + } + } + }, + "ModelCopyAuthorizationDefinition": { + "title": "ModelCopyAuthorizationDefinition", + "required": [ + "sourceResourceId" + ], + "type": "object", + "properties": { + "sourceResourceId": { + "description": "The Azure Resource ID of the source speech resource.", + "minLength": 1, + "type": "string" + } + } + }, + "ModelFile": { + "title": "ModelFile", + "type": "object", + "properties": { + "name": { + "description": "The name of this file.", + "type": "string", + "readOnly": true + }, + "contentUrl": { + "format": "uri", + "description": "The url to retrieve the content of this file.", + "type": "string", + "readOnly": true + } + } + }, + "ModelManifest": { + "title": "ModelManifest", + "required": [ + "model", + "modelFiles", + "properties" + ], + "type": "object", + "properties": { + "model": { + "$ref": "#/definitions/EntityReference" + }, + "modelFiles": { + "description": "The model files of this model.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelFile" + } + }, + "properties": { + "description": "The configuration for running this model in a container.", + "type": "object", + "additionalProperties": {} + } + } + }, + "ModelUpdate": { + "title": "ModelUpdate", + "type": "object", + "properties": { + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "project": { + "$ref": "#/definitions/EntityReference" + } + } + }, + "Operation": { + "title": "Operation", + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "The identifier of this Operation.", + "type": "string" + }, + "result": { + "$ref": "#/definitions/OperationResult" + }, + "error": { + "$ref": "#/definitions/EntityError" + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Status" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + } + } + }, + "OperationResult": { + "title": "OperationResult", + "type": "object", + "properties": { + "link": { + "format": "uri", + "description": "The link to the result of the operation.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "OutputFormatType": { + "title": "OutputFormatType", + "enum": [ + "Lexical", + "Display" + ], + "type": "string", + "x-ms-enum": { + "name": "OutputFormatType", + "modelAsString": true, + "values": [ + { + "value": "Lexical", + "description": "Model provides the transcription output without formatting." + }, + { + "value": "Display", + "description": "Model supports display formatting transcriptions output or endpoints." + } + ] + } + }, + "PaginatedBaseModels": { + "title": "PaginatedBaseModels", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/BaseModel" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedCustomModels": { + "title": "PaginatedCustomModels", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomModel" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedDatasets": { + "title": "PaginatedDatasets", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/Dataset" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedEndpoints": { + "title": "PaginatedEndpoints", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/Endpoint" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedEvaluations": { + "title": "PaginatedEvaluations", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/Evaluation" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedFiles": { + "title": "PaginatedFiles", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/File" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedProjects": { + "title": "PaginatedProjects", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/Project" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedTranscriptions": { + "title": "PaginatedTranscriptions", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/Transcription" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "PaginatedWebHooks": { + "title": "PaginatedWebHooks", + "type": "object", + "properties": { + "values": { + "description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.", + "type": "array", + "items": { + "$ref": "#/definitions/WebHook" + }, + "readOnly": true + }, + "@nextLink": { + "format": "uri", + "description": "A link to the next set of paginated results if there are more entities available; otherwise null.", + "type": "string", + "readOnly": true + } + } + }, + "ProfanityFilterMode": { + "title": "ProfanityFilterMode", + "description": "Mode of profanity filtering.", + "enum": [ + "None", + "Removed", + "Tags", + "Masked" + ], + "type": "string", + "x-ms-enum": { + "name": "ProfanityFilterMode", + "modelAsString": false, + "values": [ + { + "value": "None", + "description": "Disable profanity filtering." + }, + { + "value": "Removed", + "description": "Remove profanity." + }, + { + "value": "Tags", + "description": "Add \"profanity\" XML tags</Profanity>" + }, + { + "value": "Masked", + "description": "Mask the profanity with * except of the first letter, e.g., f***" + } + ] + } + }, + "Project": { + "title": "Project", + "required": [ + "displayName", + "locale" + ], + "type": "object", + "properties": { + "links": { + "$ref": "#/definitions/ProjectLinks" + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "minLength": 1, + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "locale": { + "description": "The locale of the contained data.", + "minLength": 1, + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + } + } + }, + "ProjectLinks": { + "title": "ProjectLinks", + "type": "object", + "properties": { + "evaluations": { + "format": "uri", + "description": "The location to get a list of all evaluations of this project. See operation \"Projects_ListEvaluations\" for more details.", + "type": "string", + "readOnly": true + }, + "datasets": { + "format": "uri", + "description": "The location to get a list of all datasets of this project. See operation \"Projects_ListDatasets\" for more details.", + "type": "string", + "readOnly": true + }, + "models": { + "format": "uri", + "description": "The location to get a list of all models of this project. See operation \"Projects_ListModels\" for more details.", + "type": "string", + "readOnly": true + }, + "endpoints": { + "format": "uri", + "description": "The location to get a list of all endpoints of this project. See operation \"Projects_ListEndpoints\" for more details.", + "type": "string", + "readOnly": true + }, + "transcriptions": { + "format": "uri", + "description": "The location to get a list of all transcriptions of this project. See operation \"Projects_ListTranscriptions\" for more details.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "ProjectUpdate": { + "title": "ProjectUpdate", + "type": "object", + "properties": { + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "PunctuationMode": { + "title": "PunctuationMode", + "description": "The mode used for punctuation.", + "enum": [ + "None", + "Dictated", + "Automatic", + "DictatedAndAutomatic" + ], + "type": "string", + "x-ms-enum": { + "name": "PunctuationMode", + "modelAsString": false, + "values": [ + { + "value": "None", + "description": "No punctuation." + }, + { + "value": "Dictated", + "description": "Dictated punctuation marks only, i.e., explicit punctuation." + }, + { + "value": "Automatic", + "description": "Automatic punctuation." + }, + { + "value": "DictatedAndAutomatic", + "description": "Dictated punctuation marks or automatic punctuation." + } + ] + } + }, + "ResponseBlock": { + "title": "ResponseBlock", + "description": "ResponseBlock.", + "type": "object", + "properties": { + "name": { + "description": "The name of the block.", + "type": "string" + }, + "size": { + "format": "int32", + "description": "The size of the block.", + "type": "integer" + } + } + }, + "SharedModel": { + "title": "SharedModel", + "required": [ + "displayName", + "locale" + ], + "type": "object", + "properties": { + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "locale": { + "description": "The locale of the contained data.", + "minLength": 1, + "type": "string" + }, + "displayName": { + "description": "The display name of the object.", + "minLength": 1, + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Status" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + } + } + }, + "SharedModelFeatures": { + "title": "SharedModelFeatures", + "description": "Features supported by the model.", + "type": "object", + "properties": { + "supportsTranscriptionsSubmit": { + "description": "A value indicating whether submission of transcription jobs is supported (POST /transcriptions:submit).", + "type": "boolean", + "readOnly": true + }, + "supportsTranscriptionsTranscribe": { + "description": "A value indicating whether the transcribe action is supported (POST /transcriptions:transcribe).", + "type": "boolean", + "readOnly": true + }, + "supportsEndpoints": { + "description": "A value indicating whether creation of endpoints for live transcription is supported.", + "type": "boolean", + "readOnly": true + }, + "supportsTranscriptionsOnSpeechContainers": { + "description": "A value indicating whether this model can be used for transcription on speech container. This feature can be added on existing models when it becomes usable on speech container.", + "type": "boolean", + "readOnly": true + }, + "supportedOutputFormats": { + "description": "Supported output formats.", + "type": "array", + "items": { + "$ref": "#/definitions/OutputFormatType" + }, + "readOnly": true + } + } + }, + "Status": { + "title": "Status", + "description": "Describe the current state of the API.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": false, + "values": [ + { + "value": "NotStarted", + "description": "The long running operation has not yet started." + }, + { + "value": "Running", + "description": "The long running operation is currently processing." + }, + { + "value": "Succeeded", + "description": "The long running operation has successfully completed." + }, + { + "value": "Failed", + "description": "The long running operation has failed." + } + ] + } + }, + "TextNormalizationKind": { + "title": "TextNormalizationKind", + "description": "The kind of text normalization.", + "enum": [ + "Default", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "TextNormalizationKind", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "Default text normalization (e.g. '2 to 3' is replaced by 'two to three' in en-US)." + }, + { + "value": "None", + "description": "No text normalization will be applied to the input text. This is an override option that should only be used when text is normalized before the upload." + } + ] + } + }, + "TokenErrorDetails": { + "title": "TokenErrorDetails", + "type": "object", + "properties": { + "punctuation": { + "$ref": "#/definitions/EditsSummary" + }, + "capitalization": { + "$ref": "#/definitions/EditsSummary" + }, + "inverseTextNormalization": { + "$ref": "#/definitions/EditsSummary" + }, + "lexical": { + "$ref": "#/definitions/EditsSummary" + }, + "others": { + "$ref": "#/definitions/EditsSummary" + } + }, + "readOnly": true + }, + "Transcription": { + "title": "Transcription", + "required": [ + "displayName", + "locale", + "properties" + ], + "type": "object", + "properties": { + "links": { + "$ref": "#/definitions/TranscriptionLinks" + }, + "properties": { + "$ref": "#/definitions/TranscriptionProperties" + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "model": { + "$ref": "#/definitions/EntityReference" + }, + "dataset": { + "$ref": "#/definitions/EntityReference" + }, + "contentUrls": { + "description": "A list of content urls to get audio files to transcribe. Up to 1000 urls are allowed.\r\nThis property will not be returned in a response.", + "type": "array", + "items": { + "format": "uri", + "type": "string" + } + }, + "contentContainerUrl": { + "format": "uri", + "description": "A URL for an Azure blob container that contains the audio files. A container is allowed to have a maximum size of 5GB and a maximum number of 10000 blobs.\r\nThe maximum size for a blob is 2.5GB.\r\nContainer SAS should contain 'r' (read) and 'l' (list) permissions.\r\nThis property will not be returned in a response.", + "type": "string" + }, + "locale": { + "description": "The locale of the contained data. If Language Identification is used, this locale is used to transcribe speech for which no language could be detected.", + "minLength": 1, + "type": "string" + }, + "displayName": { + "description": "The display name of the object.", + "minLength": 1, + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "project": { + "$ref": "#/definitions/EntityReference" + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Status" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + } + } + }, + "TranscriptionLinks": { + "title": "TranscriptionLinks", + "type": "object", + "properties": { + "files": { + "format": "uri", + "description": "The location to get all files of this entity. See operation \"Transcriptions_ListFiles\" for more details.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "TranscriptionLocales": { + "title": "TranscriptionLocales", + "type": "object", + "properties": { + "Transcribe": { + "type": "array", + "items": { + "type": "string" + } + }, + "Submit": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "TranscriptionProperties": { + "title": "TranscriptionProperties", + "required": [ + "timeToLive" + ], + "type": "object", + "properties": { + "wordLevelTimestampsEnabled": { + "description": "A value indicating whether word level timestamps are requested. The default value is\r\n`false`.", + "type": "boolean" + }, + "displayFormWordLevelTimestampsEnabled": { + "description": "A value indicating whether word level timestamps for the display form are requested. The default value is `false`.", + "type": "boolean" + }, + "duration": { + "description": "The duration of the transcription. The duration is encoded as ISO 8601 duration\r\n(\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations).", + "type": "string", + "readOnly": true + }, + "channels": { + "description": "A collection of the requested channel numbers.\r\nIn the default case, the channels 0 and 1 are considered.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "destinationContainerUrl": { + "format": "uri", + "description": "The requested destination container.\r\n### Remarks ###\r\nWhen a destination container is used in combination with a `timeToLive`, the metadata of a\r\ntranscription will be deleted normally, but the data stored in the destination container, including\r\ntranscription results, will remain untouched, because no delete permissions are required for this\r\ncontainer.\n\r\nTo support automatic cleanup, either configure blob lifetimes on the container, or use \"Bring your own Storage (BYOS)\"\r\ninstead of `destinationContainerUrl`, where blobs can be cleaned up.", + "type": "string" + }, + "punctuationMode": { + "$ref": "#/definitions/PunctuationMode" + }, + "profanityFilterMode": { + "$ref": "#/definitions/ProfanityFilterMode" + }, + "timeToLive": { + "description": "How long the transcription will be kept in the system after it has completed. Once the\r\ntranscription reaches the time to live after completion (successful or failed) it will be automatically\r\ndeleted.\r\n \r\nNote: When using BYOS (bring your own storage), the result files on the customer owned storage account\r\nwill also be deleted. Use either destinationContainerUrl to specify a separate container for result files\r\nwhich will not be deleted when the timeToLive expires, or retrieve the result files through the API and\r\nstore them as needed.\r\n \r\nThe shortest supported duration is 6h, the longest supported duration is 31 days. 2 days (\"P2D\") is the recommended default value\r\nwhen data is consumed directly.\r\nThe duration is encoded as ISO 8601 duration (\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations).", + "type": "string" + }, + "email": { + "description": "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email.", + "type": "string" + }, + "error": { + "$ref": "#/definitions/EntityError" + }, + "diarizationEnabled": { + "description": "A value indicating whether diarization (speaker identification) is requested. The default value\r\nis `false`.\r\nIf this field is set to true and the improved diarization system is configured by specifying\r\n`DiarizationProperties`, the improved diarization system will provide diarization for a configurable\r\nrange of speakers.\r\nIf this field is set to true and the improved diarization system is not enabled (not specifying\r\n`DiarizationProperties`), the basic diarization system will distinguish between up to two speakers.\r\nNo extra charges are applied for the basic diarization.\r\n \r\nThe basic diarization system is deprecated and will be removed in the next major version of the API.\r\nThis `diarizationEnabled` setting will also be removed.", + "type": "boolean" + }, + "diarization": { + "$ref": "#/definitions/DiarizationProperties" + }, + "languageIdentification": { + "$ref": "#/definitions/LanguageIdentificationProperties" + } + } + }, + "TranscriptionUpdate": { + "title": "TranscriptionUpdate", + "type": "object", + "properties": { + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "project": { + "$ref": "#/definitions/EntityReference" + } + } + }, + "UploadedBlocks": { + "title": "UploadedBlocks", + "description": "List of uploaded blocks.", + "type": "object", + "properties": { + "committedBlocks": { + "description": "The block description of blocks already committed.", + "type": "array", + "items": { + "$ref": "#/definitions/ResponseBlock" + } + }, + "uncommittedBlocks": { + "description": "The block description of blocks not committed to the blob.", + "type": "array", + "items": { + "$ref": "#/definitions/ResponseBlock" + } + } + } + }, + "WebHook": { + "title": "WebHook", + "required": [ + "displayName", + "events", + "webUrl" + ], + "type": "object", + "properties": { + "webUrl": { + "format": "uri", + "description": "The registered URL that will be used to send the POST requests for the registered events to.", + "type": "string" + }, + "links": { + "$ref": "#/definitions/WebHookLinks" + }, + "properties": { + "$ref": "#/definitions/WebHookProperties" + }, + "self": { + "format": "uri", + "description": "The location of this entity.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the object.", + "minLength": 1, + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "events": { + "$ref": "#/definitions/WebHookEvents" + }, + "createdDateTime": { + "format": "date-time", + "description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Status" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "WebHookEvents": { + "title": "WebHookEvents", + "type": "object", + "properties": { + "datasetCreation": { + "type": "boolean" + }, + "datasetProcessing": { + "type": "boolean" + }, + "datasetCompletion": { + "type": "boolean" + }, + "datasetDeletion": { + "type": "boolean" + }, + "modelCreation": { + "type": "boolean" + }, + "modelProcessing": { + "type": "boolean" + }, + "modelCompletion": { + "type": "boolean" + }, + "modelDeletion": { + "type": "boolean" + }, + "evaluationCreation": { + "type": "boolean" + }, + "evaluationProcessing": { + "type": "boolean" + }, + "evaluationCompletion": { + "type": "boolean" + }, + "evaluationDeletion": { + "type": "boolean" + }, + "transcriptionCreation": { + "type": "boolean" + }, + "transcriptionProcessing": { + "type": "boolean" + }, + "transcriptionCompletion": { + "type": "boolean" + }, + "transcriptionDeletion": { + "type": "boolean" + }, + "endpointCreation": { + "type": "boolean" + }, + "endpointProcessing": { + "type": "boolean" + }, + "endpointCompletion": { + "type": "boolean" + }, + "endpointDeletion": { + "type": "boolean" + }, + "ping": { + "type": "boolean" + }, + "challenge": { + "type": "boolean" + } + } + }, + "WebHookLinks": { + "title": "WebHookLinks", + "type": "object", + "properties": { + "ping": { + "format": "uri", + "description": "The URL that can be used to trigger the sending of a ping event to the registered URL of a web hook registration. See operation \"WebHooks_Ping\" for more details.", + "type": "string", + "readOnly": true + }, + "test": { + "format": "uri", + "description": "The URL that can be used sending test events to the registered URL of a web hook registration. See operation \"WebHooks_Test\" for more details.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "WebHookProperties": { + "title": "WebHookProperties", + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/EntityError" + }, + "apiVersion": { + "description": "The API version the web hook was created in. This defines the shape of the payload in the callbacks.\r\nIf the payload type is not supported anymore, because the shape changed and the API version using it is removed (after deprecation),\r\nthe web hook will be disabled.", + "type": "string", + "readOnly": true + }, + "secret": { + "description": "A secret that will be used to create a SHA256 hash of the payload with the secret as HMAC key.\r\nThis hash will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL.", + "type": "string" + } + } + }, + "WebHookPropertiesUpdate": { + "title": "WebHookPropertiesUpdate", + "type": "object", + "properties": { + "secret": { + "description": "A secret that will be used to create a SHA256 hash of the payload with the secret as HMAC key.\r\nThis hash will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL.", + "type": "string" + } + } + }, + "WebHookUpdate": { + "title": "WebHookUpdate", + "type": "object", + "properties": { + "webUrl": { + "format": "uri", + "description": "The registered URL that will be used to send the POST requests for the registered events to.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/WebHookPropertiesUpdate" + }, + "events": { + "$ref": "#/definitions/WebHookEvents" + }, + "displayName": { + "description": "The name of the object.", + "type": "string" + }, + "description": { + "description": "The description of the object.", + "type": "string" + }, + "customProperties": { + "description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "CombinedPhrases": { + "required": [ + "text" + ], + "type": "object", + "properties": { + "channel": { + "format": "int32", + "description": "The 0-based channel index. Only present if channel separation is enabled.", + "type": "integer" + }, + "text": { + "description": "The complete transcribed text for the channel.", + "type": "string" + } + } + }, + "Phrase": { + "description": "A transcribed phrase.", + "required": [ + "confidence", + "duration", + "offset", + "text" + ], + "type": "object", + "properties": { + "channel": { + "format": "int32", + "description": "The 0-based channel index. Only present if channel separation is enabled.", + "type": "integer" + }, + "speaker": { + "format": "int32", + "description": "The speaker number. Only present if speaker diarization is enabled.", + "type": "integer" + }, + "offset": { + "format": "int64", + "description": "The start offset of the phrase in milliseconds.", + "type": "integer" + }, + "duration": { + "format": "int64", + "description": "The duration of the phrase in milliseconds.", + "type": "integer" + }, + "text": { + "description": "The transcribed text of the phrase.", + "type": "string" + }, + "words": { + "description": "The words that make up the phrase. Only present if word-level timestamps are enabled.", + "type": "array", + "items": { + "$ref": "#/definitions/Word" + } + }, + "locale": { + "description": "The locale of the phrase.", + "type": "string" + }, + "confidence": { + "format": "float", + "description": "The confidence value for the phrase.", + "type": "number" + } + } + }, + "TranscribeDefinition": { + "description": "Metadata for a fast transcription request.", + "type": "object", + "properties": { + "locales": { + "description": "The input locales. Currently, only one locale is supported.", + "type": "array", + "items": { + "type": "string" + } + }, + "models": { + "description": "Maps some or all candidate locales to a model URI to be used for transcription. If no mapping is given, the default model for the locale is used.", + "type": "object", + "additionalProperties": { + "format": "uri", + "type": "string" + } + }, + "profanityFilterMode": { + "$ref": "#/definitions/ProfanityFilterMode" + }, + "channels": { + "description": "The 0-based indices of the channels to be transcribed separately. If not specified, multiple channels are merged and transcribed jointly. Only up to two channels are supported.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + } + } + }, + "TranscribeResult": { + "description": "The result of the transcribe operation.", + "required": [ + "combinedPhrases", + "duration", + "phrases" + ], + "type": "object", + "properties": { + "duration": { + "format": "int64", + "description": "The duration of the audio in milliseconds.", + "type": "integer" + }, + "combinedPhrases": { + "description": "The combined transcription results for each channel.", + "type": "array", + "items": { + "$ref": "#/definitions/CombinedPhrases" + } + }, + "phrases": { + "description": "The transcription results segmented into phrases.", + "type": "array", + "items": { + "$ref": "#/definitions/Phrase" + } + } + } + }, + "Word": { + "description": "Time-stamped word in the display form.", + "required": [ + "duration", + "offset", + "text" + ], + "type": "object", + "properties": { + "text": { + "description": "The recognized word, including punctuation.", + "type": "string" + }, + "offset": { + "format": "int64", + "description": "The start offset of the word in milliseconds.", + "type": "integer" + }, + "duration": { + "format": "int64", + "description": "The duration of the word in milliseconds.", + "type": "integer" + } + } + } + }, + "parameters": { + "endpoint": { + "in": "path", + "name": "endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", + "required": true, + "type": "string", + "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-parameter-location": "client" + }, + "skipQueryParameter": { + "in": "query", + "name": "skip", + "description": "Number of datasets that will be skipped.", + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "topQueryParameter": { + "in": "query", + "name": "top", + "description": "Number of datasets that will be included after skipping.", + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "sasValidityQueryParameter": { + "in": "query", + "name": "sasValidityInSeconds", + "description": "The duration in seconds that an SAS url should be valid. The default duration is 12 hours. When using BYOS (https://learn.microsoft.com/en-us/azure/cognitive-services/speech-service/speech-encryption-of-data-at-rest#bring-your-own-storage-byos-for-customization-and-logging): A value of 0 means that a plain blob URI without SAS token will be generated.", + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "api_key": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header", + "description": "Provide your cognitive services account key here." + }, + "token": { + "type": "apiKey", + "name": "Authorization", + "in": "header", + "description": "Provide an access token from the JWT returned by the STS of this region. Make sure to add the management scope to the token by adding the following query string to the STS URL: ?scope=speechservicesmanagement" + } + }, + "security": [ + { + "api_key": [] + }, + { + "token": [] + } + ], + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/speechtotext", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/endpoint" + } + ] + } +} diff --git a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md index 880ec988957b..883049a017dc 100644 --- a/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md +++ b/specification/cognitiveservices/data-plane/Speech/SpeechToText/readme.md @@ -162,4 +162,27 @@ directive: reason: There is a sub-route called /models/base/ that refers to the base models. Therefore, the correct operation ID seems to be "Models_GetBaseModel", for example. - suppress: HostParametersValidation reason: Existing API, change would potentially be breaking. -``` \ No newline at end of file +``` + +## Tag: release_2024_05_15_preview + +These settings apply only when `--tag=release_2024_05_15_preview` is specified on the command line. + +```yaml $(tag) == 'release_2024_05_15_preview' +input-file: + - preview/2024-05-15-preview/speechtotext.json +``` + +AutoRest-Linter Suppressions + +``` yaml +# Ignore autorest-linter issues that cannot be resolve without updates to the API implementation +directive: + - suppress: LongRunningOperationsWithLongRunningExtension + reason: Does not apply in those two places. The method is a DELETE which lazily deletes blobs, so it's Accepted, not NoContent. + - suppress: OperationIdNounVerb + where: $..paths[($..operationId["Models_*"])] + reason: There is a sub-route called /models/base/ that refers to the base models. Therefore, the correct operation ID seems to be "Models_GetBaseModel", for example. + - suppress: HostParametersValidation + reason: Existing API, change would potentially be breaking. +``` diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2023-10-01-preview/examples/GetRaiPolicy.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2023-10-01-preview/examples/GetRaiPolicy.json index b04d5f571b97..85119a45c5d8 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2023-10-01-preview/examples/GetRaiPolicy.json +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2023-10-01-preview/examples/GetRaiPolicy.json @@ -14,24 +14,88 @@ "name": "raiPolicyName", "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", "properties": { - "basePolicyName": "112", + "basePolicyName": "Microsoft.Default", + "mode": "Deferred", "contentFilters": [ { "name": "hate", - "allowedContentLevel": "Low", - "blocking": true + "blocking": false, + "enabled": false, + "allowedContentLevel": "High", + "source": "Prompt" + }, + { + "name": "hate", + "blocking": true, + "enabled": true, + "allowedContentLevel": "Medium", + "source": "Completion" + }, + { + "name": "sexual", + "blocking": true, + "enabled": true, + "allowedContentLevel": "High", + "source": "Prompt" }, { "name": "sexual", - "allowedContentLevel": "Low" + "blocking": true, + "enabled": true, + "allowedContentLevel": "Medium", + "source": "Completion" + }, + { + "name": "selfharm", + "blocking": true, + "enabled": true, + "allowedContentLevel": "High", + "source": "Prompt" + }, + { + "name": "selfharm", + "blocking": true, + "enabled": true, + "allowedContentLevel": "Medium", + "source": "Completion" }, { "name": "violence", - "enabled": false + "blocking": true, + "enabled": true, + "allowedContentLevel": "Medium", + "source": "Prompt" + }, + { + "name": "violence", + "blocking": true, + "enabled": true, + "allowedContentLevel": "Medium", + "source": "Completion" + }, + { + "name": "jailbreak", + "blocking": true, + "source": "Prompt", + "enabled": true + }, + { + "name": "protected_material_text", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "protected_material_code", + "blocking": true, + "source": "Completion", + "enabled": true }, { - "name": "DefaultHateSpeechBlockList", - "enabled": false + "name": "profanity", + "blocking": true, + "source": "Prompt", + "enabled": true } ] } diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2023-10-01-preview/examples/ListRaiPolicies.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2023-10-01-preview/examples/ListRaiPolicies.json index f316a6870ab6..d49dc1160cb2 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2023-10-01-preview/examples/ListRaiPolicies.json +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2023-10-01-preview/examples/ListRaiPolicies.json @@ -13,24 +13,88 @@ "name": "raiPolicyName", "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", "properties": { - "basePolicyName": "112", + "basePolicyName": "Microsoft.Default", + "mode": "Deferred", "contentFilters": [ { "name": "hate", - "allowedContentLevel": "Low", - "blocking": true + "blocking": false, + "enabled": false, + "allowedContentLevel": "High", + "source": "Prompt" + }, + { + "name": "hate", + "blocking": true, + "enabled": true, + "allowedContentLevel": "Medium", + "source": "Completion" + }, + { + "name": "sexual", + "blocking": true, + "enabled": true, + "allowedContentLevel": "High", + "source": "Prompt" }, { "name": "sexual", - "allowedContentLevel": "Low" + "blocking": true, + "enabled": true, + "allowedContentLevel": "Medium", + "source": "Completion" + }, + { + "name": "selfharm", + "blocking": true, + "enabled": true, + "allowedContentLevel": "High", + "source": "Prompt" + }, + { + "name": "selfharm", + "blocking": true, + "enabled": true, + "allowedContentLevel": "Medium", + "source": "Completion" }, { "name": "violence", - "enabled": false + "blocking": true, + "enabled": true, + "allowedContentLevel": "Medium", + "source": "Prompt" + }, + { + "name": "violence", + "blocking": true, + "enabled": true, + "allowedContentLevel": "Medium", + "source": "Completion" + }, + { + "name": "jailbreak", + "blocking": true, + "source": "Prompt", + "enabled": true + }, + { + "name": "protected_material_text", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "protected_material_code", + "blocking": true, + "source": "Completion", + "enabled": true }, { - "name": "DefaultHateSpeechBlockList", - "enabled": false + "name": "profanity", + "blocking": true, + "source": "Prompt", + "enabled": true } ] } diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2023-10-01-preview/examples/PutRaiPolicy.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2023-10-01-preview/examples/PutRaiPolicy.json index 143258bae145..c2a710551e6e 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2023-10-01-preview/examples/PutRaiPolicy.json +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2023-10-01-preview/examples/PutRaiPolicy.json @@ -7,7 +7,8 @@ "raiPolicyName": "raiPolicyName", "raiPolicy": { "properties": { - "basePolicyName": "112", + "basePolicyName": "Microsoft.Default", + "mode": "Deferred", "contentFilters": [ { "name": "hate", @@ -88,12 +89,6 @@ "blocking": true, "source": "Prompt", "enabled": true - }, - { - "name": "profanity", - "blocking": true, - "source": "Completion", - "enabled": true } ] } @@ -106,6 +101,7 @@ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", "properties": { "basePolicyName": "Microsoft.Default", + "mode": "Deferred", "contentFilters": [ { "name": "hate", @@ -186,12 +182,6 @@ "blocking": true, "source": "Prompt", "enabled": true - }, - { - "name": "profanity", - "blocking": true, - "source": "Completion", - "enabled": true } ] } @@ -203,6 +193,7 @@ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", "properties": { "basePolicyName": "Microsoft.Default", + "mode": "Deferred", "contentFilters": [ { "name": "hate", @@ -283,12 +274,6 @@ "blocking": true, "source": "Prompt", "enabled": true - }, - { - "name": "profanity", - "blocking": true, - "source": "Completion", - "enabled": true } ] } diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-04-01-preview/examples/GetRaiPolicy.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-04-01-preview/examples/GetRaiPolicy.json index 71b9955fe66e..5fafce6b4614 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-04-01-preview/examples/GetRaiPolicy.json +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-04-01-preview/examples/GetRaiPolicy.json @@ -14,24 +14,88 @@ "name": "raiPolicyName", "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", "properties": { - "basePolicyName": "112", + "basePolicyName": "Microsoft.Default", + "mode": "Deferred", "contentFilters": [ { "name": "hate", - "allowedContentLevel": "Low", - "blocking": true + "blocking": false, + "enabled": false, + "allowedContentLevel": "High", + "source": "Prompt" + }, + { + "name": "hate", + "blocking": true, + "enabled": true, + "allowedContentLevel": "Medium", + "source": "Completion" + }, + { + "name": "sexual", + "blocking": true, + "enabled": true, + "allowedContentLevel": "High", + "source": "Prompt" }, { "name": "sexual", - "allowedContentLevel": "Low" + "blocking": true, + "enabled": true, + "allowedContentLevel": "Medium", + "source": "Completion" + }, + { + "name": "selfharm", + "blocking": true, + "enabled": true, + "allowedContentLevel": "High", + "source": "Prompt" + }, + { + "name": "selfharm", + "blocking": true, + "enabled": true, + "allowedContentLevel": "Medium", + "source": "Completion" }, { "name": "violence", - "enabled": false + "blocking": true, + "enabled": true, + "allowedContentLevel": "Medium", + "source": "Prompt" + }, + { + "name": "violence", + "blocking": true, + "enabled": true, + "allowedContentLevel": "Medium", + "source": "Completion" + }, + { + "name": "jailbreak", + "blocking": true, + "source": "Prompt", + "enabled": true + }, + { + "name": "protected_material_text", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "protected_material_code", + "blocking": true, + "source": "Completion", + "enabled": true }, { - "name": "DefaultHateSpeechBlockList", - "enabled": false + "name": "profanity", + "blocking": true, + "source": "Prompt", + "enabled": true } ] } diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-04-01-preview/examples/ListRaiPolicies.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-04-01-preview/examples/ListRaiPolicies.json index 30623cb1abf7..8920f8e89dcc 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-04-01-preview/examples/ListRaiPolicies.json +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-04-01-preview/examples/ListRaiPolicies.json @@ -13,24 +13,88 @@ "name": "raiPolicyName", "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", "properties": { - "basePolicyName": "112", + "basePolicyName": "Microsoft.Default", + "mode": "Deferred", "contentFilters": [ { "name": "hate", - "allowedContentLevel": "Low", - "blocking": true + "blocking": false, + "enabled": false, + "allowedContentLevel": "High", + "source": "Prompt" + }, + { + "name": "hate", + "blocking": true, + "enabled": true, + "allowedContentLevel": "Medium", + "source": "Completion" + }, + { + "name": "sexual", + "blocking": true, + "enabled": true, + "allowedContentLevel": "High", + "source": "Prompt" }, { "name": "sexual", - "allowedContentLevel": "Low" + "blocking": true, + "enabled": true, + "allowedContentLevel": "Medium", + "source": "Completion" + }, + { + "name": "selfharm", + "blocking": true, + "enabled": true, + "allowedContentLevel": "High", + "source": "Prompt" + }, + { + "name": "selfharm", + "blocking": true, + "enabled": true, + "allowedContentLevel": "Medium", + "source": "Completion" }, { "name": "violence", - "enabled": false + "blocking": true, + "enabled": true, + "allowedContentLevel": "Medium", + "source": "Prompt" + }, + { + "name": "violence", + "blocking": true, + "enabled": true, + "allowedContentLevel": "Medium", + "source": "Completion" + }, + { + "name": "jailbreak", + "blocking": true, + "source": "Prompt", + "enabled": true + }, + { + "name": "protected_material_text", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "protected_material_code", + "blocking": true, + "source": "Completion", + "enabled": true }, { - "name": "DefaultHateSpeechBlockList", - "enabled": false + "name": "profanity", + "blocking": true, + "source": "Prompt", + "enabled": true } ] } diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-04-01-preview/examples/PutRaiPolicy.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-04-01-preview/examples/PutRaiPolicy.json index 6a207d994a48..f1d22528c464 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-04-01-preview/examples/PutRaiPolicy.json +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-04-01-preview/examples/PutRaiPolicy.json @@ -7,7 +7,8 @@ "raiPolicyName": "raiPolicyName", "raiPolicy": { "properties": { - "basePolicyName": "112", + "basePolicyName": "Microsoft.Default", + "mode": "Deferred", "contentFilters": [ { "name": "hate", @@ -88,12 +89,6 @@ "blocking": true, "source": "Prompt", "enabled": true - }, - { - "name": "profanity", - "blocking": true, - "source": "Completion", - "enabled": true } ] } @@ -106,6 +101,7 @@ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", "properties": { "basePolicyName": "Microsoft.Default", + "mode": "Deferred", "contentFilters": [ { "name": "hate", @@ -186,12 +182,6 @@ "blocking": true, "source": "Prompt", "enabled": true - }, - { - "name": "profanity", - "blocking": true, - "source": "Completion", - "enabled": true } ] } @@ -203,6 +193,7 @@ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", "properties": { "basePolicyName": "Microsoft.Default", + "mode": "Deferred", "contentFilters": [ { "name": "hate", @@ -283,12 +274,6 @@ "blocking": true, "source": "Prompt", "enabled": true - }, - { - "name": "profanity", - "blocking": true, - "source": "Completion", - "enabled": true } ] } diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/cognitiveservices.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/cognitiveservices.json new file mode 100644 index 000000000000..9d108138d811 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/cognitiveservices.json @@ -0,0 +1,6969 @@ +{ + "swagger": "2.0", + "info": { + "title": "CognitiveServicesManagementClient", + "description": "Cognitive Services Management Client", + "version": "2024-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}": { + "put": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Create Cognitive Services Account. Accounts is a resource group wide resource type. It holds the keys for developer to access intelligent APIs. It's also the resource type for billing.", + "operationId": "Accounts_Create", + "x-ms-examples": { + "Create Account": { + "$ref": "./examples/CreateAccount.json" + }, + "Create Account Min": { + "$ref": "./examples/CreateAccountMin.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "name": "account", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Account" + }, + "description": "The parameters to provide for the created account." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "If resource is created successfully or already existed, the service should return 200 (OK).", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "201": { + "description": "If resource is created successfully, the service should return 201 (OK).", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Updates a Cognitive Services account", + "operationId": "Accounts_Update", + "x-ms-examples": { + "Update Account": { + "$ref": "./examples/UpdateAccount.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "name": "account", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Account" + }, + "description": "The parameters to provide for the created account." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Deletes a Cognitive Services account from the resource group. ", + "operationId": "Accounts_Delete", + "x-ms-examples": { + "Delete Account": { + "$ref": "./examples/DeleteAccount.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A 200 (OK) should be returned if the object exists and was deleted successfully;" + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." + }, + "204": { + "description": "a 204 (NoContent) should be used if the resource does not exist and the request is well formed." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Returns a Cognitive Services account specified by the parameters.", + "operationId": "Accounts_Get", + "x-ms-examples": { + "Get Account": { + "$ref": "./examples/GetAccount.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. The only GET specific properties are \"name,\" \"type\" and \"id.\"\nField\tDescription\nKind\trequired. String.\n\tThe API set for this API account. It can be \n\t· a single API, for example: Face API, Vision API, Speech API. \n\ta bundle of APIs: Face + Speech, Vision + Emotion, etc.\nsku.name\tRequired.\n\tThe pricing tier/plan of this API. Could be: \n\tF0 - Free\n\tB0 - Basic\n\tS0 - Standard\n\tP0 - Premium\n", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/resourceGroups/{resourceGroupName}/deletedAccounts/{accountName}": { + "get": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Returns a Cognitive Services account specified by the parameters.", + "operationId": "DeletedAccounts_Get", + "x-ms-examples": { + "Get Account": { + "$ref": "./examples/GetDeletedAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. The only GET specific properties are \"name,\" \"type\" and \"id.\"\nField\tDescription\nKind\trequired. String.\n\tThe API set for this API account. It can be \n\t· a single API, for example: Face API, Vision API, Speech API. \n\ta bundle of APIs: Face + Speech, Vision + Emotion, etc.\nsku.name\tRequired.\n\tThe pricing tier/plan of this API. Could be: \n\tF0 - Free\n\tB0 - Basic\n\tS0 - Standard\n\tP0 - Premium\n", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Deletes a Cognitive Services account from the resource group. ", + "operationId": "DeletedAccounts_Purge", + "x-ms-examples": { + "Delete Account": { + "$ref": "./examples/PurgeDeletedAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A 200 (OK) should be returned if the object exists and was deleted successfully;" + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." + }, + "204": { + "description": "a 204 (NoContent) should be used if the resource does not exist and the request is well formed." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts": { + "get": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Returns all the resources of a particular type belonging to a resource group", + "operationId": "Accounts_ListByResourceGroup", + "x-ms-examples": { + "List Accounts by Resource Group": { + "$ref": "./examples/ListAccountsByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses here. If a resource provider does not support paging, it should return the same body (JSON object with \"value\" property) but omit nextLink entirely (or set to null, *not* empty string) for future compatibility.\nThe nextLink should be implemented using following query parameters:\n· skipToken: opaque token that allows the resource provider to skip resources already enumerated. This value is defined and returned by the RP after first request via nextLink.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients must fetch records until the nextLink is not returned back / null. Clients should never rely on number of returned records to determinate if pagination is completed.", + "schema": { + "$ref": "#/definitions/AccountListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/accounts": { + "get": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Returns all the resources of a particular type belonging to a subscription.", + "operationId": "Accounts_List", + "x-ms-examples": { + "List Accounts by Subscription": { + "$ref": "./examples/ListAccountsBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses. If a resource provider does not support paging, it should return the same body but leave nextLink empty for future compatibility.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. ", + "schema": { + "$ref": "#/definitions/AccountListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/deletedAccounts": { + "get": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Returns all the resources of a particular type belonging to a subscription.", + "operationId": "DeletedAccounts_List", + "x-ms-examples": { + "List Deleted Accounts by Subscription": { + "$ref": "./examples/ListDeletedAccountsBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses. If a resource provider does not support paging, it should return the same body but leave nextLink empty for future compatibility.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. ", + "schema": { + "$ref": "#/definitions/AccountListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/listKeys": { + "post": { + "tags": [ + "CognitiveServicesAccounts" + ], + "operationId": "Accounts_ListKeys", + "description": "Lists the account keys for the specified Cognitive Services account.", + "x-ms-examples": { + "List Keys": { + "$ref": "./examples/ListKeys.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns with a response body containing the subscription keys for the resource: key1\nThe first API key for authentication when client calls the API endpoint.\n\nkey2\nThe second API key for authentication when client calls the API endpoint.", + "schema": { + "$ref": "#/definitions/ApiKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/regenerateKey": { + "post": { + "tags": [ + "CognitiveServicesAccounts" + ], + "operationId": "Accounts_RegenerateKey", + "description": "Regenerates the specified account key for the specified Cognitive Services account.", + "x-ms-examples": { + "Regenerate Keys": { + "$ref": "./examples/RegenerateKey.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/RegenerateKeyParameters" + }, + "description": "regenerate key parameters." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ApiKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/skus": { + "get": { + "tags": [ + "Skus", + "CognitiveServicesAccounts" + ], + "operationId": "ResourceSkus_List", + "description": "Gets the list of Microsoft.CognitiveServices SKUs available for your Subscription.", + "x-ms-examples": { + "Regenerate Keys": { + "$ref": "./examples/GetSkus.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceSkuListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/skus": { + "get": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "List available SKUs for the requested Cognitive Services account", + "x-ms-examples": { + "List SKUs": { + "$ref": "./examples/ListSkus.json" + } + }, + "operationId": "Accounts_ListSkus", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. The only GET specific properties are \"name,\" \"type\" and \"id.\"\nField\tDescription\nsku\tRequired, object\n\tThe exact set of keys that define this sku. This matches the fields on the respective resource.\nsku.name\tRequired, string\n\tThe name of the SKU. This is typically a letter + number code, such as A0 or P3\nsku.tier\tRequired, string\n\tThe tier of this particular SKU. Typically one of:\n\t· Free\n\t· Basic\n\t· Standard\n\t· Premium\n", + "schema": { + "$ref": "#/definitions/AccountSkuListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/usages": { + "get": { + "tags": [ + "Usages" + ], + "description": "Get usages for the requested subscription", + "x-ms-examples": { + "Get Usages": { + "$ref": "./examples/ListUsages.json" + } + }, + "operationId": "Usages_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/usageFilterParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/UsageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/usages": { + "get": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Get usages for the requested Cognitive Services account", + "x-ms-examples": { + "Get Usages": { + "$ref": "./examples/GetUsages.json" + } + }, + "operationId": "Accounts_ListUsages", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/usageFilterParameter" + } + ], + "responses": { + "200": { + "description": "The usages for Cognitive Services account were retrieved successfully.", + "schema": { + "$ref": "#/definitions/UsageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/models": { + "get": { + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "List available Models for the requested Cognitive Services account", + "x-ms-examples": { + "List AccountModels": { + "$ref": "./examples/ListAccountModels.json" + } + }, + "operationId": "Accounts_ListModels", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. The only GET specific properties are \"name,\" \"type\" and \"id.\"\nField\tDescription\nsku\tRequired, object\n\tThe exact set of keys that define this sku. This matches the fields on the respective resource.\nsku.name\tRequired, string\n\tThe name of the SKU. This is typically a letter + number code, such as A0 or P3\nsku.tier\tRequired, string\n\tThe tier of this particular SKU. Typically one of:\n\t· Free\n\t· Basic\n\t· Standard\n\t· Premium\n", + "schema": { + "$ref": "#/definitions/AccountModelListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.CognitiveServices/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all the available Cognitive Services account operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "Get Operations": { + "$ref": "./examples/GetOperations.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/checkSkuAvailability": { + "post": { + "tags": [ + "CognitiveServicesAccounts" + ], + "operationId": "CheckSkuAvailability", + "description": "Check available SKUs.", + "x-ms-examples": { + "Check SKU Availability": { + "$ref": "./examples/CheckSkuAvailability.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CheckSkuAvailabilityParameter" + }, + "description": "Check SKU Availability POST body." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SkuAvailabilityListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/commitmentTiers": { + "get": { + "tags": [ + "CommitmentTiers" + ], + "operationId": "CommitmentTiers_List", + "description": "List Commitment Tiers.", + "x-ms-examples": { + "ListCommitmentTiers": { + "$ref": "./examples/ListCommitmentTiers.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/locationParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/CommitmentTierListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/models": { + "get": { + "tags": [ + "Models" + ], + "operationId": "Models_List", + "description": "List Models.", + "x-ms-examples": { + "ListLocationModels": { + "$ref": "./examples/ListLocationModels.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/locationParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/ModelListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/modelCapacities": { + "get": { + "tags": [ + "ModelCapacities" + ], + "operationId": "LocationBasedModelCapacities_List", + "description": "List Location Based ModelCapacities.", + "x-ms-examples": { + "ListLocationBasedModelCapacities": { + "$ref": "./examples/ListLocationBasedModelCapacities.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/modelFormatFilterParameter" + }, + { + "$ref": "#/parameters/modelNameFilterParameter" + }, + { + "$ref": "#/parameters/modelVersionFilterParameter" + } + ], + "responses": { + "200": { + "description": "OK. Successfully retrieved modelCapacities by location.", + "schema": { + "$ref": "#/definitions/ModelCapacityListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/modelCapacities": { + "get": { + "tags": [ + "ModelCapacities" + ], + "operationId": "ModelCapacities_List", + "description": "List ModelCapacities.", + "x-ms-examples": { + "ListModelCapacities": { + "$ref": "./examples/ListModelCapacities.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/modelFormatFilterParameter" + }, + { + "$ref": "#/parameters/modelNameFilterParameter" + }, + { + "$ref": "#/parameters/modelVersionFilterParameter" + } + ], + "responses": { + "200": { + "description": "OK. Successfully retrieved modelCapacities.", + "schema": { + "$ref": "#/definitions/ModelCapacityListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/checkDomainAvailability": { + "post": { + "tags": [ + "CognitiveServicesAccounts" + ], + "operationId": "CheckDomainAvailability", + "description": "Check whether a domain is available.", + "x-ms-examples": { + "Check SKU Availability": { + "$ref": "./examples/CheckDomainAvailability.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CheckDomainAvailabilityParameter" + }, + "description": "Check Domain Availability parameter." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/DomainAvailability" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/calculateModelCapacity": { + "post": { + "tags": [ + "CognitiveServicesAccounts" + ], + "operationId": "calculateModelCapacity", + "description": "Model capacity calculator.", + "x-ms-examples": { + "Calculate Model Capacity": { + "$ref": "./examples/CalculateModelCapacity.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CalculateModelCapacityParameter" + }, + "description": "Check Domain Availability parameter." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/CalculateModelCapacityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "description": "Gets the private endpoint connections associated with the Cognitive Services account.", + "x-ms-examples": { + "GetPrivateEndpointConnection": { + "$ref": "./examples/ListPrivateEndpointConnections.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private endpoint connections.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "description": "Gets the specified private endpoint connection associated with the Cognitive Services account.", + "x-ms-examples": { + "GetPrivateEndpointConnection": { + "$ref": "./examples/GetPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/privateEndpointConnectionNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the private endpoint connection properties successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "description": "Update the state of specified private endpoint connection associated with the Cognitive Services account.", + "x-ms-examples": { + "PutPrivateEndpointConnection": { + "$ref": "./examples/PutPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/privateEndpointConnectionNameParameter" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The private endpoint connection properties." + } + ], + "responses": { + "200": { + "description": "OK -- Update the private endpoint connection properties successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "description": "Deletes the specified private endpoint connection associated with the Cognitive Services account.", + "x-ms-examples": { + "DeletePrivateEndpointConnection": { + "$ref": "./examples/DeletePrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/privateEndpointConnectionNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Delete the private endpoint connection successfully." + }, + "202": { + "description": "Accepted -- the operation was successfully started and will complete asynchronously." + }, + "204": { + "description": "No Content -- The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_List", + "description": "Gets the private link resources that need to be created for a Cognitive Services account.", + "x-ms-examples": { + "ListPrivateLinkResources": { + "$ref": "./examples/ListPrivateLinkResources.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments": { + "get": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_List", + "description": "Gets the deployments associated with the Cognitive Services account.", + "x-ms-examples": { + "ListDeployments": { + "$ref": "./examples/ListDeployments.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved deployments.", + "schema": { + "$ref": "#/definitions/DeploymentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}": { + "get": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_Get", + "description": "Gets the specified deployments associated with the Cognitive Services account.", + "x-ms-examples": { + "GetDeployment": { + "$ref": "./examples/GetDeployment.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/deploymentNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the deployments properties successfully.", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_CreateOrUpdate", + "description": "Update the state of specified deployments associated with the Cognitive Services account.", + "x-ms-examples": { + "PutDeployment": { + "$ref": "./examples/PutDeployment.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/deploymentNameParameter" + }, + { + "name": "deployment", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + }, + "description": "The deployment properties." + } + ], + "responses": { + "200": { + "description": "Create/Update the deployment successfully.", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "201": { + "description": "Create the deployment successfully.", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_Update", + "description": "Update specified deployments associated with the Cognitive Services account.", + "x-ms-examples": { + "UpdateDeployment": { + "$ref": "./examples/UpdateDeployment.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/deploymentNameParameter" + }, + { + "name": "deployment", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PatchResourceTagsAndSku" + }, + "description": "The deployment properties." + } + ], + "responses": { + "200": { + "description": "Updated the deployment successfully.", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "202": { + "headers": { + "location": { + "type": "string" + } + }, + "description": "If resource is updated successfully, the service should return 201 (OK)." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "delete": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_Delete", + "description": "Deletes the specified deployment associated with the Cognitive Services account.", + "x-ms-examples": { + "DeleteDeployment": { + "$ref": "./examples/DeleteDeployment.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/deploymentNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Delete the deployment successfully." + }, + "202": { + "description": "Accepted -- the operation was successfully started and will complete asynchronously." + }, + "204": { + "description": "No Content -- The deployment does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}/skus": { + "get": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_ListSkus", + "description": "Lists the specified deployments skus associated with the Cognitive Services account.", + "x-ms-examples": { + "ListDeploymentSkus": { + "$ref": "./examples/ListDeploymentSkus.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/deploymentNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- List the deployments skus successfully.", + "schema": { + "$ref": "#/definitions/DeploymentSkuListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/commitmentPlans": { + "get": { + "tags": [ + "CommitmentPlans" + ], + "operationId": "CommitmentPlans_List", + "description": "Gets the commitmentPlans associated with the Cognitive Services account.", + "x-ms-examples": { + "ListCommitmentPlans": { + "$ref": "./examples/ListCommitmentPlans.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved commitmentPlans.", + "schema": { + "$ref": "#/definitions/CommitmentPlanListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/commitmentPlans/{commitmentPlanName}": { + "get": { + "tags": [ + "CommitmentPlans" + ], + "operationId": "CommitmentPlans_Get", + "description": "Gets the specified commitmentPlans associated with the Cognitive Services account.", + "x-ms-examples": { + "GetCommitmentPlan": { + "$ref": "./examples/GetCommitmentPlan.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/commitmentPlanNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the commitmentPlans properties successfully.", + "schema": { + "$ref": "#/definitions/CommitmentPlan" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "CommitmentPlans" + ], + "operationId": "CommitmentPlans_CreateOrUpdate", + "description": "Update the state of specified commitmentPlans associated with the Cognitive Services account.", + "x-ms-examples": { + "PutCommitmentPlan": { + "$ref": "./examples/PutCommitmentPlan.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/commitmentPlanNameParameter" + }, + { + "name": "commitmentPlan", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CommitmentPlan" + }, + "description": "The commitmentPlan properties." + } + ], + "responses": { + "200": { + "description": "Create/Update the CommitmentPlan successfully.", + "schema": { + "$ref": "#/definitions/CommitmentPlan" + } + }, + "201": { + "description": "Create the CommitmentPlan successfully.", + "schema": { + "$ref": "#/definitions/CommitmentPlan" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "CommitmentPlans" + ], + "operationId": "CommitmentPlans_Delete", + "description": "Deletes the specified commitmentPlan associated with the Cognitive Services account.", + "x-ms-examples": { + "DeleteCommitmentPlan": { + "$ref": "./examples/DeleteCommitmentPlan.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/commitmentPlanNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Delete the commitmentPlan successfully." + }, + "202": { + "description": "Accepted -- the operation was successfully started and will complete asynchronously." + }, + "204": { + "description": "No Content -- The commitmentPlan does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/encryptionScopes": { + "get": { + "tags": [ + "EncryptionScopes" + ], + "operationId": "EncryptionScopes_List", + "description": "Gets the content filters associated with the Azure OpenAI account.", + "x-ms-examples": { + "ListEncryptionScopes": { + "$ref": "./examples/ListEncryptionScopes.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved Content Filters.", + "schema": { + "$ref": "#/definitions/EncryptionScopeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/encryptionScopes/{encryptionScopeName}": { + "get": { + "tags": [ + "EncryptionScopes" + ], + "operationId": "EncryptionScopes_Get", + "description": "Gets the specified EncryptionScope associated with the Cognitive Services account.", + "x-ms-examples": { + "GetEncryptionScope": { + "$ref": "./examples/GetEncryptionScope.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/encryptionScopeNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the EncryptionScopes properties successfully.", + "schema": { + "$ref": "#/definitions/EncryptionScope" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "EncryptionScopes" + ], + "operationId": "EncryptionScopes_CreateOrUpdate", + "description": "Update the state of specified encryptionScope associated with the Cognitive Services account.", + "x-ms-examples": { + "PutEncryptionScope": { + "$ref": "./examples/PutEncryptionScope.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/encryptionScopeNameParameter" + }, + { + "name": "encryptionScope", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EncryptionScope" + }, + "description": "The encryptionScope properties." + } + ], + "responses": { + "200": { + "description": "Create/Update the EncryptionScope successfully.", + "schema": { + "$ref": "#/definitions/EncryptionScope" + } + }, + "201": { + "description": "Create the EncryptionScope successfully.", + "schema": { + "$ref": "#/definitions/EncryptionScope" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "EncryptionScopes" + ], + "operationId": "EncryptionScopes_Delete", + "description": "Deletes the specified encryptionScope associated with the Cognitive Services account.", + "x-ms-examples": { + "DeleteEncryptionScope": { + "$ref": "./examples/DeleteEncryptionScope.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/encryptionScopeNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- the operation was successfully started and will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content -- The Content Filters does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiPolicies": { + "get": { + "tags": [ + "RaiPolicies" + ], + "operationId": "RaiPolicies_List", + "description": "Gets the content filters associated with the Azure OpenAI account.", + "x-ms-examples": { + "ListRaiPolicies": { + "$ref": "./examples/ListRaiPolicies.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved Content Filters.", + "schema": { + "$ref": "#/definitions/RaiPolicyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists": { + "get": { + "tags": [ + "RaiBlocklists" + ], + "operationId": "RaiBlocklists_List", + "description": "Gets the custom blocklists associated with the Azure OpenAI account.", + "x-ms-examples": { + "ListBlocklists": { + "$ref": "./examples/ListBlocklists.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved blocklists.", + "schema": { + "$ref": "#/definitions/RaiBlockListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}/raiBlocklistItems": { + "get": { + "tags": [ + "RaiBlocklists" + ], + "operationId": "RaiBlocklistItems_List", + "description": "Gets the blocklist items associated with the custom blocklist.", + "x-ms-examples": { + "ListBlocklistItems": { + "$ref": "./examples/ListBlocklistItems.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiBlocklistNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved blocklist items.", + "schema": { + "$ref": "#/definitions/RaiBlockListItemsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiPolicies/{raiPolicyName}": { + "get": { + "tags": [ + "RaiPolicies" + ], + "operationId": "RaiPolicies_Get", + "description": "Gets the specified Content Filters associated with the Azure OpenAI account.", + "x-ms-examples": { + "GetRaiPolicy": { + "$ref": "./examples/GetRaiPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiPolicyNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the Content Filters successfully.", + "schema": { + "$ref": "#/definitions/RaiPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "RaiPolicies" + ], + "operationId": "RaiPolicies_CreateOrUpdate", + "description": "Update the state of specified Content Filters associated with the Azure OpenAI account.", + "x-ms-examples": { + "PutRaiPolicy": { + "$ref": "./examples/PutRaiPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiPolicyNameParameter" + }, + { + "name": "raiPolicy", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RaiPolicy" + }, + "description": "Properties describing the Content Filters." + } + ], + "responses": { + "200": { + "description": "Create/Update the Content Filters successfully.", + "schema": { + "$ref": "#/definitions/RaiPolicy" + } + }, + "201": { + "description": "Create the Content Filters successfully.", + "schema": { + "$ref": "#/definitions/RaiPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "RaiPolicies" + ], + "operationId": "RaiPolicies_Delete", + "description": "Deletes the specified Content Filters associated with the Azure OpenAI account.", + "x-ms-examples": { + "DeleteRaiPolicy": { + "$ref": "./examples/DeleteRaiPolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiPolicyNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- the operation was successfully started and will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content -- The Content Filters does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}": { + "get": { + "tags": [ + "RaiBlocklists" + ], + "operationId": "RaiBlocklists_Get", + "description": "Gets the specified custom blocklist associated with the Azure OpenAI account.", + "x-ms-examples": { + "GetRaiBlocklist": { + "$ref": "./examples/GetRaiBlocklist.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiBlocklistNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the custom blocklist successfully.", + "schema": { + "$ref": "#/definitions/RaiBlocklist" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "RaiBlocklists" + ], + "operationId": "RaiBlocklists_CreateOrUpdate", + "description": "Update the state of specified blocklist associated with the Azure OpenAI account.", + "x-ms-examples": { + "PutRaiBlocklist": { + "$ref": "./examples/PutRaiBlocklist.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiBlocklistNameParameter" + }, + { + "name": "raiBlocklist", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RaiBlocklist" + }, + "description": "Properties describing the custom blocklist." + } + ], + "responses": { + "200": { + "description": "Created/updated the custom blocklist successfully.", + "schema": { + "$ref": "#/definitions/RaiBlocklist" + } + }, + "201": { + "description": "Created/updated the custom blocklist successfully.", + "schema": { + "$ref": "#/definitions/RaiBlocklist" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "RaiBlocklists" + ], + "operationId": "RaiBlocklists_Delete", + "description": "Deletes the specified custom blocklist associated with the Azure OpenAI account.", + "x-ms-examples": { + "DeleteRaiBlocklist": { + "$ref": "./examples/DeleteRaiBlocklist.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiBlocklistNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- the operation was successfully started and will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content -- The Content Filters does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}/raiBlocklistItems/{raiBlocklistItemName}": { + "get": { + "tags": [ + "RaiBlocklists" + ], + "operationId": "RaiBlocklistItems_Get", + "description": "Gets the specified custom blocklist Item associated with the custom blocklist.", + "x-ms-examples": { + "GetRaiBlocklistItem": { + "$ref": "./examples/GetRaiBlocklistItem.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiBlocklistNameParameter" + }, + { + "$ref": "#/parameters/raiBlocklistItemNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the custom blocklist Item successfully.", + "schema": { + "$ref": "#/definitions/RaiBlocklistItem" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "RaiBlocklists" + ], + "operationId": "RaiBlocklistItems_CreateOrUpdate", + "description": "Update the state of specified blocklist item associated with the Azure OpenAI account.", + "x-ms-examples": { + "PutRaiBlocklistItem": { + "$ref": "./examples/PutRaiBlocklistItem.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiBlocklistNameParameter" + }, + { + "$ref": "#/parameters/raiBlocklistItemNameParameter" + }, + { + "name": "raiBlocklistItem", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RaiBlocklistItem" + }, + "description": "Properties describing the custom blocklist." + } + ], + "responses": { + "200": { + "description": "Created/updated the blocklist Item successfully.", + "schema": { + "$ref": "#/definitions/RaiBlocklistItem" + } + }, + "201": { + "description": "Created/updated the blocklist Item successfully.", + "schema": { + "$ref": "#/definitions/RaiBlocklistItem" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "RaiBlocklists" + ], + "operationId": "RaiBlocklistItems_Delete", + "description": "Deletes the specified blocklist Item associated with the custom blocklist.", + "x-ms-examples": { + "DeleteRaiBlocklistItem": { + "$ref": "./examples/DeleteRaiBlocklistItem.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiBlocklistNameParameter" + }, + { + "$ref": "#/parameters/raiBlocklistItemNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- the operation was successfully started and will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content -- The blocklist item does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}/addRaiBlocklistItems": { + "post": { + "tags": [ + "RaiBlocklists" + ], + "operationId": "RaiBlocklistItems_BatchAdd", + "description": "Batch operation to add blocklist items.", + "x-ms-examples": { + "AddRaiBlocklistItems": { + "$ref": "./examples/AddRaiBlocklistItems.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiBlocklistNameParameter" + }, + { + "name": "raiBlocklistItems", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RaiBlocklistItemsBulkAddRequest" + }, + "description": "Properties describing the custom blocklist items." + } + ], + "responses": { + "200": { + "description": "Added the blocklist Items successfully.", + "schema": { + "$ref": "#/definitions/RaiBlocklist" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}/deleteRaiBlocklistItems": { + "post": { + "tags": [ + "RaiBlocklists" + ], + "operationId": "RaiBlocklistItems_BatchDelete", + "description": "Batch operation to delete blocklist items.", + "x-ms-examples": { + "DeleteRaiBlocklistItems": { + "$ref": "./examples/DeleteRaiBlocklistItems.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/raiBlocklistNameParameter" + }, + { + "name": "raiBlocklistItemsNames", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RaiBlocklistItemsBulkDeleteRequest" + }, + "description": "List of RAI Blocklist Items Names." + } + ], + "responses": { + "204": { + "description": "Added the blocklist Items successfully." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/raiContentFilters": { + "get": { + "tags": [ + "RaiContentFilters" + ], + "operationId": "RaiContentFilters_List", + "description": "List Content Filters types.", + "x-ms-examples": { + "ListRaiContentFilters": { + "$ref": "./examples/ListRaiContentFilters.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/locationParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/RaiContentFilterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/raiContentFilters/{filterName}": { + "get": { + "tags": [ + "RaiContentFilters" + ], + "operationId": "RaiContentFilters_Get", + "description": "Get Content Filters by Name.", + "x-ms-examples": { + "GetRaiContentFilters": { + "$ref": "./examples/GetRaiContentFilter.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/raiContentFilterNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. Get the RAI content filter successfully.", + "schema": { + "$ref": "#/definitions/RaiContentFilter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/commitmentPlans/{commitmentPlanName}": { + "put": { + "tags": [ + "CognitiveServicesCommitmentPlans" + ], + "description": "Create Cognitive Services commitment plan.", + "operationId": "CommitmentPlans_CreateOrUpdatePlan", + "x-ms-examples": { + "Create Commitment Plan": { + "$ref": "./examples/CreateSharedCommitmentPlan.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/commitmentPlanResourceNameParameter" + }, + { + "name": "commitmentPlan", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CommitmentPlan" + }, + "description": "The parameters to provide for the created commitment plan." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "If resource is created successfully or already existed, the service should return 200 (OK).", + "schema": { + "$ref": "#/definitions/CommitmentPlan" + } + }, + "201": { + "description": "If resource is created successfully, the service should return 201 (OK).", + "schema": { + "$ref": "#/definitions/CommitmentPlan" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "CognitiveServicesCommitmentPlans" + ], + "description": "Create Cognitive Services commitment plan.", + "operationId": "CommitmentPlans_UpdatePlan", + "x-ms-examples": { + "Create Commitment Plan": { + "$ref": "./examples/UpdateSharedCommitmentPlan.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/commitmentPlanResourceNameParameter" + }, + { + "name": "commitmentPlan", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PatchResourceTagsAndSku" + }, + "description": "The parameters to provide for the created commitment plan." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "If resource is updated successfully or already existed, the service should return 200 (OK).", + "schema": { + "$ref": "#/definitions/CommitmentPlan" + } + }, + "202": { + "headers": { + "location": { + "type": "string" + } + }, + "description": "If resource is updated successfully, the service should return 201 (OK)." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "delete": { + "tags": [ + "CognitiveServicesCommitmentPlans" + ], + "description": "Deletes a Cognitive Services commitment plan from the resource group. ", + "operationId": "CommitmentPlans_DeletePlan", + "x-ms-examples": { + "Delete Commitment Plan": { + "$ref": "./examples/DeleteSharedCommitmentPlan.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/commitmentPlanResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A 200 (OK) should be returned if the object exists and was deleted successfully;" + }, + "202": { + "headers": { + "location": { + "type": "string" + } + }, + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." + }, + "204": { + "description": "a 204 (NoContent) should be used if the resource does not exist and the request is well formed." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "CognitiveServicesCommitmentPlans" + ], + "description": "Returns a Cognitive Services commitment plan specified by the parameters.", + "operationId": "CommitmentPlans_GetPlan", + "x-ms-examples": { + "Get Commitment Plan": { + "$ref": "./examples/GetSharedCommitmentPlan.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/commitmentPlanResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved commitment plan resources.", + "schema": { + "$ref": "#/definitions/CommitmentPlan" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/commitmentPlans": { + "get": { + "tags": [ + "CognitiveServicesCommitmentPlans" + ], + "description": "Returns all the resources of a particular type belonging to a resource group", + "operationId": "CommitmentPlans_ListPlansByResourceGroup", + "x-ms-examples": { + "List Commitment Plans by Resource Group": { + "$ref": "./examples/ListSharedCommitmentPlansByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved commitment plan resources.", + "schema": { + "$ref": "#/definitions/CommitmentPlanListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/commitmentPlans": { + "get": { + "tags": [ + "CognitiveServicesCommitmentPlans" + ], + "description": "Returns all the resources of a particular type belonging to a subscription.", + "operationId": "CommitmentPlans_ListPlansBySubscription", + "x-ms-examples": { + "List Accounts by Subscription": { + "$ref": "./examples/ListSharedCommitmentPlansBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved commitment plan resources.", + "schema": { + "$ref": "#/definitions/CommitmentPlanListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/commitmentPlans/{commitmentPlanName}/accountAssociations": { + "get": { + "tags": [ + "CommitmentPlans" + ], + "operationId": "CommitmentPlans_ListAssociations", + "description": "Gets the associations of the Cognitive Services commitment plan.", + "x-ms-examples": { + "ListCommitmentPlans": { + "$ref": "./examples/ListSharedCommitmentPlanAssociations.json" + } + }, + "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/commitmentPlanResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved Commitment Plan Associations.", + "schema": { + "$ref": "#/definitions/CommitmentPlanAccountAssociationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/commitmentPlans/{commitmentPlanName}/accountAssociations/{commitmentPlanAssociationName}": { + "get": { + "tags": [ + "CommitmentPlans" + ], + "operationId": "CommitmentPlans_GetAssociation", + "description": "Gets the association of the Cognitive Services commitment plan.", + "x-ms-examples": { + "GetCommitmentPlan": { + "$ref": "./examples/GetSharedCommitmentPlanAssociation.json" + } + }, + "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/commitmentPlanResourceNameParameter" + }, + { + "$ref": "#/parameters/commitmentPlanAssociationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the Commitment Plan Association successfully.", + "schema": { + "$ref": "#/definitions/CommitmentPlanAccountAssociation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "CommitmentPlans" + ], + "operationId": "CommitmentPlans_CreateOrUpdateAssociation", + "description": "Create or update the association of the Cognitive Services commitment plan.", + "x-ms-examples": { + "PutCommitmentPlan": { + "$ref": "./examples/CreateSharedCommitmentPlanAssociation.json" + } + }, + "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/commitmentPlanResourceNameParameter" + }, + { + "$ref": "#/parameters/commitmentPlanAssociationNameParameter" + }, + { + "name": "association", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CommitmentPlanAccountAssociation" + }, + "description": "The commitmentPlan properties." + } + ], + "responses": { + "200": { + "description": "Create/Update the Commitment Plan Association successfully.", + "schema": { + "$ref": "#/definitions/CommitmentPlanAccountAssociation" + } + }, + "201": { + "description": "Create the Commitment Plan Association successfully.", + "schema": { + "$ref": "#/definitions/CommitmentPlanAccountAssociation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "CommitmentPlans" + ], + "operationId": "CommitmentPlans_DeleteAssociation", + "description": "Deletes the association of the Cognitive Services commitment plan.", + "x-ms-examples": { + "DeleteCommitmentPlan": { + "$ref": "./examples/DeleteSharedCommitmentPlanAssociation.json" + } + }, + "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/commitmentPlanResourceNameParameter" + }, + { + "$ref": "#/parameters/commitmentPlanAssociationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Delete the CommitmentPlanAssociation successfully." + }, + "202": { + "headers": { + "location": { + "type": "string" + } + }, + "description": "Accepted -- the operation was successfully started and will complete asynchronously." + }, + "204": { + "description": "No Content -- The Commitment Plan Association does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/networkSecurityPerimeterConfigurations": { + "get": { + "tags": [ + "NetworkSecurityPerimeterConfigurations" + ], + "operationId": "NetworkSecurityPerimeterConfigurations_List", + "description": "Gets a list of NSP configurations for an account.", + "x-ms-examples": { + "ListNetworkSecurityPerimeterConfigurations": { + "$ref": "./examples/ListNetworkSecurityPerimeterConfigurations.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of configs.", + "schema": { + "$ref": "#/definitions/NetworkSecurityPerimeterConfigurationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/networkSecurityPerimeterConfigurations/{nspConfigurationName}": { + "get": { + "tags": [ + "NetworkSecurityPerimeterConfigurations" + ], + "operationId": "NetworkSecurityPerimeterConfigurations_Get", + "description": "Gets the specified NSP configurations for an account.", + "x-ms-examples": { + "GetNetworkSecurityPerimeterConfigurations": { + "$ref": "./examples/GetNetworkSecurityPerimeterConfigurations.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/nspConfigurationNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the config.", + "schema": { + "$ref": "#/definitions/NetworkSecurityPerimeterConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/networkSecurityPerimeterConfigurations/{nspConfigurationName}/reconcile": { + "post": { + "tags": [ + "NetworkSecurityPerimeterConfigurations" + ], + "operationId": "NetworkSecurityPerimeterConfigurations_Reconcile", + "description": "Reconcile the NSP configuration for an account.", + "x-ms-examples": { + "ReconcileNetworkSecurityPerimeterConfigurations": { + "$ref": "./examples/ReconcileNetworkSecurityPerimeterConfigurations.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/nspConfigurationNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully Reconciled the NSP configuration.", + "schema": { + "$ref": "#/definitions/NetworkSecurityPerimeterConfiguration" + } + }, + "202": { + "headers": { + "location": { + "type": "string" + } + }, + "description": "Request to reconcile the NSP configuration accepted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/defenderForAISettings": { + "get": { + "tags": [ + "DefenderForAISettings" + ], + "operationId": "DefenderForAISettings_List", + "description": "Lists the Defender for AI settings.", + "x-ms-examples": { + "ListDefenderForAISetting": { + "$ref": "./examples/ListDefenderForAISetting.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- List the defender setting name successfully.", + "schema": { + "$ref": "#/definitions/DefenderForAISettingResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/defenderForAISettings/{defenderForAISettingName}": { + "get": { + "tags": [ + "DefenderForAISettings" + ], + "operationId": "DefenderForAISettings_Get", + "description": "Gets the specified Defender for AI setting by name.", + "x-ms-examples": { + "GetDefenderForAISetting": { + "$ref": "./examples/GetDefenderForAISetting.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/defenderForAISettingNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the defender setting name successfully.", + "schema": { + "$ref": "#/definitions/DefenderForAISetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "DefenderForAISettings" + ], + "operationId": "DefenderForAISettings_CreateOrUpdate", + "description": "Creates or Updates the specified Defender for AI setting.", + "x-ms-examples": { + "PutDefenderForAISetting": { + "$ref": "./examples/PutDefenderForAISetting.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/defenderForAISettingNameParameter" + }, + { + "name": "defenderForAISettings", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DefenderForAISetting" + }, + "description": "Properties describing the Defender for AI setting." + } + ], + "responses": { + "200": { + "description": "Created/updated the Defender for AI setting successfully.", + "schema": { + "$ref": "#/definitions/DefenderForAISetting" + } + }, + "201": { + "description": "Created the Defender for AI setting successfully.", + "schema": { + "$ref": "#/definitions/DefenderForAISetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "DefenderForAISettings" + ], + "operationId": "DefenderForAISettings_Update", + "description": "Updates the specified Defender for AI setting.", + "x-ms-examples": { + "UpdateDefenderForAISetting": { + "$ref": "./examples/UpdateDefenderForAISetting.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/defenderForAISettingNameParameter" + }, + { + "name": "defenderForAISettings", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DefenderForAISetting" + }, + "description": "Properties describing the Defender for AI setting." + } + ], + "responses": { + "200": { + "description": "Updated the Defender for AI setting successfully.", + "schema": { + "$ref": "#/definitions/DefenderForAISetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "Kind": { + "type": "string", + "description": "The kind (type) of cognitive service account." + }, + "Sku": { + "description": "The resource model definition representing SKU", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU. Ex - P3. It is typically a letter+number code" + }, + "tier": { + "type": "string", + "enum": [ + "Free", + "Basic", + "Standard", + "Premium", + "Enterprise" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + }, + "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT." + }, + "size": { + "type": "string", + "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. " + }, + "family": { + "type": "string", + "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here." + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted." + } + }, + "required": [ + "name" + ] + }, + "SkuName": { + "type": "string", + "description": "The name of SKU." + }, + "Account": { + "description": "Cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU.", + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/Kind", + "description": "The Kind of the resource." + }, + "sku": { + "$ref": "#/definitions/Sku" + }, + "identity": { + "$ref": "#/definitions/Identity" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "properties": { + "$ref": "#/definitions/AccountProperties", + "description": "Properties of Cognitive Services account." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/AzureEntityResource" + } + ] + }, + "AccountListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of accounts.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Account" + }, + "description": "Gets the list of Cognitive Services accounts and their properties." + } + }, + "description": "The list of cognitive services accounts operation response." + }, + "AccountProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the cognitive services account at the time the operation was called.", + "enum": [ + "Accepted", + "Creating", + "Deleting", + "Moving", + "Failed", + "Succeeded", + "ResolvingDNS" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "endpoint": { + "type": "string", + "description": "Endpoint of the created account.", + "readOnly": true + }, + "internalId": { + "type": "string", + "description": "The internal identifier (deprecated, do not use this property).", + "readOnly": true + }, + "capabilities": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SkuCapability" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "Gets the capabilities of the cognitive services account. Each item indicates the capability of a specific feature. The values are read-only and for reference only." + }, + "isMigrated": { + "type": "boolean", + "description": "If the resource is migrated from an existing key.", + "readOnly": true + }, + "migrationToken": { + "type": "string", + "description": "Resource migration token." + }, + "skuChangeInfo": { + "$ref": "#/definitions/SkuChangeInfo", + "description": "Sku change info of account.", + "readOnly": true + }, + "customSubDomainName": { + "type": "string", + "description": "Optional subdomain name used for token-based authentication." + }, + "networkAcls": { + "$ref": "#/definitions/NetworkRuleSet", + "description": "A collection of rules governing the accessibility from specific network locations." + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "The encryption properties for this resource." + }, + "userOwnedStorage": { + "type": "array", + "items": { + "$ref": "#/definitions/UserOwnedStorage" + }, + "x-ms-identifiers": [ + "resourceId" + ], + "description": "The storage accounts for this resource." + }, + "amlWorkspace": { + "$ref": "#/definitions/UserOwnedAmlWorkspace", + "description": "The user owned AML workspace properties." + }, + "privateEndpointConnections": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The private endpoint connection associated with the Cognitive Services account." + }, + "publicNetworkAccess": { + "type": "string", + "description": "Whether or not public endpoint access is allowed for this account.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + }, + "apiProperties": { + "$ref": "#/definitions/ApiProperties", + "description": "The api properties for special APIs." + }, + "dateCreated": { + "readOnly": true, + "type": "string", + "description": "Gets the date of cognitive services account creation." + }, + "callRateLimit": { + "readOnly": true, + "$ref": "#/definitions/CallRateLimit" + }, + "dynamicThrottlingEnabled": { + "type": "boolean", + "description": "The flag to enable dynamic throttling." + }, + "quotaLimit": { + "readOnly": true, + "$ref": "#/definitions/QuotaLimit" + }, + "restrictOutboundNetworkAccess": { + "type": "boolean" + }, + "allowedFqdnList": { + "type": "array", + "items": { + "type": "string" + } + }, + "disableLocalAuth": { + "type": "boolean" + }, + "endpoints": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "restore": { + "type": "boolean", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "deletionDate": { + "type": "string", + "description": "The deletion date, only available for deleted account.", + "readOnly": true + }, + "scheduledPurgeDate": { + "type": "string", + "description": "The scheduled purge date, only available for deleted account.", + "readOnly": true + }, + "locations": { + "$ref": "#/definitions/MultiRegionSettings", + "description": "The multiregion settings of Cognitive Services account." + }, + "commitmentPlanAssociations": { + "type": "array", + "items": { + "$ref": "#/definitions/CommitmentPlanAssociation" + }, + "x-ms-identifiers": [ + "commitmentPlanId" + ], + "description": "The commitment plan associations of Cognitive Services account.", + "readOnly": true + }, + "abusePenalty": { + "readOnly": true, + "$ref": "#/definitions/AbusePenalty" + }, + "raiMonitorConfig": { + "$ref": "#/definitions/RaiMonitorConfig" + } + }, + "description": "Properties of Cognitive Services account." + }, + "ApiProperties": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "properties": { + "qnaRuntimeEndpoint": { + "type": "string", + "description": "(QnAMaker Only) The runtime endpoint of QnAMaker." + }, + "qnaAzureSearchEndpointKey": { + "type": "string", + "description": "(QnAMaker Only) The Azure Search endpoint key of QnAMaker." + }, + "qnaAzureSearchEndpointId": { + "type": "string", + "description": "(QnAMaker Only) The Azure Search endpoint id of QnAMaker." + }, + "statisticsEnabled": { + "type": "boolean", + "description": "(Bing Search Only) The flag to enable statistics of Bing Search." + }, + "eventHubConnectionString": { + "type": "string", + "description": "(Personalization Only) The flag to enable statistics of Bing Search.", + "pattern": "^( *)Endpoint=sb://(.*);( *)SharedAccessKeyName=(.*);( *)SharedAccessKey=(.*)$", + "maxLength": 1000 + }, + "storageAccountConnectionString": { + "type": "string", + "description": "(Personalization Only) The storage account connection string.", + "pattern": "^(( *)DefaultEndpointsProtocol=(http|https)( *);( *))?AccountName=(.*)AccountKey=(.*)EndpointSuffix=(.*)$", + "maxLength": 1000 + }, + "aadClientId": { + "type": "string", + "description": "(Metrics Advisor Only) The Azure AD Client Id (Application Id).", + "maxLength": 500 + }, + "aadTenantId": { + "type": "string", + "description": "(Metrics Advisor Only) The Azure AD Tenant Id.", + "maxLength": 500 + }, + "superUser": { + "type": "string", + "description": "(Metrics Advisor Only) The super user of Metrics Advisor.", + "maxLength": 500 + }, + "websiteName": { + "type": "string", + "description": "(Metrics Advisor Only) The website name of Metrics Advisor.", + "maxLength": 500 + } + }, + "description": "The api properties for special APIs." + }, + "CommitmentPlanAccountAssociationListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of Commitment Plan Account Association.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/CommitmentPlanAccountAssociation" + }, + "x-ms-identifiers": [ + "id" + ], + "description": "Gets the list of Cognitive Services Commitment Plan Account Association and their properties." + } + }, + "description": "The list of cognitive services Commitment Plan Account Association operation response." + }, + "CommitmentPlanAccountAssociation": { + "description": "The commitment plan association.", + "type": "object", + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CommitmentPlanAccountAssociationProperties", + "description": "Properties of Cognitive Services account commitment plan association." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "AbusePenalty": { + "description": "The abuse penalty.", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "Throttle", + "Block" + ], + "x-ms-enum": { + "name": "AbusePenaltyAction", + "modelAsString": true + }, + "description": "The action of AbusePenalty." + }, + "rateLimitPercentage": { + "type": "number", + "description": "The percentage of rate limit." + }, + "expiration": { + "type": "string", + "format": "date-time", + "description": "The datetime of expiration of the AbusePenalty." + } + } + }, + "CommitmentPlanAccountAssociationProperties": { + "type": "object", + "properties": { + "accountId": { + "type": "string", + "description": "The Azure resource id of the account." + } + }, + "description": "The commitment plan account association properties." + }, + "CommitmentPlanAssociation": { + "type": "object", + "properties": { + "commitmentPlanId": { + "type": "string", + "description": "The Azure resource id of the commitment plan." + }, + "commitmentPlanLocation": { + "type": "string", + "description": "The location of of the commitment plan." + } + }, + "description": "The commitment plan association." + }, + "MultiRegionSettings": { + "type": "object", + "properties": { + "routingMethod": { + "type": "string", + "enum": [ + "Priority", + "Weighted", + "Performance" + ], + "x-ms-enum": { + "name": "RoutingMethods", + "modelAsString": true + }, + "description": "Multiregion routing methods." + }, + "regions": { + "type": "array", + "items": { + "$ref": "#/definitions/RegionSetting" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "description": "The multiregion settings Cognitive Services account." + }, + "RegionSetting": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the region." + }, + "value": { + "type": "number", + "description": "A value for priority or weighted routing methods." + }, + "customsubdomain": { + "type": "string", + "description": "Maps the region to the regional custom subdomain." + } + }, + "description": "The call rate limit Cognitive Services account." + }, + "CapacityConfig": { + "type": "object", + "properties": { + "minimum": { + "type": "integer", + "format": "int32", + "description": "The minimum capacity." + }, + "maximum": { + "type": "integer", + "format": "int32", + "description": "The maximum capacity." + }, + "step": { + "type": "integer", + "format": "int32", + "description": "The minimal incremental between allowed values for capacity." + }, + "default": { + "type": "integer", + "format": "int32", + "description": "The default capacity." + }, + "allowedValues": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "The array of allowed values for capacity." + } + }, + "description": "The capacity configuration." + }, + "CallRateLimit": { + "type": "object", + "properties": { + "count": { + "type": "number", + "description": "The count value of Call Rate Limit." + }, + "renewalPeriod": { + "type": "number", + "description": "The renewal period in seconds of Call Rate Limit." + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/ThrottlingRule" + }, + "x-ms-identifiers": [ + "key" + ] + } + }, + "description": "The call rate limit Cognitive Services account." + }, + "BillingMeterInfo": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "meterId": { + "type": "string" + }, + "unit": { + "type": "string" + } + } + }, + "DeploymentCapacitySettings": { + "type": "object", + "description": "Internal use only.", + "properties": { + "designatedCapacity": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The designated capacity." + }, + "priority": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The priority of this capacity setting." + } + } + }, + "QuotaLimit": { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "renewalPeriod": { + "type": "number" + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/ThrottlingRule" + }, + "x-ms-identifiers": [ + "key" + ] + } + } + }, + "ThrottlingRule": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "renewalPeriod": { + "type": "number" + }, + "count": { + "type": "number" + }, + "minCount": { + "type": "number" + }, + "dynamicThrottlingEnabled": { + "type": "boolean" + }, + "matchPatterns": { + "type": "array", + "items": { + "$ref": "#/definitions/RequestMatchPattern" + }, + "x-ms-identifiers": [ + "path", + "method" + ] + } + } + }, + "RequestMatchPattern": { + "type": "object", + "properties": { + "path": { + "type": "string" + }, + "method": { + "type": "string" + } + } + }, + "ApiKeys": { + "type": "object", + "properties": { + "key1": { + "type": "string", + "description": "Gets the value of key 1." + }, + "key2": { + "type": "string", + "description": "Gets the value of key 2." + } + }, + "description": "The access keys for the cognitive services account." + }, + "SkuChangeInfo": { + "type": "object", + "properties": { + "countOfDowngrades": { + "type": "number", + "description": "Gets the count of downgrades." + }, + "countOfUpgradesAfterDowngrades": { + "type": "number", + "description": "Gets the count of upgrades after downgrades." + }, + "lastChangeDate": { + "type": "string", + "description": "Gets the last change date." + } + }, + "description": "Sku change info of account." + }, + "RegenerateKeyParameters": { + "type": "object", + "properties": { + "keyName": { + "type": "string", + "description": "key name to generate (Key1|Key2)", + "enum": [ + "Key1", + "Key2" + ], + "x-ms-enum": { + "name": "KeyName", + "modelAsString": false + } + } + }, + "required": [ + "keyName" + ], + "description": "Regenerate key parameters." + }, + "AccountSkuListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AccountSku" + }, + "x-ms-identifiers": [ + "sku/name", + "resourceType" + ], + "description": "Gets the list of Cognitive Services accounts and their properties." + } + }, + "description": "The list of cognitive services accounts operation response." + }, + "AccountSku": { + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "description": "Resource Namespace and Type" + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU of Cognitive Services account." + } + }, + "description": "Cognitive Services resource type and SKU." + }, + "UsageListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of Usages.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of usages for Cognitive Service account." + } + }, + "description": "The response to a list usage request." + }, + "Usage": { + "type": "object", + "properties": { + "unit": { + "description": "The unit of the metric.", + "$ref": "#/definitions/UnitType" + }, + "name": { + "$ref": "#/definitions/MetricName", + "description": "The name information for the metric." + }, + "quotaPeriod": { + "type": "string", + "description": "The quota period used to summarize the usage values." + }, + "limit": { + "type": "number", + "format": "double", + "description": "Maximum value for this metric." + }, + "currentValue": { + "type": "number", + "format": "double", + "description": "Current value for this metric." + }, + "nextResetTime": { + "type": "string", + "description": "Next reset time for current quota." + }, + "status": { + "type": "string", + "description": "Cognitive Services account quota usage status.", + "enum": [ + "Included", + "Blocked", + "InOverage", + "Unknown" + ], + "x-ms-enum": { + "name": "QuotaUsageStatus", + "modelAsString": true + } + } + }, + "description": "The usage data for a usage request." + }, + "MetricName": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The name of the metric." + }, + "localizedValue": { + "type": "string", + "description": "The friendly name of the metric." + } + }, + "description": "A metric name." + }, + "UnitType": { + "type": "string", + "description": "The unit of the metric.", + "enum": [ + "Count", + "Bytes", + "Seconds", + "Percent", + "CountPerSecond", + "BytesPerSecond", + "Milliseconds" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "UnitType" + } + }, + "CheckSkuAvailabilityParameter": { + "type": "object", + "description": "Check SKU availability parameter.", + "properties": { + "skus": { + "type": "array", + "items": { + "$ref": "#/definitions/SkuName" + }, + "description": "The SKU of the resource." + }, + "kind": { + "$ref": "#/definitions/Kind" + }, + "type": { + "type": "string", + "description": "The Type of the resource." + } + }, + "required": [ + "skus", + "kind", + "type" + ] + }, + "CalculateModelCapacityParameter": { + "type": "object", + "description": "Calculate Model Capacity parameter.", + "properties": { + "model": { + "$ref": "#/definitions/DeploymentModel" + }, + "skuName": { + "$ref": "#/definitions/SkuName" + }, + "workloads": { + "type": "array", + "items": { + "$ref": "#/definitions/ModelCapacityCalculatorWorkload" + }, + "x-ms-identifiers": [], + "description": "List of Model Capacity Calculator Workload." + } + } + }, + "ModelCapacityCalculatorWorkload": { + "type": "object", + "description": "Model Capacity Calculator Workload.", + "properties": { + "requestPerMinute": { + "type": "integer", + "format": "int64", + "description": "Request per minute." + }, + "requestParameters": { + "$ref": "#/definitions/ModelCapacityCalculatorWorkloadRequestParam" + } + } + }, + "ModelCapacityCalculatorWorkloadRequestParam": { + "type": "object", + "description": "Dictionary, Model Capacity Calculator Workload Parameters.", + "properties": { + "avgPromptTokens": { + "type": "integer", + "format": "int64", + "description": "Average prompt tokens." + }, + "avgGeneratedTokens": { + "type": "integer", + "format": "int64", + "description": "Average generated tokens." + } + } + }, + "CalculateModelCapacityResult": { + "type": "object", + "description": "Calculate Model Capacity result.", + "properties": { + "model": { + "$ref": "#/definitions/DeploymentModel" + }, + "skuName": { + "type": "string" + }, + "estimatedCapacity": { + "type": "object", + "description": "Model Estimated Capacity.", + "properties": { + "value": { + "type": "integer", + "format": "int32" + }, + "deployableValue": { + "type": "integer", + "format": "int32" + } + } + } + } + }, + "SkuAvailabilityListResult": { + "type": "object", + "description": "Check SKU availability result list.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SkuAvailability" + }, + "x-ms-identifiers": [ + "skuName", + "type", + "kind" + ], + "description": "Check SKU availability result list." + } + } + }, + "SkuAvailability": { + "type": "object", + "description": "SKU availability.", + "properties": { + "kind": { + "$ref": "#/definitions/Kind", + "description": "The Kind of the resource." + }, + "type": { + "type": "string", + "description": "The Type of the resource." + }, + "skuName": { + "$ref": "#/definitions/SkuName", + "description": "The SKU of Cognitive Services account." + }, + "skuAvailable": { + "type": "boolean", + "description": "Indicates the given SKU is available or not." + }, + "reason": { + "type": "string", + "description": "Reason why the SKU is not available." + }, + "message": { + "type": "string", + "description": "Additional error message." + } + } + }, + "SkuCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the SkuCapability." + }, + "value": { + "type": "string", + "description": "The value of the SkuCapability." + } + }, + "description": "SkuCapability indicates the capability of a certain feature." + }, + "CheckDomainAvailabilityParameter": { + "type": "object", + "description": "Check Domain availability parameter.", + "properties": { + "subdomainName": { + "type": "string", + "description": "The subdomain name to use." + }, + "type": { + "type": "string", + "description": "The Type of the resource." + }, + "kind": { + "$ref": "#/definitions/Kind", + "description": "The Kind of the resource." + } + }, + "required": [ + "subdomainName", + "type" + ] + }, + "DomainAvailability": { + "type": "object", + "description": "Domain availability.", + "properties": { + "isSubdomainAvailable": { + "type": "boolean", + "description": "Indicates the given SKU is available or not." + }, + "reason": { + "type": "string", + "description": "Reason why the SKU is not available." + }, + "subdomainName": { + "type": "string", + "description": "The subdomain name to use." + }, + "type": { + "type": "string", + "description": "The Type of the resource." + }, + "kind": { + "$ref": "#/definitions/Kind", + "description": "The Kind of the resource." + } + } + }, + "ResourceSkuRestrictions": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of restrictions.", + "enum": [ + "Location", + "Zone" + ], + "x-ms-enum": { + "name": "ResourceSkuRestrictionsType", + "modelAsString": false + } + }, + "values": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted." + }, + "restrictionInfo": { + "$ref": "#/definitions/ResourceSkuRestrictionInfo", + "description": "The information about the restriction where the SKU cannot be used." + }, + "reasonCode": { + "type": "string", + "description": "The reason for restriction.", + "enum": [ + "QuotaId", + "NotAvailableForSubscription" + ], + "x-ms-enum": { + "name": "ResourceSkuRestrictionsReasonCode", + "modelAsString": true + } + } + }, + "description": "Describes restrictions of a SKU." + }, + "ResourceSku": { + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "description": "The type of resource the SKU applies to." + }, + "name": { + "type": "string", + "description": "The name of SKU." + }, + "tier": { + "type": "string", + "description": "Specifies the tier of Cognitive Services account." + }, + "kind": { + "type": "string", + "description": "The Kind of resources that are supported in this SKU." + }, + "locations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of locations that the SKU is available." + }, + "restrictions": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceSkuRestrictions" + }, + "x-ms-identifiers": [], + "description": "The restrictions because of which SKU cannot be used. This is empty if there are no restrictions." + } + }, + "description": "Describes an available Cognitive Services SKU." + }, + "ResourceSkuRestrictionInfo": { + "type": "object", + "properties": { + "locations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Locations where the SKU is restricted" + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of availability zones where the SKU is restricted." + } + } + }, + "ResourceSkuListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceSku" + }, + "x-ms-identifiers": [ + "resourceType", + "name", + "kind" + ], + "description": "The list of skus available for the subscription." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Skus." + } + }, + "required": [ + "value" + ], + "description": "The Get Skus operation response." + }, + "NetworkRuleSet": { + "type": "object", + "properties": { + "defaultAction": { + "type": "string", + "description": "The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "NetworkRuleAction", + "modelAsString": true + } + }, + "bypass": { + "type": "string", + "description": "Setting for trusted services.", + "enum": [ + "None", + "AzureServices" + ], + "x-ms-enum": { + "name": "ByPassSelection", + "modelAsString": true + } + }, + "ipRules": { + "type": "array", + "items": { + "$ref": "#/definitions/IpRule" + }, + "x-ms-identifiers": [], + "description": "The list of IP address rules." + }, + "virtualNetworkRules": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkRule" + }, + "description": "The list of virtual network rules." + } + }, + "description": "A set of rules governing the network accessibility." + }, + "IpRule": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "An IPv4 address range in CIDR notation, such as '124.56.78.91' (simple IP address) or '124.56.78.0/24' (all addresses that start with 124.56.78)." + } + }, + "required": [ + "value" + ], + "description": "A rule governing the accessibility from a specific ip address or ip range." + }, + "VirtualNetworkRule": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'." + }, + "state": { + "type": "string", + "description": "Gets the state of virtual network rule." + }, + "ignoreMissingVnetServiceEndpoint": { + "type": "boolean", + "description": "Ignore missing vnet service endpoint or not." + } + }, + "required": [ + "id" + ], + "description": "A rule governing the accessibility from a specific virtual network." + }, + "Identity": { + "type": "object", + "description": "Identity for the resource.", + "properties": { + "type": { + "type": "string", + "description": "The identity type.", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID of resource." + }, + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of resource identity." + }, + "userAssignedIdentities": { + "description": "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}", + "type": "object", + "additionalProperties": { + "description": "User-assigned managed identity.", + "$ref": "#/definitions/UserAssignedIdentity" + } + } + } + }, + "UserAssignedIdentity": { + "type": "object", + "description": "User-assigned managed identity.", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "Azure Active Directory principal ID associated with this Identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "Client App Id associated with this identity." + } + } + }, + "Encryption": { + "type": "object", + "properties": { + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Properties of KeyVault" + }, + "keySource": { + "type": "string", + "description": "Enumerates the possible value of keySource for Encryption", + "default": "Microsoft.KeyVault", + "enum": [ + "Microsoft.CognitiveServices", + "Microsoft.KeyVault" + ], + "x-ms-enum": { + "name": "keySource", + "modelAsString": true + } + } + }, + "description": "Properties to configure Encryption" + }, + "KeyVaultProperties": { + "type": "object", + "properties": { + "keyName": { + "type": "string", + "description": "Name of the Key from KeyVault" + }, + "keyVersion": { + "type": "string", + "description": "Version of the Key from KeyVault" + }, + "keyVaultUri": { + "type": "string", + "description": "Uri of KeyVault" + }, + "identityClientId": { + "type": "string" + } + }, + "description": "Properties to configure keyVault Properties" + }, + "EncryptionScopeListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of EncryptionScope.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EncryptionScope" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of EncryptionScope." + } + }, + "description": "The list of cognitive services EncryptionScopes." + }, + "EncryptionScope": { + "type": "object", + "description": "Cognitive Services EncryptionScope", + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "properties": { + "$ref": "#/definitions/EncryptionScopeProperties", + "description": "Properties of Cognitive Services EncryptionScope." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "EncryptionScopeProperties": { + "type": "object", + "description": "Properties to EncryptionScope", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the resource at the time the operation was called.", + "enum": [ + "Accepted", + "Creating", + "Deleting", + "Moving", + "Failed", + "Succeeded", + "Canceled" + ], + "x-ms-enum": { + "name": "EncryptionScopeProvisioningState", + "modelAsString": true + } + }, + "state": { + "type": "string", + "description": "The encryptionScope state.", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "EncryptionScopeState", + "modelAsString": true + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/Encryption" + } + ] + }, + "UserOwnedStorage": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "description": "Full resource id of a Microsoft.Storage resource." + }, + "identityClientId": { + "type": "string" + } + }, + "description": "The user owned storage for Cognitive Services account." + }, + "UserOwnedAmlWorkspace": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "description": "Full resource id of a AML workspace resource." + }, + "identityClientId": { + "type": "string", + "description": "Identity Client id of a AML workspace resource." + } + }, + "description": "The user owned AML workspace for Cognitive Services account." + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private endpoint connections", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + }, + "description": "A list of private endpoint connections" + }, + "PrivateEndpointConnection": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Resource properties." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + }, + "location": { + "type": "string", + "description": "The location of the private endpoint connection" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/AzureEntityResource" + } + ], + "description": "The Private Endpoint Connection resource." + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "properties": { + "privateEndpoint": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpoint", + "description": "The resource of private end point." + }, + "privateLinkServiceConnectionState": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "provisioningState": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnectionProvisioningState", + "description": "The provisioning state of the private endpoint connection resource." + }, + "groupIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private link resource group ids." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ], + "description": "Properties of the PrivateEndpointConnectProperties." + }, + "PrivateLinkResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + }, + "description": "A list of private link resources" + }, + "PrivateLinkResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ], + "description": "A private link resource" + }, + "PrivateLinkResourceProperties": { + "type": "object", + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private link resource Private link DNS zone name." + }, + "displayName": { + "description": "The private link resource display name.", + "type": "string", + "readOnly": true + } + }, + "description": "Properties of a private link resource." + }, + "DeploymentListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of Deployment.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Deployment" + }, + "description": "Gets the list of Cognitive Services accounts Deployment and their properties." + } + }, + "description": "The list of cognitive services accounts operation response." + }, + "Deployment": { + "description": "Cognitive Services account deployment.", + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/Sku" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "properties": { + "$ref": "#/definitions/DeploymentProperties", + "description": "Properties of Cognitive Services account deployment." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "DeploymentProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the resource at the time the operation was called.", + "enum": [ + "Accepted", + "Creating", + "Deleting", + "Moving", + "Failed", + "Succeeded", + "Disabled", + "Canceled" + ], + "x-ms-enum": { + "name": "DeploymentProvisioningState", + "modelAsString": true + } + }, + "model": { + "$ref": "#/definitions/DeploymentModel" + }, + "scaleSettings": { + "$ref": "#/definitions/DeploymentScaleSettings" + }, + "capabilities": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The capabilities." + }, + "raiPolicyName": { + "type": "string", + "description": "The name of RAI policy." + }, + "callRateLimit": { + "readOnly": true, + "$ref": "#/definitions/CallRateLimit" + }, + "rateLimits": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ThrottlingRule" + }, + "x-ms-identifiers": [ + "key" + ] + }, + "versionUpgradeOption": { + "type": "string", + "description": "Deployment model version upgrade option.", + "enum": [ + "OnceNewDefaultVersionAvailable", + "OnceCurrentVersionExpired", + "NoAutoUpgrade" + ], + "x-ms-enum": { + "name": "DeploymentModelVersionUpgradeOption", + "modelAsString": true + } + }, + "dynamicThrottlingEnabled": { + "type": "boolean", + "description": "If the dynamic throttling is enabled.", + "readOnly": true + }, + "currentCapacity": { + "type": "integer", + "format": "int32", + "description": "The current capacity." + }, + "capacitySettings": { + "$ref": "#/definitions/DeploymentCapacitySettings" + } + }, + "description": "Properties of Cognitive Services account deployment." + }, + "DeploymentModel": { + "type": "object", + "properties": { + "format": { + "type": "string", + "description": "Deployment model format." + }, + "name": { + "type": "string", + "description": "Deployment model name." + }, + "version": { + "type": "string", + "description": "Optional. Deployment model version. If version is not specified, a default version will be assigned. The default version is different for different models and might change when there is new version available for a model. Default version for a model could be found from list models API." + }, + "source": { + "type": "string", + "description": "Optional. Deployment model source ARM resource ID." + }, + "callRateLimit": { + "readOnly": true, + "$ref": "#/definitions/CallRateLimit" + } + }, + "description": "Properties of Cognitive Services account deployment model." + }, + "DeploymentScaleSettings": { + "type": "object", + "properties": { + "scaleType": { + "type": "string", + "description": "Deployment scale type.", + "enum": [ + "Standard", + "Manual" + ], + "x-ms-enum": { + "name": "DeploymentScaleType", + "modelAsString": true + } + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "Deployment capacity." + }, + "activeCapacity": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Deployment active capacity. This value might be different from `capacity` if customer recently updated `capacity`." + } + }, + "description": "Properties of Cognitive Services account deployment model. (Deprecated, please use Deployment.sku instead.)" + }, + "DeploymentSkuListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of deployment skus.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SkuResource" + }, + "x-ms-identifiers": [ + "resourceType" + ], + "description": "Gets the list of Cognitive Services accounts deployment skus." + } + }, + "description": "The list of cognitive services accounts operation response." + }, + "SkuResource": { + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "description": "The resource type name." + }, + "sku": { + "$ref": "#/definitions/Sku" + }, + "capacity": { + "$ref": "#/definitions/CapacityConfig" + } + }, + "description": "Properties of Cognitive Services account resource sku resource properties." + }, + "CommitmentTierListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of CommitmentTier.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/CommitmentTier" + }, + "x-ms-identifiers": [ + "kind", + "tier", + "skuName", + "hostingModel", + "planType" + ], + "description": "Gets the list of Cognitive Services accounts CommitmentTier and their properties." + } + }, + "description": "The list of cognitive services accounts operation response." + }, + "CommitmentTier": { + "description": "Cognitive Services account commitment tier.", + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/Kind", + "description": "The Kind of the resource." + }, + "skuName": { + "type": "string", + "description": "The name of the SKU. Ex - P3. It is typically a letter+number code" + }, + "hostingModel": { + "$ref": "#/definitions/HostingModel", + "description": "Account hosting model." + }, + "planType": { + "type": "string", + "description": "Commitment plan type." + }, + "tier": { + "type": "string", + "description": "Commitment period commitment tier." + }, + "maxCount": { + "type": "integer", + "format": "int32", + "description": "Commitment period commitment max count." + }, + "quota": { + "$ref": "#/definitions/CommitmentQuota" + }, + "cost": { + "$ref": "#/definitions/CommitmentCost" + } + } + }, + "CommitmentQuota": { + "type": "object", + "properties": { + "quantity": { + "type": "integer", + "format": "int64", + "description": "Commitment quota quantity." + }, + "unit": { + "type": "string", + "description": "Commitment quota unit." + } + }, + "description": "Cognitive Services account commitment quota." + }, + "CommitmentCost": { + "type": "object", + "properties": { + "commitmentMeterId": { + "type": "string", + "description": "Commitment meter Id." + }, + "overageMeterId": { + "type": "string", + "description": "Overage meter Id." + } + }, + "description": "Cognitive Services account commitment cost." + }, + "CommitmentPlanListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of CommitmentPlan.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/CommitmentPlan" + }, + "description": "Gets the list of Cognitive Services accounts CommitmentPlan and their properties." + } + }, + "description": "The list of cognitive services accounts operation response." + }, + "CommitmentPlan": { + "description": "Cognitive Services account commitment plan.", + "type": "object", + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + }, + "kind": { + "$ref": "#/definitions/Kind", + "description": "The Kind of the resource." + }, + "sku": { + "$ref": "#/definitions/Sku" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "properties": { + "$ref": "#/definitions/CommitmentPlanProperties", + "description": "Properties of Cognitive Services account commitment plan." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "CommitmentPlanProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the resource at the time the operation was called.", + "enum": [ + "Accepted", + "Creating", + "Deleting", + "Moving", + "Failed", + "Succeeded", + "Canceled" + ], + "x-ms-enum": { + "name": "CommitmentPlanProvisioningState", + "modelAsString": true + } + }, + "commitmentPlanGuid": { + "type": "string", + "description": "Commitment plan guid." + }, + "hostingModel": { + "$ref": "#/definitions/HostingModel", + "description": "Account hosting model." + }, + "planType": { + "type": "string", + "description": "Commitment plan type." + }, + "current": { + "$ref": "#/definitions/CommitmentPeriod" + }, + "autoRenew": { + "type": "boolean", + "description": "AutoRenew commitment plan." + }, + "next": { + "$ref": "#/definitions/CommitmentPeriod" + }, + "last": { + "$ref": "#/definitions/CommitmentPeriod", + "readOnly": true + }, + "provisioningIssues": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of ProvisioningIssue." + } + }, + "description": "Properties of Cognitive Services account commitment plan." + }, + "HostingModel": { + "type": "string", + "description": "Account hosting model.", + "enum": [ + "Web", + "ConnectedContainer", + "DisconnectedContainer", + "ProvisionedWeb" + ], + "x-ms-enum": { + "name": "HostingModel", + "modelAsString": true + } + }, + "CommitmentPeriod": { + "type": "object", + "properties": { + "tier": { + "type": "string", + "description": "Commitment period commitment tier." + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Commitment period commitment count." + }, + "quota": { + "$ref": "#/definitions/CommitmentQuota", + "readOnly": true + }, + "startDate": { + "type": "string", + "description": "Commitment period start date.", + "readOnly": true + }, + "endDate": { + "type": "string", + "description": "Commitment period end date.", + "readOnly": true + } + }, + "description": "Cognitive Services account commitment period." + }, + "ModelListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of Model.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Model" + }, + "x-ms-identifiers": [ + "kind", + "skuName", + "/model/name", + "/model/format", + "/model/version" + ], + "description": "Gets the list of Cognitive Services accounts Model and their properties." + } + }, + "description": "The list of cognitive services models." + }, + "Model": { + "description": "Cognitive Services Model.", + "type": "object", + "properties": { + "model": { + "$ref": "#/definitions/AccountModel" + }, + "kind": { + "$ref": "#/definitions/Kind" + }, + "skuName": { + "$ref": "#/definitions/SkuName" + }, + "description": { + "type": "string", + "description": "The description of the model." + } + } + }, + "ModelSku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the model SKU." + }, + "usageName": { + "type": "string", + "description": "The usage name of the model SKU." + }, + "deprecationDate": { + "type": "string", + "format": "date-time", + "description": "The datetime of deprecation of the model SKU." + }, + "capacity": { + "$ref": "#/definitions/CapacityConfig" + }, + "rateLimits": { + "type": "array", + "items": { + "$ref": "#/definitions/CallRateLimit" + }, + "x-ms-identifiers": [], + "description": "The list of rateLimit." + }, + "cost": { + "type": "array", + "items": { + "$ref": "#/definitions/BillingMeterInfo" + }, + "x-ms-identifiers": [], + "description": "The list of billing meter info." + } + }, + "description": "Describes an available Cognitive Services Model SKU." + }, + "AccountModelListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of Model.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AccountModel" + }, + "x-ms-identifiers": [ + "name", + "format", + "version" + ], + "description": "Gets the list of Cognitive Services accounts Model and their properties." + } + }, + "description": "The list of cognitive services accounts operation response." + }, + "AccountModel": { + "description": "Cognitive Services account Model.", + "type": "object", + "properties": { + "baseModel": { + "$ref": "#/definitions/DeploymentModel" + }, + "isDefaultVersion": { + "type": "boolean", + "description": "If the model is default version." + }, + "skus": { + "type": "array", + "items": { + "$ref": "#/definitions/ModelSku" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of Model Sku." + }, + "maxCapacity": { + "type": "integer", + "format": "int32", + "description": "The max capacity." + }, + "capabilities": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The capabilities." + }, + "finetuneCapabilities": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The capabilities for finetune models." + }, + "deprecation": { + "$ref": "#/definitions/ModelDeprecationInfo" + }, + "lifecycleStatus": { + "type": "string", + "enum": [ + "GenerallyAvailable", + "Preview" + ], + "x-ms-enum": { + "name": "ModelLifecycleStatus", + "modelAsString": true + }, + "description": "Model lifecycle status." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "#/definitions/DeploymentModel" + } + ] + }, + "ModelDeprecationInfo": { + "description": "Cognitive Services account ModelDeprecationInfo.", + "type": "object", + "properties": { + "fineTune": { + "type": "string", + "description": "The datetime of deprecation of the fineTune Model." + }, + "inference": { + "type": "string", + "description": "The datetime of deprecation of the inference Model." + } + } + }, + "ModelCapacityListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of ModelSkuCapacity.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "type": "object", + "readOnly": true, + "properties": { + "location": { + "type": "string", + "description": "The location of the Model Sku Capacity." + }, + "properties": { + "$ref": "#/definitions/ModelSkuCapacityProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "x-ms-identifiers": [ + "model" + ], + "description": "Gets the list of Cognitive Services accounts ModelSkuCapacity." + } + }, + "description": "The list of cognitive services accounts operation response." + }, + "ModelSkuCapacityProperties": { + "description": "Cognitive Services account ModelSkuCapacity.", + "type": "object", + "properties": { + "model": { + "$ref": "#/definitions/DeploymentModel" + }, + "skuName": { + "type": "string" + }, + "availableCapacity": { + "type": "number", + "description": "The available capacity for deployment with this model and sku." + }, + "availableFinetuneCapacity": { + "type": "number", + "description": "The available capacity for deployment with a fine-tune version of this model and sku." + } + } + }, + "PatchResourceTags": { + "description": "The object being used to update tags of a resource, in general used for PATCH operations.", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + } + } + }, + "PatchResourceTagsAndSku": { + "description": "The object being used to update tags and sku of a resource, in general used for PATCH operations.", + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/Sku" + } + }, + "allOf": [ + { + "$ref": "#/definitions/PatchResourceTags" + } + ] + }, + "RaiMonitorConfig": { + "description": "Cognitive Services Rai Monitor Config.", + "type": "object", + "properties": { + "adxStorageResourceId": { + "type": "string", + "description": "The storage resource Id." + }, + "identityClientId": { + "type": "string", + "description": "The identity client Id to access the storage." + } + } + }, + "RaiPolicyListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of RaiPolicy.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RaiPolicy" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of RaiPolicy." + } + }, + "description": "The list of cognitive services RaiPolicies." + }, + "RaiPolicy": { + "description": "Cognitive Services RaiPolicy.", + "type": "object", + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "properties": { + "$ref": "#/definitions/RaiPolicyProperties", + "description": "Properties of Cognitive Services RaiPolicy." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "RaiBlockListResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of RaiBlocklists.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RaiBlocklist" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of RaiBlocklist." + } + }, + "description": "The list of cognitive services RAI Blocklists." + }, + "RaiBlocklist": { + "description": "Cognitive Services RaiBlocklist.", + "type": "object", + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "properties": { + "$ref": "#/definitions/RaiBlocklistProperties", + "description": "Properties of Cognitive Services RaiBlocklist." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "RaiBlocklistProperties": { + "description": "RAI Custom Blocklist properties.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the block list." + } + } + }, + "RaiBlocklistItemProperties": { + "description": "RAI Custom Blocklist Item properties.", + "type": "object", + "properties": { + "pattern": { + "type": "string", + "description": "Pattern to match against." + }, + "isRegex": { + "type": "boolean", + "description": "If the pattern is a regex pattern." + } + } + }, + "RaiBlockListItemsResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of RaiBlocklistItems.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RaiBlocklistItem" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of RaiBlocklistItems." + } + }, + "description": "The list of cognitive services RAI Blocklist Items." + }, + "RaiBlocklistItemsBulkAddRequest": { + "description": "The list of Cognitive Services RaiBlocklist Items for batch add.", + "type": "array", + "items": { + "$ref": "#/definitions/RaiBlocklistItemBulkRequest" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "RaiBlocklistItemBulkRequest": { + "description": "The Cognitive Services RaiBlocklist Item request body.", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "properties": { + "$ref": "#/definitions/RaiBlocklistItemProperties", + "description": "Properties of Cognitive Services RaiBlocklist Item." + } + } + }, + "RaiBlocklistItemsBulkDeleteRequest": { + "description": "The list of Cognitive Services RaiBlocklist Items Names.", + "type": "object", + "items": { + "type": "string" + } + }, + "RaiBlocklistItem": { + "description": "Cognitive Services RaiBlocklist Item.", + "type": "object", + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "properties": { + "$ref": "#/definitions/RaiBlocklistItemProperties", + "description": "Properties of Cognitive Services RaiBlocklist Item." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "RaiPolicyProperties": { + "description": "Azure OpenAI Content Filters properties.", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "UserManaged", + "SystemManaged" + ], + "x-ms-enum": { + "name": "RaiPolicyType", + "modelAsString": true + }, + "description": "Content Filters policy type.", + "readOnly": true + }, + "mode": { + "type": "string", + "enum": [ + "Default", + "Deferred", + "Blocking", + "Asynchronous_filter" + ], + "x-ms-enum": { + "name": "RaiPolicyMode", + "modelAsString": true + }, + "description": "Rai policy mode. The enum value mapping is as below: Default = 0, Deferred=1, Blocking=2, Asynchronous_filter =3. Please use 'Asynchronous_filter' after 2024-06-01-preview. It is the same as 'Deferred' in previous version." + }, + "basePolicyName": { + "type": "string", + "description": "Name of Rai policy." + }, + "contentFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/RaiPolicyContentFilter" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of Content Filters." + }, + "customBlocklists": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomBlocklistConfig" + }, + "x-ms-identifiers": [], + "description": "The list of custom Blocklist." + } + } + }, + "CustomBlocklistConfig": { + "description": "Gets or sets the source to which filter applies.", + "type": "object", + "properties": { + "source": { + "$ref": "#/definitions/RaiPolicyContentSource" + } + }, + "allOf": [ + { + "$ref": "#/definitions/RaiBlocklistConfig" + } + ] + }, + "RaiPolicyContentSource": { + "description": "Content source to apply the Content Filters.", + "type": "string", + "enum": [ + "Prompt", + "Completion" + ], + "x-ms-enum": { + "name": "RaiPolicyContentSource", + "modelAsString": true + } + }, + "RaiPolicyContentFilter": { + "description": "Azure OpenAI Content Filter.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of ContentFilter." + }, + "enabled": { + "type": "boolean", + "description": "If the ContentFilter is enabled." + }, + "severityThreshold": { + "description": "Level at which content is filtered.", + "type": "string", + "enum": [ + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "ContentLevel", + "modelAsString": true + } + }, + "blocking": { + "type": "boolean", + "description": "If blocking would occur." + }, + "source": { + "$ref": "#/definitions/RaiPolicyContentSource" + } + } + }, + "RaiBlocklistConfig": { + "description": "Azure OpenAI blocklist config.", + "type": "object", + "properties": { + "blocklistName": { + "type": "string", + "description": "Name of ContentFilter." + }, + "blocking": { + "type": "boolean", + "description": "If blocking would occur." + } + } + }, + "RaiContentFilterListResult": { + "description": "The list of Content Filters.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of Content Filters.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RaiContentFilter" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of RaiContentFilter." + } + } + }, + "RaiContentFilter": { + "description": "Azure OpenAI Content Filter.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Azure OpenAI Content Filter Properties.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Content Filter." + }, + "isMultiLevelFilter": { + "type": "boolean", + "description": "If the Content Filter has multi severity levels(Low, Medium, or High)." + }, + "source": { + "$ref": "#/definitions/RaiPolicyContentSource" + } + } + } + } + }, + "NetworkSecurityPerimeterConfigurationList": { + "description": "A list of NSP configurations for an Cognitive Services account.", + "type": "object", + "properties": { + "value": { + "description": "Array of NSP configurations List Result for an Cognitive Services account.", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityPerimeterConfiguration" + }, + "x-ms-identifiers": [ + "id" + ] + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string" + } + } + }, + "NetworkSecurityPerimeterConfiguration": { + "description": "NSP Configuration for an Cognitive Services account.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/NetworkSecurityPerimeterConfigurationProperties", + "description": "NSP Configuration properties." + } + } + }, + "NetworkSecurityPerimeterConfigurationProperties": { + "description": "The properties of an NSP Configuration.", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "description": "Provisioning state of NetworkSecurityPerimeter configuration", + "type": "string" + }, + "provisioningIssues": { + "description": "List of Provisioning Issues", + "type": "array", + "items": { + "$ref": "#/definitions/ProvisioningIssue" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "networkSecurityPerimeter": { + "$ref": "#/definitions/NetworkSecurityPerimeter" + }, + "resourceAssociation": { + "$ref": "#/definitions/NetworkSecurityPerimeterConfigurationAssociationInfo" + }, + "profile": { + "$ref": "#/definitions/NetworkSecurityPerimeterProfileInfo" + } + } + }, + "ProvisioningIssue": { + "type": "object", + "properties": { + "name": { + "description": "Name of the NSP provisioning issue", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/ProvisioningIssueProperties" + } + } + }, + "ProvisioningIssueProperties": { + "description": "Properties of Provisioning Issue", + "type": "object", + "properties": { + "issueType": { + "description": "Type of Issue", + "type": "string" + }, + "severity": { + "description": "Severity of the issue", + "type": "string" + }, + "description": { + "description": "Description of the issue", + "type": "string" + }, + "suggestedResourceIds": { + "description": "IDs of resources that can be associated to the same perimeter to remediate the issue.", + "type": "array", + "items": { + "type": "string", + "format": "arm-id", + "description": "Fully qualified resource ID for the resource." + } + }, + "suggestedAccessRules": { + "description": "Optional array, suggested access rules", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityPerimeterAccessRule" + } + } + } + }, + "NetworkSecurityPerimeter": { + "description": "Information about a linked Network Security Perimeter", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified identifier of the resource", + "type": "string", + "format": "arm-id" + }, + "perimeterGuid": { + "description": "Guid of the resource", + "type": "string" + }, + "location": { + "description": "Location of the resource", + "type": "string" + } + } + }, + "NetworkSecurityPerimeterConfigurationAssociationInfo": { + "description": "Network Security Perimeter Configuration Association Information", + "type": "object", + "properties": { + "name": { + "description": "Name of the resource association", + "type": "string" + }, + "accessMode": { + "description": "Access Mode of the resource association", + "type": "string" + } + } + }, + "NetworkSecurityPerimeterProfileInfo": { + "description": "Network Security Perimeter Profile Information", + "type": "object", + "properties": { + "name": { + "description": "Name of the resource profile", + "type": "string" + }, + "accessRulesVersion": { + "description": "Access rules version of the resource profile", + "type": "integer", + "format": "int64" + }, + "accessRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityPerimeterAccessRule" + }, + "x-ms-identifiers": [] + }, + "diagnosticSettingsVersion": { + "description": "Current diagnostic settings version", + "type": "integer", + "format": "int64" + }, + "enabledLogCategories": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of enabled log categories" + } + } + }, + "NetworkSecurityPerimeterAccessRule": { + "description": "Network Security Perimeter Access Rule", + "type": "object", + "properties": { + "name": { + "description": "Network Security Perimeter Access Rule Name", + "type": "string" + }, + "properties": { + "description": "Properties of Network Security Perimeter Access Rule", + "$ref": "#/definitions/NetworkSecurityPerimeterAccessRuleProperties" + } + } + }, + "NetworkSecurityPerimeterAccessRuleProperties": { + "description": "The Properties of Network Security Perimeter Rule", + "type": "object", + "properties": { + "direction": { + "enum": [ + "Inbound", + "Outbound" + ], + "type": "string", + "description": "Direction of Access Rule", + "x-ms-enum": { + "name": "NspAccessRuleDirection", + "modelAsString": true + } + }, + "addressPrefixes": { + "description": "Address prefixes for inbound rules", + "type": "array", + "items": { + "description": "IP Address", + "type": "string" + } + }, + "subscriptions": { + "description": "Subscriptions for inbound rules", + "type": "array", + "items": { + "description": "Subscription for inbound rule", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified identifier of subscription", + "type": "string" + } + } + } + }, + "networkSecurityPerimeters": { + "description": "NetworkSecurityPerimeters for inbound rules", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityPerimeter" + } + }, + "fullyQualifiedDomainNames": { + "description": "Fully qualified domain name for outbound rules", + "type": "array", + "items": { + "description": "Fully qualified domain name", + "type": "string" + } + } + } + }, + "DefenderForAISettingResult": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of Defender for AI Settings.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DefenderForAISetting" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of Defender for AI Settings." + } + }, + "description": "The list of cognitive services Defender for AI Settings." + }, + "DefenderForAISetting": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DefenderForAISettingProperties" + } + }, + "description": "The Defender for AI resource." + }, + "DefenderForAISettingProperties": { + "type": "object", + "properties": { + "state": { + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "DefenderForAISettingState", + "modelAsString": true + }, + "description": "Defender for AI state on the AI resource." + } + }, + "description": "The Defender for AI resource properties." + } + }, + "parameters": { + "accountNameParameter": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 64, + "minLength": 2, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of Cognitive Services account.", + "x-ms-parameter-location": "method" + }, + "locationParameter": { + "name": "location", + "in": "path", + "description": "Resource location.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "usageFilterParameter": { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names).", + "x-ms-parameter-location": "method" + }, + "privateEndpointConnectionNameParameter": { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection associated with the Cognitive Services Account", + "x-ms-parameter-location": "method" + }, + "deploymentNameParameter": { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment associated with the Cognitive Services Account", + "x-ms-parameter-location": "method" + }, + "raiPolicyNameParameter": { + "name": "raiPolicyName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the RaiPolicy associated with the Cognitive Services Account", + "x-ms-parameter-location": "method" + }, + "raiBlocklistNameParameter": { + "name": "raiBlocklistName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the RaiBlocklist associated with the Cognitive Services Account", + "x-ms-parameter-location": "method" + }, + "raiBlocklistItemNameParameter": { + "name": "raiBlocklistItemName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the RaiBlocklist Item associated with the custom blocklist", + "x-ms-parameter-location": "method" + }, + "commitmentPlanNameParameter": { + "name": "commitmentPlanName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the commitmentPlan associated with the Cognitive Services Account", + "x-ms-parameter-location": "method" + }, + "commitmentPlanResourceNameParameter": { + "name": "commitmentPlanName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the commitmentPlan associated with the Cognitive Services Account", + "x-ms-parameter-location": "method" + }, + "commitmentPlanAssociationNameParameter": { + "name": "commitmentPlanAssociationName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the commitment plan association with the Cognitive Services Account", + "x-ms-parameter-location": "method" + }, + "encryptionScopeNameParameter": { + "name": "encryptionScopeName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the encryptionScope associated with the Cognitive Services Account", + "x-ms-parameter-location": "method" + }, + "modelFormatFilterParameter": { + "name": "modelFormat", + "in": "query", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The format of the Model", + "x-ms-parameter-location": "method" + }, + "modelNameFilterParameter": { + "name": "modelName", + "in": "query", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the Model", + "x-ms-parameter-location": "method" + }, + "modelVersionFilterParameter": { + "name": "modelVersion", + "in": "query", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The version of the Model", + "x-ms-parameter-location": "method" + }, + "defenderForAISettingNameParameter": { + "name": "defenderForAISettingName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the defender for AI setting.", + "x-ms-parameter-location": "method" + }, + "nspConfigurationNameParameter": { + "name": "nspConfigurationName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^.*$", + "description": "The name of the NSP Configuration.", + "x-ms-parameter-location": "method" + }, + "raiContentFilterNameParameter": { + "name": "filterName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the RAI Content Filter.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/AddRaiBlocklistItems.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/AddRaiBlocklistItems.json new file mode 100644 index 000000000000..681f3cf50519 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/AddRaiBlocklistItems.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiBlocklistName": "myblocklist", + "raiBlocklistItems": [ + { + "name": "myblocklistitem1", + "properties": { + "pattern": "^[a-z0-9_-]{2,16}$", + "isRegex": true + } + }, + { + "name": "myblocklistitem2", + "properties": { + "pattern": "blockwords", + "isRegex": false + } + } + ] + }, + "responses": { + "200": { + "body": { + "name": "myblocklist", + "properties": { + "description": "Brief description of the blocklist" + }, + "etag": "\"00000000-0000-0000-0000-000000000000\"" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/CalculateModelCapacity.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/CalculateModelCapacity.json new file mode 100644 index 000000000000..da4842487689 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/CalculateModelCapacity.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "parameters": { + "model": { + "format": "OpenAI", + "name": "gpt-4", + "version": "0613" + }, + "skuName": "ProvisinedManaged", + "workloads": [ + { + "requestPerMinute": 10, + "requestParameters": { + "avgPromptTokens": 30, + "avgGeneratedTokens": 50 + } + }, + { + "requestPerMinute": 20, + "requestParameters": { + "avgPromptTokens": 60, + "avgGeneratedTokens": 20 + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "model": { + "format": "OpenAI", + "name": "gpt-4", + "version": "0613" + }, + "skuName": "ProvisinedManaged", + "estimatedCapacity": { + "value": 346, + "deployableValue": 400 + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/CheckDomainAvailability.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/CheckDomainAvailability.json new file mode 100644 index 000000000000..88626f4bd978 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/CheckDomainAvailability.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "location": "westus", + "parameters": { + "subdomainName": "contosodemoapp1", + "type": "Microsoft.CognitiveServices/accounts" + } + }, + "responses": { + "200": { + "body": { + "isSubdomainAvailable": false, + "reason": "Sub domain name 'contosodemoapp1' is not valid", + "subdomainName": "contosodemoapp1", + "type": "Microsoft.CognitiveServices/accounts" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/CheckSkuAvailability.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/CheckSkuAvailability.json new file mode 100644 index 000000000000..cf1db164b678 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/CheckSkuAvailability.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "location": "westus", + "parameters": { + "skus": [ + "S0" + ], + "kind": "Face", + "type": "Microsoft.CognitiveServices/accounts" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "kind": "Face", + "type": "Microsoft.CognitiveServices/accounts", + "skuName": "S0", + "skuAvailable": true, + "reason": null, + "message": null + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/CreateAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/CreateAccount.json new file mode 100644 index 000000000000..0de93e58ef07 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/CreateAccount.json @@ -0,0 +1,140 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "myResourceGroup", + "accountName": "testCreate1", + "account": { + "location": "West US", + "kind": "Emotion", + "sku": { + "name": "S0" + }, + "properties": { + "encryption": { + "keyVaultProperties": { + "keyName": "KeyName", + "keyVersion": "891CF236-D241-4738-9462-D506AF493DFA", + "keyVaultUri": "https://pltfrmscrts-use-pc-dev.vault.azure.net/" + }, + "keySource": "Microsoft.KeyVault" + }, + "userOwnedStorage": [ + { + "resourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount" + } + ] + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "Emotion", + "etag": "W/\"datetime'2017-04-10T08%3A00%3A05.445595Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded", + "encryption": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "FakeKeyName", + "keyVersion": "891CF236-D241-4738-9462-D506AF493DFA", + "keyVaultUri": "https://pltfrmscrts-use-pc-dev.vault.azure.net/" + } + }, + "userOwnedStorage": [ + { + "resourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount" + } + ] + }, + "identity": { + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "Emotion", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded", + "encryption": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "FakeKeyName", + "keyVersion": "891CF236-D241-4738-9462-D506AF493DFA", + "keyVaultUri": "https://pltfrmscrts-use-pc-dev.vault.azure.net/" + } + }, + "userOwnedStorage": [ + { + "resourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount" + } + ] + }, + "identity": { + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "Emotion", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded", + "encryption": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "FakeKeyName", + "keyVersion": "891CF236-D241-4738-9462-D506AF493DFA", + "keyVaultUri": "https://pltfrmscrts-use-pc-dev.vault.azure.net/" + } + }, + "userOwnedStorage": [ + { + "resourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount" + } + ] + }, + "identity": { + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/CreateAccountMin.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/CreateAccountMin.json new file mode 100644 index 000000000000..e3d35e38d670 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/CreateAccountMin.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "myResourceGroup", + "accountName": "testCreate1", + "account": { + "location": "West US", + "kind": "CognitiveServices", + "sku": { + "name": "S0" + }, + "properties": {}, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "Emotion", + "etag": "W/\"datetime'2017-04-10T08%3A00%3A05.445595Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + }, + "identity": { + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "Emotion", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + }, + "identity": { + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "Emotion", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + }, + "identity": { + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/CreateSharedCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/CreateSharedCommitmentPlan.json new file mode 100644 index 000000000000..eefc560a3178 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/CreateSharedCommitmentPlan.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "resourceGroupName", + "commitmentPlanName": "commitmentPlanName", + "commitmentPlan": { + "location": "West US", + "kind": "SpeechServices", + "sku": { + "name": "S0" + }, + "properties": { + "hostingModel": "Web", + "planType": "STT", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName", + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/commitmentPlans", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "SpeechServices", + "properties": { + "provisioningState": "Succeeded", + "hostingModel": "Web", + "planType": "STT", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName", + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/commitmentPlans", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "SpeechServices", + "properties": { + "provisioningState": "Succeeded", + "hostingModel": "Web", + "planType": "STT", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/CreateSharedCommitmentPlanAssociation.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/CreateSharedCommitmentPlanAssociation.json new file mode 100644 index 000000000000..08f0aa1393ce --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/CreateSharedCommitmentPlanAssociation.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "resourceGroupName", + "commitmentPlanName": "commitmentPlanName", + "commitmentPlanAssociationName": "commitmentPlanAssociationName", + "association": { + "properties": { + "accountId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName/accountAssociations/commitmentPlanAssociationName", + "name": "commitmentPlanAssociationName", + "type": "Microsoft.CognitiveServices/commitmentPlans/accountAssociations", + "properties": { + "accountId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName/accountAssociations/commitmentPlanAssociationName", + "name": "commitmentPlanAssociationName", + "type": "Microsoft.CognitiveServices/commitmentPlans/accountAssociations", + "properties": { + "accountId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeleteAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeleteAccount.json new file mode 100644 index 000000000000..1ddf9a3b2ab9 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeleteAccount.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "myResourceGroup", + "accountName": "PropTest01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeleteCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeleteCommitmentPlan.json new file mode 100644 index 000000000000..b6f7f772d88f --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeleteCommitmentPlan.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "commitmentPlanName": "commitmentPlanName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeleteDeployment.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeleteDeployment.json new file mode 100644 index 000000000000..6fe58be41176 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeleteDeployment.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "deploymentName": "deploymentName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeleteEncryptionScope.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeleteEncryptionScope.json new file mode 100644 index 000000000000..b056c2c289c0 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeleteEncryptionScope.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "encryptionScopeName": "encryptionScopeName" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeletePrivateEndpointConnection.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..b2ef3f078e7f --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeletePrivateEndpointConnection.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res6977", + "accountName": "sto2527", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2024-06-01-preview", + "monitor": "true" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeleteRaiBlocklist.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeleteRaiBlocklist.json new file mode 100644 index 000000000000..73fa4c96d169 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeleteRaiBlocklist.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiBlocklistName": "raiBlocklistName" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeleteRaiBlocklistItem.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeleteRaiBlocklistItem.json new file mode 100644 index 000000000000..4eeefd5b74b1 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeleteRaiBlocklistItem.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiBlocklistName": "raiBlocklistName", + "raiBlocklistItemName": "raiBlocklistItemName" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeleteRaiBlocklistItems.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeleteRaiBlocklistItems.json new file mode 100644 index 000000000000..25e6bc30d003 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeleteRaiBlocklistItems.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiBlocklistName": "raiBlocklistName", + "raiBlocklistItemsNames": [ + "myblocklistitem1", + "myblocklistitem2" + ] + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeleteRaiPolicy.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeleteRaiPolicy.json new file mode 100644 index 000000000000..c5f033990ad0 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeleteRaiPolicy.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiPolicyName": "raiPolicyName" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeleteSharedCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeleteSharedCommitmentPlan.json new file mode 100644 index 000000000000..29212cc75d4d --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeleteSharedCommitmentPlan.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "resourceGroupName", + "commitmentPlanName": "commitmentPlanName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeleteSharedCommitmentPlanAssociation.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeleteSharedCommitmentPlanAssociation.json new file mode 100644 index 000000000000..c8439997d189 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/DeleteSharedCommitmentPlanAssociation.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "resourceGroupName", + "commitmentPlanName": "commitmentPlanName", + "commitmentPlanAssociationName": "commitmentPlanAssociationName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetAccount.json new file mode 100644 index 000000000000..84c5e085a833 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetAccount.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "myResourceGroup", + "accountName": "myAccount" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount", + "name": "myAccount", + "type": "Microsoft.CognitiveServices/accounts", + "location": "westus", + "sku": { + "name": "F0" + }, + "kind": "Emotion", + "tags": { + "Owner": "felixwa", + "ExpiredDate": "2017/09/01" + }, + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetCommitmentPlan.json new file mode 100644 index 000000000000..d3ca4da9f567 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetCommitmentPlan.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "commitmentPlanName": "commitmentPlanName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/commitmentPlans/commitmentPlanName", + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/accounts/commitmentPlans", + "properties": { + "hostingModel": "Web", + "planType": "Speech2Text", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetDefenderForAISetting.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetDefenderForAISetting.json new file mode 100644 index 000000000000..4fd50e2e8f67 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetDefenderForAISetting.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "defenderForAISettingName": "Default" + }, + "responses": { + "200": { + "body": { + "name": "Default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/defenderForAISettings/Default", + "type": "Microsoft.CognitiveServices/accounts/defenderForAISettings", + "properties": { + "state": "Enabled" + }, + "systemData": { + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "createdAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z" + }, + "etag": "\"00000000-0000-0000-0000-000000000000\"" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetDeletedAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetDeletedAccount.json new file mode 100644 index 000000000000..abe96564d53a --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetDeletedAccount.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "myResourceGroup", + "accountName": "myAccount", + "location": "westus" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.CognitiveServices/locations/westus/resourceGroups/myResourceGroup/deletedAccounts/myAccount", + "name": "myAccount", + "type": "Microsoft.CognitiveServices/accounts", + "location": "westus", + "sku": { + "name": "F0" + }, + "kind": "Emotion", + "tags": { + "Owner": "felixwa", + "ExpiredDate": "2017/09/01" + }, + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetDeployment.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetDeployment.json new file mode 100644 index 000000000000..4608622f83aa --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetDeployment.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "deploymentName": "deploymentName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName", + "name": "deploymentName", + "type": "Microsoft.CognitiveServices/accounts/deployments", + "sku": { + "name": "Standard", + "capacity": 1 + }, + "properties": { + "model": { + "format": "OpenAI", + "name": "ada", + "version": "1" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetEncryptionScope.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetEncryptionScope.json new file mode 100644 index 000000000000..8efb580d3b63 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetEncryptionScope.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "encryptionScopeName": "encryptionScopeName" + }, + "responses": { + "200": { + "body": { + "name": "encryptionScopeName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/encryptionScopes/encryptionScopeName", + "type": "Microsoft.CognitiveServices/accounts/encryptionScopes", + "systemData": { + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "createdAt": "2023-06-08T06:35:08.0662558Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-08T06:35:08.0662558Z" + }, + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "state": "Enabled", + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "DevKeyWestUS2", + "keyVersion": "9f85549d7bf14ff4bf178c10d3bdca95", + "keyVaultUri": "https://devkvwestus2.vault.azure.net/", + "identityClientId": "00000000-0000-0000-0000-000000000000" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetNetworkSecurityPerimeterConfigurations.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetNetworkSecurityPerimeterConfigurations.json new file mode 100644 index 000000000000..b5014e01d23e --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetNetworkSecurityPerimeterConfigurations.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "nspConfigurationName": "NSPConfigurationName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/networkSecurityPerimeterConfigurations", + "name": "networkSecurityPerimeterConfigurationName", + "type": "Microsoft.CognitiveServices/accounts/networkSecurityPerimeterConfigurations", + "properties": { + "provisioningState": "Succeeded", + "networkSecurityPerimeter": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.Network/networkSecurityPerimeters/perimeter", + "perimeterGuid": "00000000-0000-0000-0000-000000000000", + "location": "East US" + }, + "resourceAssociation": { + "name": "associationName", + "accessMode": "Enforced" + }, + "profile": { + "name": "profileName", + "accessRulesVersion": 1, + "accessRules": [ + { + "name": "ruleName", + "properties": { + "direction": "Inbound", + "addressPrefixes": [ + "148.0.0.0/8", + "152.4.6.0/24" + ] + } + } + ] + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetOperations.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetOperations.json new file mode 100644 index 000000000000..f1580bc95213 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetOperations.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.CognitiveServices/accounts/read", + "display": { + "provider": "Microsoft Cognitive Services", + "resource": "Cognitive Services API Account", + "operation": "Read API Account", + "description": "Reads API accounts." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.CognitiveServices/accounts/write", + "display": { + "provider": "Microsoft Cognitive Services", + "resource": "Cognitive Services API Account", + "operation": "Write API Account", + "description": "Writes API Accounts." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.CognitiveServices/accounts/delete", + "display": { + "provider": "Microsoft Cognitive Services", + "resource": "Cognitive Services API Account", + "operation": "Delete API Account", + "description": "Deletes API accounts" + }, + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetPrivateEndpointConnection.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetPrivateEndpointConnection.json new file mode 100644 index 000000000000..c87db6c185e2 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetPrivateEndpointConnection.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res6977", + "accountName": "sto2527", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2024-06-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.CognitiveServices/accounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.CognitiveServices/accounts/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetRaiBlocklist.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetRaiBlocklist.json new file mode 100644 index 000000000000..13407c34e2ac --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetRaiBlocklist.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiBlocklistName": "raiBlocklistName" + }, + "responses": { + "200": { + "body": { + "name": "raiBlocklistName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName", + "properties": { + "description": "This is a sample blocklist" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetRaiBlocklistItem.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetRaiBlocklistItem.json new file mode 100644 index 000000000000..8996eb10f541 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetRaiBlocklistItem.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiBlocklistName": "raiBlocklistName", + "raiBlocklistItemName": "raiBlocklistItemName" + }, + "responses": { + "200": { + "body": { + "name": "raiBlocklistItemName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName/raiBlocklistItems/raiBlocklistItemName", + "properties": { + "pattern": "Pattern To Block", + "isRegex": false + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetRaiContentFilter.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetRaiContentFilter.json new file mode 100644 index 000000000000..d88f99fa3012 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetRaiContentFilter.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "WestUS", + "filterName": "IndirectAttack" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/IndirectAttack", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "name": "IndirectAttack", + "properties": { + "name": "Indirect Attack", + "isMultiLevelFilter": false, + "source": "Prompt" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetRaiPolicy.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetRaiPolicy.json new file mode 100644 index 000000000000..4df61383bbfc --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetRaiPolicy.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "deploymentName": "deploymentName", + "raiPolicyName": "raiPolicyName", + "effective": true + }, + "responses": { + "200": { + "body": { + "name": "raiPolicyName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", + "properties": { + "basePolicyName": "Microsoft.Default", + "mode": "Asynchronous_filter", + "contentFilters": [ + { + "name": "hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "jailbreak", + "blocking": true, + "source": "Prompt", + "enabled": true + }, + { + "name": "protected_material_text", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "protected_material_code", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "profanity", + "blocking": true, + "source": "Prompt", + "enabled": true + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetSharedCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetSharedCommitmentPlan.json new file mode 100644 index 000000000000..5258b860a05c --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetSharedCommitmentPlan.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "resourceGroupName", + "commitmentPlanName": "commitmentPlanName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName", + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/commitmentPlans", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "SpeechServices", + "properties": { + "provisioningState": "Succeeded", + "hostingModel": "Web", + "planType": "STT", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetSharedCommitmentPlanAssociation.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetSharedCommitmentPlanAssociation.json new file mode 100644 index 000000000000..fc079bc27d95 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetSharedCommitmentPlanAssociation.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "resourceGroupName", + "commitmentPlanName": "commitmentPlanName", + "commitmentPlanAssociationName": "commitmentPlanAssociationName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName/accountAssociations/commitmentPlanAssociationName", + "name": "commitmentPlanAssociationName", + "type": "Microsoft.CognitiveServices/commitmentPlans/accountAssociations", + "properties": { + "accountId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetSkus.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetSkus.json new file mode 100644 index 000000000000..ed7f29a07ce8 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetSkus.json @@ -0,0 +1,2164 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "f1c637e4-72ec-4f89-8d2b-0f933c036002" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Bing.Speech", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Bing.Speech", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "SpeechTranslation", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "SpeechTranslation", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "SpeechTranslation", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "SpeechTranslation", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "SpeechTranslation", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextTranslation", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextTranslation", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextTranslation", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextTranslation", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextTranslation", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S5", + "tier": "Standard", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S6", + "tier": "Standard", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S7", + "tier": "Standard", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S8", + "tier": "Standard", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "Bing.Autosuggest.v7", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "Bing.CustomSearch", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "Bing.SpellCheck.v7", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Bing.EntitySearch", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "Bing.EntitySearch", + "locations": [ + "GLOBAL" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "AUSTRALIAEAST" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "BRAZILSOUTH" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "CENTRALUSEUAP" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "SpeakerRecognition", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "SpeakerRecognition", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "CustomSpeech", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "CustomSpeech", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "WESTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "WESTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "NORTHEUROPE" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "SOUTHEASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "EASTASIA" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "WESTCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "CustomVision.Training", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "CustomVision.Training", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "CustomVision.Prediction", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "CustomVision.Prediction", + "locations": [ + "SOUTHCENTRALUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "EASTUS" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ContentModerator", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "ContentModerator", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "Face", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "Face", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "LUIS", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "LUIS", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "ComputerVision", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "F0", + "tier": "Free", + "kind": "TextAnalytics", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S0", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S1", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S2", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S3", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + }, + { + "resourceType": "accounts", + "name": "S4", + "tier": "Standard", + "kind": "TextAnalytics", + "locations": [ + "EASTUS2" + ], + "restrictions": [] + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetUsages.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetUsages.json new file mode 100644 index 000000000000..d6c2df5cda8a --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/GetUsages.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "5a4f5c2e-6983-4ccb-bd34-2196d5b5bbd3", + "resourceGroupName": "myResourceGroup", + "accountName": "TestUsage02" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": { + "value": "Face.Transactions", + "localizedValue": "Face.Transactions" + }, + "status": "Included", + "currentValue": 3, + "limit": 30000, + "nextResetTime": "2018-03-28T09:33:51Z", + "quotaPeriod": "30.00:00:00", + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListAccountModels.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListAccountModels.json new file mode 100644 index 000000000000..15b08332ab1e --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListAccountModels.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroupName", + "location": "location", + "accountName": "accountName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "baseModel": { + "format": "OpenAI", + "name": "ada", + "version": "1" + }, + "format": "OpenAI", + "name": "ada.1", + "version": "1", + "maxCapacity": 10, + "capabilities": { + "fineTune": "true" + }, + "deprecation": { + "fineTune": "2024-01-01T00:00:00Z", + "inference": "2024-01-01T00:00:00Z" + } + }, + { + "format": "OpenAI", + "name": "davinci", + "version": "1", + "maxCapacity": 10, + "capabilities": { + "fineTune": "true" + }, + "deprecation": { + "fineTune": "2024-01-01T00:00:00Z", + "inference": "2024-01-01T00:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListAccountsByResourceGroup.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListAccountsByResourceGroup.json new file mode 100644 index 000000000000..5d75737b1f95 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListAccountsByResourceGroup.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount", + "name": "myAccount", + "type": "Microsoft.CognitiveServices/accounts", + "location": "westus", + "sku": { + "name": "F0" + }, + "kind": "Emotion", + "tags": { + "Owner": "felixwa", + "ExpiredDate": "2017/09/01" + }, + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/TestPropertyWU2", + "name": "TestPropertyWU2", + "type": "Microsoft.CognitiveServices/accounts", + "location": "westus", + "sku": { + "name": "S0" + }, + "kind": "Face", + "tags": {}, + "etag": "W/\"datetime'2017-04-07T04%3A32%3A38.9187216Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/face/v1.0", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListAccountsBySubscription.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListAccountsBySubscription.json new file mode 100644 index 000000000000..26bffd71cfdf --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListAccountsBySubscription.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch", + "name": "bingSearch", + "type": "Microsoft.CognitiveServices/accounts", + "location": "global", + "sku": { + "name": "S1" + }, + "kind": "Bing.Search", + "etag": "W/\"datetime'2017-03-27T11%3A19%3A08.762494Z'\"", + "properties": { + "endpoint": "https://api.cognitive.microsoft.com/bing/v5.0", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/CrisProd", + "name": "CrisProd", + "type": "Microsoft.CognitiveServices/accounts", + "location": "westus", + "sku": { + "name": "S0" + }, + "kind": "CRIS", + "tags": { + "can't delete it successfully": "v-yunjin" + }, + "etag": "W/\"datetime'2017-03-31T08%3A57%3A07.4499566Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/sts/v1.0", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/rayrptest0308", + "name": "rayrptest0308", + "type": "Microsoft.CognitiveServices/accounts", + "location": "westus", + "sku": { + "name": "S0" + }, + "kind": "Face", + "etag": "W/\"datetime'2017-03-27T11%3A15%3A23.5232645Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/face/v1.0", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/raytest02", + "name": "raytest02", + "type": "Microsoft.CognitiveServices/accounts", + "location": "westus", + "sku": { + "name": "S0" + }, + "kind": "Emotion", + "etag": "W/\"datetime'2017-04-04T02%3A07%3A07.3957572Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListBlocklistItems.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListBlocklistItems.json new file mode 100644 index 000000000000..e22c72d8d9da --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListBlocklistItems.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiBlocklistName": "raiBlocklistName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "raiBlocklistItemName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName/raiBlocklistItems/raiBlocklistItemName", + "properties": { + "pattern": "Pattern To Block", + "isRegex": false + } + }, + { + "name": "raiBlocklistItemName2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName/raiBlocklistItems/raiBlocklistItemName2", + "properties": { + "pattern": "Another Pattern To Block", + "isRegex": false + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListBlocklists.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListBlocklists.json new file mode 100644 index 000000000000..710111ff7331 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListBlocklists.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "raiBlocklistName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName", + "properties": { + "description": "This is a sample blocklist" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListCommitmentPlans.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListCommitmentPlans.json new file mode 100644 index 000000000000..eeef732f7018 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListCommitmentPlans.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/commitmentPlans/commitmentPlanName", + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/accounts/commitmentPlans", + "properties": { + "hostingModel": "Web", + "planType": "Speech2Text", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListCommitmentTiers.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListCommitmentTiers.json new file mode 100644 index 000000000000..85963b8aeaa5 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListCommitmentTiers.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroupName", + "location": "location" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "kind": "TextAnalytics", + "skuName": "S", + "hostingModel": "Web", + "planType": "TA", + "tier": "T1", + "quota": { + "quantity": 1000000, + "unit": "Transaction" + }, + "cost": {} + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListDefenderForAISetting.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListDefenderForAISetting.json new file mode 100644 index 000000000000..f94cb2a9bf09 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListDefenderForAISetting.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/defenderForAISettings/Default", + "type": "Microsoft.CognitiveServices/accounts/defenderForAISettings", + "properties": { + "state": "Enabled" + }, + "systemData": { + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "createdAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z" + }, + "etag": "\"00000000-0000-0000-0000-000000000000\"" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListDeletedAccountsBySubscription.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListDeletedAccountsBySubscription.json new file mode 100644 index 000000000000..26bffd71cfdf --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListDeletedAccountsBySubscription.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch", + "name": "bingSearch", + "type": "Microsoft.CognitiveServices/accounts", + "location": "global", + "sku": { + "name": "S1" + }, + "kind": "Bing.Search", + "etag": "W/\"datetime'2017-03-27T11%3A19%3A08.762494Z'\"", + "properties": { + "endpoint": "https://api.cognitive.microsoft.com/bing/v5.0", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/CrisProd", + "name": "CrisProd", + "type": "Microsoft.CognitiveServices/accounts", + "location": "westus", + "sku": { + "name": "S0" + }, + "kind": "CRIS", + "tags": { + "can't delete it successfully": "v-yunjin" + }, + "etag": "W/\"datetime'2017-03-31T08%3A57%3A07.4499566Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/sts/v1.0", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/rayrptest0308", + "name": "rayrptest0308", + "type": "Microsoft.CognitiveServices/accounts", + "location": "westus", + "sku": { + "name": "S0" + }, + "kind": "Face", + "etag": "W/\"datetime'2017-03-27T11%3A15%3A23.5232645Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/face/v1.0", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/raytest02", + "name": "raytest02", + "type": "Microsoft.CognitiveServices/accounts", + "location": "westus", + "sku": { + "name": "S0" + }, + "kind": "Emotion", + "etag": "W/\"datetime'2017-04-04T02%3A07%3A07.3957572Z'\"", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListDeploymentSkus.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListDeploymentSkus.json new file mode 100644 index 000000000000..01e6812926cf --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListDeploymentSkus.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "deploymentName": "deploymentName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.CognitiveServices/accounts/deployments", + "sku": { + "name": "Standard", + "capacity": 1 + }, + "capacity": { + "minimum": 100, + "maximum": 1000, + "step": 100, + "default": 100, + "allowedValues": [ + 100, + 200 + ] + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListDeployments.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListDeployments.json new file mode 100644 index 000000000000..316baba04dcc --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListDeployments.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName", + "name": "deploymentName", + "type": "Microsoft.CognitiveServices/accounts/deployments", + "sku": { + "name": "Standard", + "capacity": 1 + }, + "properties": { + "model": { + "format": "OpenAI", + "name": "ada", + "version": "1" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListEncryptionScopes.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListEncryptionScopes.json new file mode 100644 index 000000000000..f13f12e6cd24 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListEncryptionScopes.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "encryptionScopeName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/encryptionScopes/encryptionScopeName", + "type": "Microsoft.CognitiveServices/accounts/encryptionScopes", + "systemData": { + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "createdAt": "2023-06-08T06:35:08.0662558Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-08T06:35:08.0662558Z" + }, + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "state": "Enabled", + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "DevKeyWestUS2", + "keyVersion": "9f85549d7bf14ff4bf178c10d3bdca95", + "keyVaultUri": "https://devkvwestus2.vault.azure.net/", + "identityClientId": "00000000-0000-0000-0000-000000000000" + } + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListKeys.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListKeys.json new file mode 100644 index 000000000000..3e85753d15df --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "myResourceGroup", + "accountName": "myAccount" + }, + "responses": { + "200": { + "body": { + "key1": "KEY1", + "key2": "KEY2" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListLocationBasedModelCapacities.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListLocationBasedModelCapacities.json new file mode 100644 index 000000000000..3f5f59958f56 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListLocationBasedModelCapacities.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "WestUS", + "modelFormat": "OpenAI", + "modelName": "ada", + "modelVersion": "1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionContext.SubscriptionId}/providers/Microsoft.CognitiveServices/locations/WestUS/models/OpenAI.ada.1/skuCapacities/Standard", + "type": "Microsoft.CognitiveServices/locations/models/skuCapacities", + "name": "Standard", + "location": "WestUS", + "properties": { + "model": { + "format": "OpenAI", + "name": "ada", + "version": "1" + }, + "skuName": "Standard", + "availableCapacity": 300, + "availableFinetuneCapacity": 20 + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListLocationModels.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListLocationModels.json new file mode 100644 index 000000000000..c9b4ac1499c6 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListLocationModels.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "WestUS" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "kind": "OpenAI", + "skuName": "S0", + "model": { + "format": "OpenAI", + "name": "ada", + "version": "1", + "maxCapacity": 3, + "capabilities": { + "fineTune": "true", + "inference": "false", + "scaleType": "Manual", + "completion": "true", + "search": "true", + "FineTuneTokensMaxValue": "37500000" + }, + "finetuneCapabilities": { + "fineTune": "true", + "inference": "false", + "scaleType": "Manual,Standard", + "completion": "true", + "search": "true", + "FineTuneTokensMaxValue": "37500000" + }, + "deprecation": { + "fineTune": "2024-01-01T00:00:00Z", + "inference": "2024-01-01T00:00:00Z" + }, + "lifecycleStatus": "Preview", + "systemData": { + "createdBy": "Microsoft", + "createdAt": "2021-10-07T00:00:00Z", + "lastModifiedBy": "Microsoft", + "lastModifiedAt": "2021-10-07T00:00:00Z" + }, + "skus": [ + { + "name": "provisioned", + "usageName": "OpenAI.Provisioned.Class1", + "capacity": { + "minimum": 100, + "maximum": 1000, + "step": 100, + "default": 100 + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListModelCapacities.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListModelCapacities.json new file mode 100644 index 000000000000..36c0a4ac9b60 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListModelCapacities.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "modelFormat": "OpenAI", + "modelName": "ada", + "modelVersion": "1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionContext.SubscriptionId}/providers/Microsoft.CognitiveServices/locations/WestUS/models/OpenAI.ada.1/skuCapacities/Standard", + "type": "Microsoft.CognitiveServices/locations/models/skuCapacities", + "name": "Standard", + "location": "WestUS", + "properties": { + "model": { + "format": "OpenAI", + "name": "ada", + "version": "1" + }, + "skuName": "Standard", + "availableCapacity": 300, + "availableFinetuneCapacity": 20 + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListNetworkSecurityPerimeterConfigurations.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListNetworkSecurityPerimeterConfigurations.json new file mode 100644 index 000000000000..cd416d43dcaf --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListNetworkSecurityPerimeterConfigurations.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/networkSecurityPerimeterConfigurations", + "name": "networkSecurityPerimeterConfigurationName", + "type": "Microsoft.CognitiveServices/accounts/networkSecurityPerimeterConfigurations", + "properties": { + "provisioningState": "Succeeded", + "networkSecurityPerimeter": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.Network/networkSecurityPerimeters/perimeter", + "perimeterGuid": "00000000-0000-0000-0000-000000000000", + "location": "East US" + }, + "resourceAssociation": { + "name": "associationName", + "accessMode": "Enforced" + }, + "profile": { + "name": "profileName", + "accessRulesVersion": 1, + "accessRules": [ + { + "name": "ruleName", + "properties": { + "direction": "Inbound", + "addressPrefixes": [ + "148.0.0.0/8", + "152.4.6.0/24" + ] + } + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListPrivateEndpointConnections.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListPrivateEndpointConnections.json new file mode 100644 index 000000000000..bdde28dcad8b --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListPrivateEndpointConnections.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res6977", + "accountName": "sto2527", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.CognitiveServices/accounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.CognitiveServices/accounts/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListPrivateLinkResources.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListPrivateLinkResources.json new file mode 100644 index 000000000000..d8cdd681773b --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListPrivateLinkResources.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res6977", + "accountName": "sto2527", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.CognitiveServices/accounts/sto2527/privateLinkResources/account", + "name": "blob", + "type": "Microsoft.CognitiveServices/accounts/privateLinkResources", + "properties": { + "groupId": "account", + "requiredMembers": [ + "default" + ], + "requiredZoneNames": [ + "privatelink.cognitiveservices.azure.com" + ] + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListRaiContentFilters.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListRaiContentFilters.json new file mode 100644 index 000000000000..7a3beaa85e7e --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListRaiContentFilters.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "WestUS" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Hate", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "name": "Hate", + "properties": { + "name": "Hate", + "isMultiLevelFilter": true + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Sexual", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "name": "Sexual", + "properties": { + "name": "Sexual", + "isMultiLevelFilter": true + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Violence", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "name": "Violence", + "properties": { + "name": "Violence", + "isMultiLevelFilter": true + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Selfharm", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "name": "Selfharm", + "properties": { + "name": "Selfharm", + "isMultiLevelFilter": true + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Jailbreak", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "name": "Jailbreak", + "properties": { + "name": "Jailbreak", + "isMultiLevelFilter": false, + "source": "Prompt" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/ProtectedMaterialText", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "name": "ProtectedMaterialText", + "properties": { + "name": "Protected Material Text", + "isMultiLevelFilter": false, + "source": "Completion" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/ProtectedMaterialCode", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "name": "ProtectedMaterialCode", + "properties": { + "name": "Protected Material Code", + "isMultiLevelFilter": false, + "source": "Completion" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Profanity", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "name": "Profanity", + "properties": { + "name": "Profanity", + "isMultiLevelFilter": false + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/IndirectAttack", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "name": "IndirectAttack", + "properties": { + "name": "Indirect Attack", + "isMultiLevelFilter": false, + "source": "Prompt" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListRaiPolicies.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListRaiPolicies.json new file mode 100644 index 000000000000..4bd27b34b9f2 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListRaiPolicies.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "raiPolicyName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", + "properties": { + "basePolicyName": "Microsoft.Default", + "mode": "Asynchronous_filter", + "contentFilters": [ + { + "name": "hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "jailbreak", + "blocking": true, + "source": "Prompt", + "enabled": true + }, + { + "name": "protected_material_text", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "protected_material_code", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "profanity", + "blocking": true, + "source": "Prompt", + "enabled": true + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListSharedCommitmentPlanAssociations.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListSharedCommitmentPlanAssociations.json new file mode 100644 index 000000000000..dd4dec34c45c --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListSharedCommitmentPlanAssociations.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "resourceGroupName", + "commitmentPlanName": "commitmentPlanName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName/accountAssociations/accountAssociationName", + "name": "accountAssociationName", + "type": "Microsoft.CognitiveServices/commitmentPlans/accountAssociations", + "properties": { + "accountId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListSharedCommitmentPlansByResourceGroup.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListSharedCommitmentPlansByResourceGroup.json new file mode 100644 index 000000000000..b5be56739d9e --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListSharedCommitmentPlansByResourceGroup.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName", + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/commitmentPlans", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "SpeechServices", + "properties": { + "provisioningState": "Succeeded", + "hostingModel": "Web", + "planType": "STT", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListSharedCommitmentPlansBySubscription.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListSharedCommitmentPlansBySubscription.json new file mode 100644 index 000000000000..6449b7fb068a --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListSharedCommitmentPlansBySubscription.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName", + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/commitmentPlans", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "SpeechServices", + "properties": { + "provisioningState": "Succeeded", + "hostingModel": "Web", + "planType": "STT", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListSkus.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListSkus.json new file mode 100644 index 000000000000..528a24ea3bf6 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListSkus.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "myResourceGroup", + "accountName": "myAccount" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.CognitiveServices/accounts", + "sku": { + "name": "F0", + "tier": "Free" + } + }, + { + "resourceType": "Microsoft.CognitiveServices/accounts", + "sku": { + "name": "S0", + "tier": "Standard" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListUsages.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListUsages.json new file mode 100644 index 000000000000..40ceab0bc870 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ListUsages.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "WestUS" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": { + "value": "AccountCount", + "localizedValue": "Cognitive Services total account limit" + }, + "currentValue": 3, + "limit": 200, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/PurgeDeletedAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/PurgeDeletedAccount.json new file mode 100644 index 000000000000..6b06c619642f --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/PurgeDeletedAccount.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "myResourceGroup", + "accountName": "PropTest01", + "location": "westus" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/PutCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/PutCommitmentPlan.json new file mode 100644 index 000000000000..4044912408b3 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/PutCommitmentPlan.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "commitmentPlanName": "commitmentPlanName", + "commitmentPlan": { + "properties": { + "hostingModel": "Web", + "planType": "Speech2Text", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/commitmentPlans/commitmentPlanName", + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/accounts/commitmentPlans", + "properties": { + "hostingModel": "Web", + "planType": "Speech2Text", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/commitmentPlans/commitmentPlanName", + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/accounts/commitmentPlans", + "properties": { + "hostingModel": "Web", + "planType": "Speech2Text", + "autoRenew": true, + "current": { + "tier": "T1" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/PutDefenderForAISetting.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/PutDefenderForAISetting.json new file mode 100644 index 000000000000..ba4a6e65efef --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/PutDefenderForAISetting.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "defenderForAISettingName": "Default", + "defenderForAISettings": { + "properties": { + "state": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "name": "Default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/defenderForAISettings/Default", + "type": "Microsoft.CognitiveServices/accounts/defenderForAISettings", + "properties": { + "state": "Enabled" + }, + "systemData": { + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "createdAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z" + }, + "etag": "\"00000000-0000-0000-0000-000000000000\"" + } + }, + "201": { + "body": { + "name": "Default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/defenderForAISettings/Default", + "type": "Microsoft.CognitiveServices/accounts/defenderForAISettings", + "properties": { + "state": "Enabled" + }, + "systemData": { + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "createdAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z" + }, + "etag": "\"00000000-0000-0000-0000-000000000000\"" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/PutDeployment.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/PutDeployment.json new file mode 100644 index 000000000000..ee8fb59a35f7 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/PutDeployment.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "deploymentName": "deploymentName", + "deployment": { + "sku": { + "name": "Standard", + "capacity": 1 + }, + "properties": { + "model": { + "format": "OpenAI", + "name": "ada", + "version": "1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName", + "name": "deploymentName", + "type": "Microsoft.CognitiveServices/accounts/deployments", + "sku": { + "name": "Standard", + "capacity": 1 + }, + "properties": { + "model": { + "format": "OpenAI", + "name": "ada", + "version": "1" + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName", + "name": "deploymentName", + "type": "Microsoft.CognitiveServices/accounts/deployments", + "sku": { + "name": "Standard", + "capacity": 1 + }, + "properties": { + "model": { + "format": "OpenAI", + "name": "ada", + "version": "1" + }, + "provisioningState": "Accepted" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/PutEncryptionScope.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/PutEncryptionScope.json new file mode 100644 index 000000000000..00b878d7545c --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/PutEncryptionScope.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "encryptionScopeName": "encryptionScopeName", + "encryptionScope": { + "properties": { + "state": "Enabled", + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "DevKeyWestUS2", + "keyVersion": "9f85549d7bf14ff4bf178c10d3bdca95", + "keyVaultUri": "https://devkvwestus2.vault.azure.net/", + "identityClientId": "00000000-0000-0000-0000-000000000000" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "encryptionScopeName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/encryptionScopes/encryptionScopeName", + "type": "Microsoft.CognitiveServices/accounts/encryptionScopes", + "systemData": { + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "createdAt": "2023-06-08T06:35:08.0662558Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-08T06:35:08.0662558Z" + }, + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "state": "Enabled", + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "DevKeyWestUS2", + "keyVersion": "9f85549d7bf14ff4bf178c10d3bdca95", + "keyVaultUri": "https://devkvwestus2.vault.azure.net/", + "identityClientId": "00000000-0000-0000-0000-000000000000" + } + } + } + }, + "201": { + "body": { + "name": "encryptionScopeName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/encryptionScopes/encryptionScopeName", + "type": "Microsoft.CognitiveServices/accounts/encryptionScopes", + "systemData": { + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "createdAt": "2023-06-08T06:35:08.0662558Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-08T06:35:08.0662558Z" + }, + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "state": "Enabled", + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "DevKeyWestUS2", + "keyVersion": "9f85549d7bf14ff4bf178c10d3bdca95", + "keyVaultUri": "https://devkvwestus2.vault.azure.net/", + "identityClientId": "00000000-0000-0000-0000-000000000000" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/PutPrivateEndpointConnection.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/PutPrivateEndpointConnection.json new file mode 100644 index 000000000000..c1a2cdcdd416 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/PutPrivateEndpointConnection.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res7687", + "accountName": "sto9699", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2024-06-01-preview", + "monitor": "true", + "properties": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.CognitiveServices/accounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.CognitiveServices/accounts/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + }, + "202": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.CognitiveServices/accounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.CognitiveServices/accounts/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/PutRaiBlocklist.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/PutRaiBlocklist.json new file mode 100644 index 000000000000..a61d19b48230 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/PutRaiBlocklist.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiBlocklistName": "raiBlocklistName", + "raiBlocklist": { + "properties": { + "description": "Basic blocklist description" + } + } + }, + "responses": { + "200": { + "body": { + "name": "raiBlocklistName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName", + "properties": { + "description": "Basic blocklist description" + } + } + }, + "201": { + "body": { + "name": "raiBlocklistName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiBlocklistName", + "properties": { + "description": "Basic blocklist description" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/PutRaiBlocklistItem.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/PutRaiBlocklistItem.json new file mode 100644 index 000000000000..b7f66ccc2898 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/PutRaiBlocklistItem.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiBlocklistName": "raiBlocklistName", + "raiBlocklistItemName": "raiBlocklistItemName", + "raiBlocklistItem": { + "properties": { + "pattern": "Pattern To Block", + "isRegex": false + } + } + }, + "responses": { + "200": { + "body": { + "name": "raiBlocklistItemName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName/raiBlocklistItems/raiBlocklistItemName", + "properties": { + "pattern": "Pattern To Block", + "isRegex": false + } + } + }, + "201": { + "body": { + "name": "raiBlocklistItemName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName/raiBlocklistItems/raiBlocklistItemName", + "properties": { + "pattern": "Pattern To Block", + "isRegex": false + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/PutRaiPolicy.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/PutRaiPolicy.json new file mode 100644 index 000000000000..f8eb50378b96 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/PutRaiPolicy.json @@ -0,0 +1,283 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "raiPolicyName": "raiPolicyName", + "raiPolicy": { + "properties": { + "basePolicyName": "Microsoft.Default", + "mode": "Asynchronous_filter", + "contentFilters": [ + { + "name": "hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "jailbreak", + "blocking": true, + "source": "Prompt", + "enabled": true + }, + { + "name": "protected_material_text", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "protected_material_code", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "profanity", + "blocking": true, + "source": "Prompt", + "enabled": true + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "raiPolicyName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", + "properties": { + "basePolicyName": "Microsoft.Default", + "mode": "Asynchronous_filter", + "contentFilters": [ + { + "name": "hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "jailbreak", + "blocking": true, + "source": "Prompt", + "enabled": true + }, + { + "name": "protected_material_text", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "protected_material_code", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "profanity", + "blocking": true, + "source": "Prompt", + "enabled": true + } + ] + } + } + }, + "201": { + "body": { + "name": "raiPolicyName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", + "properties": { + "basePolicyName": "Microsoft.Default", + "mode": "Asynchronous_filter", + "contentFilters": [ + { + "name": "hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "jailbreak", + "blocking": true, + "source": "Prompt", + "enabled": true + }, + { + "name": "protected_material_text", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "protected_material_code", + "blocking": true, + "source": "Completion", + "enabled": true + }, + { + "name": "profanity", + "blocking": true, + "source": "Prompt", + "enabled": true + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ReconcileNetworkSecurityPerimeterConfigurations.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ReconcileNetworkSecurityPerimeterConfigurations.json new file mode 100644 index 000000000000..190c2c919bbd --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/ReconcileNetworkSecurityPerimeterConfigurations.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "nspConfigurationName": "NSPConfigurationName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/networkSecurityPerimeterConfigurations", + "name": "networkSecurityPerimeterConfigurationName", + "type": "Microsoft.CognitiveServices/accounts/networkSecurityPerimeterConfigurations", + "properties": { + "provisioningState": "Succeeded", + "networkSecurityPerimeter": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.Network/networkSecurityPerimeters/perimeter", + "perimeterGuid": "00000000-0000-0000-0000-000000000000", + "location": "East US" + }, + "resourceAssociation": { + "name": "associationName", + "accessMode": "Enforced" + }, + "profile": { + "name": "profileName", + "accessRulesVersion": 1, + "accessRules": [ + { + "name": "ruleName", + "properties": { + "direction": "Inbound", + "addressPrefixes": [ + "148.0.0.0/8", + "152.4.6.0/24" + ] + } + } + ] + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/RegenerateKey.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/RegenerateKey.json new file mode 100644 index 000000000000..39da8a2e7193 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/RegenerateKey.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "myResourceGroup", + "accountName": "myAccount", + "parameters": { + "keyName": "Key2" + } + }, + "responses": { + "200": { + "body": { + "key1": "KEY1", + "key2": "KEY2" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/UpdateAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/UpdateAccount.json new file mode 100644 index 000000000000..ccc1a5bc6489 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/UpdateAccount.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "bvttest", + "accountName": "bingSearch", + "account": { + "location": "global", + "sku": { + "name": "S2" + } + } + }, + "responses": { + "200": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/global/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-06-01-preview", + "azure-AsyncOperation": "http://azure.async.operation/status" + }, + "body": { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch", + "name": "bingSearch", + "type": "Microsoft.CognitiveServices/accounts", + "location": "global", + "sku": { + "name": "S2" + }, + "kind": "Bing.Search", + "etag": "W/\"datetime'2017-04-10T07%3A46%3A21.5618831Z'\"", + "properties": { + "endpoint": "https://api.cognitive.microsoft.com/bing/v5.0", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/global/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-06-01-preview", + "azure-AsyncOperation": "http://azure.async.operation/status" + }, + "body": { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch", + "name": "bingSearch", + "type": "Microsoft.CognitiveServices/accounts", + "location": "global", + "sku": { + "name": "S2" + }, + "kind": "Bing.Search", + "etag": "W/\"datetime'2017-04-10T07%3A46%3A21.5618831Z'\"", + "properties": { + "endpoint": "https://api.cognitive.microsoft.com/bing/v5.0", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/UpdateDefenderForAISetting.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/UpdateDefenderForAISetting.json new file mode 100644 index 000000000000..60da40ea6119 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/UpdateDefenderForAISetting.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "defenderForAISettingName": "Default", + "defenderForAISettings": { + "properties": { + "state": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "name": "Default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/defenderForAISettings/Default", + "type": "Microsoft.CognitiveServices/accounts/defenderForAISettings", + "properties": { + "state": "Enabled" + }, + "systemData": { + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "createdAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z" + }, + "etag": "\"00000000-0000-0000-0000-000000000000\"" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/UpdateDeployment.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/UpdateDeployment.json new file mode 100644 index 000000000000..a8ad7beab6dd --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/UpdateDeployment.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroupName", + "accountName": "accountName", + "deploymentName": "deploymentName", + "deployment": { + "sku": { + "name": "Standard", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName", + "name": "deploymentName", + "type": "Microsoft.CognitiveServices/accounts/deployments", + "sku": { + "name": "Standard", + "capacity": 1 + }, + "properties": { + "model": { + "format": "OpenAI", + "name": "ada", + "version": "1" + }, + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/UpdateSharedCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/UpdateSharedCommitmentPlan.json new file mode 100644 index 000000000000..6e7e5e14ed6b --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-06-01-preview/examples/UpdateSharedCommitmentPlan.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "resourceGroupName", + "commitmentPlanName": "commitmentPlanName", + "commitmentPlan": { + "tags": { + "name": "value" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName", + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/commitmentPlans", + "location": "West US", + "sku": { + "name": "S0" + }, + "kind": "SpeechServices", + "properties": { + "provisioningState": "Succeeded", + "hostingModel": "Web", + "planType": "STT", + "autoRenew": true, + "current": { + "tier": "T1" + } + }, + "tags": { + "name": "value" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/readme.md b/specification/cognitiveservices/resource-manager/readme.md index 6fddeacdd2af..fe067d66ac4a 100644 --- a/specification/cognitiveservices/resource-manager/readme.md +++ b/specification/cognitiveservices/resource-manager/readme.md @@ -30,10 +30,19 @@ These are the global settings for the CognitiveServices API. ``` yaml openapi-type: arm -tag: package-preview-2024-04 +tag: package-preview-2024-06 ``` +### Tag: package-preview-2024-06 + +These settings apply only when `--tag=package-preview-2024-06` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-06' +input-file: + - Microsoft.CognitiveServices/preview/2024-06-01-preview/cognitiveservices.json +``` + ### Tag: package-preview-2024-04 These settings apply only when `--tag=package-preview-2024-04` is specified on the command line. diff --git a/specification/communication/Communication.Messages/client.tsp b/specification/communication/Communication.Messages/client.tsp index d8c9d9c1f1be..6fad713a917c 100644 --- a/specification/communication/Communication.Messages/client.tsp +++ b/specification/communication/Communication.Messages/client.tsp @@ -36,3 +36,8 @@ interface MessageTemplateClient "templateValues", "python" ); + +@@clientName(Azure.Communication.MessagesService.NotificationMessagesSendRequestBody.body, + "notificationContent", + "csharp,java" +); diff --git a/specification/communication/Communication.Messages/models.tsp b/specification/communication/Communication.Messages/models.tsp index 4949f3b23047..9d9c555ad3ff 100644 --- a/specification/communication/Communication.Messages/models.tsp +++ b/specification/communication/Communication.Messages/models.tsp @@ -375,13 +375,9 @@ enum Versions { c2024_02_01: "2024-02-01", } -alias BodyParameter< - T, - TName extends valueof string = "body", - TDoc extends valueof string = "Body parameter." -> = { - @doc(TDoc) - @friendlyName(TName) +@doc("Notification messages send request body.") +model NotificationMessagesSendRequestBody { + @doc("Details of the message to send.") @bodyRoot - body: T; -}; + body: NotificationContent; +} diff --git a/specification/communication/Communication.Messages/routes.tsp b/specification/communication/Communication.Messages/routes.tsp index a2c5d85987a4..75fc25bf3be6 100644 --- a/specification/communication/Communication.Messages/routes.tsp +++ b/specification/communication/Communication.Messages/routes.tsp @@ -35,7 +35,7 @@ interface NotificationMessagesOperations { @doc("Sends a notification message from Business to User.") send is Operations.ResourceCollectionAction< Notifications, - BodyParameter, + NotificationMessagesSendRequestBody, AcceptedResponse & SendMessageResult >; } diff --git a/specification/communication/data-plane/Email/preview/2021-10-01-preview/examples/GetSendStatus.json b/specification/communication/data-plane/Email/preview/2021-10-01-preview/examples/GetSendStatus.json index 31bb078abc0e..554b1288afe3 100644 --- a/specification/communication/data-plane/Email/preview/2021-10-01-preview/examples/GetSendStatus.json +++ b/specification/communication/data-plane/Email/preview/2021-10-01-preview/examples/GetSendStatus.json @@ -8,7 +8,7 @@ "responses": { "200": { "headers": { - "Retry-After": 100 + "Retry-After": "100" }, "body": { "messageId": "F9168C5E-CEB2-4faa-B6BF-329BF39FA1E4", diff --git a/specification/communication/data-plane/Email/preview/2021-10-01-preview/examples/SendEmail.json b/specification/communication/data-plane/Email/preview/2021-10-01-preview/examples/SendEmail.json index 331b415fa3a9..1c3ac170b61a 100644 --- a/specification/communication/data-plane/Email/preview/2021-10-01-preview/examples/SendEmail.json +++ b/specification/communication/data-plane/Email/preview/2021-10-01-preview/examples/SendEmail.json @@ -81,7 +81,7 @@ "headers": { "Repeatability-Result": "accepted", "Operation-Location": "https://contoso.westus.communications.azure.com//email/status/8540c0de-899f-5cce-acb5-3ec493af3800?api-version=2021-10-01-preview", - "Retry-After": 1, + "Retry-After": "1", "x-ms-request-id": "8540c0de-899f-5cce-acb5-3ec493af3800" } } diff --git a/specification/communication/data-plane/Email/preview/2023-01-15-preview/examples/GetOperationStatusReturnsNonTerminalStatus.json b/specification/communication/data-plane/Email/preview/2023-01-15-preview/examples/GetOperationStatusReturnsNonTerminalStatus.json index b41652df6f31..b069db247ffa 100644 --- a/specification/communication/data-plane/Email/preview/2023-01-15-preview/examples/GetOperationStatusReturnsNonTerminalStatus.json +++ b/specification/communication/data-plane/Email/preview/2023-01-15-preview/examples/GetOperationStatusReturnsNonTerminalStatus.json @@ -8,7 +8,7 @@ "responses": { "200": { "headers": { - "retry-after": 100 + "retry-after": "100" }, "body": { "id": "F9168C5E-CEB2-4faa-B6BF-329BF39FA1E4", diff --git a/specification/communication/data-plane/Email/preview/2023-01-15-preview/examples/SendEmail.json b/specification/communication/data-plane/Email/preview/2023-01-15-preview/examples/SendEmail.json index b2aa331b52d2..d28653a9cb97 100644 --- a/specification/communication/data-plane/Email/preview/2023-01-15-preview/examples/SendEmail.json +++ b/specification/communication/data-plane/Email/preview/2023-01-15-preview/examples/SendEmail.json @@ -73,7 +73,7 @@ "202": { "headers": { "Operation-Location": "https://contoso.westus.communications.azure.com//emails/operations/8540c0de-899f-5cce-acb5-3ec493af3800?api-version=2023-01-15-preview", - "retry-after": 20 + "retry-after": "20" }, "body": { "id": "8540c0de-899f-5cce-acb5-3ec493af3800", diff --git a/specification/communication/data-plane/Email/stable/2023-03-31/examples/GetOperationStatusReturnsNonTerminalStatus.json b/specification/communication/data-plane/Email/stable/2023-03-31/examples/GetOperationStatusReturnsNonTerminalStatus.json index 294c5ff9ac61..b673bdfc234a 100644 --- a/specification/communication/data-plane/Email/stable/2023-03-31/examples/GetOperationStatusReturnsNonTerminalStatus.json +++ b/specification/communication/data-plane/Email/stable/2023-03-31/examples/GetOperationStatusReturnsNonTerminalStatus.json @@ -8,7 +8,7 @@ "responses": { "200": { "headers": { - "retry-after": 100 + "retry-after": "100" }, "body": { "id": "F9168C5E-CEB2-4faa-B6BF-329BF39FA1E4", diff --git a/specification/communication/data-plane/Email/stable/2023-03-31/examples/SendEmail.json b/specification/communication/data-plane/Email/stable/2023-03-31/examples/SendEmail.json index 4698fe5905f9..95c89220ce98 100644 --- a/specification/communication/data-plane/Email/stable/2023-03-31/examples/SendEmail.json +++ b/specification/communication/data-plane/Email/stable/2023-03-31/examples/SendEmail.json @@ -73,7 +73,7 @@ "202": { "headers": { "Operation-Location": "https://contoso.westus.communications.azure.com//emails/operations/8540c0de-899f-5cce-acb5-3ec493af3800?api-version=2023-03-31", - "retry-after": 20 + "retry-after": "20" }, "body": { "id": "8540c0de-899f-5cce-acb5-3ec493af3800", diff --git a/specification/communication/data-plane/Messages/stable/2024-02-01/communicationservicesmessages.json b/specification/communication/data-plane/Messages/stable/2024-02-01/communicationservicesmessages.json index ec91ed70c2ed..7a383c60e5d5 100644 --- a/specification/communication/data-plane/Messages/stable/2024-02-01/communicationservicesmessages.json +++ b/specification/communication/data-plane/Messages/stable/2024-02-01/communicationservicesmessages.json @@ -162,13 +162,7 @@ "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" }, { - "name": "body", - "in": "body", - "description": "Body parameter.", - "required": true, - "schema": { - "$ref": "#/definitions/NotificationContent" - } + "$ref": "#/parameters/NotificationMessagesSendRequestBody" } ], "responses": { @@ -1063,6 +1057,16 @@ "type": "string", "x-ms-parameter-location": "method", "x-ms-client-name": "repeatabilityRequestId" + }, + "NotificationMessagesSendRequestBody": { + "name": "body", + "in": "body", + "description": "Details of the message to send.", + "required": true, + "schema": { + "$ref": "#/definitions/NotificationContent" + }, + "x-ms-parameter-location": "method" } } } diff --git a/specification/communitytraining/Community.Management/main.tsp b/specification/communitytraining/Community.Management/main.tsp index 2c2a9c763bc4..cef54df93a7c 100644 --- a/specification/communitytraining/Community.Management/main.tsp +++ b/specification/communitytraining/Community.Management/main.tsp @@ -144,9 +144,12 @@ interface CommunityTrainings { CommunityTraining, LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; - update is ArmResourcePatchAsync< + update is ArmCustomPatchAsync< CommunityTraining, - CommunityTrainingProperties + Azure.ResourceManager.Foundations.ResourceUpdateModel< + CommunityTraining, + CommunityTrainingProperties + > >; delete is ArmResourceDeleteAsync; listByResourceGroup is ArmResourceListByParent; diff --git a/specification/communitytraining/Community.Management/tspconfig.yaml b/specification/communitytraining/Community.Management/tspconfig.yaml index 096a9c28d477..5b9db1d431bc 100644 --- a/specification/communitytraining/Community.Management/tspconfig.yaml +++ b/specification/communitytraining/Community.Management/tspconfig.yaml @@ -4,6 +4,9 @@ options: "@azure-tools/typespec-autorest": emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/CommunityTrainings.json" examples-directory: "{project-root}/examples" linter: diff --git a/specification/communitytraining/resource-manager/Microsoft.Community/stable/2023-11-01/CommunityTrainings.json b/specification/communitytraining/resource-manager/Microsoft.Community/stable/2023-11-01/CommunityTrainings.json index 267b74e8889a..63742e82e588 100644 --- a/specification/communitytraining/resource-manager/Microsoft.Community/stable/2023-11-01/CommunityTrainings.json +++ b/specification/communitytraining/resource-manager/Microsoft.Community/stable/2023-11-01/CommunityTrainings.json @@ -553,6 +553,7 @@ }, "properties": { "$ref": "#/definitions/CommunityTrainingUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/disk.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/disk.json new file mode 100644 index 000000000000..13946af356cf --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/disk.json @@ -0,0 +1,911 @@ +{ + "swagger": "2.0", + "info": { + "title": "DiskResourceProviderClient", + "description": "The Disk Resource Provider Client.", + "version": "2024-03-02" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}": { + "put": { + "tags": [ + "Disks" + ], + "operationId": "Disks_CreateOrUpdate", + "description": "Creates or updates a disk.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "disk", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Disk" + }, + "description": "Disk object supplied in the body of the Put disk operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Disk" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/Disk" + } + } + }, + "x-ms-examples": { + "Create an empty managed disk.": { + "$ref": "./examples/diskExamples/Disk_Create_Empty.json" + }, + "Create a managed disk from a platform image.": { + "$ref": "./examples/diskExamples/Disk_Create_FromAPlatformImage.json" + }, + "Create a managed disk from an existing managed disk in the same or different subscription.": { + "$ref": "./examples/diskExamples/Disk_Create_FromAnExistingManagedDisk.json" + }, + "Create a managed disk by importing an unmanaged blob from the same subscription.": { + "$ref": "./examples/diskExamples/Disk_Create_ByImportingBlobFromTheSameSubscription.json" + }, + "Create a managed disk by importing an unmanaged blob from a different subscription.": { + "$ref": "./examples/diskExamples/Disk_Create_ByImportingBlobFromADifferentSubscription.json" + }, + "Create a managed disk by copying a snapshot.": { + "$ref": "./examples/diskExamples/Disk_Create_ByCopyingASnapshot.json" + }, + "Create a managed upload disk.": { + "$ref": "./examples/diskExamples/Disk_Create_UploadDisk.json" + }, + "Create a managed disk and associate with disk access resource.": { + "$ref": "./examples/diskExamples/Disk_Create_WithDiskAccess.json" + }, + "Create a managed disk with dataAccessAuthMode": { + "$ref": "./examples/diskExamples/Disk_Create_WithDataAccessAuthMode.json" + }, + "Create a managed disk and associate with disk encryption set.": { + "$ref": "./examples/diskExamples/Disk_Create_WithDiskEncryptionSet.json" + }, + "Create an ultra managed disk with logicalSectorSize 512E": { + "$ref": "./examples/diskExamples/Disk_Create_WithLogicalSectorSize.json" + }, + "Create an empty managed disk in extended location.": { + "$ref": "./examples/diskExamples/Disk_Create_InExtendedLocation.json" + }, + "Create a managed disk with ssd zrs account type.": { + "$ref": "./examples/diskExamples/Disk_Create_WithSSDZRSAccountType.json" + }, + "Create a managed disk with premium v2 account type.": { + "$ref": "./examples/diskExamples/Disk_Create_WithPremiumV2_LRSAccountType.json" + }, + "Create a managed disk with security profile": { + "$ref": "./examples/diskExamples/Disk_Create_WithSecurityProfile.json" + }, + "Create a managed disk from ImportSecure create option": { + "$ref": "./examples/diskExamples/Disk_Create_FromImportSecure.json" + }, + "Create a managed disk from UploadPreparedSecure create option": { + "$ref": "./examples/diskExamples/Disk_Create_FromUploadPreparedSecure.json" + }, + "Create a confidential VM supported disk encrypted with customer managed key": { + "$ref": "./examples/diskExamples/Disk_Create_ConfidentialVMSupportedDiskEncryptedWithCMK.json" + }, + "Create a managed disk from an Azure Compute Gallery image.": { + "$ref": "./examples/diskExamples/Disk_Create_FromAnAzureComputeGalleryImage.json" + }, + "Create a managed disk from an Azure Compute Gallery direct shared image.": { + "$ref": "./examples/diskExamples/Disk_Create_FromAnAzureComputeGalleryDirectSharedImage.json" + }, + "Create a managed disk from an Azure Compute Gallery community image.": { + "$ref": "./examples/diskExamples/Disk_Create_FromAnAzureComputeGalleryCommunityImage.json" + }, + "Create a managed disk with optimizedForFrequentAttach.": { + "$ref": "./examples/diskExamples/Disk_Create_WithOptimizedForFrequentAttach.json" + }, + "Create a managed disk with performancePlus.": { + "$ref": "./examples/diskExamples/Disk_Create_PerformancePlus.json" + }, + "Create a managed disk with ultra account type with readOnly property set.": { + "$ref": "./examples/diskExamples/Disk_Create_WithUltraSSD_ReadOnly.json" + }, + "Create a managed disk from elastic san volume snapshot.": { + "$ref": "./examples/diskExamples/Disk_Create_FromAnElasticSanVolumeSnapshot.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Disks" + ], + "operationId": "Disks_Update", + "description": "Updates (patches) a disk.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "disk", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DiskUpdate" + }, + "description": "Disk object supplied in the body of the Patch disk operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Disk" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/Disk" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update managed disk to remove disk access resource association.": { + "$ref": "./examples/diskExamples/Disk_Update_RemoveDiskAccess.json" + }, + "Update a managed disk to add purchase plan.": { + "$ref": "./examples/diskExamples/Disk_Update_AddPurchasePlan.json" + }, + "Update a managed disk to disable bursting.": { + "$ref": "./examples/diskExamples/Disk_Update_DisableBursting.json" + }, + "Create or update a bursting enabled managed disk.": { + "$ref": "./examples/diskExamples/Disk_CreateOrUpdate_BurstingEnabled.json" + }, + "Update a managed disk to add supportsHibernation.": { + "$ref": "./examples/diskExamples/Disk_Update_AddSupportsHibernation.json" + }, + "Update a managed disk to add accelerated networking.": { + "$ref": "./examples/diskExamples/Disk_Update_AddAcceleratedNetworking.json" + }, + "Update a managed disk to change tier.": { + "$ref": "./examples/diskExamples/Disk_Update_ChangeTier.json" + }, + "Update a managed disk to add architecture.": { + "$ref": "./examples/diskExamples//Disk_Update_ToAddArchitecture.json" + }, + "Update a managed disk to disable optimizedForFrequentAttach.": { + "$ref": "./examples/diskExamples//Disk_Update_DisableOptimizedForFrequentAttach.json" + }, + "Update a managed disk with diskControllerTypes.": { + "$ref": "./examples/diskExamples//Disk_Update_AddDiskControllerTypes.json" + } + } + }, + "get": { + "tags": [ + "Disks" + ], + "operationId": "Disks_Get", + "description": "Gets information about a disk.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Disk" + } + } + }, + "x-ms-examples": { + "Get information about a managed disk.": { + "$ref": "./examples/diskExamples/Disk_Get.json" + } + } + }, + "delete": { + "tags": [ + "Disks" + ], + "operationId": "Disks_Delete", + "description": "Deletes a disk.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "If the disk is deleted, this is an expected error code." + } + }, + "x-ms-examples": { + "Delete a managed disk.": { + "$ref": "./examples/diskExamples/Disk_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks": { + "get": { + "tags": [ + "Disks" + ], + "operationId": "Disks_ListByResourceGroup", + "description": "Lists all the disks under a resource group.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskList" + } + } + }, + "x-ms-examples": { + "List all managed disks in a resource group.": { + "$ref": "./examples/diskExamples/Disk_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/disks": { + "get": { + "tags": [ + "Disks" + ], + "operationId": "Disks_List", + "description": "Lists all the disks under a subscription.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskList" + } + } + }, + "x-ms-examples": { + "List all managed disks in a subscription.": { + "$ref": "./examples/diskExamples/Disk_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}/beginGetAccess": { + "post": { + "tags": [ + "Disks" + ], + "operationId": "Disks_GrantAccess", + "description": "Grants access to a disk.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "grantAccessData", + "in": "body", + "required": true, + "schema": { + "$ref": "./diskRPCommon.json#/definitions/GrantAccessData" + }, + "description": "Access data object supplied in the body of the get disk access operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./diskRPCommon.json#/definitions/AccessUri" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-examples": { + "Get a sas on a managed disk.": { + "$ref": "./examples/diskExamples/Disk_BeginGetAccess.json" + }, + "Get sas on managed disk and VM guest state": { + "$ref": "./examples/diskExamples/Disk_BeginGetAccess_WithVMGuestState.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}/endGetAccess": { + "post": { + "tags": [ + "Disks" + ], + "operationId": "Disks_RevokeAccess", + "description": "Revokes access to a disk.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-examples": { + "Revoke access to a managed disk.": { + "$ref": "./examples/diskExamples/Disk_EndGetAccess.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "Disk": { + "properties": { + "managedBy": { + "readOnly": true, + "type": "string", + "description": "A relative URI containing the ID of the VM that has the disk attached." + }, + "managedByExtended": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "List of relative URIs containing the IDs of the VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs." + }, + "sku": { + "$ref": "#/definitions/DiskSku" + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The Logical zone list for Disk." + }, + "extendedLocation": { + "$ref": "../../../common-types/v1/common.json#/definitions/ExtendedLocation", + "description": "The extended location where the disk will be created. Extended location cannot be changed." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DiskProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Disk resource." + }, + "DiskUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DiskUpdateProperties" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "sku": { + "$ref": "#/definitions/DiskSku" + } + }, + "description": "Disk update resource." + }, + "DiskList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Disk" + }, + "description": "A list of disks." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of disks. Call ListNext() with this to fetch the next page of disks." + } + }, + "required": [ + "value" + ], + "description": "The List Disks operation response." + }, + "DiskSku": { + "properties": { + "name": { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "UltraSSD_LRS", + "Premium_ZRS", + "StandardSSD_ZRS", + "PremiumV2_LRS" + ], + "x-ms-enum": { + "name": "DiskStorageAccountTypes", + "modelAsString": true, + "values": [ + { + "value": "Standard_LRS", + "description": "Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access." + }, + { + "value": "Premium_LRS", + "description": "Premium SSD locally redundant storage. Best for production and performance sensitive workloads." + }, + { + "value": "StandardSSD_LRS", + "description": "Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test." + }, + { + "value": "UltraSSD_LRS", + "description": "Ultra SSD locally redundant storage. Best for IO-intensive workloads such as SAP HANA, top tier databases (for example, SQL, Oracle), and other transaction-heavy workloads." + }, + { + "value": "Premium_ZRS", + "description": "Premium SSD zone redundant storage. Best for the production workloads that need storage resiliency against zone failures." + }, + { + "value": "StandardSSD_ZRS", + "description": "Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures." + }, + { + "value": "PremiumV2_LRS", + "description": "Premium SSD v2 locally redundant storage. Best for production and performance-sensitive workloads that consistently require low latency and high IOPS and throughput." + } + ] + }, + "description": "The sku name." + }, + "tier": { + "type": "string", + "readOnly": true, + "description": "The sku tier." + } + }, + "description": "The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS." + }, + "DiskProperties": { + "properties": { + "timeCreated": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time when the disk was created." + }, + "osType": { + "type": "string", + "description": "The Operating System type.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "hyperVGeneration": { + "type": "string", + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only.", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGeneration", + "modelAsString": true + } + }, + "purchasePlan": { + "$ref": "./diskRPCommon.json#/definitions/PurchasePlan", + "description": "Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}" + }, + "supportedCapabilities": { + "$ref": "./diskRPCommon.json#/definitions/SupportedCapabilities", + "description": "List of supported capabilities for the image from which the OS disk was created." + }, + "creationData": { + "$ref": "./diskRPCommon.json#/definitions/CreationData", + "description": "Disk source information. CreationData information cannot be changed after the disk has been created." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + }, + "diskSizeBytes": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The size of the disk in bytes. This field is read only." + }, + "uniqueId": { + "type": "string", + "readOnly": true, + "description": "Unique Guid identifying the resource." + }, + "encryptionSettingsCollection": { + "$ref": "./diskRPCommon.json#/definitions/EncryptionSettingsCollection", + "description": "Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The disk provisioning state." + }, + "diskIOPSReadWrite": { + "type": "integer", + "format": "int64", + "description": "The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes." + }, + "diskMBpsReadWrite": { + "type": "integer", + "format": "int64", + "description": "The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10." + }, + "diskIOPSReadOnly": { + "type": "integer", + "format": "int64", + "description": "The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes." + }, + "diskMBpsReadOnly": { + "type": "integer", + "format": "int64", + "description": "The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10." + }, + "diskState": { + "$ref": "./diskRPCommon.json#/definitions/DiskState", + "description": "The state of the disk." + }, + "encryption": { + "$ref": "./diskRPCommon.json#/definitions/Encryption", + "description": "Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys." + }, + "maxShares": { + "type": "integer", + "format": "int32", + "description": "The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time." + }, + "shareInfo": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ShareInfoElement" + }, + "x-ms-identifiers": [ + "vmUri" + ], + "description": "Details of the list of all VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs." + }, + "networkAccessPolicy": { + "$ref": "./diskRPCommon.json#/definitions/NetworkAccessPolicy" + }, + "diskAccessId": { + "type": "string", + "description": "ARM id of the DiskAccess resource for using private endpoints on disks." + }, + "burstingEnabledTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "Latest time when bursting was last enabled on a disk." + }, + "tier": { + "type": "string", + "description": "Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks." + }, + "burstingEnabled": { + "type": "boolean", + "description": "Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks." + }, + "propertyUpdatesInProgress": { + "readOnly": true, + "$ref": "#/definitions/PropertyUpdatesInProgress", + "description": "Properties of the disk for which update is pending." + }, + "supportsHibernation": { + "type": "boolean", + "description": "Indicates the OS on a disk supports hibernation." + }, + "securityProfile": { + "$ref": "./diskRPCommon.json#/definitions/DiskSecurityProfile", + "description": "Contains the security related information for the resource." + }, + "completionPercent": { + "type": "number", + "description": "Percentage complete for the background copy when a resource is created via the CopyStart operation." + }, + "publicNetworkAccess": { + "$ref": "./diskRPCommon.json#/definitions/PublicNetworkAccess" + }, + "dataAccessAuthMode": { + "$ref": "./diskRPCommon.json#/definitions/DataAccessAuthMode" + }, + "optimizedForFrequentAttach": { + "type": "boolean", + "description": "Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine." + }, + "LastOwnershipUpdateTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The UTC time when the ownership state of the disk was last changed i.e., the time the disk was last attached or detached from a VM or the time when the VM to which the disk was attached was deallocated or started." + } + }, + "required": [ + "creationData" + ], + "description": "Disk resource properties." + }, + "DiskUpdateProperties": { + "properties": { + "osType": { + "type": "string", + "description": "the Operating System type.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + }, + "encryptionSettingsCollection": { + "$ref": "./diskRPCommon.json#/definitions/EncryptionSettingsCollection", + "description": "Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot." + }, + "diskIOPSReadWrite": { + "type": "integer", + "format": "int64", + "description": "The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes." + }, + "diskMBpsReadWrite": { + "type": "integer", + "format": "int64", + "description": "The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10." + }, + "diskIOPSReadOnly": { + "type": "integer", + "format": "int64", + "description": "The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes." + }, + "diskMBpsReadOnly": { + "type": "integer", + "format": "int64", + "description": "The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10." + }, + "maxShares": { + "type": "integer", + "format": "int32", + "description": "The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time." + }, + "encryption": { + "$ref": "./diskRPCommon.json#/definitions/Encryption", + "description": "Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys." + }, + "networkAccessPolicy": { + "$ref": "./diskRPCommon.json#/definitions/NetworkAccessPolicy" + }, + "diskAccessId": { + "type": "string", + "description": "ARM id of the DiskAccess resource for using private endpoints on disks." + }, + "tier": { + "type": "string", + "description": "Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks." + }, + "burstingEnabled": { + "type": "boolean", + "description": "Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks." + }, + "purchasePlan": { + "$ref": "./diskRPCommon.json#/definitions/PurchasePlan", + "description": "Purchase plan information to be added on the OS disk" + }, + "supportedCapabilities": { + "$ref": "./diskRPCommon.json#/definitions/SupportedCapabilities", + "description": "List of supported capabilities to be added on the OS disk." + }, + "propertyUpdatesInProgress": { + "readOnly": true, + "$ref": "#/definitions/PropertyUpdatesInProgress", + "description": "Properties of the disk for which update is pending." + }, + "supportsHibernation": { + "type": "boolean", + "description": "Indicates the OS on a disk supports hibernation." + }, + "publicNetworkAccess": { + "$ref": "./diskRPCommon.json#/definitions/PublicNetworkAccess" + }, + "dataAccessAuthMode": { + "$ref": "./diskRPCommon.json#/definitions/DataAccessAuthMode" + }, + "optimizedForFrequentAttach": { + "type": "boolean", + "description": "Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine." + } + }, + "description": "Disk resource update properties." + }, + "ShareInfoElement": { + "properties": { + "vmUri": { + "readOnly": true, + "type": "string", + "description": "A relative URI containing the ID of the VM that has the disk attached." + } + } + }, + "PropertyUpdatesInProgress": { + "properties": { + "targetTier": { + "type": "string", + "description": "The target performance tier of the disk if a tier change operation is in progress." + } + }, + "description": "Properties of the disk for which update is pending." + } + }, + "parameters": { + "DiskNameParameter": { + "name": "diskName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/diskAccess.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/diskAccess.json new file mode 100644 index 000000000000..c1f244f7e9c3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/diskAccess.json @@ -0,0 +1,824 @@ +{ + "swagger": "2.0", + "info": { + "title": "DiskResourceProviderClient", + "description": "The Disk Resource Provider Client.", + "version": "2024-03-02" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}": { + "put": { + "tags": [ + "DiskAccesses" + ], + "operationId": "DiskAccesses_CreateOrUpdate", + "description": "Creates or updates a disk access resource", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskAccessNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "diskAccess", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DiskAccess" + }, + "description": "disk access object supplied in the body of the Put disk access operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskAccess" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DiskAccess" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a disk access resource.": { + "$ref": "./examples/diskAccessExamples/DiskAccess_Create.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "DiskAccesses" + ], + "operationId": "DiskAccesses_Update", + "description": "Updates (patches) a disk access resource.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskAccessNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "diskAccess", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DiskAccessUpdate" + }, + "description": "disk access object supplied in the body of the Patch disk access operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskAccess" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DiskAccess" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update a disk access resource.": { + "$ref": "./examples/diskAccessExamples/DiskAccess_Update.json" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "DiskAccesses" + ], + "operationId": "DiskAccesses_Get", + "description": "Gets information about a disk access resource.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskAccessNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskAccess" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get information about a disk access resource.": { + "$ref": "./examples/diskAccessExamples/DiskAccess_Get.json" + }, + "Get information about a disk access resource with private endpoints.": { + "$ref": "./examples/diskAccessExamples/DiskAccess_Get_WithPrivateEndpoints.json" + } + } + }, + "delete": { + "tags": [ + "DiskAccesses" + ], + "operationId": "DiskAccesses_Delete", + "description": "Deletes a disk access resource.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskAccessNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "If the disk access resource is already deleted, this is an expected error code." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete a disk access resource.": { + "$ref": "./examples/diskAccessExamples/DiskAccess_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses": { + "get": { + "tags": [ + "DiskAccesses" + ], + "operationId": "DiskAccesses_ListByResourceGroup", + "description": "Lists all the disk access resources under a resource group.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskAccessList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all disk access resources in a resource group.": { + "$ref": "./examples/diskAccessExamples/DiskAccess_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskAccesses": { + "get": { + "tags": [ + "DiskAccesses" + ], + "operationId": "DiskAccesses_List", + "description": "Lists all the disk access resources under a subscription.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskAccessList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all disk access resources in a subscription.": { + "$ref": "./examples/diskAccessExamples/DiskAccess_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privateLinkResources": { + "get": { + "tags": [ + "DiskAccesses" + ], + "operationId": "DiskAccesses_GetPrivateLinkResources", + "description": "Gets the private link resources possible under disk access resource", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskAccessNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + } + }, + "x-ms-examples": { + "List all possible private link resources under disk access resource.": { + "$ref": "./examples/diskAccessExamples/DiskAccessPrivateLinkResources_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "put": { + "tags": [ + "DiskAccesses" + ], + "operationId": "DiskAccesses_UpdateAPrivateEndpointConnection", + "description": "Approve or reject a private endpoint connection under disk access resource, this can't be used to create a new private endpoint connection.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskAccessNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "privateEndpointConnection", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "private endpoint connection object supplied in the body of the Put private endpoint connection operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Approve a Private Endpoint Connection under a disk access resource.": { + "$ref": "./examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Approve.json" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "DiskAccesses" + ], + "operationId": "DiskAccesses_GetAPrivateEndpointConnection", + "description": "Gets information about a private endpoint connection under a disk access resource.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskAccessNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get information about a private endpoint connection under a disk access resource.": { + "$ref": "./examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Get.json" + } + } + }, + "delete": { + "tags": [ + "DiskAccesses" + ], + "operationId": "DiskAccesses_DeleteAPrivateEndpointConnection", + "description": "Deletes a private endpoint connection under a disk access resource.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskAccessNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "If the private endpoint connection is already deleted, this is an expected error code." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete a private endpoint connection under a disk access resource.": { + "$ref": "./examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privateEndpointConnections": { + "get": { + "tags": [ + "DiskAccesses" + ], + "operationId": "DiskAccesses_ListPrivateEndpointConnections", + "description": "List information about private endpoint connections under a disk access resource", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskAccessNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get information about a private endpoint connection under a disk access resource.": { + "$ref": "./examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_ListByDiskAccess.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "DiskAccessProperties": { + "properties": { + "privateEndpointConnections": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The disk access resource provisioning state." + }, + "timeCreated": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time when the disk access was created." + } + } + }, + "DiskAccess": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DiskAccessProperties" + }, + "extendedLocation": { + "$ref": "../../../common-types/v1/common.json#/definitions/ExtendedLocation", + "description": "The extended location where the disk access will be created. Extended location cannot be changed." + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "disk access resource." + }, + "DiskAccessList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskAccess" + }, + "description": "A list of disk access resources." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of disk access resources. Call ListNext() with this to fetch the next page of disk access resources." + } + }, + "required": [ + "value" + ], + "description": "The List disk access operation response." + }, + "DiskAccessUpdate": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "description": "Used for updating a disk access resource." + }, + "PrivateLinkResourceListResult": { + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + }, + "description": "A list of private link resources" + }, + "PrivateLinkResource": { + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + }, + "id": { + "readOnly": true, + "type": "string", + "description": "private link resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "private link resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "private link resource type" + } + }, + "description": "A private link resource" + }, + "PrivateLinkResourceProperties": { + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private link resource DNS zone name." + } + }, + "description": "Properties of a private link resource." + }, + "PrivateEndpoint": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ARM identifier for Private Endpoint" + } + }, + "description": "The Private Endpoint resource." + }, + "PrivateEndpointServiceConnectionStatus": { + "type": "string", + "description": "The private endpoint connection status.", + "enum": [ + "Pending", + "Approved", + "Rejected" + ], + "x-ms-enum": { + "name": "PrivateEndpointServiceConnectionStatus", + "modelAsString": true + } + }, + "PrivateEndpointConnectionProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "PrivateLinkServiceConnectionState": { + "properties": { + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + }, + "description": { + "type": "string", + "description": "The reason for approval/rejection of the connection." + }, + "actionsRequired": { + "type": "string", + "description": "A message indicating if changes on the service provider require any updates on the consumer." + } + }, + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "PrivateEndpointConnectionProperties": { + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private end point.", + "readOnly": true + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between DiskAccess and Virtual Network." + }, + "provisioningState": { + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState", + "description": "The provisioning state of the private endpoint connection resource." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ], + "description": "Properties of the PrivateEndpointConnectProperties." + }, + "PrivateEndpointConnection": { + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "x-ms-client-flatten": true, + "description": "Resource properties." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "private endpoint connection Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "private endpoint connection name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "private endpoint connection type" + } + }, + "description": "The Private Endpoint Connection resource.", + "x-ms-azure-resource": true + }, + "PrivateEndpointConnectionListResult": { + "properties": { + "value": { + "type": "array", + "description": "Array of private endpoint connections", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of snapshots. Call ListNext() with this to fetch the next page of snapshots." + } + }, + "description": "A list of private link resources" + } + }, + "parameters": { + "DiskAccessNameParameter": { + "name": "diskAccessName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the disk access resource that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.", + "x-ms-parameter-location": "method" + }, + "PrivateEndpointConnectionNameParameter": { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/diskEncryptionSet.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/diskEncryptionSet.json new file mode 100644 index 000000000000..eba38152e955 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/diskEncryptionSet.json @@ -0,0 +1,604 @@ +{ + "swagger": "2.0", + "info": { + "title": "DiskResourceProviderClient", + "description": "The Disk Resource Provider Client.", + "version": "2024-03-02" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}": { + "put": { + "tags": [ + "DiskEncryptionSets" + ], + "operationId": "DiskEncryptionSets_CreateOrUpdate", + "description": "Creates or updates a disk encryption set", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskEncryptionSetNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "diskEncryptionSet", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DiskEncryptionSet" + }, + "description": "disk encryption set object supplied in the body of the Put disk encryption set operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskEncryptionSet" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DiskEncryptionSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a disk encryption set.": { + "$ref": "./examples/diskEncryptionSetExamples/DiskEncryptionSet_Create.json" + }, + "Create a disk encryption set with key vault from a different subscription.": { + "$ref": "./examples/diskEncryptionSetExamples/DiskEncryptionSet_Create_WithKeyVaultFromADifferentSubscription.json" + }, + "Create a disk encryption set with key vault from a different tenant.": { + "$ref": "./examples/diskEncryptionSetExamples/DiskEncryptionSet_Create_WithKeyVaultFromADifferentTenant.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "DiskEncryptionSets" + ], + "operationId": "DiskEncryptionSets_Update", + "description": "Updates (patches) a disk encryption set.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskEncryptionSetNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "diskEncryptionSet", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DiskEncryptionSetUpdate" + }, + "description": "disk encryption set object supplied in the body of the Patch disk encryption set operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskEncryptionSet" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DiskEncryptionSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update a disk encryption set.": { + "$ref": "./examples/diskEncryptionSetExamples/DiskEncryptionSet_Update.json" + }, + "Update a disk encryption set with rotationToLatestKeyVersionEnabled set to true - Succeeded": { + "$ref": "./examples/diskEncryptionSetExamples/DiskEncryptionSet_Update_WithRotationToLatestKeyVersionEnabled.json" + }, + "Update a disk encryption set with rotationToLatestKeyVersionEnabled set to true - Updating": { + "$ref": "./examples/diskEncryptionSetExamples/DiskEncryptionSet_Update_WithRotationToLatestKeyVersionEnabledInProgress.json" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "DiskEncryptionSets" + ], + "operationId": "DiskEncryptionSets_Get", + "description": "Gets information about a disk encryption set.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskEncryptionSetNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskEncryptionSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get information about a disk encryption set.": { + "$ref": "./examples/diskEncryptionSetExamples/DiskEncryptionSet_Get.json" + }, + "Get information about a disk encryption set when auto-key rotation failed.": { + "$ref": "./examples/diskEncryptionSetExamples/DiskEncryptionSet_Get_WithAutoKeyRotationError.json" + } + } + }, + "delete": { + "tags": [ + "DiskEncryptionSets" + ], + "operationId": "DiskEncryptionSets_Delete", + "description": "Deletes a disk encryption set.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskEncryptionSetNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "If the disk encryption set is already deleted, this is an expected error code." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete a disk encryption set.": { + "$ref": "./examples/diskEncryptionSetExamples/DiskEncryptionSet_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets": { + "get": { + "tags": [ + "DiskEncryptionSets" + ], + "operationId": "DiskEncryptionSets_ListByResourceGroup", + "description": "Lists all the disk encryption sets under a resource group.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskEncryptionSetList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all disk encryption sets in a resource group.": { + "$ref": "./examples/diskEncryptionSetExamples/DiskEncryptionSet_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskEncryptionSets": { + "get": { + "tags": [ + "DiskEncryptionSets" + ], + "operationId": "DiskEncryptionSets_List", + "description": "Lists all the disk encryption sets under a subscription.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskEncryptionSetList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all disk encryption sets in a subscription.": { + "$ref": "./examples/diskEncryptionSetExamples/DiskEncryptionSet_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}/associatedResources": { + "get": { + "tags": [ + "DiskEncryptionSets" + ], + "operationId": "DiskEncryptionSets_ListAssociatedResources", + "description": "Lists all resources that are encrypted with this disk encryption set.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskEncryptionSetNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceUriList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all resources that are encrypted with this disk encryption set.": { + "$ref": "./examples/diskEncryptionSetExamples/DiskEncryptionSet_ListAssociatedResources.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "EncryptionSetProperties": { + "properties": { + "encryptionType": { + "$ref": "#/definitions/DiskEncryptionSetType" + }, + "activeKey": { + "$ref": "#/definitions/KeyForDiskEncryptionSet", + "description": "The key vault key which is currently used by this disk encryption set." + }, + "previousKeys": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/KeyForDiskEncryptionSet" + }, + "x-ms-identifiers": [ + "sourceVault/id" + ], + "description": "A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The disk encryption set provisioning state." + }, + "rotationToLatestKeyVersionEnabled": { + "type": "boolean", + "description": "Set this flag to true to enable auto-updating of this disk encryption set to the latest key version." + }, + "lastKeyRotationTimestamp": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time when the active key of this disk encryption set was updated." + }, + "autoKeyRotationError": { + "readOnly": true, + "$ref": "../../../common-types/v1/common.json#/definitions/ApiError", + "description": "The error that was encountered during auto-key rotation. If an error is present, then auto-key rotation will not be attempted until the error on this disk encryption set is fixed." + }, + "federatedClientId": { + "type": "string", + "description": "Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property." + } + } + }, + "EncryptionSetIdentity": { + "properties": { + "type": { + "type": "string", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "DiskEncryptionSetIdentityType", + "modelAsString": true + }, + "description": "The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys." + }, + "principalId": { + "readOnly": true, + "type": "string", + "description": "The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity" + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity" + }, + "userAssignedIdentities": { + "$ref": "../../../common-types/v1/common.json#/definitions/UserAssignedIdentities", + "description": "The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks." + }, + "DiskEncryptionSetType": { + "type": "string", + "description": "The type of key used to encrypt the data of the disk.", + "enum": [ + "EncryptionAtRestWithCustomerKey", + "EncryptionAtRestWithPlatformAndCustomerKeys", + "ConfidentialVmEncryptedWithCustomerKey" + ], + "x-ms-enum": { + "name": "DiskEncryptionSetType", + "modelAsString": true, + "values": [ + { + "value": "EncryptionAtRestWithCustomerKey", + "description": "Resource using diskEncryptionSet would be encrypted at rest with Customer managed key that can be changed and revoked by a customer." + }, + { + "value": "EncryptionAtRestWithPlatformAndCustomerKeys", + "description": "Resource using diskEncryptionSet would be encrypted at rest with two layers of encryption. One of the keys is Customer managed and the other key is Platform managed." + }, + { + "value": "ConfidentialVmEncryptedWithCustomerKey", + "description": "Confidential VM supported disk and VM guest state would be encrypted with customer managed key." + } + ] + } + }, + "KeyForDiskEncryptionSet": { + "properties": { + "sourceVault": { + "$ref": "./diskRPCommon.json#/definitions/SourceVault", + "description": "Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription." + }, + "keyUrl": { + "type": "string", + "description": "Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value." + } + }, + "required": [ + "keyUrl" + ], + "description": "Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots" + }, + "DiskEncryptionSet": { + "properties": { + "identity": { + "$ref": "#/definitions/EncryptionSetIdentity" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EncryptionSetProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "disk encryption set resource." + }, + "DiskEncryptionSetUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DiskEncryptionSetUpdateProperties" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "identity": { + "$ref": "#/definitions/EncryptionSetIdentity" + } + }, + "description": "disk encryption set update resource." + }, + "DiskEncryptionSetUpdateProperties": { + "properties": { + "encryptionType": { + "$ref": "#/definitions/DiskEncryptionSetType" + }, + "activeKey": { + "$ref": "#/definitions/KeyForDiskEncryptionSet" + }, + "rotationToLatestKeyVersionEnabled": { + "type": "boolean", + "description": "Set this flag to true to enable auto-updating of this disk encryption set to the latest key version." + }, + "federatedClientId": { + "type": "string", + "description": "Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property." + } + }, + "description": "disk encryption set resource update properties." + }, + "DiskEncryptionSetList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskEncryptionSet" + }, + "description": "A list of disk encryption sets." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of disk encryption sets. Call ListNext() with this to fetch the next page of disk encryption sets." + } + }, + "required": [ + "value" + ], + "description": "The List disk encryption set operation response." + }, + "ResourceUriList": { + "properties": { + "value": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of IDs or Owner IDs of resources which are encrypted with the disk encryption set." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of encrypted resources. Call ListNext() with this to fetch the next page of encrypted resources." + } + }, + "required": [ + "value" + ], + "description": "The List resources which are encrypted with the disk encryption set." + } + }, + "parameters": { + "DiskEncryptionSetNameParameter": { + "name": "diskEncryptionSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the disk encryption set that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/diskRPCommon.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/diskRPCommon.json new file mode 100644 index 000000000000..c3e36d8b7dba --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/diskRPCommon.json @@ -0,0 +1,649 @@ +{ + "swagger": "2.0", + "info": { + "title": "DiskResourceProviderClient", + "description": "The Disk Resource Provider Client.", + "version": "2024-03-02" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "EncryptionSettingsCollection": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged." + }, + "encryptionSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EncryptionSettingsElement" + }, + "x-ms-identifiers": [ + "diskEncryptionKey/sourceVault/id" + ], + "description": "A collection of encryption settings, one for each disk volume." + }, + "encryptionSettingsVersion": { + "type": "string", + "description": "Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption with AAD app.'1.1' corresponds to Azure Disk Encryption." + } + }, + "required": [ + "enabled" + ], + "description": "Encryption settings for disk or snapshot" + }, + "EncryptionSettingsElement": { + "properties": { + "diskEncryptionKey": { + "$ref": "#/definitions/KeyVaultAndSecretReference", + "description": "Key Vault Secret Url and vault id of the disk encryption key" + }, + "keyEncryptionKey": { + "$ref": "#/definitions/KeyVaultAndKeyReference", + "description": "Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key." + } + }, + "description": "Encryption settings for one disk volume." + }, + "KeyVaultAndSecretReference": { + "properties": { + "sourceVault": { + "$ref": "#/definitions/SourceVault", + "description": "Resource id of the KeyVault containing the key or secret" + }, + "secretUrl": { + "type": "string", + "description": "Url pointing to a key or secret in KeyVault" + } + }, + "required": [ + "secretUrl", + "sourceVault" + ], + "description": "Key Vault Secret Url and vault id of the encryption key " + }, + "KeyVaultAndKeyReference": { + "properties": { + "sourceVault": { + "$ref": "#/definitions/SourceVault", + "description": "Resource id of the KeyVault containing the key or secret" + }, + "keyUrl": { + "type": "string", + "description": "Url pointing to a key or secret in KeyVault" + } + }, + "required": [ + "keyUrl", + "sourceVault" + ], + "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" + }, + "SourceVault": { + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + }, + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "EncryptionType": { + "type": "string", + "description": "The type of key used to encrypt the data of the disk.", + "enum": [ + "EncryptionAtRestWithPlatformKey", + "EncryptionAtRestWithCustomerKey", + "EncryptionAtRestWithPlatformAndCustomerKeys" + ], + "x-ms-enum": { + "name": "EncryptionType", + "modelAsString": true, + "values": [ + { + "value": "EncryptionAtRestWithPlatformKey", + "description": "Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets." + }, + { + "value": "EncryptionAtRestWithCustomerKey", + "description": "Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer." + }, + { + "value": "EncryptionAtRestWithPlatformAndCustomerKeys", + "description": "Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed." + } + ] + } + }, + "Encryption": { + "properties": { + "diskEncryptionSetId": { + "type": "string", + "description": "ResourceId of the disk encryption set to use for enabling encryption at rest." + }, + "type": { + "$ref": "#/definitions/EncryptionType" + } + }, + "description": "Encryption at rest settings for disk or snapshot" + }, + "NetworkAccessPolicy": { + "type": "string", + "description": "Policy for accessing the disk via network.", + "enum": [ + "AllowAll", + "AllowPrivate", + "DenyAll" + ], + "x-ms-enum": { + "name": "NetworkAccessPolicy", + "modelAsString": true, + "values": [ + { + "value": "AllowAll", + "description": "The disk can be exported or uploaded to from any network." + }, + { + "value": "AllowPrivate", + "description": "The disk can be exported or uploaded to using a DiskAccess resource's private endpoints." + }, + { + "value": "DenyAll", + "description": "The disk cannot be exported." + } + ] + } + }, + "PublicNetworkAccess": { + "type": "string", + "description": "Policy for controlling export on the disk.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate." + }, + { + "value": "Disabled", + "description": "You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate." + } + ] + } + }, + "DiskState": { + "type": "string", + "description": "This enumerates the possible state of the disk.", + "readOnly": true, + "enum": [ + "Unattached", + "Attached", + "Reserved", + "Frozen", + "ActiveSAS", + "ActiveSASFrozen", + "ReadyToUpload", + "ActiveUpload" + ], + "x-ms-enum": { + "name": "DiskState", + "modelAsString": true, + "values": [ + { + "value": "Unattached", + "description": "The disk is not being used and can be attached to a VM." + }, + { + "value": "Attached", + "description": "The disk is currently attached to a running VM." + }, + { + "value": "Reserved", + "description": "The disk is attached to a stopped-deallocated VM." + }, + { + "value": "Frozen", + "description": "The disk is attached to a VM which is in hibernated state." + }, + { + "value": "ActiveSAS", + "description": "The disk currently has an Active SAS Uri associated with it." + }, + { + "value": "ActiveSASFrozen", + "description": "The disk is attached to a VM in hibernated state and has an active SAS URI associated with it." + }, + { + "value": "ReadyToUpload", + "description": "A disk is ready to be created by upload by requesting a write token." + }, + { + "value": "ActiveUpload", + "description": "A disk is created for upload and a write token has been issued for uploading to it." + } + ] + } + }, + "CreationData": { + "properties": { + "createOption": { + "type": "string", + "enum": [ + "Empty", + "Attach", + "FromImage", + "Import", + "Copy", + "Restore", + "Upload", + "CopyStart", + "ImportSecure", + "UploadPreparedSecure", + "CopyFromSanSnapshot" + ], + "x-ms-enum": { + "name": "DiskCreateOption", + "modelAsString": true, + "values": [ + { + "value": "Empty", + "description": "Create an empty data disk of a size given by diskSizeGB." + }, + { + "value": "Attach", + "description": "Disk will be attached to a VM." + }, + { + "value": "FromImage", + "description": "Create a new disk from a platform image specified by the given imageReference or galleryImageReference." + }, + { + "value": "Import", + "description": "Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId." + }, + { + "value": "Copy", + "description": "Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId." + }, + { + "value": "Restore", + "description": "Create a new disk by copying from a backup recovery point." + }, + { + "value": "Upload", + "description": "Create a new disk by obtaining a write token and using it to directly upload the contents of the disk." + }, + { + "value": "CopyStart", + "description": "Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source." + }, + { + "value": "ImportSecure", + "description": "Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blob for VM guest state specified by securityDataUri in storage account specified by storageAccountId" + }, + { + "value": "UploadPreparedSecure", + "description": "Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in both disk and VM guest state" + }, + { + "value": "CopyFromSanSnapshot", + "description": "Create a new disk by exporting from elastic san volume snapshot" + } + ] + }, + "description": "This enumerates the possible sources of a disk's creation." + }, + "storageAccountId": { + "type": "string", + "description": "Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk." + }, + "imageReference": { + "$ref": "#/definitions/ImageDiskReference", + "description": "Disk source information for PIR or user images." + }, + "galleryImageReference": { + "$ref": "#/definitions/ImageDiskReference", + "description": "Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk." + }, + "sourceUri": { + "type": "string", + "description": "If createOption is Import, this is the URI of a blob to be imported into a managed disk." + }, + "sourceResourceId": { + "type": "string", + "description": "If createOption is Copy, this is the ARM id of the source snapshot or disk." + }, + "sourceUniqueId": { + "readOnly": true, + "type": "string", + "description": "If this field is set, this is the unique id identifying the source of this resource." + }, + "uploadSizeBytes": { + "type": "integer", + "format": "int64", + "description": "If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer)." + }, + "logicalSectorSize": { + "type": "integer", + "format": "int32", + "description": "Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default." + }, + "securityDataUri": { + "type": "string", + "description": "If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state." + }, + "performancePlus": { + "type": "boolean", + "description": "Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled." + }, + "elasticSanResourceId": { + "type": "string", + "description": "Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot." + }, + "provisionedBandwidthCopySpeed": { + "type": "string", + "description": "If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed.", + "enum": [ + "None", + "Enhanced" + ], + "x-ms-enum": { + "name": "ProvisionedBandwidthCopyOption", + "modelAsString": true + } + } + }, + "required": [ + "createOption" + ], + "description": "Data used when creating a disk." + }, + "ImageDiskReference": { + "properties": { + "id": { + "type": "string", + "description": "A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference." + }, + "sharedGalleryImageId": { + "type": "string", + "description": "A relative uri containing a direct shared Azure Compute Gallery image reference." + }, + "communityGalleryImageId": { + "type": "string", + "description": "A relative uri containing a community Azure Compute Gallery image reference." + }, + "lun": { + "type": "integer", + "format": "int32", + "description": "If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null." + } + }, + "description": "The source image used for creating the disk." + }, + "PurchasePlan": { + "properties": { + "name": { + "type": "string", + "description": "The plan ID." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." + }, + "product": { + "type": "string", + "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." + }, + "promotionCode": { + "type": "string", + "description": "The Offer Promotion Code." + } + }, + "required": [ + "publisher", + "name", + "product" + ], + "description": "Used for establishing the purchase context of any 3rd Party artifact through MarketPlace." + }, + "CopyCompletionError": { + "type": "object", + "properties": { + "errorCode": { + "type": "string", + "description": "Indicates the error code if the background copy of a resource created via the CopyStart operation fails.", + "enum": [ + "CopySourceNotFound" + ], + "x-ms-enum": { + "name": "CopyCompletionErrorReason", + "modelAsString": true, + "values": [ + { + "value": "CopySourceNotFound", + "description": "Indicates that the source snapshot was deleted while the background copy of the resource created via CopyStart operation was in progress." + } + ] + } + }, + "errorMessage": { + "type": "string", + "description": "Indicates the error message if the background copy of a resource created via the CopyStart operation fails." + } + }, + "required": [ + "errorCode", + "errorMessage" + ], + "description": "Indicates the error details if the background copy of a resource created via the CopyStart operation fails." + }, + "SupportedCapabilities": { + "type": "object", + "properties": { + "diskControllerTypes": { + "type": "string", + "description": "The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI." + }, + "acceleratedNetwork": { + "type": "boolean", + "description": "True if the image from which the OS disk is created supports accelerated networking." + }, + "architecture": { + "type": "string", + "description": "CPU architecture supported by an OS disk.", + "enum": [ + "x64", + "Arm64" + ], + "x-ms-enum": { + "name": "Architecture", + "modelAsString": true + } + } + }, + "description": "List of supported capabilities persisted on the disk resource for VM use." + }, + "DiskSecurityType": { + "type": "string", + "description": "Specifies the SecurityType of the VM. Applicable for OS disks only.", + "enum": [ + "TrustedLaunch", + "ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey", + "ConfidentialVM_DiskEncryptedWithPlatformKey", + "ConfidentialVM_DiskEncryptedWithCustomerKey", + "ConfidentialVM_NonPersistedTPM" + ], + "x-ms-enum": { + "name": "DiskSecurityTypes", + "modelAsString": true, + "values": [ + { + "value": "TrustedLaunch", + "description": "Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM)" + }, + { + "value": "ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey", + "description": "Indicates Confidential VM disk with only VM guest state encrypted" + }, + { + "value": "ConfidentialVM_DiskEncryptedWithPlatformKey", + "description": "Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key" + }, + { + "value": "ConfidentialVM_DiskEncryptedWithCustomerKey", + "description": "Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key" + }, + { + "value": "ConfidentialVM_NonPersistedTPM", + "description": "Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots." + } + ] + } + }, + "DiskSecurityProfile": { + "properties": { + "securityType": { + "$ref": "#/definitions/DiskSecurityType" + }, + "secureVMDiskEncryptionSetId": { + "type": "string", + "description": "ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key" + } + }, + "description": "Contains the security related information for the resource." + }, + "GrantAccessData": { + "properties": { + "access": { + "type": "string", + "enum": [ + "None", + "Read", + "Write" + ], + "x-ms-enum": { + "name": "AccessLevel", + "modelAsString": true + } + }, + "durationInSeconds": { + "type": "integer", + "format": "int32", + "description": "Time duration in seconds until the SAS access expires." + }, + "getSecureVMGuestStateSAS": { + "type": "boolean", + "description": "Set this flag to true to get additional SAS for VM guest state" + }, + "fileFormat": { + "type": "string", + "description": "Used to specify the file format when making request for SAS on a VHDX file format snapshot", + "enum": [ + "VHD", + "VHDX" + ], + "x-ms-enum": { + "name": "FileFormat", + "modelAsString": true, + "values": [ + { + "value": "VHD", + "description": "A VHD file is a disk image file in the Virtual Hard Disk file format." + }, + { + "value": "VHDX", + "description": "A VHDX file is a disk image file in the Virtual Hard Disk v2 file format." + } + ] + } + } + }, + "required": [ + "access", + "durationInSeconds" + ], + "description": "Data used for requesting a SAS." + }, + "AccessUri": { + "properties": { + "accessSAS": { + "readOnly": true, + "type": "string", + "description": "A SAS uri for accessing a disk." + }, + "securityDataAccessSAS": { + "readOnly": true, + "type": "string", + "description": "A SAS uri for accessing a VM guest state." + } + }, + "description": "A disk access SAS uri." + }, + "DataAccessAuthMode": { + "type": "string", + "description": "Additional authentication requirements when exporting or uploading to a disk or snapshot.", + "enum": [ + "AzureActiveDirectory", + "None" + ], + "x-ms-enum": { + "name": "DataAccessAuthMode", + "modelAsString": true, + "values": [ + { + "value": "AzureActiveDirectory", + "description": "When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth." + }, + { + "value": "None", + "description": "No additional authentication would be performed when accessing export/upload URL." + } + ] + } + } + }, + "parameters": { + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/diskRestorePoint.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/diskRestorePoint.json new file mode 100644 index 000000000000..027a5ff3d2a3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/diskRestorePoint.json @@ -0,0 +1,436 @@ +{ + "swagger": "2.0", + "info": { + "title": "DiskResourceProviderClient", + "description": "The Disk Resource Provider Client.", + "version": "2024-03-02" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{vmRestorePointName}/diskRestorePoints/{diskRestorePointName}": { + "get": { + "tags": [ + "IncrementalRestorePoints" + ], + "operationId": "DiskRestorePoint_Get", + "description": "Get disk restorePoint resource", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RestorePointCollectionNameParameter" + }, + { + "$ref": "#/parameters/VmRestorePointNameParameter" + }, + { + "$ref": "#/parameters/DiskRestorePointNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskRestorePoint" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get an incremental disk restorePoint resource.": { + "$ref": "./examples/diskRestorePointExamples/DiskRestorePoint_Get.json" + }, + "Get an incremental disk restorePoint when source resource is from a different region": { + "$ref": "./examples/diskRestorePointExamples/DiskRestorePoint_Get_WhenSourceResourceIsFromDifferentRegion.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{vmRestorePointName}/diskRestorePoints": { + "get": { + "tags": [ + "IncrementalRestorePoints" + ], + "operationId": "DiskRestorePoint_ListByRestorePoint", + "description": "Lists diskRestorePoints under a vmRestorePoint.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RestorePointCollectionNameParameter" + }, + { + "$ref": "#/parameters/VmRestorePointNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskRestorePointList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get an incremental disk restorePoint resource.": { + "$ref": "./examples/diskRestorePointExamples/DiskRestorePoint_ListByVmRestorePoint.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{vmRestorePointName}/diskRestorePoints/{diskRestorePointName}/beginGetAccess": { + "post": { + "tags": [ + "IncrementalRestorePoints" + ], + "operationId": "DiskRestorePoint_GrantAccess", + "description": "Grants access to a diskRestorePoint.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RestorePointCollectionNameParameter" + }, + { + "$ref": "#/parameters/VmRestorePointNameParameter" + }, + { + "$ref": "#/parameters/DiskRestorePointNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "grantAccessData", + "in": "body", + "required": true, + "schema": { + "$ref": "./diskRPCommon.json#/definitions/GrantAccessData" + }, + "description": "Access data object supplied in the body of the get disk access operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./diskRPCommon.json#/definitions/AccessUri" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Grants access to a diskRestorePoint.": { + "$ref": "./examples/diskRestorePointExamples/DiskRestorePoint_BeginGetAccess.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{vmRestorePointName}/diskRestorePoints/{diskRestorePointName}/endGetAccess": { + "post": { + "tags": [ + "IncrementalRestorePoints" + ], + "operationId": "DiskRestorePoint_RevokeAccess", + "description": "Revokes access to a diskRestorePoint.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RestorePointCollectionNameParameter" + }, + { + "$ref": "#/parameters/VmRestorePointNameParameter" + }, + { + "$ref": "#/parameters/DiskRestorePointNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Revokes access to a diskRestorePoint.": { + "$ref": "./examples/diskRestorePointExamples/DiskRestorePoint_EndGetAccess.json" + } + } + } + } + }, + "definitions": { + "DiskRestorePoint": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DiskRestorePointProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "description": "Properties of disk restore point" + }, + "DiskRestorePointList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskRestorePoint" + }, + "description": "A list of disk restore points." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of disk restore points. Call ListNext() with this to fetch the next page of disk restore points." + } + }, + "required": [ + "value" + ], + "description": "The List Disk Restore Points operation response." + }, + "DiskRestorePointProperties": { + "properties": { + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "The timestamp of restorePoint creation", + "readOnly": true + }, + "sourceResourceId": { + "type": "string", + "description": "arm id of source disk or source disk restore point.", + "readOnly": true + }, + "osType": { + "type": "string", + "readOnly": true, + "description": "The Operating System type.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "hyperVGeneration": { + "type": "string", + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only.", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGeneration", + "modelAsString": true + } + }, + "purchasePlan": { + "$ref": "./diskRPCommon.json#/definitions/PurchasePlan", + "description": "Purchase plan information for the the image from which the OS disk was created." + }, + "supportedCapabilities": { + "$ref": "./diskRPCommon.json#/definitions/SupportedCapabilities", + "description": "List of supported capabilities for the image from which the OS disk was created." + }, + "familyId": { + "type": "string", + "description": "id of the backing snapshot's MIS family", + "readOnly": true + }, + "sourceUniqueId": { + "type": "string", + "description": "unique incarnation id of the source disk", + "readOnly": true + }, + "encryption": { + "$ref": "./diskRPCommon.json#/definitions/Encryption", + "description": "Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.", + "readOnly": true + }, + "supportsHibernation": { + "type": "boolean", + "description": "Indicates the OS on a disk supports hibernation." + }, + "networkAccessPolicy": { + "$ref": "./diskRPCommon.json#/definitions/NetworkAccessPolicy" + }, + "publicNetworkAccess": { + "$ref": "./diskRPCommon.json#/definitions/PublicNetworkAccess" + }, + "diskAccessId": { + "type": "string", + "description": "ARM id of the DiskAccess resource for using private endpoints on disks." + }, + "completionPercent": { + "type": "number", + "description": "Percentage complete for the background copy of disk restore point when source resource is from a different region." + }, + "replicationState": { + "type": "string", + "description": "Replication state of disk restore point when source resource is from a different region.", + "readOnly": true + }, + "sourceResourceLocation": { + "type": "string", + "description": "Location of source disk or source disk restore point when source resource is from a different region.", + "readOnly": true + }, + "securityProfile": { + "$ref": "./diskRPCommon.json#/definitions/DiskSecurityProfile", + "description": "Contains the security related information for the resource." + }, + "logicalSectorSize": { + "type": "integer", + "format": "int32", + "description": "Logical sector size in bytes for disk restore points of UltraSSD_LRS and PremiumV2_LRS disks. Supported values are 512 and 4096. 4096 is the default.", + "readOnly": true + } + }, + "description": "Properties of an incremental disk restore point" + }, + "ProxyOnlyResource": { + "description": "The ProxyOnly Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + } + } + } + }, + "parameters": { + "DiskRestorePointNameParameter": { + "name": "diskRestorePointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the disk restore point created.", + "x-ms-parameter-location": "method" + }, + "RestorePointCollectionNameParameter": { + "name": "restorePointCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the restore point collection that the disk restore point belongs.", + "x-ms-parameter-location": "method" + }, + "VmRestorePointNameParameter": { + "name": "vmRestorePointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vm restore point that the disk disk restore point belongs.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Approve.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Approve.json new file mode 100644 index 000000000000..f4d64f9b0587 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Approve.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskAccessName": "myDiskAccess", + "privateEndpointConnectionName": "myPrivateEndpointConnection", + "privateEndpointConnection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approving myPrivateEndpointConnection" + } + } + } + }, + "responses": { + "202": { + "body": { + "name": "myPrivateEndpointConenction", + "type": "Microsoft.Compute/diskAccesses/privateEndpointConnections", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess/privateEndpoinConnections/myPrivateEndpointConnectionName", + "properties": { + "provisioningState": "Updating", + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "actionsRequired": "None", + "description": "Approving myPrivateEndpointConnection", + "status": "Approved" + } + } + } + }, + "200": { + "body": { + "name": "myPrivateEndpointConnectionName", + "type": "Microsoft.Compute/diskAccesses/PrivateEndpointConnections", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess/privateEndpoinConnections/myPrivateEndpointConnectionName", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "actionsRequired": "None", + "description": "Approving myPrivateEndpointConnection", + "status": "Approved" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Delete.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Delete.json new file mode 100644 index 000000000000..e3a62463e488 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "diskAccessName": "myDiskAccess", + "privateEndpointConnectionName": "myPrivateEndpointConnection", + "api-version": "2024-03-02" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/operations/{operationId}&monitor=true&api-version=2024-03-02" + } + }, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Get.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Get.json new file mode 100644 index 000000000000..b6015e6240dc --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskAccessName": "myDiskAccess", + "privateEndpointConnectionName": "myPrivateEndpointConnection" + }, + "responses": { + "200": { + "body": { + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Compute/diskAccesses/PrivateEndpointConnections", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess/privateEndpoinConnections/myPrivateEndpointConnection", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "actionsRequired": "None", + "description": "Auto-Approved", + "status": "Approved" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_ListByDiskAccess.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_ListByDiskAccess.json new file mode 100644 index 000000000000..e99783b6cb98 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_ListByDiskAccess.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskAccessName": "myDiskAccess" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Compute/diskAccesses/PrivateEndpointConnections", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess/privateEndpoinConnections/myPrivateEndpointConnection", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "actionsRequired": "None", + "description": "Auto-Approved", + "status": "Approved" + } + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccessPrivateLinkResources_Get.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccessPrivateLinkResources_Get.json new file mode 100644 index 000000000000..797b0c796056 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccessPrivateLinkResources_Get.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskAccessName": "myDiskAccess" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess/privateLinkResources/disks", + "name": "disks", + "type": "Microsoft.Compute/diskAccesses/privateLinkResources", + "properties": { + "groupId": "disks", + "requiredMembers": [ + "diskAccess_1" + ], + "requiredZoneNames": [ + "privatelink.blob.core.windows.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccess_Create.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccess_Create.json new file mode 100644 index 000000000000..2802473efd57 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccess_Create.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskAccessName": "myDiskAccess", + "diskAccess": { + "location": "West US" + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourcegroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess", + "name": "myDiskAccess", + "location": "West US", + "type": "Microsoft.Compute/diskAccesses" + } + }, + "200": { + "body": { + "name": "myDiskAccess", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourcegroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess", + "type": "Microsoft.Compute/diskAccesses", + "location": "West US", + "properties": { + "provisioningState": "Succeeded", + "timeCreated": "2020-05-01T04:41:35.079872+00:00" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccess_Delete.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccess_Delete.json new file mode 100644 index 000000000000..9f1d17d644cd --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccess_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "diskAccessName": "myDiskAccess", + "api-version": "2024-03-02" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/operations/{operationId}&monitor=true&api-version=2024-03-02" + } + }, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccess_Get.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccess_Get.json new file mode 100644 index 000000000000..dfd198ad4d50 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccess_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskAccessName": "myDiskAccess" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "timeCreated": "2020-05-01T04:41:35.079872+00:00" + }, + "type": "Microsoft.Compute/diskAccesses", + "location": "westus", + "tags": { + "department": "Development", + "project": "PrivateEndpoints" + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess", + "name": "myDiskAccess" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccess_Get_WithPrivateEndpoints.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccess_Get_WithPrivateEndpoints.json new file mode 100644 index 000000000000..b3d17413d00f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccess_Get_WithPrivateEndpoints.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskAccessName": "myDiskAccess" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "timeCreated": "2020-05-01T04:41:35.079872+00:00", + "privateEndpointConnections": [ + { + "name": "myDiskAccess.d4914cfa-6bc2-4049-a57c-3d1f622d8eef", + "type": "Microsoft.Compute/diskAccesses/PrivateEndpointConnections", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess/privateEndpoinConnections/myDiskAccess.d4914cfa-6bc2-4049-a57c-3d1f622d8eef", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "actionsRequired": "None", + "description": "Auto-Approved", + "status": "Approved" + } + } + } + ] + }, + "type": "Microsoft.Compute/diskAccesses", + "location": "westus", + "tags": { + "department": "Development", + "project": "PrivateEndpoints" + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess", + "name": "myDiskAccess" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccess_ListByResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccess_ListByResourceGroup.json new file mode 100644 index 000000000000..7514b51e00c1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccess_ListByResourceGroup.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "timeCreated": "2020-05-01T04:41:35.079872+00:00" + }, + "type": "Microsoft.Compute/diskAccesses", + "location": "westus", + "tags": { + "department": "Development", + "project": "PrivateEndpoints" + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess", + "name": "myDiskAccess" + }, + { + "properties": { + "provisioningState": "Succeeded", + "timeCreated": "2020-05-01T04:41:35.079872+00:00", + "privateEndpointConnections": [ + { + "name": "myDiskAccess.d4914cfa-6bc2-4049-a57c-3d1f622d8eef", + "type": "Microsoft.Compute/diskAccesses/PrivateEndpointConnections", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess2/privateEndpoinConnections/myDiskAccess2.d4914cfa-6bc2-4049-a57c-3d1f622d8eef", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint2" + }, + "privateLinkServiceConnectionState": { + "actionsRequired": "None", + "description": "Auto-Approved", + "status": "Approved" + } + } + } + ] + }, + "type": "Microsoft.Compute/diskAccesses", + "location": "westus", + "tags": { + "department": "Development", + "project": "PrivateEndpoints" + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess2", + "name": "myDiskAccess2" + } + ], + "nextLink": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskAccesses?$skiptoken={token}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccess_ListBySubscription.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccess_ListBySubscription.json new file mode 100644 index 000000000000..f89a00168fc8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccess_ListBySubscription.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2024-03-02" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "timeCreated": "2020-05-01T04:41:35.079872+00:00" + }, + "type": "Microsoft.Compute/diskAccesses", + "location": "westus", + "tags": { + "department": "Development", + "project": "PrivateEndpoints" + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess", + "name": "myDiskAccess" + }, + { + "properties": { + "provisioningState": "Succeeded", + "timeCreated": "2020-05-01T04:41:35.079872+00:00", + "privateEndpointConnections": [ + { + "name": "myDiskAccess.d4914cfa-6bc2-4049-a57c-3d1f622d8eef", + "type": "Microsoft.Compute/diskAccesses/PrivateEndpointConnections", + "id": "/subscriptions/{subscription-id}/resourceGroups/mySecondResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess2/privateEndpoinConnections/myDiskAccess2.d4914cfa-6bc2-4049-a57c-3d1f622d8eef", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/mySecondResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint2" + }, + "privateLinkServiceConnectionState": { + "actionsRequired": "None", + "description": "Auto-Approved", + "status": "Approved" + } + } + } + ] + }, + "type": "Microsoft.Compute/diskAccesses", + "location": "westus", + "tags": { + "department": "Development", + "project": "PrivateEndpoints" + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/mySecondResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess2", + "name": "myDiskAccess2" + } + ], + "nextLink": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskAccesses?$skiptoken={token}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccess_Update.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccess_Update.json new file mode 100644 index 000000000000..83d7407a3d29 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccess_Update.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskAccessName": "myDiskAccess", + "diskAccess": { + "tags": { + "department": "Development", + "project": "PrivateEndpoints" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess?api-version=2024-03-02" + }, + "body": { + "name": "myDiskAccess", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourcegroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess", + "type": "Microsoft.Compute/diskAccesses", + "location": "West US", + "tags": { + "department": "Development", + "project": "PrivateEndpoints" + } + } + }, + "200": { + "body": { + "name": "myDiskAccess", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourcegroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess", + "type": "Microsoft.Compute/diskAccesses", + "location": "West US", + "tags": { + "department": "Development", + "project": "PrivateEndpoints" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Create.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Create.json new file mode 100644 index 000000000000..e89045bb22f1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Create.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskEncryptionSetName": "myDiskEncryptionSet", + "diskEncryptionSet": { + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey" + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "name": "myDiskEncryptionSet", + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "previousKeys": [] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "name": "myDiskEncryptionSet", + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "previousKeys": [] + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Create_WithKeyVaultFromADifferentSubscription.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Create_WithKeyVaultFromADifferentSubscription.json new file mode 100644 index 000000000000..4adc2964e1f8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Create_WithKeyVaultFromADifferentSubscription.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskEncryptionSetName": "myDiskEncryptionSet", + "diskEncryptionSet": { + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "keyUrl": "https://myvaultdifferentsub.vault-int.azure-int.net/keys/{key}" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey" + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "name": "myDiskEncryptionSet", + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "keyUrl": "https://myvaultdifferentsub.vault-int.azure-int.net/keys/{key}" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "previousKeys": [] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "name": "myDiskEncryptionSet", + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "keyUrl": "https://myvaultdifferentsub.vault-int.azure-int.net/keys/{key}" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "previousKeys": [] + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Create_WithKeyVaultFromADifferentTenant.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Create_WithKeyVaultFromADifferentTenant.json new file mode 100644 index 000000000000..70ca494a4294 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Create_WithKeyVaultFromADifferentTenant.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskEncryptionSetName": "myDiskEncryptionSet", + "diskEncryptionSet": { + "location": "West US", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}": {} + } + }, + "properties": { + "activeKey": { + "keyUrl": "https://myvaultdifferenttenant.vault-int.azure-int.net/keys/{key}" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "federatedClientId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "name": "myDiskEncryptionSet", + "location": "West US", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}": {} + } + }, + "properties": { + "activeKey": { + "keyUrl": "https://myvaultdifferenttenant.vault-int.azure-int.net/keys/{key}" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "federatedClientId": "00000000-0000-0000-0000-000000000000", + "previousKeys": [] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "name": "myDiskEncryptionSet", + "location": "West US", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}": {} + } + }, + "properties": { + "activeKey": { + "keyUrl": "https://myvaultdifferenttenant.vault-int.azure-int.net/keys/{key}" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "federatedClientId": "00000000-0000-0000-0000-000000000000", + "previousKeys": [] + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Delete.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Delete.json new file mode 100644 index 000000000000..383e40c91c4d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "diskEncryptionSetName": "myDiskEncryptionSet", + "api-version": "2024-03-02" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/operations/{operationId}&monitor=true&api-version=2024-03-02" + } + }, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Get.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Get.json new file mode 100644 index 000000000000..7246bd81fbc1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskEncryptionSetName": "myDiskEncryptionSet" + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "previousKeys": [], + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/diskEncryptionSets", + "location": "westus", + "tags": { + "department": "Development", + "project": "Encryption" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "name": "myDiskEncryptionSet" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Get_WithAutoKeyRotationError.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Get_WithAutoKeyRotationError.json new file mode 100644 index 000000000000..db71f0337e4e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Get_WithAutoKeyRotationError.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskEncryptionSetName": "myDiskEncryptionSet" + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "previousKeys": [], + "rotationToLatestKeyVersionEnabled": true, + "provisioningState": "Succeeded", + "autoKeyRotationError": { + "code": "ManagedServiceIdentityNotFound", + "message": "Auto-key rotation was disabled as managed service identity associated with DiskEncryptionSet 'myDiskEncryptionSet' was not found. Please update the resource with correct identity to re-enable auto-key rotation." + } + }, + "type": "Microsoft.Compute/diskEncryptionSets", + "location": "westus", + "tags": { + "department": "Development", + "project": "Encryption" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "name": "myDiskEncryptionSet" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_ListAssociatedResources.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_ListAssociatedResources.json new file mode 100644 index 000000000000..d55d9de89a23 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_ListAssociatedResources.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskEncryptionSetName": "myDiskEncryptionSet" + }, + "responses": { + "200": { + "body": { + "value": [ + "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk", + "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + ], + "nextLink": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}/associatedResources?$skiptoken={token}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_ListByResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_ListByResourceGroup.json new file mode 100644 index 000000000000..3caf20442574 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_ListByResourceGroup.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "previousKeys": [], + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/diskEncryptionSets", + "location": "westus", + "tags": { + "department": "Development", + "project": "Encryption" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "name": "myDiskEncryptionSet" + }, + { + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault2" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "previousKeys": [], + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/diskEncryptionSets", + "location": "westus", + "tags": { + "department": "Development", + "project": "Encryption" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet2", + "name": "myDiskEncryptionSet2" + } + ], + "nextLink": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskEncryptionSets?$skiptoken={token}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_ListBySubscription.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_ListBySubscription.json new file mode 100644 index 000000000000..f4d31abe3a24 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_ListBySubscription.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2024-03-02" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "previousKeys": [], + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/diskEncryptionSets", + "location": "westus", + "tags": { + "department": "Development", + "project": "Encryption" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "name": "myDiskEncryptionSet" + }, + { + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/mySecondResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault2" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "previousKeys": [], + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/diskEncryptionSets", + "location": "westus", + "tags": { + "department": "Development", + "project": "Encryption" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/mySecondResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet2", + "name": "myDiskEncryptionSet2" + } + ], + "nextLink": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskEncryptionSets?$skiptoken={token}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Update.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Update.json new file mode 100644 index 000000000000..284834989dbf --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Update.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskEncryptionSetName": "myDiskEncryptionSet", + "diskEncryptionSet": { + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/keyName/keyVersion" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey" + }, + "tags": { + "department": "Development", + "project": "Encryption" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet?api-version=2024-03-02" + }, + "body": { + "name": "myDiskEncryptionSet", + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/keyName/keyVersion" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "previousKeys": [] + }, + "tags": { + "department": "Development", + "project": "Encryption" + } + } + }, + "200": { + "body": { + "name": "myDiskEncryptionSet", + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/keyName/keyVersion" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "previousKeys": [], + "lastKeyRotationTimestamp": "2021-04-01T04:41:35.079872+00:00" + }, + "tags": { + "department": "Development", + "project": "Encryption" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Update_WithRotationToLatestKeyVersionEnabled.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Update_WithRotationToLatestKeyVersionEnabled.json new file mode 100644 index 000000000000..2de11c0fed29 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Update_WithRotationToLatestKeyVersionEnabled.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskEncryptionSetName": "myDiskEncryptionSet", + "diskEncryptionSet": { + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "keyUrl": "https://myvaultdifferentsub.vault-int.azure-int.net/keys/keyName/keyVersion1" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "rotationToLatestKeyVersionEnabled": true + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet?api-version=2024-03-02" + }, + "body": { + "name": "myDiskEncryptionSet", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "type": "Microsoft.Compute/diskEncryptionSets", + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "keyUrl": "https://myvaultdifferentsub.vault-int.azure-int.net/keys/keyName/keyVersion1" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "previousKeys": [] + } + } + }, + "200": { + "body": { + "name": "myDiskEncryptionSet", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "type": "Microsoft.Compute/diskEncryptionSets", + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "keyUrl": "https://myvaultdifferentsub.vault-int.azure-int.net/keys/keyName/KeyVersion2" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "rotationToLatestKeyVersionEnabled": true, + "provisioningState": "Succeeded", + "lastKeyRotationTimestamp": "2021-04-01T04:41:35.079872+00:00" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Update_WithRotationToLatestKeyVersionEnabledInProgress.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Update_WithRotationToLatestKeyVersionEnabledInProgress.json new file mode 100644 index 000000000000..be8664a53794 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Update_WithRotationToLatestKeyVersionEnabledInProgress.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskEncryptionSetName": "myDiskEncryptionSet", + "diskEncryptionSet": { + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "keyUrl": "https://myvaultdifferentsub.vault-int.azure-int.net/keys/keyName/keyVersion1" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "rotationToLatestKeyVersionEnabled": true + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet?api-version=2024-03-02" + }, + "body": { + "name": "myDiskEncryptionSet", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "type": "Microsoft.Compute/diskEncryptionSets", + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "keyUrl": "https://myvaultdifferentsub.vault-int.azure-int.net/keys/keyName/keyVersion1" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "previousKeys": [] + } + } + }, + "200": { + "body": { + "name": "myDiskEncryptionSet", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "type": "Microsoft.Compute/diskEncryptionSets", + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "keyUrl": "https://myvaultdifferentsub.vault-int.azure-int.net/keys/keyName/keyVersion2" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "rotationToLatestKeyVersionEnabled": true, + "previousKeys": [ + { + "keyUrl": "https://myvaultdifferentsub.vault-int.azure-int.net/keys/keyName/keyVersion1" + } + ], + "provisioningState": "Updating", + "lastKeyRotationTimestamp": "2021-04-01T04:41:35.079872+00:00" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_BeginGetAccess.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_BeginGetAccess.json new file mode 100644 index 000000000000..5e67de6f89ed --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_BeginGetAccess.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "diskName": "myDisk", + "api-version": "2024-03-02", + "grantAccessData": { + "access": "Read", + "durationInSeconds": 300, + "fileFormat": "VHD" + } + }, + "responses": { + "200": { + "body": { + "accessSAS": "https://md-gpvmcxzlzxgd.partition.blob.storage.azure.net/xx3cqcx53f0v/abcd?sv=2014-02-14&sr=b&sk=key1&sig=XXX&st=2021-05-24T18:02:34Z&se=2021-05-24T18:19:14Z&sp=r" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/operations/{operationId}&monitor=true&api-version=2024-03-02" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_BeginGetAccess_WithVMGuestState.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_BeginGetAccess_WithVMGuestState.json new file mode 100644 index 000000000000..62a415311ff9 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_BeginGetAccess_WithVMGuestState.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "diskName": "myDisk", + "api-version": "2024-03-02", + "grantAccessData": { + "access": "Read", + "durationInSeconds": 300, + "getSecureVMGuestStateSAS": true + } + }, + "responses": { + "200": { + "body": { + "accessSAS": "https://md-gpvmcxzlzxgd.partition.blob.storage.azure.net/xx3cqcx53f0v/abcd?sv=2014-02-14&sr=b&sk=key1&sig=XXX&st=2021-05-24T18:02:34Z&se=2021-05-24T18:19:14Z&sp=r", + "securityDataAccessSAS": "https://md-gpvmcxzlzxgd.partition.blob.storage.azure.net/xx3cqcx53f0v/b9bf5824-6122-49e0-ba22-042f76ccd8a1_vmgs?sv=2014-02-14&sr=b&sk=key1&sig=XXX&st=2021-05-24T18:02:34Z&se=2021-05-24T18:19:14Z&sp=r" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/operations/{operationId}&monitor=true&api-version=2024-03-02" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_CreateOrUpdate_BurstingEnabled.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_CreateOrUpdate_BurstingEnabled.json new file mode 100644 index 000000000000..a040868b261e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_CreateOrUpdate_BurstingEnabled.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "properties": { + "diskSizeGB": 1024, + "burstingEnabled": true + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk?api-version=2024-03-02" + }, + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 1024, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 1024, + "burstingEnabled": true, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_ByCopyingASnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_ByCopyingASnapshot.json new file mode 100644 index 000000000000..181fe6086b5c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_ByCopyingASnapshot.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_ByImportingBlobFromADifferentSubscription.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_ByImportingBlobFromADifferentSubscription.json new file mode 100644 index 000000000000..322a0cbb98bf --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_ByImportingBlobFromADifferentSubscription.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Import", + "storageAccountId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Import", + "storageAccountId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Import", + "storageAccountId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_ByImportingBlobFromTheSameSubscription.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_ByImportingBlobFromTheSameSubscription.json new file mode 100644 index 000000000000..c9f440860b50 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_ByImportingBlobFromTheSameSubscription.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Import", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Import", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Import", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_ConfidentialVMSupportedDiskEncryptedWithCMK.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_ConfidentialVMSupportedDiskEncryptedWithCMK.json new file mode 100644 index 000000000000..43ae1f93e6f6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_ConfidentialVMSupportedDiskEncryptedWithCMK.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "osType": "Windows", + "securityProfile": { + "securityType": "ConfidentialVM_DiskEncryptedWithCustomerKey", + "secureVMDiskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/westus/Publishers/{publisher}/ArtifactTypes/VMImage/Offers/{offer}/Skus/{sku}/Versions/1.0.0" + } + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "osType": "Windows", + "securityProfile": { + "securityType": "ConfidentialVM_DiskEncryptedWithCustomerKey", + "secureVMDiskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/westus/Publishers/{publisher}/ArtifactTypes/VMImage/Offers/{offer}/Skus/{sku}/Versions/1.0.0" + } + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Succeeded", + "osType": "Windows", + "securityProfile": { + "securityType": "ConfidentialVM_DiskEncryptedWithCustomerKey", + "secureVMDiskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/westus/Publishers/{publisher}/ArtifactTypes/VMImage/Offers/{offer}/Skus/{sku}/Versions/1.0.0" + } + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_Empty.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_Empty.json new file mode 100644 index 000000000000..03466244ba8e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_Empty.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200 + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_FromAPlatformImage.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_FromAPlatformImage.json new file mode 100644 index 000000000000..c8f8f892bc97 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_FromAPlatformImage.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/westus/Publishers/{publisher}/ArtifactTypes/VMImage/Offers/{offer}/Skus/{sku}/Versions/1.0.0" + } + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "purchasePlan": { + "name": "{sku}", + "publisher": "{publisher}", + "product": "{offer}" + }, + "supportedCapabilities": { + "acceleratedNetwork": true + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/westus/Publishers/{publisher}/ArtifactTypes/VMImage/Offers/{offer}/Skus/{sku}/Versions/1.0.0" + } + }, + "provisioningState": "Updating" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Succeeded", + "osType": "Windows", + "hyperVGeneration": "V1", + "purchasePlan": { + "name": "{sku}", + "publisher": "{publisher}", + "product": "{offer}" + }, + "supportedCapabilities": { + "acceleratedNetwork": true + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/westus/Publishers/{publisher}/ArtifactTypes/VMImage/Offers/{offer}/Skus/{sku}/Versions/1.0.0" + } + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_FromAnAzureComputeGalleryCommunityImage.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_FromAnAzureComputeGalleryCommunityImage.json new file mode 100644 index 000000000000..3eba2944e79f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_FromAnAzureComputeGalleryCommunityImage.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "FromImage", + "galleryImageReference": { + "communityGalleryImageId": "/CommunityGalleries/{communityGalleryPublicGalleryName}/Images/{imageName}/Versions/1.0.0" + } + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "supportedCapabilities": { + "acceleratedNetwork": true + }, + "creationData": { + "createOption": "FromImage", + "galleryImageReference": { + "communityGalleryImageId": "/CommunityGalleries/{communityGalleryPublicGalleryName}/Images/{imageName}/Versions/1.0.0" + } + }, + "provisioningState": "Updating" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Succeeded", + "osType": "Windows", + "hyperVGeneration": "V1", + "supportedCapabilities": { + "acceleratedNetwork": true + }, + "creationData": { + "createOption": "FromImage", + "galleryImageReference": { + "communityGalleryImageId": "/CommunityGalleries/{communityGalleryPublicGalleryName}/Images/{imageName}/Versions/1.0.0" + } + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_FromAnAzureComputeGalleryDirectSharedImage.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_FromAnAzureComputeGalleryDirectSharedImage.json new file mode 100644 index 000000000000..92909e6a2bcd --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_FromAnAzureComputeGalleryDirectSharedImage.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "FromImage", + "galleryImageReference": { + "sharedGalleryImageId": "/SharedGalleries/{sharedGalleryUniqueName}/Images/{imageName}/Versions/1.0.0" + } + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "supportedCapabilities": { + "acceleratedNetwork": true + }, + "creationData": { + "createOption": "FromImage", + "galleryImageReference": { + "sharedGalleryImageId": "/SharedGalleries/{sharedGalleryUniqueName}/Images/{imageName}/Versions/1.0.0" + } + }, + "provisioningState": "Updating" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Succeeded", + "osType": "Windows", + "hyperVGeneration": "V1", + "supportedCapabilities": { + "acceleratedNetwork": true + }, + "creationData": { + "createOption": "FromImage", + "galleryImageReference": { + "sharedGalleryImageId": "/SharedGalleries/{sharedGalleryUniqueName}/Images/{imageName}/Versions/1.0.0" + } + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_FromAnAzureComputeGalleryImage.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_FromAnAzureComputeGalleryImage.json new file mode 100644 index 000000000000..44ed0d88f275 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_FromAnAzureComputeGalleryImage.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "FromImage", + "galleryImageReference": { + "id": "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Providers/Microsoft.Compute/Galleries/{galleryName}/Images/{imageName}/Versions/1.0.0" + } + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "supportedCapabilities": { + "acceleratedNetwork": true + }, + "creationData": { + "createOption": "FromImage", + "galleryImageReference": { + "id": "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Providers/Microsoft.Compute/Galleries/{galleryName}/Images/{imageName}/Versions/1.0.0" + } + }, + "provisioningState": "Updating" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Succeeded", + "osType": "Windows", + "hyperVGeneration": "V1", + "supportedCapabilities": { + "acceleratedNetwork": true + }, + "creationData": { + "createOption": "FromImage", + "galleryImageReference": { + "id": "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Providers/Microsoft.Compute/Galleries/{galleryName}/Images/{imageName}/Versions/1.0.0" + } + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_FromAnElasticSanVolumeSnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_FromAnElasticSanVolumeSnapshot.json new file mode 100644 index 000000000000..d59afb5cf293 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_FromAnElasticSanVolumeSnapshot.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "CopyFromSanSnapshot", + "elasticSanResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ElasticSan/elasticSans/myElasticSan/volumegroups/myElasticSanVolumeGroup/snapshots/myElasticSanVolumeSnapshot" + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "CopyFromSanSnapshot", + "elasticSanResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ElasticSan/elasticSans/myElasticSan/volumegroups/myElasticSanVolumeGroup/snapshots/myElasticSanVolumeSnapshot" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "CopyFromSanSnapshot", + "elasticSanResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ElasticSan/elasticSans/myElasticSan/volumegroups/myElasticSanVolumeGroup/snapshots/myElasticSanVolumeSnapshot" + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_FromAnExistingManagedDisk.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_FromAnExistingManagedDisk.json new file mode 100644 index 000000000000..7ddcffcb6a2f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_FromAnExistingManagedDisk.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk2", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk1" + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk1" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk2" + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk1" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk2" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_FromImportSecure.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_FromImportSecure.json new file mode 100644 index 000000000000..e1ea344b620b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_FromImportSecure.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "osType": "Windows", + "securityProfile": { + "securityType": "ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey" + }, + "creationData": { + "createOption": "ImportSecure", + "storageAccountId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "securityDataUri": "https://mystorageaccount.blob.core.windows.net/osimages/vmgs.vhd" + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "osType": "Windows", + "securityProfile": { + "securityType": "ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey" + }, + "creationData": { + "createOption": "ImportSecure", + "storageAccountId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "securityDataUri": "https://mystorageaccount.blob.core.windows.net/osimages/vmgs.vhd" + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Succeeded", + "osType": "Windows", + "securityProfile": { + "securityType": "ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey" + }, + "creationData": { + "createOption": "ImportSecure", + "storageAccountId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "securityDataUri": "https://mystorageaccount.blob.core.windows.net/osimages/vmgs.vhd" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_FromUploadPreparedSecure.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_FromUploadPreparedSecure.json new file mode 100644 index 000000000000..1c15a8bb18ea --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_FromUploadPreparedSecure.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "osType": "Windows", + "securityProfile": { + "securityType": "TrustedLaunch" + }, + "creationData": { + "createOption": "UploadPreparedSecure", + "uploadSizeBytes": 10737418752 + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "osType": "Windows", + "securityProfile": { + "securityType": "TrustedLaunch" + }, + "creationData": { + "createOption": "UploadPreparedSecure", + "uploadSizeBytes": 10737418752 + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "osType": "Windows", + "securityProfile": { + "securityType": "TrustedLaunch" + }, + "creationData": { + "createOption": "UploadPreparedSecure", + "uploadSizeBytes": 10737418752 + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_InExtendedLocation.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_InExtendedLocation.json new file mode 100644 index 000000000000..adcbea6118cf --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_InExtendedLocation.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "extendedLocation": { + "type": "EdgeZone", + "name": "{edge-zone-id}" + }, + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200 + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk", + "extendedLocation": { + "type": "EdgeZone", + "name": "{edge-zone-id}" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk", + "extendedLocation": { + "type": "EdgeZone", + "name": "{edge-zone-id}" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_PerformancePlus.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_PerformancePlus.json new file mode 100644 index 000000000000..ca8c09d59c2e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_PerformancePlus.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Upload", + "performancePlus": true + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Upload", + "performancePlus": true + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Upload", + "performancePlus": true + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_UploadDisk.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_UploadDisk.json new file mode 100644 index 000000000000..04d8463fc1ee --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_UploadDisk.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Upload", + "uploadSizeBytes": 10737418752 + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Upload", + "uploadSizeBytes": 10737418752 + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Upload", + "uploadSizeBytes": 10737418752 + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_WithDataAccessAuthMode.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_WithDataAccessAuthMode.json new file mode 100644 index 000000000000..bfc046b5f4cb --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_WithDataAccessAuthMode.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "dataAccessAuthMode": "AzureActiveDirectory" + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Succeeded", + "dataAccessAuthMode": "AzureActiveDirectory" + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_WithDiskAccess.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_WithDiskAccess.json new file mode 100644 index 000000000000..a92786884172 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_WithDiskAccess.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "networkAccessPolicy": "AllowPrivate", + "diskAccessId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/{existing-diskAccess-name}" + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Succeeded", + "networkAccessPolicy": "AllowPrivate", + "diskAccessId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/{existing-diskAccess-name}", + "publicNetworkAccess": "Enabled" + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_WithDiskEncryptionSet.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_WithDiskEncryptionSet.json new file mode 100644 index 000000000000..9f29ac69512b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_WithDiskEncryptionSet.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "encryption": { + "diskEncryptionSetId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Succeeded", + "encryption": { + "diskEncryptionSetId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_WithLogicalSectorSize.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_WithLogicalSectorSize.json new file mode 100644 index 000000000000..a053c358effa --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_WithLogicalSectorSize.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "sku": { + "name": "UltraSSD_LRS" + }, + "properties": { + "creationData": { + "createOption": "Empty", + "logicalSectorSize": 512 + }, + "diskSizeGB": 200 + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty", + "logicalSectorSize": 512 + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk", + "sku": { + "name": "UltraSSD_LRS", + "tier": "Ultra" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty", + "logicalSectorSize": 512 + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk", + "sku": { + "name": "UltraSSD_LRS", + "tier": "Ultra" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_WithOptimizedForFrequentAttach.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_WithOptimizedForFrequentAttach.json new file mode 100644 index 000000000000..64ba2043df5c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_WithOptimizedForFrequentAttach.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "optimizedForFrequentAttach": true + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating", + "optimizedForFrequentAttach": true + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Succeeded", + "optimizedForFrequentAttach": true + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_WithPremiumV2_LRSAccountType.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_WithPremiumV2_LRSAccountType.json new file mode 100644 index 000000000000..704330b55931 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_WithPremiumV2_LRSAccountType.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myPremiumV2Disk", + "disk": { + "location": "West US", + "sku": { + "name": "PremiumV2_LRS" + }, + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "diskIOPSReadWrite": 125, + "diskMBpsReadWrite": 3000 + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myPremiumV2Disk", + "sku": { + "name": "PremiumV2_LRS", + "tier": "Premium" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myPremiumV2Disk", + "sku": { + "name": "PremiumV2_LRS", + "tier": "Premium" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_WithSSDZRSAccountType.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_WithSSDZRSAccountType.json new file mode 100644 index 000000000000..9f621a5223e7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_WithSSDZRSAccountType.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "sku": { + "name": "Premium_ZRS" + }, + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200 + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk", + "sku": { + "name": "Premium_ZRS", + "tier": "Premium" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk", + "sku": { + "name": "Premium_ZRS", + "tier": "Premium" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_WithSecurityProfile.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_WithSecurityProfile.json new file mode 100644 index 000000000000..00701b35e583 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_WithSecurityProfile.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "location": "North Central US", + "properties": { + "osType": "Windows", + "securityProfile": { + "securityType": "TrustedLaunch" + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/uswest/Publishers/Microsoft/ArtifactTypes/VMImage/Offers/{offer}" + } + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "North Central US", + "properties": { + "provisioningState": "Updating", + "osType": "Windows", + "securityProfile": { + "securityType": "TrustedLaunch" + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/uswest/Publishers/Microsoft/ArtifactTypes/VMImage/Offers/{offer}" + } + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "North Central US", + "properties": { + "provisioningState": "Succeeded", + "osType": "Windows", + "securityProfile": { + "securityType": "TrustedLaunch" + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/uswest/Publishers/Microsoft/ArtifactTypes/VMImage/Offers/{offer}" + } + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_WithUltraSSD_ReadOnly.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_WithUltraSSD_ReadOnly.json new file mode 100644 index 000000000000..ca5b5d967fa3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Create_WithUltraSSD_ReadOnly.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myUltraReadOnlyDisk", + "disk": { + "location": "West US", + "sku": { + "name": "UltraSSD_LRS" + }, + "properties": { + "creationData": { + "createOption": "Empty", + "logicalSectorSize": 4096 + }, + "diskSizeGB": 200, + "diskIOPSReadWrite": 125, + "diskMBpsReadWrite": 3000, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myUltraReadOnlyDisk", + "sku": { + "name": "UltraSSD_LRS", + "tier": "Ultra" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating", + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + } + }, + "location": "West US", + "name": "myUltraReadOnlyDisk", + "sku": { + "name": "UltraSSD_LRS", + "tier": "Ultra" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Delete.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Delete.json new file mode 100644 index 000000000000..8fe35d2d1368 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "diskName": "myDisk", + "api-version": "2024-03-02" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/operations/{operationId}&monitor=true&api-version=2024-03-02" + } + }, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_EndGetAccess.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_EndGetAccess.json new file mode 100644 index 000000000000..d70e05baf123 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_EndGetAccess.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "diskName": "myDisk", + "api-version": "2024-03-02" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/operations/{operationId}&monitor=true&api-version=2024-03-02" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Get.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Get.json new file mode 100644 index 000000000000..db2fdb75b338 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Get.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myManagedDisk" + }, + "responses": { + "200": { + "body": { + "managedBy": "/subscriptions/123caaa-123v-v211-a49f-f88ccac5bf88/resourceGroups/ResourceGroupName/providers/Microsoft.Compute/virtualMachines/TestVM414689371c88843d65ec", + "sku": { + "name": "Standard_LRS" + }, + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "purchasePlan": { + "name": "test_sku", + "publisher": "test_test_pmc2pc1", + "product": "marketplace_vm_test" + }, + "supportedCapabilities": { + "acceleratedNetwork": true + }, + "supportsHibernation": true, + "securityProfile": { + "securityType": "TrustedLaunch" + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscription-id}/Providers/Microsoft.Compute/Locations/westus/Publishers/test_test_pmc2pc1/ArtifactTypes/VMImage/Offers/marketplace_vm_test/Skus/test_sku/Versions/1.0.0" + } + }, + "diskSizeGB": 10, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "LastOwnershipUpdateTime": "2016-12-28T04:41:35.079872+00:00", + "timeCreated": "2016-12-28T04:41:35.079872+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "tags": { + "department": "Development", + "project": "ManagedDisks" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk", + "name": "myManagedDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_ListByResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_ListByResourceGroup.json new file mode 100644 index 000000000000..3d636104b9b1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_ListByResourceGroup.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "diskSizeGB": 200, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:35.9278721+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "tags": { + "department": "Development", + "project": "ManagedDisks" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk", + "name": "myManagedDisk1" + }, + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 10, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:36.872242+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk", + "name": "myManagedDisk2" + }, + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/uswest/Publishers/Microsoft/ArtifactTypes/VMImage/Offers/{offer}" + } + }, + "diskSizeGB": 200, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:36.3973934+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "tags": { + "department": "Development", + "project": "ManagedDisks" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk", + "name": "myManagedDisk3" + } + ], + "nextLink": "http://disksvchost:99/subscriptions/{subscriptionId}/providers/Microsoft.Compute/disks?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/Disks/myManagedDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_ListBySubscription.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_ListBySubscription.json new file mode 100644 index 000000000000..15d47758c870 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_ListBySubscription.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2024-03-02" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "diskSizeGB": 200, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:35.9278721+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "tags": { + "department": "Development", + "project": "ManagedDisks" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1", + "name": "myManagedDisk1" + }, + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 10, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:36.872242+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2", + "name": "myManagedDisk2" + }, + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/uswest/Publishers/Microsoft/ArtifactTypes/VMImage/Offers/{offer}" + } + }, + "diskSizeGB": 200, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:36.3973934+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "tags": { + "department": "Development", + "project": "ManagedDisks" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk3", + "name": "myManagedDisk3" + } + ], + "nextLink": "http://disksvchost:99/subscriptions/{subscriptionId}/providers/Microsoft.Compute/disks?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/Disks/myManagedDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Update_AddAcceleratedNetworking.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Update_AddAcceleratedNetworking.json new file mode 100644 index 000000000000..b25cadce8162 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Update_AddAcceleratedNetworking.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "properties": { + "supportedCapabilities": { + "acceleratedNetwork": false + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk?api-version=2024-03-02" + }, + "body": { + "name": "myDisk", + "location": "westus", + "sku": { + "name": "Standard_LRS", + "tier": "Standard" + }, + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "supportedCapabilities": { + "acceleratedNetwork": false + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscription-id}/Providers/Microsoft.Compute/Locations/westus/Publishers/test_test_pmc2pc1/ArtifactTypes/VMImage/Offers/marketplace_vm_test/Skus/test_sku/Versions/1.0.0" + } + }, + "diskSizeGB": 127, + "provisioningState": "Updating" + } + } + }, + "200": { + "body": { + "name": "myDisk", + "location": "westus", + "sku": { + "name": "Standard_LRS", + "tier": "Standard" + }, + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "supportedCapabilities": { + "acceleratedNetwork": false + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscription-id}/Providers/Microsoft.Compute/Locations/westus/Publishers/test_test_pmc2pc1/ArtifactTypes/VMImage/Offers/marketplace_vm_test/Skus/test_sku/Versions/1.0.0" + } + }, + "diskSizeGB": 127, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Update_AddDiskControllerTypes.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Update_AddDiskControllerTypes.json new file mode 100644 index 000000000000..3901c926ffa0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Update_AddDiskControllerTypes.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "properties": { + "supportedCapabilities": { + "diskControllerTypes": "SCSI" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk?api-version=2024-03-02" + }, + "body": { + "name": "myDisk", + "location": "westus", + "sku": { + "name": "Standard_LRS", + "tier": "Standard" + }, + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "supportedCapabilities": { + "diskControllerTypes": "SCSI" + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscription-id}/Providers/Microsoft.Compute/Locations/westus/Publishers/marketplacetestfirstparty/ArtifactTypes/VMImage/Offers/nvme_test_062/Skus/test_sku/Versions/1.0.0" + } + }, + "diskSizeGB": 127, + "provisioningState": "Updating" + } + } + }, + "200": { + "body": { + "name": "myDisk", + "location": "westus", + "sku": { + "name": "Standard_LRS", + "tier": "Standard" + }, + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "supportedCapabilities": { + "diskControllerTypes": "SCSI" + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscription-id}/Providers/Microsoft.Compute/Locations/westus/Publishers/marketplacetestfirstparty/ArtifactTypes/VMImage/Offers/nvme_test_062/Skus/test_sku/Versions/1.0.0" + } + }, + "diskSizeGB": 127, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Update_AddPurchasePlan.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Update_AddPurchasePlan.json new file mode 100644 index 000000000000..8d6d0b8ce5a3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Update_AddPurchasePlan.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "properties": { + "purchasePlan": { + "name": "myPurchasePlanName", + "publisher": "myPurchasePlanPublisher", + "product": "myPurchasePlanProduct", + "promotionCode": "myPurchasePlanPromotionCode" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk?api-version=2024-03-02" + }, + "body": { + "name": "myDisk", + "location": "westus", + "sku": { + "name": "Standard_LRS", + "tier": "Standard" + }, + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "purchasePlan": { + "name": "myPurchasePlanName", + "publisher": "myPurchasePlanPublisher", + "product": "myPurchasePlanProduct", + "promotionCode": "myPurchasePlanPromotionCode" + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscription-id}/Providers/Microsoft.Compute/Locations/westus/Publishers/test_test_pmc2pc1/ArtifactTypes/VMImage/Offers/marketplace_vm_test/Skus/test_sku/Versions/1.0.0" + } + }, + "diskSizeGB": 127, + "provisioningState": "Updating" + } + } + }, + "200": { + "body": { + "name": "myDisk", + "location": "westus", + "sku": { + "name": "Standard_LRS", + "tier": "Standard" + }, + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "purchasePlan": { + "name": "myPurchasePlanName", + "publisher": "myPurchasePlanPublisher", + "product": "myPurchasePlanProduct", + "promotionCode": "myPurchasePlanPromotionCode" + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscription-id}/Providers/Microsoft.Compute/Locations/westus/Publishers/test_test_pmc2pc1/ArtifactTypes/VMImage/Offers/marketplace_vm_test/Skus/test_sku/Versions/1.0.0" + } + }, + "diskSizeGB": 127, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Update_AddSupportsHibernation.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Update_AddSupportsHibernation.json new file mode 100644 index 000000000000..365d5e1024a4 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Update_AddSupportsHibernation.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "properties": { + "supportsHibernation": true + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk?api-version=2024-03-02" + }, + "body": { + "name": "myDisk", + "location": "westus", + "sku": { + "name": "Standard_LRS", + "tier": "Standard" + }, + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "supportsHibernation": true, + "creationData": { + "createOption": "Import", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + }, + "diskSizeGB": 127, + "provisioningState": "Updating" + } + } + }, + "200": { + "body": { + "name": "myDisk", + "location": "westus", + "sku": { + "name": "Standard_LRS", + "tier": "Standard" + }, + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "supportsHibernation": true, + "creationData": { + "createOption": "Import", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + }, + "diskSizeGB": 127, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Update_ChangeTier.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Update_ChangeTier.json new file mode 100644 index 000000000000..73e18a50790d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Update_ChangeTier.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "properties": { + "tier": "P30" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk?api-version=2024-03-02" + }, + "body": { + "properties": { + "creationData": { + "createOption": "Empty" + }, + "provisioningState": "Updating", + "tier": "P10", + "propertyUpdatesInProgress": { + "targetTier": "P30" + } + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "properties": { + "creationData": { + "createOption": "Empty" + }, + "provisioningState": "Succeeded", + "tier": "P30" + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Update_DisableBursting.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Update_DisableBursting.json new file mode 100644 index 000000000000..7e238ab61802 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Update_DisableBursting.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "properties": { + "burstingEnabled": false + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk?api-version=2024-03-02" + }, + "body": { + "properties": { + "creationData": { + "createOption": "Empty" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "properties": { + "creationData": { + "createOption": "Empty" + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Update_DisableOptimizedForFrequentAttach.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Update_DisableOptimizedForFrequentAttach.json new file mode 100644 index 000000000000..d6197a7e7cef --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Update_DisableOptimizedForFrequentAttach.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "properties": { + "optimizedForFrequentAttach": false + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk?api-version=2024-03-02" + }, + "body": { + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating", + "optimizedForFrequentAttach": false + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Succeeded", + "optimizedForFrequentAttach": false + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Update_RemoveDiskAccess.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Update_RemoveDiskAccess.json new file mode 100644 index 000000000000..91fa2c900d36 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Update_RemoveDiskAccess.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "properties": { + "networkAccessPolicy": "AllowAll" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk?api-version=2024-03-02" + }, + "body": { + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating", + "networkAccessPolicy": "AllowAll" + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Succeeded", + "networkAccessPolicy": "AllowAll" + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Update_ToAddArchitecture.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Update_ToAddArchitecture.json new file mode 100644 index 000000000000..d3dbc1a5019c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskExamples/Disk_Update_ToAddArchitecture.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "diskName": "myDisk", + "disk": { + "properties": { + "supportedCapabilities": { + "architecture": "Arm64" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk?api-version=2024-03-02" + }, + "body": { + "name": "myDisk", + "location": "westus", + "sku": { + "name": "Standard_LRS", + "tier": "Standard" + }, + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "supportedCapabilities": { + "architecture": "Arm64" + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscription-id}/Providers/Microsoft.Compute/Locations/westus/Publishers/test_test_pmc2pc1/ArtifactTypes/VMImage/Offers/marketplace_vm_test/Skus/test_sku/Versions/1.0.0" + } + }, + "diskSizeGB": 127, + "provisioningState": "Updating" + } + } + }, + "200": { + "body": { + "name": "myDisk", + "location": "westus", + "sku": { + "name": "Standard_LRS", + "tier": "Standard" + }, + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "supportedCapabilities": { + "architecture": "Arm64" + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscription-id}/Providers/Microsoft.Compute/Locations/westus/Publishers/test_test_pmc2pc1/ArtifactTypes/VMImage/Offers/marketplace_vm_test/Skus/test_sku/Versions/1.0.0" + } + }, + "diskSizeGB": 127, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskRestorePointExamples/DiskRestorePoint_BeginGetAccess.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskRestorePointExamples/DiskRestorePoint_BeginGetAccess.json new file mode 100644 index 000000000000..cf429d1c90a4 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskRestorePointExamples/DiskRestorePoint_BeginGetAccess.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "restorePointCollectionName": "rpc", + "vmRestorePointName": "vmrp", + "diskRestorePointName": "TestDisk45ceb03433006d1baee0_b70cd924-3362-4a80-93c2-9415eaa12745", + "api-version": "2024-03-02", + "grantAccessData": { + "access": "Read", + "durationInSeconds": 300, + "fileFormat": "VHDX" + } + }, + "responses": { + "200": { + "body": { + "accessSAS": "https://md-gpvmcxzlzxgd.partition.blob.storage.azure.net/xx3cqcx53f0v/abcd?sv=2014-02-14&sr=b&sk=key1&sig=XXX&st=2021-05-24T18:02:34Z&se=2021-05-24T18:19:14Z&sp=r" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/operations/{operationId}&monitor=true&api-version=2024-03-02" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskRestorePointExamples/DiskRestorePoint_EndGetAccess.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskRestorePointExamples/DiskRestorePoint_EndGetAccess.json new file mode 100644 index 000000000000..8aeded869324 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskRestorePointExamples/DiskRestorePoint_EndGetAccess.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "restorePointCollectionName": "rpc", + "vmRestorePointName": "vmrp", + "diskRestorePointName": "TestDisk45ceb03433006d1baee0_b70cd924-3362-4a80-93c2-9415eaa12745", + "api-version": "2024-03-02" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/operations/{operationId}&monitor=true&api-version=2024-03-02" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskRestorePointExamples/DiskRestorePoint_Get.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskRestorePointExamples/DiskRestorePoint_Get.json new file mode 100644 index 000000000000..9f0527cf3638 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskRestorePointExamples/DiskRestorePoint_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "restorePointCollectionName": "rpc", + "vmRestorePointName": "vmrp", + "diskRestorePointName": "TestDisk45ceb03433006d1baee0_b70cd924-3362-4a80-93c2-9415eaa12745", + "api-version": "2024-03-02" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpc/restorePoints/vmrp/diskRestorePoints/TestDisk45ceb03433006d1baee0_b70cd924-3362-4a80-93c2-9415eaa12745", + "name": "TestDisk45ceb03433006d1baee0_b70cd924-3362-4a80-93c2-9415eaa12745", + "properties": { + "timeCreated": "2020-09-16T04:41:35.079872+00:00", + "sourceResourceId": "/subscriptions/d2260d06-e00d-422f-8b63-93df551a59ae/resourceGroups/rg0680fb0c-89f1-41b4-96c0-35733a181558/providers/Microsoft.Compute/disks/TestDisk45ceb03433006d1baee0", + "osType": "Windows", + "hyperVGeneration": "V1", + "familyId": "996bf3ce-b6ff-4e86-9db6-dc27ea06cea5", + "sourceUniqueId": "48e058b1-7eea-4968-b532-10a8a1130c13", + "networkAccessPolicy": "AllowAll", + "publicNetworkAccess": "Disabled", + "logicalSectorSize": 4096 + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskRestorePointExamples/DiskRestorePoint_Get_WhenSourceResourceIsFromDifferentRegion.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskRestorePointExamples/DiskRestorePoint_Get_WhenSourceResourceIsFromDifferentRegion.json new file mode 100644 index 000000000000..6317923753bd --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskRestorePointExamples/DiskRestorePoint_Get_WhenSourceResourceIsFromDifferentRegion.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "restorePointCollectionName": "rpc", + "vmRestorePointName": "vmrp", + "diskRestorePointName": "TestDisk45ceb03433006d1baee0_b70cd924-3362-4a80-93c2-9415eaa12745", + "api-version": "2024-03-02" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpc/restorePoints/vmrp/diskRestorePoints/TestDisk45ceb03433006d1baee0_b70cd924-3362-4a80-93c2-9415eaa12745", + "name": "TestDisk45ceb03433006d1baee0_b70cd924-3362-4a80-93c2-9415eaa12745", + "properties": { + "timeCreated": "2020-09-16T04:41:35.079872+00:00", + "sourceResourceId": "/subscriptions/d2260d06-e00d-422f-8b63-93df551a59ae/resourceGroups/rg0680fb0c-89f1-41b4-96c0-35733a181558/providers/Microsoft.Compute/disks/TestDisk45ceb03433006d1baee0", + "osType": "Windows", + "hyperVGeneration": "V1", + "familyId": "996bf3ce-b6ff-4e86-9db6-dc27ea06cea5", + "sourceUniqueId": "48e058b1-7eea-4968-b532-10a8a1130c13", + "networkAccessPolicy": "AllowAll", + "publicNetworkAccess": "Disabled", + "replicationState": "Succeeded", + "completionPercent": 100, + "sourceResourceLocation": "eastus2", + "logicalSectorSize": 4096 + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskRestorePointExamples/DiskRestorePoint_ListByVmRestorePoint.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskRestorePointExamples/DiskRestorePoint_ListByVmRestorePoint.json new file mode 100644 index 000000000000..047410076360 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskRestorePointExamples/DiskRestorePoint_ListByVmRestorePoint.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "restorePointCollectionName": "rpc", + "vmRestorePointName": "vmrp", + "api-version": "2024-03-02" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpc/restorePoints/vmrp/diskRestorePoints/TestDisk45ceb03433006d1baee0_b70cd924-3362-4a80-93c2-9415eaa12745", + "name": "TestDisk45ceb03433006d1baee0_b70cd924-3362-4a80-93c2-9415eaa12745", + "properties": { + "timeCreated": "2020-09-16T04:41:35.079872+00:00", + "sourceResourceId": "/subscriptions/d2260d06-e00d-422f-8b63-93df551a59ae/resourceGroups/rg0680fb0c-89f1-41b4-96c0-35733a181558/providers/Microsoft.Compute/disks/TestDisk45ceb03433006d1baee0", + "osType": "Windows", + "hyperVGeneration": "V1", + "familyId": "996bf3ce-b6ff-4e86-9db6-dc27ea06cea5", + "sourceUniqueId": "48e058b1-7eea-4968-b532-10a8a1130c13", + "networkAccessPolicy": "AllowAll", + "publicNetworkAccess": "Disabled", + "logicalSectorSize": 4096 + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_BeginGetAccess.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_BeginGetAccess.json new file mode 100644 index 000000000000..2427b503a750 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_BeginGetAccess.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "snapshotName": "mySnapshot", + "api-version": "2024-03-02", + "grantAccessData": { + "access": "Read", + "durationInSeconds": 300, + "fileFormat": "VHDX" + } + }, + "responses": { + "200": { + "body": { + "accessSAS": "https://md-gpvmcxzlzxgd.partition.blob.storage.azure.net/xx3cqcx53f0v/abcd?sv=2014-02-14&sr=b&sk=key1&sig=XXX&st=2021-05-24T18:02:34Z&se=2021-05-24T18:19:14Z&sp=r" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/operations/{operationId}&monitor=true&api-version=2024-03-02" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_Create_ByImportingAnUnmanagedBlobFromADifferentSubscription.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_Create_ByImportingAnUnmanagedBlobFromADifferentSubscription.json new file mode 100644 index 000000000000..edacffdb0795 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_Create_ByImportingAnUnmanagedBlobFromADifferentSubscription.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "snapshotName": "mySnapshot1", + "snapshot": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Import", + "storageAccountId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot", + "properties": { + "creationData": { + "createOption": "Import", + "storageAccountId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "mySnapshot1" + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot", + "properties": { + "creationData": { + "createOption": "Import", + "storageAccountId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "mySnapshot1" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_Create_ByImportingAnUnmanagedBlobFromTheSameSubscription.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_Create_ByImportingAnUnmanagedBlobFromTheSameSubscription.json new file mode 100644 index 000000000000..69183dcffd79 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_Create_ByImportingAnUnmanagedBlobFromTheSameSubscription.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "snapshotName": "mySnapshot1", + "snapshot": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Import", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot", + "properties": { + "creationData": { + "createOption": "Import", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "mySnapshot1" + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot", + "properties": { + "creationData": { + "createOption": "Import", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "mySnapshot1" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_Create_EnhancedProvisionedBandwidthCopySpeed.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_Create_EnhancedProvisionedBandwidthCopySpeed.json new file mode 100644 index 000000000000..238410244ab8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_Create_EnhancedProvisionedBandwidthCopySpeed.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "snapshotName": "mySnapshot2", + "snapshot": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "CopyStart", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1", + "provisionedBandwidthCopySpeed": "Enhanced" + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2", + "name": "mySnapshot2", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "CopyStart", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1", + "provisionedBandwidthCopySpeed": "Enhanced" + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2", + "name": "mySnapshot2", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "CopyStart", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1", + "provisionedBandwidthCopySpeed": "Enhanced" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_Create_FromAnElasticSanVolumeSnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_Create_FromAnElasticSanVolumeSnapshot.json new file mode 100644 index 000000000000..f2eaa2e8089e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_Create_FromAnElasticSanVolumeSnapshot.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "snapshotName": "mySnapshot", + "snapshot": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "CopyFromSanSnapshot", + "elasticSanResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ElasticSan/elasticSans/myElasticSan/volumegroups/myElasticSanVolumeGroup/snapshots/myElasticSanVolumeSnapshot" + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot", + "name": "mySnapshot", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "CopyFromSanSnapshot", + "elasticSanResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ElasticSan/elasticSans/myElasticSan/volumegroups/myElasticSanVolumeGroup/snapshots/myElasticSanVolumeSnapshot" + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot", + "name": "mySnapshot", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "CopyFromSanSnapshot", + "elasticSanResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ElasticSan/elasticSans/myElasticSan/volumegroups/myElasticSanVolumeGroup/snapshots/myElasticSanVolumeSnapshot" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_Create_FromAnExistingSnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_Create_FromAnExistingSnapshot.json new file mode 100644 index 000000000000..8b6f71eae379 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_Create_FromAnExistingSnapshot.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "snapshotName": "mySnapshot2", + "snapshot": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2", + "name": "mySnapshot2", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2", + "name": "mySnapshot2", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_Create_FromAnExistingSnapshotInDifferentRegion.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_Create_FromAnExistingSnapshotInDifferentRegion.json new file mode 100644 index 000000000000..a4f49f7087ce --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_Create_FromAnExistingSnapshotInDifferentRegion.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "snapshotName": "mySnapshot2", + "snapshot": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "CopyStart", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2", + "name": "mySnapshot2", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "CopyStart", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2", + "name": "mySnapshot2", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "CopyStart", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_Delete.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_Delete.json new file mode 100644 index 000000000000..39bb9c7f6220 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "snapshotName": "mySnapshot", + "api-version": "2024-03-02" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/operations/{operationId}&monitor=true&api-version=2024-03-02" + } + }, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_EndGetAccess.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_EndGetAccess.json new file mode 100644 index 000000000000..58e743fc1e37 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_EndGetAccess.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "snapshotName": "mySnapshot", + "api-version": "2024-03-02" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/operations/{operationId}&monitor=true&api-version=2024-03-02" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_Get.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_Get.json new file mode 100644 index 000000000000..5a79ed6e5362 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_Get.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "snapshotName": "mySnapshot" + }, + "responses": { + "200": { + "body": { + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "purchasePlan": { + "name": "test_sku", + "publisher": "test_test_pmc2pc1", + "product": "marketplace_vm_test" + }, + "supportedCapabilities": { + "acceleratedNetwork": true + }, + "supportsHibernation": true, + "creationData": { + "createOption": "Copy", + "sourceResourceId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "sourceUniqueId": "d633885d-d102-4481-901e-5b2413d1a7be" + }, + "diskSizeGB": 100, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:35.079872+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/snapshots", + "location": "westus", + "tags": { + "department": "Development", + "project": "Snapshots" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot", + "name": "mySnapshot" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_GetIncrementalSnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_GetIncrementalSnapshot.json new file mode 100644 index 000000000000..b7f1d9d81b11 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_GetIncrementalSnapshot.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02", + "snapshotName": "myIncrementalSnapshot" + }, + "responses": { + "200": { + "body": { + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "purchasePlan": { + "name": "test_sku", + "publisher": "test_test_pmc2pc1", + "product": "marketplace_vm_test" + }, + "supportedCapabilities": { + "acceleratedNetwork": true + }, + "supportsHibernation": true, + "creationData": { + "createOption": "Copy", + "sourceResourceId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "sourceUniqueId": "d633885d-d102-4481-901e-5b2413d1a7be" + }, + "diskSizeGB": 100, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "incremental": true, + "networkAccessPolicy": "0", + "diskState": "0", + "diskSizeBytes": 10737418240, + "uniqueId": "a395e9c1-fb9e-446e-a9ba-7b2fa0bcd305", + "incrementalSnapshotFamilyId": "d1a341d5-1ea7-4a85-b304-944ad8021639", + "timeCreated": "2016-12-28T04:41:35.079872+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/snapshots", + "location": "westus", + "tags": { + "department": "Development", + "project": "Snapshots" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/myIncrementalSnapshot", + "name": "myIncrementalSnapshot" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_ListByResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_ListByResourceGroup.json new file mode 100644 index 000000000000..76d30d5c7599 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_ListByResourceGroup.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-03-02" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "diskSizeGB": 200, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:35.9278721+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/snapshots", + "location": "westus", + "tags": { + "department": "Development", + "project": "Snapshots" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot", + "name": "mySnapshot" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_ListBySubscription.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_ListBySubscription.json new file mode 100644 index 000000000000..43bd2c74bccd --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_ListBySubscription.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2024-03-02" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "diskSizeGB": 200, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:47:30.6630569+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/snapshots", + "location": "westus", + "tags": { + "department": "Development", + "project": "Snapshots" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1", + "name": "mySnapshot1" + }, + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Import", + "storageAccountId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + }, + "diskSizeGB": 200, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:47:30.3247198+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/snapshots", + "location": "westus", + "tags": { + "department": "Development", + "project": "Snapshots" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2", + "name": "mySnapshot2" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_Update.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_Update.json new file mode 100644 index 000000000000..a69e03bb94e5 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_Update.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "snapshotName": "mySnapshot", + "api-version": "2024-03-02", + "snapshot": { + "properties": { + "diskSizeGB": 20 + }, + "tags": { + "department": "Development", + "project": "UpdateSnapshots" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot?api-version=2024-03-02" + }, + "body": { + "properties": { + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "diskSizeGB": 20, + "provisioningState": "Updating" + }, + "tags": { + "department": "Development", + "project": "UpdateSnapshots" + }, + "location": "West US", + "name": "mySnapshot" + } + }, + "200": { + "body": { + "properties": { + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "diskSizeGB": 20, + "provisioningState": "Succeeded" + }, + "tags": { + "department": "Development", + "project": "UpdateSnapshots" + }, + "location": "West US", + "name": "mySnapshot" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_Update_WithAcceleratedNetwork.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_Update_WithAcceleratedNetwork.json new file mode 100644 index 000000000000..74920e2d9d42 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_Update_WithAcceleratedNetwork.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "snapshotName": "mySnapshot", + "api-version": "2024-03-02", + "snapshot": { + "properties": { + "diskSizeGB": 20, + "supportedCapabilities": { + "acceleratedNetwork": false + } + }, + "tags": { + "department": "Development", + "project": "UpdateSnapshots" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot?api-version=2024-03-02" + }, + "body": { + "properties": { + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "supportedCapabilities": { + "acceleratedNetwork": false + }, + "diskSizeGB": 20, + "provisioningState": "Updating" + }, + "tags": { + "department": "Development", + "project": "UpdateSnapshots" + }, + "location": "West US", + "name": "mySnapshot" + } + }, + "200": { + "body": { + "properties": { + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "supportedCapabilities": { + "acceleratedNetwork": false + }, + "diskSizeGB": 20, + "provisioningState": "Succeeded" + }, + "tags": { + "department": "Development", + "project": "UpdateSnapshots" + }, + "location": "West US", + "name": "mySnapshot" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/snapshot.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/snapshot.json new file mode 100644 index 000000000000..f9b1f49b1bd6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/snapshot.json @@ -0,0 +1,679 @@ +{ + "swagger": "2.0", + "info": { + "title": "DiskResourceProviderClient", + "description": "The Disk Resource Provider Client.", + "version": "2024-03-02" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}": { + "put": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_CreateOrUpdate", + "description": "Creates or updates a snapshot.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SnapshotNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "snapshot", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Snapshot" + }, + "description": "Snapshot object supplied in the body of the Put disk operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/Snapshot" + } + } + }, + "x-ms-examples": { + "Create a snapshot from an existing snapshot in the same or a different subscription.": { + "$ref": "./examples/snapshotExamples/Snapshot_Create_FromAnExistingSnapshot.json" + }, + "Create a snapshot by importing an unmanaged blob from the same subscription.": { + "$ref": "./examples/snapshotExamples/Snapshot_Create_ByImportingAnUnmanagedBlobFromTheSameSubscription.json" + }, + "Create a snapshot by importing an unmanaged blob from a different subscription.": { + "$ref": "./examples/snapshotExamples/Snapshot_Create_ByImportingAnUnmanagedBlobFromADifferentSubscription.json" + }, + "Create a snapshot from an existing snapshot in the same or a different subscription in a different region.": { + "$ref": "./examples/snapshotExamples/Snapshot_Create_FromAnExistingSnapshotInDifferentRegion.json" + }, + "Create a snapshot from an elastic san volume snapshot.": { + "$ref": "./examples/snapshotExamples/Snapshot_Create_FromAnElasticSanVolumeSnapshot.json" + }, + "Create a snapshot from an existing snapshot in the same or a different subscription in a different region with quicker copy speed.": { + "$ref": "./examples/snapshotExamples/Snapshot_Create_EnhancedProvisionedBandwidthCopySpeed.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Update", + "description": "Updates (patches) a snapshot.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SnapshotNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "snapshot", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SnapshotUpdate" + }, + "description": "Snapshot object supplied in the body of the Patch snapshot operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/Snapshot" + } + } + }, + "x-ms-examples": { + "Update a snapshot.": { + "$ref": "./examples/snapshotExamples/Snapshot_Update.json" + }, + "Update a snapshot with accelerated networking.": { + "$ref": "./examples/snapshotExamples/Snapshot_Update_WithAcceleratedNetwork.json" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Get", + "description": "Gets information about a snapshot.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SnapshotNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + } + }, + "x-ms-examples": { + "Get information about a snapshot.": { + "$ref": "./examples/snapshotExamples/Snapshot_Get.json" + }, + "Get information about an incremental snapshot.": { + "$ref": "./examples/snapshotExamples/Snapshot_GetIncrementalSnapshot.json" + } + } + }, + "delete": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Delete", + "description": "Deletes a snapshot.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SnapshotNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "If the snapshot is deleted, this is an expected error code." + } + }, + "x-ms-examples": { + "Delete a snapshot.": { + "$ref": "./examples/snapshotExamples/Snapshot_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_ListByResourceGroup", + "description": "Lists snapshots under a resource group.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotList" + } + } + }, + "x-ms-examples": { + "List all snapshots in a resource group.": { + "$ref": "./examples/snapshotExamples/Snapshot_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_List", + "description": "Lists snapshots under a subscription.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotList" + } + } + }, + "x-ms-examples": { + "List all snapshots in a subscription.": { + "$ref": "./examples/snapshotExamples/Snapshot_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}/beginGetAccess": { + "post": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_GrantAccess", + "description": "Grants access to a snapshot.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SnapshotNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "grantAccessData", + "in": "body", + "required": true, + "schema": { + "$ref": "./diskRPCommon.json#/definitions/GrantAccessData" + }, + "description": "Access data object supplied in the body of the get snapshot access operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./diskRPCommon.json#/definitions/AccessUri" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-examples": { + "Get a sas on a snapshot.": { + "$ref": "./examples/snapshotExamples/Snapshot_BeginGetAccess.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}/endGetAccess": { + "post": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_RevokeAccess", + "description": "Revokes access to a snapshot.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SnapshotNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-examples": { + "Revoke access to a snapshot.": { + "$ref": "./examples/snapshotExamples/Snapshot_EndGetAccess.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "Snapshot": { + "properties": { + "managedBy": { + "readOnly": true, + "type": "string", + "description": "Unused. Always Null." + }, + "sku": { + "$ref": "#/definitions/SnapshotSku" + }, + "extendedLocation": { + "$ref": "../../../common-types/v1/common.json#/definitions/ExtendedLocation", + "description": "The extended location where the snapshot will be created. Extended location cannot be changed." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SnapshotProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Snapshot resource." + }, + "SnapshotUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SnapshotUpdateProperties" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "sku": { + "$ref": "#/definitions/SnapshotSku" + } + }, + "description": "Snapshot update resource." + }, + "SnapshotList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Snapshot" + }, + "description": "A list of snapshots." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of snapshots. Call ListNext() with this to fetch the next page of snapshots." + } + }, + "required": [ + "value" + ], + "description": "The List Snapshots operation response." + }, + "SnapshotSku": { + "properties": { + "name": { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "Standard_ZRS" + ], + "x-ms-enum": { + "name": "SnapshotStorageAccountTypes", + "modelAsString": true, + "values": [ + { + "value": "Standard_LRS", + "description": "Standard HDD locally redundant storage" + }, + { + "value": "Premium_LRS", + "description": "Premium SSD locally redundant storage" + }, + { + "value": "Standard_ZRS", + "description": "Standard zone redundant storage" + } + ] + }, + "description": "The sku name." + }, + "tier": { + "type": "string", + "readOnly": true, + "description": "The sku tier." + } + }, + "description": "The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot" + }, + "SnapshotProperties": { + "properties": { + "timeCreated": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time when the snapshot was created." + }, + "osType": { + "type": "string", + "description": "The Operating System type.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "hyperVGeneration": { + "type": "string", + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only.", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGeneration", + "modelAsString": true + } + }, + "purchasePlan": { + "$ref": "./diskRPCommon.json#/definitions/PurchasePlan", + "description": "Purchase plan information for the image from which the source disk for the snapshot was originally created." + }, + "supportedCapabilities": { + "$ref": "./diskRPCommon.json#/definitions/SupportedCapabilities", + "description": "List of supported capabilities for the image from which the source disk from the snapshot was originally created." + }, + "creationData": { + "$ref": "./diskRPCommon.json#/definitions/CreationData", + "description": "Disk source information. CreationData information cannot be changed after the disk has been created." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + }, + "diskSizeBytes": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The size of the disk in bytes. This field is read only." + }, + "diskState": { + "$ref": "./diskRPCommon.json#/definitions/DiskState", + "description": "The state of the snapshot." + }, + "uniqueId": { + "type": "string", + "readOnly": true, + "description": "Unique Guid identifying the resource." + }, + "encryptionSettingsCollection": { + "$ref": "./diskRPCommon.json#/definitions/EncryptionSettingsCollection", + "description": "Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The disk provisioning state." + }, + "incremental": { + "type": "boolean", + "description": "Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed." + }, + "incrementalSnapshotFamilyId": { + "type": "string", + "readOnly": true, + "description": "Incremental snapshots for a disk share an incremental snapshot family id. The Get Page Range Diff API can only be called on incremental snapshots with the same family id." + }, + "encryption": { + "$ref": "./diskRPCommon.json#/definitions/Encryption", + "description": "Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys." + }, + "networkAccessPolicy": { + "$ref": "./diskRPCommon.json#/definitions/NetworkAccessPolicy" + }, + "diskAccessId": { + "type": "string", + "description": "ARM id of the DiskAccess resource for using private endpoints on disks." + }, + "securityProfile": { + "$ref": "./diskRPCommon.json#/definitions/DiskSecurityProfile", + "description": "Contains the security related information for the resource." + }, + "supportsHibernation": { + "type": "boolean", + "description": "Indicates the OS on a snapshot supports hibernation." + }, + "publicNetworkAccess": { + "$ref": "./diskRPCommon.json#/definitions/PublicNetworkAccess" + }, + "completionPercent": { + "type": "number", + "description": "Percentage complete for the background copy when a resource is created via the CopyStart operation." + }, + "copyCompletionError": { + "$ref": "./diskRPCommon.json#/definitions/CopyCompletionError", + "description": "Indicates the error details if the background copy of a resource created via the CopyStart operation fails." + }, + "dataAccessAuthMode": { + "$ref": "./diskRPCommon.json#/definitions/DataAccessAuthMode" + } + }, + "required": [ + "creationData" + ], + "description": "Snapshot resource properties." + }, + "SnapshotUpdateProperties": { + "properties": { + "osType": { + "type": "string", + "description": "the Operating System type.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + }, + "encryptionSettingsCollection": { + "$ref": "./diskRPCommon.json#/definitions/EncryptionSettingsCollection", + "description": "Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot." + }, + "encryption": { + "$ref": "./diskRPCommon.json#/definitions/Encryption", + "description": "Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys." + }, + "networkAccessPolicy": { + "$ref": "./diskRPCommon.json#/definitions/NetworkAccessPolicy" + }, + "diskAccessId": { + "type": "string", + "description": "ARM id of the DiskAccess resource for using private endpoints on disks." + }, + "supportsHibernation": { + "type": "boolean", + "description": "Indicates the OS on a snapshot supports hibernation." + }, + "publicNetworkAccess": { + "$ref": "./diskRPCommon.json#/definitions/PublicNetworkAccess" + }, + "dataAccessAuthMode": { + "$ref": "./diskRPCommon.json#/definitions/DataAccessAuthMode" + }, + "supportedCapabilities": { + "$ref": "./diskRPCommon.json#/definitions/SupportedCapabilities", + "description": "List of supported capabilities for the image from which the OS disk was created." + } + }, + "description": "Snapshot resource update properties." + } + }, + "parameters": { + "SnapshotNameParameter": { + "name": "snapshotName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The max name length is 80 characters.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/compute/resource-manager/readme.md b/specification/compute/resource-manager/readme.md index 9430dac0c63d..a0fd73a736a4 100644 --- a/specification/compute/resource-manager/readme.md +++ b/specification/compute/resource-manager/readme.md @@ -34,7 +34,7 @@ These are the global settings for the Compute API. title: ComputeManagementClient description: Compute Client openapi-type: arm -tag: package-2024-03-01 +tag: package-2024-03-02 directive: - where: @@ -271,6 +271,56 @@ suppressions: from: diagnostic.json ``` +### Tag: package-2024-03-02 + +These settings apply only when `--tag=package-2024-03-02` is specified on the command line. + +``` yaml $(tag) == 'package-2024-03-02' +input-file: + - Microsoft.Compute/common-types/v1/common.json + - Microsoft.Compute/ComputeRP/stable/2024-03-01/computeRPCommon.json + - Microsoft.Compute/ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json + - Microsoft.Compute/ComputeRP/stable/2024-03-01/virtualMachine.json + - Microsoft.Compute/ComputeRP/stable/2024-03-01/virtualMachineImage.json + - Microsoft.Compute/ComputeRP/stable/2024-03-01/virtualMachineExtensionImage.json + - Microsoft.Compute/ComputeRP/stable/2024-03-01/availabilitySet.json + - Microsoft.Compute/ComputeRP/stable/2024-03-01/proximityPlacementGroup.json + - Microsoft.Compute/ComputeRP/stable/2024-03-01/dedicatedHost.json + - Microsoft.Compute/ComputeRP/stable/2024-03-01/sshPublicKey.json + - Microsoft.Compute/ComputeRP/stable/2024-03-01/image.json + - Microsoft.Compute/ComputeRP/stable/2024-03-01/restorePoint.json + - Microsoft.Compute/ComputeRP/stable/2024-03-01/capacityReservation.json + - Microsoft.Compute/ComputeRP/stable/2024-03-01/logAnalytic.json + - Microsoft.Compute/ComputeRP/stable/2024-03-01/runCommand.json + - Microsoft.Compute/DiskRP/stable/2024-03-02/diskRPCommon.json + - Microsoft.Compute/DiskRP/stable/2024-03-02/disk.json + - Microsoft.Compute/DiskRP/stable/2024-03-02/diskAccess.json + - Microsoft.Compute/DiskRP/stable/2024-03-02/diskEncryptionSet.json + - Microsoft.Compute/DiskRP/stable/2024-03-02/diskRestorePoint.json + - Microsoft.Compute/DiskRP/stable/2024-03-02/snapshot.json + - Microsoft.Compute/Skus/stable/2021-07-01/skus.json + - Microsoft.Compute/GalleryRP/stable/2023-07-03/galleryRPCommon.json + - Microsoft.Compute/GalleryRP/stable/2023-07-03/gallery.json + - Microsoft.Compute/GalleryRP/stable/2023-07-03/sharedGallery.json + - Microsoft.Compute/GalleryRP/stable/2023-07-03/communityGallery.json + - Microsoft.Compute/CloudserviceRP/stable/2022-09-04/cloudService.json +``` + +### Tag: package-2024-03-02-only + +These settings apply only when `--tag=package-2024-03-02-only` is specified on the command line. + +```yaml $(tag) == 'package-2024-03-02-only' +input-file: + - Microsoft.Compute/common-types/v1/common.json + - Microsoft.Compute/DiskRP/stable/2024-03-02/diskRPCommon.json + - Microsoft.Compute/DiskRP/stable/2024-03-02/disk.json + - Microsoft.Compute/DiskRP/stable/2024-03-02/diskAccess.json + - Microsoft.Compute/DiskRP/stable/2024-03-02/diskEncryptionSet.json + - Microsoft.Compute/DiskRP/stable/2024-03-02/diskRestorePoint.json + - Microsoft.Compute/DiskRP/stable/2024-03-02/snapshot.json +``` + ### Tag: package-2024-06-01-preview These settings apply only when `--tag=package-2024-06-01-preview` is specified on the command line. diff --git a/specification/compute/resource-manager/readme.python.md b/specification/compute/resource-manager/readme.python.md index cf794ac31d1c..8ccc287e67b2 100644 --- a/specification/compute/resource-manager/readme.python.md +++ b/specification/compute/resource-manager/readme.python.md @@ -37,9 +37,10 @@ Generate all API versions currently shipped for this package ```yaml $(python) multiapi: true -default-api-version: "2024-03-01" +default-api-version: "2024-03-02" clear-output-folder: true batch: + - tag: package-2024-03-02-only - tag: package-2024-03-01-only - tag: package-2023-10-02-only - tag: package-2023-09-01-only @@ -95,6 +96,16 @@ perform-load: false clear-output-folder: false ``` +### Tag: package-2024-03-02-only + +These settings apply only when `--tag=package-2024-03-02-only --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2024-03-02-only' +namespace: azure.mgmt.compute.v2024_03_02 +output-folder: $(python-sdks-folder)/compute/azure-mgmt-compute/azure/mgmt/compute/v2024_03_02 +``` + ### Tag: package-2024-03-01-only These settings apply only when `--tag=package-2024-03-01-only --python` is specified on the command line. diff --git a/specification/compute/resource-manager/readme.typescript.md b/specification/compute/resource-manager/readme.typescript.md index 0cc616ea2d70..de9a3220d7db 100644 --- a/specification/compute/resource-manager/readme.typescript.md +++ b/specification/compute/resource-manager/readme.typescript.md @@ -28,6 +28,12 @@ directive: transform: >- return $. replace(/[,|*] 'DummyOrchestrationServiceName'/g,''); + + # we do not need to hack to add a dummy enum entry in track 2, because track 2 generator will generate the enum type even if it only has on entry + - from: diskRPCommon.json + where: "$.definitions.PurchasePlan" + transform: > + $["x-ms-client-name"] = "DiskPurchasePlan"; ``` ``` yaml $(typescript) && !$(profile-content) diff --git a/specification/compute/resource-manager/sdk-suppressions.yaml b/specification/compute/resource-manager/sdk-suppressions.yaml index 4591cd0aac17..ca32bd674393 100644 --- a/specification/compute/resource-manager/sdk-suppressions.yaml +++ b/specification/compute/resource-manager/sdk-suppressions.yaml @@ -11,4 +11,8 @@ suppressions: - package: "@azure/arm-compute" breaking-changes: - Parameter id of interface SecurityPostureReference is now required - - Type of parameter excludeExtensions of interface SecurityPostureReference is changed from VirtualMachineExtension[] to string[] \ No newline at end of file + - Type of parameter excludeExtensions of interface SecurityPostureReference is changed from VirtualMachineExtension[] to string[] + - Type of parameter purchasePlan of interface Disk is changed from PurchasePlanAutoGenerated to DiskPurchasePlan + - Type of parameter purchasePlan of interface DiskRestorePoint is changed from PurchasePlanAutoGenerated to DiskPurchasePlan + - Type of parameter purchasePlan of interface DiskUpdate is changed from PurchasePlanAutoGenerated to DiskPurchasePlan + - Type of parameter purchasePlan of interface Snapshot is changed from PurchasePlanAutoGenerated to DiskPurchasePlan \ No newline at end of file diff --git a/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/Operations_List_MaximumSet_Gen.json b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..611fd9cdde51 --- /dev/null +++ b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_ListMax - generated by [MaximumSet] rule", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ennucrkvxylbsli", + "isDataAction": true, + "display": { + "provider": "brssqjspiggui", + "resource": "aujpznmlzjgsyynq", + "operation": "sjldnlycokfcufegoktphlwpvxkx", + "description": "deurosfshmtoujzbhldvflxxkz" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/Operations_List_MinimumSet_Gen.json b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/Operations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..a354a7ed854b --- /dev/null +++ b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/Operations_List_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Operations_ListMax - generated by [MinimumSet] rule", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesCancelOperations_MaximumSet_Gen.json b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesCancelOperations_MaximumSet_Gen.json new file mode 100644 index 000000000000..f55b5052cb2d --- /dev/null +++ b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesCancelOperations_MaximumSet_Gen.json @@ -0,0 +1,47 @@ +{ + "title": "ScheduledActions_VirtualMachinesCancelOperations - generated by [MaximumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesCancelOperations", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "juzzyocyywfxwakqmgahb", + "requestBody": { + "operationIds": [ + "23480d2f-1dca-4610-afb4-dd25eec1f34r" + ], + "correlationid": "01080d2f-1dca-4610-afb4-dd25eec1f3c1" + } + }, + "responses": { + "200": { + "body": { + "results": [ + { + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource1", + "errorCode": "pliurpaykwv", + "errorDetails": "mbqwkpxl", + "operation": { + "operationId": "23480d2f-1dca-4610-afb4-dd25eec1f34", + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource1", + "opType": "Unknown", + "subscriptionId": "52C81249-550F-459E-9B6E-5BAB6EE62227", + "deadline": "2024-07-12T18:06:52.974Z", + "deadlineType": "Unknown", + "state": "Unknown", + "timeZone": "lsoalxijilbrqum", + "resourceOperationError": { + "errorCode": "fticyqukvkillwd", + "errorDetails": "yimgxqrkp" + }, + "completedAt": "2024-07-12T18:06:52.974Z", + "retryPolicy": { + "retryCount": 30, + "retryWindowInMinutes": 27 + } + } + } + ] + } + } + } +} diff --git a/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesCancelOperations_MinimumSet_Gen.json b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesCancelOperations_MinimumSet_Gen.json new file mode 100644 index 000000000000..de6dac36c786 --- /dev/null +++ b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesCancelOperations_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "ScheduledActions_VirtualMachinesCancelOperations - generated by [MinimumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesCancelOperations", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "lzrfledwkzrp", + "requestBody": { + "operationIds": [ + "01080d2f-1dca-4610-afb4-dd25eec1f3df" + ], + "correlationid": "01080d2f-1dca-4610-afb4-dd25eec1f3c1" + } + }, + "responses": { + "200": { + "body": { + "results": [ + {} + ] + } + } + } +} diff --git a/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesExecuteDeallocate_MaximumSet_Gen.json b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesExecuteDeallocate_MaximumSet_Gen.json new file mode 100644 index 000000000000..9e5039c4a1cb --- /dev/null +++ b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesExecuteDeallocate_MaximumSet_Gen.json @@ -0,0 +1,59 @@ +{ + "title": "ScheduledActions_VirtualMachinesExecuteDeallocate - generated by [MaximumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesExecuteDeallocate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "dspazcfydfdhxer", + "requestBody": { + "executionParameters": { + "optimizationPreference": "Cost", + "retryPolicy": { + "retryCount": 30, + "retryWindowInMinutes": 27 + } + }, + "resources": { + "ids": [ + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource2" + ] + }, + "correlationid": "01080d2f-1dca-4610-afb4-dd25eddf1f3c1" + } + }, + "responses": { + "200": { + "body": { + "type": "eokrhxypminzcgplibblmwojvjd", + "location": "qbbvrdisvjgxirnzdvdsodkt", + "results": [ + { + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource2", + "errorCode": "pliurpaykwv", + "errorDetails": "mbqwkpxl", + "operation": { + "operationId": "23480d2f-1dca-4610-afb4-dd25eec1f34", + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource2", + "opType": "Unknown", + "subscriptionId": "52C81249-550F-459E-9B6E-5BAB6EE62227", + "deadline": "2024-07-12T18:06:52.974Z", + "deadlineType": "Unknown", + "state": "Unknown", + "timeZone": "lsoalxijilbrqum", + "resourceOperationError": { + "errorCode": "fticyqukvkillwd", + "errorDetails": "yimgxqrkp" + }, + "completedAt": "2024-07-12T18:06:52.974Z", + "retryPolicy": { + "retryCount": 30, + "retryWindowInMinutes": 27 + } + } + } + ], + "description": "lydvixvsrotpqrztll" + } + } + } +} diff --git a/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesExecuteDeallocate_MinimumSet_Gen.json b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesExecuteDeallocate_MinimumSet_Gen.json new file mode 100644 index 000000000000..a7b15939d228 --- /dev/null +++ b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesExecuteDeallocate_MinimumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "title": "ScheduledActions_VirtualMachinesExecuteDeallocate - generated by [MinimumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesExecuteDeallocate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "zanmxbtvfqzqqtywqtnslqxfk", + "requestBody": { + "executionParameters": {}, + "resources": { + "ids": [ + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource2" + ] + }, + "correlationid": "01080d2f-1dca-4610-afb4-dd25eec1f3c1" + } + }, + "responses": { + "200": { + "body": { + "type": "eokrhxypminzcgplibblmwojvjd", + "location": "qbbvrdisvjgxirnzdvdsodkt", + "description": "anxrfkvievuotqdlmowhn" + } + } + } +} diff --git a/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesExecuteHibernate_MaximumSet_Gen.json b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesExecuteHibernate_MaximumSet_Gen.json new file mode 100644 index 000000000000..31c5212a8a00 --- /dev/null +++ b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesExecuteHibernate_MaximumSet_Gen.json @@ -0,0 +1,59 @@ +{ + "title": "ScheduledActions_VirtualMachinesExecuteHibernate - generated by [MaximumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesExecuteHibernate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "az", + "requestBody": { + "executionParameters": { + "optimizationPreference": "Cost", + "retryPolicy": { + "retryCount": 30, + "retryWindowInMinutes": 27 + } + }, + "resources": { + "ids": [ + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3" + ] + }, + "correlationid": "01080d2f-1dca-4610-afb4-dd25eec1f3c1" + } + }, + "responses": { + "200": { + "body": { + "type": "mkmgbfpkiudefzhdppgjmqztx", + "location": "rvlnzczpesuvusbmbcjctzcinzlr", + "results": [ + { + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3", + "errorCode": "pliurpaykwv", + "errorDetails": "mbqwkpxl", + "operation": { + "operationId": "23480d2f-1dca-4610-afb4-dd25eec1f34", + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3", + "opType": "Unknown", + "subscriptionId": "52C81249-550F-459E-9B6E-5BAB6EE62227", + "deadline": "2024-07-12T18:06:52.974Z", + "deadlineType": "Unknown", + "state": "Unknown", + "timeZone": "lsoalxijilbrqum", + "resourceOperationError": { + "errorCode": "fticyqukvkillwd", + "errorDetails": "yimgxqrkp" + }, + "completedAt": "2024-07-12T18:06:52.974Z", + "retryPolicy": { + "retryCount": 30, + "retryWindowInMinutes": 27 + } + } + } + ], + "description": "hnyafndkyssbbeyjzhndexmhwdqe" + } + } + } +} diff --git a/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesExecuteHibernate_MinimumSet_Gen.json b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesExecuteHibernate_MinimumSet_Gen.json new file mode 100644 index 000000000000..f4a339a0a496 --- /dev/null +++ b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesExecuteHibernate_MinimumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "title": "ScheduledActions_VirtualMachinesExecuteHibernate - generated by [MinimumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesExecuteHibernate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "oowpasegipasucmq", + "requestBody": { + "executionParameters": {}, + "resources": { + "ids": [ + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3" + ] + }, + "correlationid": "01080d2f-1dca-4610-afb4-dd25eec1f3c1" + } + }, + "responses": { + "200": { + "body": { + "type": "mkmgbfpkiudefzhdppgjmqztx", + "location": "rvlnzczpesuvusbmbcjctzcinzlr", + "description": "dgliqjj" + } + } + } +} diff --git a/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesExecuteStart_MaximumSet_Gen.json b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesExecuteStart_MaximumSet_Gen.json new file mode 100644 index 000000000000..e7da1e9585f3 --- /dev/null +++ b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesExecuteStart_MaximumSet_Gen.json @@ -0,0 +1,59 @@ +{ + "title": "ScheduledActions_VirtualMachinesExecuteStart - generated by [MaximumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesExecuteStart", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "cwkjesffxrcxaxbnvqumkjbbymwlpe", + "requestBody": { + "executionParameters": { + "optimizationPreference": "Cost", + "retryPolicy": { + "retryCount": 30, + "retryWindowInMinutes": 27 + } + }, + "resources": { + "ids": [ + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource4" + ] + }, + "correlationid": "23230d2f-1dca-4610-afb4-dd25eec1f34" + } + }, + "responses": { + "200": { + "body": { + "type": "gxmnjtgu", + "location": "uvlidhowwv", + "results": [ + { + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource4", + "errorCode": "pliurpaykwv", + "errorDetails": "mbqwkpxl", + "operation": { + "operationId": "23480d2f-1dca-4610-afb4-dd25eec1f34", + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource4", + "opType": "Unknown", + "subscriptionId": "52C81249-550F-459E-9B6E-5BAB6EE62227", + "deadline": "2024-07-12T18:06:52.974Z", + "deadlineType": "Unknown", + "state": "Unknown", + "timeZone": "lsoalxijilbrqum", + "resourceOperationError": { + "errorCode": "fticyqukvkillwd", + "errorDetails": "yimgxqrkp" + }, + "completedAt": "2024-07-12T18:06:52.974Z", + "retryPolicy": { + "retryCount": 30, + "retryWindowInMinutes": 27 + } + } + } + ], + "description": "dtwditzxiiwiqvbaylczcfnvo" + } + } + } +} diff --git a/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesExecuteStart_MinimumSet_Gen.json b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesExecuteStart_MinimumSet_Gen.json new file mode 100644 index 000000000000..24c06ac07b57 --- /dev/null +++ b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesExecuteStart_MinimumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "title": "ScheduledActions_VirtualMachinesExecuteStart - generated by [MinimumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesExecuteStart", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "puguskuewwqfrdkmwrnzb", + "requestBody": { + "executionParameters": {}, + "resources": { + "ids": [ + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource4" + ] + }, + "correlationid": "01080d2f-1dca-4610-afb4-dd25eec1f3c1" + } + }, + "responses": { + "200": { + "body": { + "type": "gxmnjtgu", + "location": "uvlidhowwv", + "description": "p" + } + } + } +} diff --git a/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesGetOperationStatus_MaximumSet_Gen.json b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesGetOperationStatus_MaximumSet_Gen.json new file mode 100644 index 000000000000..d06fa9e2558a --- /dev/null +++ b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesGetOperationStatus_MaximumSet_Gen.json @@ -0,0 +1,47 @@ +{ + "title": "ScheduledActions_VirtualMachinesGetOperationStatus - generated by [MaximumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesGetOperationStatus", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "lfmx", + "requestBody": { + "operationIds": [ + "23480d2f-1dca-4610-afb4-dd25eec1f34" + ], + "correlationid": "23519o2f-1dca-4610-afb4-dd25eec1f34" + } + }, + "responses": { + "200": { + "body": { + "results": [ + { + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource5", + "errorCode": "pliurpaykwv", + "errorDetails": "mbqwkpxl", + "operation": { + "operationId": "23480d2f-1dca-4610-afb4-dd25eec1f34", + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource5", + "opType": "Unknown", + "subscriptionId": "52C81249-550F-459E-9B6E-5BAB6EE62227", + "deadline": "2024-07-12T18:06:52.974Z", + "deadlineType": "Unknown", + "state": "Unknown", + "timeZone": "lsoalxijilbrqum", + "resourceOperationError": { + "errorCode": "fticyqukvkillwd", + "errorDetails": "yimgxqrkp" + }, + "completedAt": "2024-07-12T18:06:52.974Z", + "retryPolicy": { + "retryCount": 30, + "retryWindowInMinutes": 27 + } + } + } + ] + } + } + } +} diff --git a/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesGetOperationStatus_MinimumSet_Gen.json b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesGetOperationStatus_MinimumSet_Gen.json new file mode 100644 index 000000000000..33b3e6f2b009 --- /dev/null +++ b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesGetOperationStatus_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "ScheduledActions_VirtualMachinesGetOperationStatus - generated by [MinimumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesGetOperationStatus", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "csay", + "requestBody": { + "operationIds": [ + "01080d2f-1dca-4610-afb4-dd25eec1f3df" + ], + "correlationid": "01080d2f-1dca-4610-afb4-dd25eec1f3c1" + } + }, + "responses": { + "200": { + "body": { + "results": [ + {} + ] + } + } + } +} diff --git a/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesSubmitDeallocate_MaximumSet_Gen.json b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesSubmitDeallocate_MaximumSet_Gen.json new file mode 100644 index 000000000000..ec877e8801b9 --- /dev/null +++ b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesSubmitDeallocate_MaximumSet_Gen.json @@ -0,0 +1,64 @@ +{ + "title": "ScheduledActions_VirtualMachinesSubmitDeallocate - generated by [MaximumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesSubmitDeallocate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "nynqafujbcjyrtqve", + "requestBody": { + "schedule": { + "deadLine": "2024-07-12T18:06:53.361Z", + "timeZone": "zlcujrtgxtgyik", + "deadlineType": "Unknown" + }, + "executionParameters": { + "optimizationPreference": "Cost", + "retryPolicy": { + "retryCount": 30, + "retryWindowInMinutes": 27 + } + }, + "resources": { + "ids": [ + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource2" + ] + }, + "correlationid": "23519o2f-1dca-4610-afb4-dd25eec1f34" + } + }, + "responses": { + "200": { + "body": { + "type": "eokrhxypminzcgplibblmwojvjd", + "location": "qbbvrdisvjgxirnzdvdsodkt", + "results": [ + { + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource2", + "errorCode": "pliurpaykwv", + "errorDetails": "mbqwkpxl", + "operation": { + "operationId": "23480d2f-1dca-4610-afb4-dd25eec1f34", + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource2", + "opType": "Unknown", + "subscriptionId": "52C81249-550F-459E-9B6E-5BAB6EE62227", + "deadline": "2024-07-12T18:06:52.974Z", + "deadlineType": "Unknown", + "state": "Unknown", + "timeZone": "lsoalxijilbrqum", + "resourceOperationError": { + "errorCode": "fticyqukvkillwd", + "errorDetails": "yimgxqrkp" + }, + "completedAt": "2024-07-12T18:06:52.974Z", + "retryPolicy": { + "retryCount": 30, + "retryWindowInMinutes": 27 + } + } + } + ], + "description": "lydvixvsrotpqrztll" + } + } + } +} diff --git a/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesSubmitDeallocate_MinimumSet_Gen.json b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesSubmitDeallocate_MinimumSet_Gen.json new file mode 100644 index 000000000000..41abbf5b1906 --- /dev/null +++ b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesSubmitDeallocate_MinimumSet_Gen.json @@ -0,0 +1,32 @@ +{ + "title": "ScheduledActions_VirtualMachinesSubmitDeallocate - generated by [MinimumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesSubmitDeallocate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "gfuns", + "requestBody": { + "schedule": { + "deadLine": "2024-07-12T18:06:53.361Z", + "timeZone": "zlcujrtgxtgyik", + "deadlineType": "Unknown" + }, + "executionParameters": {}, + "resources": { + "ids": [ + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource2" + ] + }, + "correlationid": "01080d2f-1dca-4610-afb4-dd25eec1f3c1" + } + }, + "responses": { + "200": { + "body": { + "type": "eokrhxypminzcgplibblmwojvjd", + "location": "qbbvrdisvjgxirnzdvdsodkt", + "description": "anxrfkvievuotqdlmowhn" + } + } + } +} diff --git a/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesSubmitHibernate_MaximumSet_Gen.json b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesSubmitHibernate_MaximumSet_Gen.json new file mode 100644 index 000000000000..638ac84434bd --- /dev/null +++ b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesSubmitHibernate_MaximumSet_Gen.json @@ -0,0 +1,64 @@ +{ + "title": "ScheduledActions_VirtualMachinesSubmitHibernate - generated by [MaximumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesSubmitHibernate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "jrulwh", + "requestBody": { + "schedule": { + "deadLine": "2024-07-12T18:06:53.361Z", + "timeZone": "zlcujrtgxtgyik", + "deadlineType": "Unknown" + }, + "executionParameters": { + "optimizationPreference": "Cost", + "retryPolicy": { + "retryCount": 30, + "retryWindowInMinutes": 27 + } + }, + "resources": { + "ids": [ + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3" + ] + }, + "correlationid": "23519o2f-1dca-4610-afb4-dd25eec1f34" + } + }, + "responses": { + "200": { + "body": { + "type": "mkmgbfpkiudefzhdppgjmqztx", + "location": "rvlnzczpesuvusbmbcjctzcinzlr", + "results": [ + { + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3", + "errorCode": "pliurpaykwv", + "errorDetails": "mbqwkpxl", + "operation": { + "operationId": "01080d2f-1dca-4610-afb4-dd25eec1f3c1", + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3", + "opType": "Unknown", + "subscriptionId": "52C81249-550F-459E-9B6E-5BAB6EE62227", + "deadline": "2024-07-12T18:06:52.974Z", + "deadlineType": "Unknown", + "state": "Unknown", + "timeZone": "lsoalxijilbrqum", + "resourceOperationError": { + "errorCode": "fticyqukvkillwd", + "errorDetails": "yimgxqrkp" + }, + "completedAt": "2024-07-12T18:06:52.974Z", + "retryPolicy": { + "retryCount": 30, + "retryWindowInMinutes": 27 + } + } + } + ], + "description": "hnyafndkyssbbeyjzhndexmhwdqe" + } + } + } +} diff --git a/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesSubmitHibernate_MinimumSet_Gen.json b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesSubmitHibernate_MinimumSet_Gen.json new file mode 100644 index 000000000000..ecca9d847c66 --- /dev/null +++ b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesSubmitHibernate_MinimumSet_Gen.json @@ -0,0 +1,32 @@ +{ + "title": "ScheduledActions_VirtualMachinesSubmitHibernate - generated by [MinimumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesSubmitHibernate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "pgedjeucp", + "requestBody": { + "schedule": { + "deadLine": "2024-07-12T18:06:53.361Z", + "timeZone": "zlcujrtgxtgyik", + "deadlineType": "Unknown" + }, + "executionParameters": {}, + "resources": { + "ids": [ + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3" + ] + }, + "correlationid": "01080d2f-1dca-4610-afb4-dd25eec1f3c1" + } + }, + "responses": { + "200": { + "body": { + "type": "mkmgbfpkiudefzhdppgjmqztx", + "location": "rvlnzczpesuvusbmbcjctzcinzlr", + "description": "dgliqjj" + } + } + } +} diff --git a/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesSubmitStart_MaximumSet_Gen.json b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesSubmitStart_MaximumSet_Gen.json new file mode 100644 index 000000000000..00a63cb04d9e --- /dev/null +++ b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesSubmitStart_MaximumSet_Gen.json @@ -0,0 +1,64 @@ +{ + "title": "ScheduledActions_VirtualMachinesSubmitStart - generated by [MaximumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesSubmitStart", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "pxbvjarpyzhastophdyu", + "requestBody": { + "schedule": { + "deadLine": "2024-07-12T18:06:53.361Z", + "timeZone": "zlcujrtgxtgyik", + "deadlineType": "Unknown" + }, + "executionParameters": { + "optimizationPreference": "Cost", + "retryPolicy": { + "retryCount": 30, + "retryWindowInMinutes": 27 + } + }, + "resources": { + "ids": [ + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource4" + ] + }, + "correlationid": "23480d2f-1dca-4610-afb4-dd25eec1f34" + } + }, + "responses": { + "200": { + "body": { + "type": "gxmnjtgu", + "location": "uvlidhowwv", + "results": [ + { + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource4", + "errorCode": "pliurpaykwv", + "errorDetails": "mbqwkpxl", + "operation": { + "operationId": "01080d2f-1dca-4610-afb4-dd25eec1f3c1", + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource4", + "opType": "Unknown", + "subscriptionId": "52C81249-550F-459E-9B6E-5BAB6EE62227", + "deadline": "2024-07-12T18:06:52.974Z", + "deadlineType": "Unknown", + "state": "Unknown", + "timeZone": "lsoalxijilbrqum", + "resourceOperationError": { + "errorCode": "fticyqukvkillwd", + "errorDetails": "yimgxqrkp" + }, + "completedAt": "2024-07-12T18:06:52.974Z", + "retryPolicy": { + "retryCount": 30, + "retryWindowInMinutes": 27 + } + } + } + ], + "description": "dtwditzxiiwiqvbaylczcfnvo" + } + } + } +} diff --git a/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesSubmitStart_MinimumSet_Gen.json b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesSubmitStart_MinimumSet_Gen.json new file mode 100644 index 000000000000..0715b595ba59 --- /dev/null +++ b/specification/computeschedule/ComputeSchedule.Management/examples/2024-06-01-preview/ScheduledActions_VirtualMachinesSubmitStart_MinimumSet_Gen.json @@ -0,0 +1,32 @@ +{ + "title": "ScheduledActions_VirtualMachinesSubmitStart - generated by [MinimumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesSubmitStart", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "vkrnfmvxrtbzgeyqmhtney", + "requestBody": { + "schedule": { + "deadLine": "2024-07-12T18:06:53.361Z", + "timeZone": "zlcujrtgxtgyik", + "deadlineType": "Unknown" + }, + "executionParameters": {}, + "resources": { + "ids": [ + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource4" + ] + }, + "correlationid": "01080d2f-1dca-4610-afb4-dd25eec1f3c1" + } + }, + "responses": { + "200": { + "body": { + "type": "gxmnjtgu", + "location": "uvlidhowwv", + "description": "p" + } + } + } +} diff --git a/specification/computeschedule/ComputeSchedule.Management/main.tsp b/specification/computeschedule/ComputeSchedule.Management/main.tsp new file mode 100644 index 000000000000..7f44d07b17ac --- /dev/null +++ b/specification/computeschedule/ComputeSchedule.Management/main.tsp @@ -0,0 +1,29 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "./routes.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.ResourceManager; + +@armProviderNamespace +@service({ + title: "Microsoft.ComputeSchedule", +}) +@doc("Microsoft.ComputeSchedule Resource Provider management API.") +@versioned(Versions) +namespace Microsoft.ComputeSchedule; + +/** ComputeSchedule API versions */ +enum Versions { + /** 2024-06-01-preview version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) + `2024-06-01-preview`, +} diff --git a/specification/computeschedule/ComputeSchedule.Management/models.tsp b/specification/computeschedule/ComputeSchedule.Management/models.tsp new file mode 100644 index 000000000000..cf5e56527233 --- /dev/null +++ b/specification/computeschedule/ComputeSchedule.Management/models.tsp @@ -0,0 +1,378 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.ResourceManager; +using TypeSpec.OpenAPI; + +namespace Microsoft.ComputeSchedule; + +// ------------------ Enums --------------- +@doc("The types of deadlines supported by ScheduledActions") +union DeadlineType { + @doc("Default value of Unknown.") + Unknown: "Unknown", + + @doc("Initiate the operation at the given deadline.") + InitiateAt: "InitiateAt", + + @doc("Complete the operation by the given deadline.") + CompleteBy: "CompleteBy", + + string, +} + +@doc("The preferences customers can select to optimize their requests to ScheduledActions") +union OptimizationPreference { + @doc("Optimize while considering cost savings") + Cost: "Cost", + + @doc("Optimize while considering availability of resources") + Availability: "Availability", + + @doc("Optimize while considering a balance of cost and availability") + CostAvailabilityBalanced: "CostAvailabilityBalanced", + + string, +} + +@doc("The kind of operation types that can be performed on resources using ScheduledActions") +union ResourceOperationType { + @doc("The default value for this enum type") + Unknown: "Unknown", + + @doc("Start operations on the resources") + Start: "Start", + + @doc("Deallocate operations on the resources") + Deallocate: "Deallocate", + + @doc("Hibernate operations on the resources") + Hibernate: "Hibernate", + + string, +} + +@doc("Values that define the states of operations in Scheduled Actions") +union OperationState { + @doc("The default value for the operation state enum") + Unknown: "Unknown", + + @doc("Operations that are pending scheduling") + PendingScheduling: "PendingScheduling", + + @doc("Operations that have been scheduled") + Scheduled: "Scheduled", + + @doc("Operations that are waiting to be executed") + PendingExecution: "PendingExecution", + + @doc("Operations that are in the process of being executed") + Executing: "Executing", + + @doc("Operations that suceeded") + Succeeded: "Succeeded", + + @doc("Operations that have failed") + Failed: "Failed", + + @doc("Operations that have been cancelled by the user") + Cancelled: "Cancelled", + + @doc("Operations that are blocked") + Blocked: "Blocked", + + string, +} + +// ------------------ Common Values --------------- +alias Params = { + ...ApiVersionParameter; + ...SubscriptionIdParameter; + + @path + @minLength(1) + @segment("locations") + @doc("The location name.") + locationparameter: string; +}; + +// ------------------ Models --------------- +@doc("The schedule details for the user request") +model Schedule { + #suppress "@azure-tools/typespec-azure-core/no-offsetdatetime" "Prefer using `utcDateTime` when representing a datetime unless an offset is necessary." + @doc("The deadline for the operation") + deadLine: offsetDateTime; + + @doc("The timezone for the operation") + timeZone: string; + + @doc("The deadlinetype of the operation, this can either be InitiateAt or CompleteBy") + @extension("x-ms-enum.modelAsString", true) + deadlineType: DeadlineType = DeadlineType.Unknown; +} + +@doc("The resources needed for the user request") +model Resources { + @doc("The resource ids used for the request") + ids: Array; +} + +@doc("The retry policy for the user request") +model RetryPolicy { + @doc("Retry count for user request") + retryCount?: int32; + + @doc("Retry window in minutes for user request") + retryWindowInMinutes?: int32; +} + +@doc("Extra details needed to run the user's request") +model ExecutionParameters { + @doc("Details that could optimize the user's request") + optimizationPreference?: OptimizationPreference; + + @doc("Retry policy the user can pass") + retryPolicy?: RetryPolicy; +} + +@doc("These describe errors that occur at the resource level") +model ResourceOperationError { + @doc("Code for the error eg 404, 500") + errorCode: string; + + @doc("Detailed message about the error") + errorDetails: string; +} + +@doc("The details of a response from an operation on a resource") +model ResourceOperationDetails { + @doc("Operation identifier for the unique operation") + operationId: string; + + @doc("Unique identifier for the resource involved in the operation, eg ArmId") + resourceId: Azure.Core.armResourceIdentifier; + + @doc("Type of operation performed on the resources") + @extension("x-ms-enum.modelAsString", true) + opType: ResourceOperationType = ResourceOperationType.Unknown; + + @doc("Subscription id attached to the request") + subscriptionId: string; + + #suppress "@azure-tools/typespec-azure-core/no-offsetdatetime" "Prefer using `utcDateTime` when representing a datetime unless an offset is necessary." + @doc("Deadline for the operation") + deadline: offsetDateTime; + + @doc("Type of deadline of the operation") + @extension("x-ms-enum.modelAsString", true) + deadlineType: DeadlineType = DeadlineType.Unknown; + + @doc("Current state of the operation") + @extension("x-ms-enum.modelAsString", true) + state: OperationState = OperationState.Unknown; + + @doc("Timezone for the operation") + timeZone?: string; + + @doc("Operation level errors if they exist") + resourceOperationError?: ResourceOperationError; + + #suppress "@azure-tools/typespec-azure-core/no-offsetdatetime" "Prefer using `utcDateTime` when representing a datetime unless an offset is necessary." + @doc("Time the operation was complete if errors are null") + completedAt?: offsetDateTime; + + @doc("Retry policy the user can pass") + retryPolicy?: RetryPolicy; +} + +@doc("High level response from an operation on a resource") +model ResourceOperation { + @doc("Unique identifier for the resource involved in the operation, eg ArmId") + resourceId?: Azure.Core.armResourceIdentifier; + + @doc("Resource level error code if it exists") + errorCode?: string; + + @doc("Resource level error details if they exist") + errorDetails?: string; + + @doc("Details of the operation performed on a resource") + operation?: ResourceOperationDetails; +} + +// ----------- SubmitDeallocate --------- +@doc("The deallocate request for resources") +model SubmitDeallocateRequest { + @doc("The schedule for the request") + schedule: Schedule; + + @doc("The execution parameters for the request") + executionParameters: ExecutionParameters; + + @doc("The resources for the request") + resources: Resources; + + @doc("Correlationid item") + correlationid: string; +} + +@doc("The response from a deallocate request") +model DeallocateResourceOperationResponse { + @doc("The description of the operation response") + description: string; + + @doc("The type of resources used in the deallocate request eg virtual machines") + type: string; + + @doc("The location of the deallocate request eg westus") + @extension("x-ms-mutability", ["read", "create"]) + location: string; + + @extension("x-ms-identifiers", ["resourceId"]) + @doc("The results from the deallocate request if no errors exist") + results?: Array; +} + +// ----------- SubmitStart --------- +@doc("This is the request for start") +model SubmitStartRequest { + @doc("The schedule for the request") + schedule: Schedule; + + @doc("The execution parameters for the request") + executionParameters: ExecutionParameters; + + @doc("The resources for the request") + resources: Resources; + + @doc("Correlationid item") + correlationid: string; +} + +@doc("The response from a start request") +model StartResourceOperationResponse { + @doc("The description of the operation response") + description: string; + + @doc("The type of resources used in the start request eg virtual machines") + type: string; + + @doc("The location of the start request eg westus") + @extension("x-ms-mutability", ["read", "create"]) + location: string; + + @extension("x-ms-identifiers", ["resourceId"]) + @doc("The results from the start request if no errors exist") + results?: Array; +} + +// ----------- SubmitHibernate --------- +@doc("This is the request for hibernate") +model SubmitHibernateRequest { + @doc("The schedule for the request") + schedule: Schedule; + + @doc("The execution parameters for the request") + executionParameters: ExecutionParameters; + + @doc("The resources for the request") + resources: Resources; + + @doc("Correlationid item") + correlationid: string; +} + +@doc("The response from a Hibernate request") +model HibernateResourceOperationResponse { + @doc("The description of the operation response") + description: string; + + @doc("The type of resources used in the Hibernate request eg virtual machines") + type: string; + + @doc("The location of the Hibernate request eg westus") + @extension("x-ms-mutability", ["read", "create"]) + location: string; + + @extension("x-ms-identifiers", ["resourceId"]) + @doc("The results from the Hibernate request if no errors exist") + results?: Array; +} + +// ----------- Execute Operations Request --------- +@doc("The ExecuteDeallocateRequest request for executeDeallocate operations") +model ExecuteDeallocateRequest { + @doc("The execution parameters for the request") + executionParameters: ExecutionParameters; + + @doc("The resources for the request") + resources: Resources; + + @doc("Correlationid item") + correlationid: string; +} + +@doc("The ExecuteHibernateRequest request for executeHibernate operations") +model ExecuteHibernateRequest { + @doc("The execution parameters for the request") + executionParameters: ExecutionParameters; + + @doc("The resources for the request") + resources: Resources; + + @doc("Correlationid item") + correlationid: string; +} + +@doc("The ExecuteStartRequest request for executeStart operations") +model ExecuteStartRequest { + @doc("The execution parameters for the request") + executionParameters: ExecutionParameters; + + @doc("The resources for the request") + resources: Resources; + + @doc("Correlationid item") + correlationid: string; +} + +// ----------- GetOperationStatus --------- +@doc("This is the request to get operation status using operationids") +model GetOperationStatusRequest { + @doc("The list of operation ids to get the status of") + operationIds: Array; + + @doc("Correlationid item") + correlationid: string; +} + +@doc("This is the response from a get operations status request") +model GetOperationStatusResponse { + @extension("x-ms-identifiers", ["resourceId"]) + @doc("An array of resource operations based on their operation ids") + results: Array; +} + +// ----------- CancelOperations --------- +@doc("This is the request to cancel running operations in scheduled actions using the operation ids") +model CancelOperationsRequest { + @doc("The list of operation ids to cancel operations on") + operationIds: Array; + + @doc("Correlationid item") + correlationid: string; +} + +@doc("This is the response from a cancel operations request") +model CancelOperationsResponse { + @extension("x-ms-identifiers", ["resourceId"]) + @doc("An array of resource operations that were successfully cancelled") + results: Array; +} diff --git a/specification/computeschedule/ComputeSchedule.Management/routes.tsp b/specification/computeschedule/ComputeSchedule.Management/routes.tsp new file mode 100644 index 000000000000..42e44b8d7cb3 --- /dev/null +++ b/specification/computeschedule/ComputeSchedule.Management/routes.tsp @@ -0,0 +1,92 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "./models.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.ResourceManager; + +namespace Microsoft.ComputeSchedule; + +interface Operations extends Azure.ResourceManager.Operations {} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "Each resource interface must have an @armResourceOperations decorator." +interface ScheduledActions { + // -------------- Routes ------------- + /** virtualMachinesSubmitDeallocate: submitDeallocate for a virtual machine */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "necessary to avoid standard routing" + @route("/subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesSubmitDeallocate") + @post + virtualMachinesSubmitDeallocate( + ...Params, + @body @doc("The request body") requestBody: SubmitDeallocateRequest, + ): ArmResponse | ErrorResponse; + + /** virtualMachinesSubmitHibernate: submitHibernate for a virtual machine */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "necessary to avoid standard routing" + @route("/subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesSubmitHibernate") + @post + virtualMachinesSubmitHibernate( + ...Params, + @body @doc("The request body") requestBody: SubmitHibernateRequest, + ): ArmResponse | ErrorResponse; + + /** virtualMachinesSubmitStart: submitStart for a virtual machine */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "necessary to avoid standard routing" + @route("/subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesSubmitStart") + @post + virtualMachinesSubmitStart( + ...Params, + @body @doc("The request body") requestBody: SubmitStartRequest, + ): ArmResponse | ErrorResponse; + + /** virtualMachinesExecuteDeallocate: executeDeallocate for a virtual machine */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "necessary to avoid standard routing" + @route("/subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesExecuteDeallocate") + @post + virtualMachinesExecuteDeallocate( + ...Params, + @body @doc("The request body") requestBody: ExecuteDeallocateRequest, + ): ArmResponse | ErrorResponse; + + /** virtualMachinesExecuteHibernate: executeHibernate for a virtual machine */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "necessary to avoid standard routing" + @route("/subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesExecuteHibernate") + @post + virtualMachinesExecuteHibernate( + ...Params, + @body @doc("The request body") requestBody: ExecuteHibernateRequest, + ): ArmResponse | ErrorResponse; + + /** virtualMachinesExecuteStart: executeStart for a virtual machine */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "necessary to avoid standard routing" + @route("/subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesExecuteStart") + @post + virtualMachinesExecuteStart( + ...Params, + @body @doc("The request body") requestBody: ExecuteStartRequest, + ): ArmResponse | ErrorResponse; + + /** virtualMachinesGetOperationStatus: getOperationStatus for a virtual machine */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "necessary to avoid standard routing" + @route("/subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesGetOperationStatus") + @post + virtualMachinesGetOperationStatus( + ...Params, + @body @doc("The request body") requestBody: GetOperationStatusRequest, + ): ArmResponse | ErrorResponse; + + /** virtualMachinesCancelOperations: cancelOperations for a virtual machine */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "necessary to avoid standard routing" + @route("/subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesCancelOperations") + @post + virtualMachinesCancelOperations( + ...Params, + @body @doc("The request body") requestBody: CancelOperationsRequest, + ): ArmResponse | ErrorResponse; +} diff --git a/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml b/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml new file mode 100644 index 000000000000..8c35b32e5278 --- /dev/null +++ b/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml @@ -0,0 +1,11 @@ +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + emitter-output-dir: "{project-root}/.." + azure-resource-provider-folder: "resource-manager" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/computeschedule.json" + examples-directory: "{project-root}/examples" +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/computeschedule.json b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/computeschedule.json new file mode 100644 index 000000000000..b600d7ff56e2 --- /dev/null +++ b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/computeschedule.json @@ -0,0 +1,1349 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.ComputeSchedule", + "version": "2024-06-01-preview", + "description": "Microsoft.ComputeSchedule Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + } + ], + "paths": { + "/providers/Microsoft.ComputeSchedule/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_ListMax - generated by [MaximumSet] rule": { + "$ref": "./examples/Operations_List_MaximumSet_Gen.json" + }, + "Operations_ListMax - generated by [MinimumSet] rule": { + "$ref": "./examples/Operations_List_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesCancelOperations": { + "post": { + "operationId": "ScheduledActions_VirtualMachinesCancelOperations", + "description": "virtualMachinesCancelOperations: cancelOperations for a virtual machine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "locationparameter", + "in": "path", + "description": "The location name.", + "required": true, + "type": "string", + "minLength": 1 + }, + { + "name": "requestBody", + "in": "body", + "description": "The request body", + "required": true, + "schema": { + "$ref": "#/definitions/CancelOperationsRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CancelOperationsResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScheduledActions_VirtualMachinesCancelOperations - generated by [MaximumSet] rule": { + "$ref": "./examples/ScheduledActions_VirtualMachinesCancelOperations_MaximumSet_Gen.json" + }, + "ScheduledActions_VirtualMachinesCancelOperations - generated by [MinimumSet] rule": { + "$ref": "./examples/ScheduledActions_VirtualMachinesCancelOperations_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesExecuteDeallocate": { + "post": { + "operationId": "ScheduledActions_VirtualMachinesExecuteDeallocate", + "description": "virtualMachinesExecuteDeallocate: executeDeallocate for a virtual machine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "locationparameter", + "in": "path", + "description": "The location name.", + "required": true, + "type": "string", + "minLength": 1 + }, + { + "name": "requestBody", + "in": "body", + "description": "The request body", + "required": true, + "schema": { + "$ref": "#/definitions/ExecuteDeallocateRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeallocateResourceOperationResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScheduledActions_VirtualMachinesExecuteDeallocate - generated by [MaximumSet] rule": { + "$ref": "./examples/ScheduledActions_VirtualMachinesExecuteDeallocate_MaximumSet_Gen.json" + }, + "ScheduledActions_VirtualMachinesExecuteDeallocate - generated by [MinimumSet] rule": { + "$ref": "./examples/ScheduledActions_VirtualMachinesExecuteDeallocate_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesExecuteHibernate": { + "post": { + "operationId": "ScheduledActions_VirtualMachinesExecuteHibernate", + "description": "virtualMachinesExecuteHibernate: executeHibernate for a virtual machine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "locationparameter", + "in": "path", + "description": "The location name.", + "required": true, + "type": "string", + "minLength": 1 + }, + { + "name": "requestBody", + "in": "body", + "description": "The request body", + "required": true, + "schema": { + "$ref": "#/definitions/ExecuteHibernateRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/HibernateResourceOperationResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScheduledActions_VirtualMachinesExecuteHibernate - generated by [MaximumSet] rule": { + "$ref": "./examples/ScheduledActions_VirtualMachinesExecuteHibernate_MaximumSet_Gen.json" + }, + "ScheduledActions_VirtualMachinesExecuteHibernate - generated by [MinimumSet] rule": { + "$ref": "./examples/ScheduledActions_VirtualMachinesExecuteHibernate_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesExecuteStart": { + "post": { + "operationId": "ScheduledActions_VirtualMachinesExecuteStart", + "description": "virtualMachinesExecuteStart: executeStart for a virtual machine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "locationparameter", + "in": "path", + "description": "The location name.", + "required": true, + "type": "string", + "minLength": 1 + }, + { + "name": "requestBody", + "in": "body", + "description": "The request body", + "required": true, + "schema": { + "$ref": "#/definitions/ExecuteStartRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/StartResourceOperationResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScheduledActions_VirtualMachinesExecuteStart - generated by [MaximumSet] rule": { + "$ref": "./examples/ScheduledActions_VirtualMachinesExecuteStart_MaximumSet_Gen.json" + }, + "ScheduledActions_VirtualMachinesExecuteStart - generated by [MinimumSet] rule": { + "$ref": "./examples/ScheduledActions_VirtualMachinesExecuteStart_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesGetOperationStatus": { + "post": { + "operationId": "ScheduledActions_VirtualMachinesGetOperationStatus", + "description": "virtualMachinesGetOperationStatus: getOperationStatus for a virtual machine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "locationparameter", + "in": "path", + "description": "The location name.", + "required": true, + "type": "string", + "minLength": 1 + }, + { + "name": "requestBody", + "in": "body", + "description": "The request body", + "required": true, + "schema": { + "$ref": "#/definitions/GetOperationStatusRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GetOperationStatusResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScheduledActions_VirtualMachinesGetOperationStatus - generated by [MaximumSet] rule": { + "$ref": "./examples/ScheduledActions_VirtualMachinesGetOperationStatus_MaximumSet_Gen.json" + }, + "ScheduledActions_VirtualMachinesGetOperationStatus - generated by [MinimumSet] rule": { + "$ref": "./examples/ScheduledActions_VirtualMachinesGetOperationStatus_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesSubmitDeallocate": { + "post": { + "operationId": "ScheduledActions_VirtualMachinesSubmitDeallocate", + "description": "virtualMachinesSubmitDeallocate: submitDeallocate for a virtual machine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "locationparameter", + "in": "path", + "description": "The location name.", + "required": true, + "type": "string", + "minLength": 1 + }, + { + "name": "requestBody", + "in": "body", + "description": "The request body", + "required": true, + "schema": { + "$ref": "#/definitions/SubmitDeallocateRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeallocateResourceOperationResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScheduledActions_VirtualMachinesSubmitDeallocate - generated by [MaximumSet] rule": { + "$ref": "./examples/ScheduledActions_VirtualMachinesSubmitDeallocate_MaximumSet_Gen.json" + }, + "ScheduledActions_VirtualMachinesSubmitDeallocate - generated by [MinimumSet] rule": { + "$ref": "./examples/ScheduledActions_VirtualMachinesSubmitDeallocate_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesSubmitHibernate": { + "post": { + "operationId": "ScheduledActions_VirtualMachinesSubmitHibernate", + "description": "virtualMachinesSubmitHibernate: submitHibernate for a virtual machine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "locationparameter", + "in": "path", + "description": "The location name.", + "required": true, + "type": "string", + "minLength": 1 + }, + { + "name": "requestBody", + "in": "body", + "description": "The request body", + "required": true, + "schema": { + "$ref": "#/definitions/SubmitHibernateRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/HibernateResourceOperationResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScheduledActions_VirtualMachinesSubmitHibernate - generated by [MaximumSet] rule": { + "$ref": "./examples/ScheduledActions_VirtualMachinesSubmitHibernate_MaximumSet_Gen.json" + }, + "ScheduledActions_VirtualMachinesSubmitHibernate - generated by [MinimumSet] rule": { + "$ref": "./examples/ScheduledActions_VirtualMachinesSubmitHibernate_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesSubmitStart": { + "post": { + "operationId": "ScheduledActions_VirtualMachinesSubmitStart", + "description": "virtualMachinesSubmitStart: submitStart for a virtual machine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "locationparameter", + "in": "path", + "description": "The location name.", + "required": true, + "type": "string", + "minLength": 1 + }, + { + "name": "requestBody", + "in": "body", + "description": "The request body", + "required": true, + "schema": { + "$ref": "#/definitions/SubmitStartRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/StartResourceOperationResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScheduledActions_VirtualMachinesSubmitStart - generated by [MaximumSet] rule": { + "$ref": "./examples/ScheduledActions_VirtualMachinesSubmitStart_MaximumSet_Gen.json" + }, + "ScheduledActions_VirtualMachinesSubmitStart - generated by [MinimumSet] rule": { + "$ref": "./examples/ScheduledActions_VirtualMachinesSubmitStart_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "CancelOperationsRequest": { + "type": "object", + "description": "This is the request to cancel running operations in scheduled actions using the operation ids", + "properties": { + "operationIds": { + "type": "array", + "description": "The list of operation ids to cancel operations on", + "items": { + "type": "string" + } + }, + "correlationid": { + "type": "string", + "description": "Correlationid item" + } + }, + "required": [ + "operationIds", + "correlationid" + ] + }, + "CancelOperationsResponse": { + "type": "object", + "description": "This is the response from a cancel operations request", + "properties": { + "results": { + "type": "array", + "description": "An array of resource operations that were successfully cancelled", + "items": { + "$ref": "#/definitions/ResourceOperation" + }, + "x-ms-identifiers": [ + "resourceId" + ] + } + }, + "required": [ + "results" + ] + }, + "DeadlineType": { + "type": "string", + "description": "The types of deadlines supported by ScheduledActions", + "enum": [ + "Unknown", + "InitiateAt", + "CompleteBy" + ], + "x-ms-enum": { + "name": "DeadlineType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Default value of Unknown." + }, + { + "name": "InitiateAt", + "value": "InitiateAt", + "description": "Initiate the operation at the given deadline." + }, + { + "name": "CompleteBy", + "value": "CompleteBy", + "description": "Complete the operation by the given deadline." + } + ] + } + }, + "DeallocateResourceOperationResponse": { + "type": "object", + "description": "The response from a deallocate request", + "properties": { + "description": { + "type": "string", + "description": "The description of the operation response" + }, + "type": { + "type": "string", + "description": "The type of resources used in the deallocate request eg virtual machines" + }, + "location": { + "type": "string", + "description": "The location of the deallocate request eg westus", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "results": { + "type": "array", + "description": "The results from the deallocate request if no errors exist", + "items": { + "$ref": "#/definitions/ResourceOperation" + }, + "x-ms-identifiers": [ + "resourceId" + ] + } + }, + "required": [ + "description", + "type", + "location" + ] + }, + "ExecuteDeallocateRequest": { + "type": "object", + "description": "The ExecuteDeallocateRequest request for executeDeallocate operations", + "properties": { + "executionParameters": { + "$ref": "#/definitions/ExecutionParameters", + "description": "The execution parameters for the request" + }, + "resources": { + "$ref": "#/definitions/Resources", + "description": "The resources for the request" + }, + "correlationid": { + "type": "string", + "description": "Correlationid item" + } + }, + "required": [ + "executionParameters", + "resources", + "correlationid" + ] + }, + "ExecuteHibernateRequest": { + "type": "object", + "description": "The ExecuteHibernateRequest request for executeHibernate operations", + "properties": { + "executionParameters": { + "$ref": "#/definitions/ExecutionParameters", + "description": "The execution parameters for the request" + }, + "resources": { + "$ref": "#/definitions/Resources", + "description": "The resources for the request" + }, + "correlationid": { + "type": "string", + "description": "Correlationid item" + } + }, + "required": [ + "executionParameters", + "resources", + "correlationid" + ] + }, + "ExecuteStartRequest": { + "type": "object", + "description": "The ExecuteStartRequest request for executeStart operations", + "properties": { + "executionParameters": { + "$ref": "#/definitions/ExecutionParameters", + "description": "The execution parameters for the request" + }, + "resources": { + "$ref": "#/definitions/Resources", + "description": "The resources for the request" + }, + "correlationid": { + "type": "string", + "description": "Correlationid item" + } + }, + "required": [ + "executionParameters", + "resources", + "correlationid" + ] + }, + "ExecutionParameters": { + "type": "object", + "description": "Extra details needed to run the user's request", + "properties": { + "optimizationPreference": { + "$ref": "#/definitions/OptimizationPreference", + "description": "Details that could optimize the user's request" + }, + "retryPolicy": { + "$ref": "#/definitions/RetryPolicy", + "description": "Retry policy the user can pass" + } + } + }, + "GetOperationStatusRequest": { + "type": "object", + "description": "This is the request to get operation status using operationids", + "properties": { + "operationIds": { + "type": "array", + "description": "The list of operation ids to get the status of", + "items": { + "type": "string" + } + }, + "correlationid": { + "type": "string", + "description": "Correlationid item" + } + }, + "required": [ + "operationIds", + "correlationid" + ] + }, + "GetOperationStatusResponse": { + "type": "object", + "description": "This is the response from a get operations status request", + "properties": { + "results": { + "type": "array", + "description": "An array of resource operations based on their operation ids", + "items": { + "$ref": "#/definitions/ResourceOperation" + }, + "x-ms-identifiers": [ + "resourceId" + ] + } + }, + "required": [ + "results" + ] + }, + "HibernateResourceOperationResponse": { + "type": "object", + "description": "The response from a Hibernate request", + "properties": { + "description": { + "type": "string", + "description": "The description of the operation response" + }, + "type": { + "type": "string", + "description": "The type of resources used in the Hibernate request eg virtual machines" + }, + "location": { + "type": "string", + "description": "The location of the Hibernate request eg westus", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "results": { + "type": "array", + "description": "The results from the Hibernate request if no errors exist", + "items": { + "$ref": "#/definitions/ResourceOperation" + }, + "x-ms-identifiers": [ + "resourceId" + ] + } + }, + "required": [ + "description", + "type", + "location" + ] + }, + "OperationState": { + "type": "string", + "description": "Values that define the states of operations in Scheduled Actions", + "enum": [ + "Unknown", + "PendingScheduling", + "Scheduled", + "PendingExecution", + "Executing", + "Succeeded", + "Failed", + "Cancelled", + "Blocked" + ], + "x-ms-enum": { + "name": "OperationState", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "The default value for the operation state enum" + }, + { + "name": "PendingScheduling", + "value": "PendingScheduling", + "description": "Operations that are pending scheduling" + }, + { + "name": "Scheduled", + "value": "Scheduled", + "description": "Operations that have been scheduled" + }, + { + "name": "PendingExecution", + "value": "PendingExecution", + "description": "Operations that are waiting to be executed" + }, + { + "name": "Executing", + "value": "Executing", + "description": "Operations that are in the process of being executed" + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Operations that suceeded" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Operations that have failed" + }, + { + "name": "Cancelled", + "value": "Cancelled", + "description": "Operations that have been cancelled by the user" + }, + { + "name": "Blocked", + "value": "Blocked", + "description": "Operations that are blocked" + } + ] + } + }, + "OptimizationPreference": { + "type": "string", + "description": "The preferences customers can select to optimize their requests to ScheduledActions", + "enum": [ + "Cost", + "Availability", + "CostAvailabilityBalanced" + ], + "x-ms-enum": { + "name": "OptimizationPreference", + "modelAsString": true, + "values": [ + { + "name": "Cost", + "value": "Cost", + "description": "Optimize while considering cost savings" + }, + { + "name": "Availability", + "value": "Availability", + "description": "Optimize while considering availability of resources" + }, + { + "name": "CostAvailabilityBalanced", + "value": "CostAvailabilityBalanced", + "description": "Optimize while considering a balance of cost and availability" + } + ] + } + }, + "ResourceOperation": { + "type": "object", + "description": "High level response from an operation on a resource", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "description": "Unique identifier for the resource involved in the operation, eg ArmId" + }, + "errorCode": { + "type": "string", + "description": "Resource level error code if it exists" + }, + "errorDetails": { + "type": "string", + "description": "Resource level error details if they exist" + }, + "operation": { + "$ref": "#/definitions/ResourceOperationDetails", + "description": "Details of the operation performed on a resource" + } + } + }, + "ResourceOperationDetails": { + "type": "object", + "description": "The details of a response from an operation on a resource", + "properties": { + "operationId": { + "type": "string", + "description": "Operation identifier for the unique operation" + }, + "resourceId": { + "type": "string", + "format": "arm-id", + "description": "Unique identifier for the resource involved in the operation, eg ArmId" + }, + "opType": { + "type": "string", + "description": "Type of operation performed on the resources", + "default": "Unknown", + "enum": [ + "Unknown", + "Start", + "Deallocate", + "Hibernate" + ], + "x-ms-enum": { + "name": "ResourceOperationType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "The default value for this enum type" + }, + { + "name": "Start", + "value": "Start", + "description": "Start operations on the resources" + }, + { + "name": "Deallocate", + "value": "Deallocate", + "description": "Deallocate operations on the resources" + }, + { + "name": "Hibernate", + "value": "Hibernate", + "description": "Hibernate operations on the resources" + } + ] + }, + "x-ms-enum.modelAsString": true + }, + "subscriptionId": { + "type": "string", + "description": "Subscription id attached to the request" + }, + "deadline": { + "type": "string", + "format": "date-time", + "description": "Deadline for the operation" + }, + "deadlineType": { + "type": "string", + "description": "Type of deadline of the operation", + "default": "Unknown", + "enum": [ + "Unknown", + "InitiateAt", + "CompleteBy" + ], + "x-ms-enum": { + "name": "DeadlineType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Default value of Unknown." + }, + { + "name": "InitiateAt", + "value": "InitiateAt", + "description": "Initiate the operation at the given deadline." + }, + { + "name": "CompleteBy", + "value": "CompleteBy", + "description": "Complete the operation by the given deadline." + } + ] + }, + "x-ms-enum.modelAsString": true + }, + "state": { + "type": "string", + "description": "Current state of the operation", + "default": "Unknown", + "enum": [ + "Unknown", + "PendingScheduling", + "Scheduled", + "PendingExecution", + "Executing", + "Succeeded", + "Failed", + "Cancelled", + "Blocked" + ], + "x-ms-enum": { + "name": "OperationState", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "The default value for the operation state enum" + }, + { + "name": "PendingScheduling", + "value": "PendingScheduling", + "description": "Operations that are pending scheduling" + }, + { + "name": "Scheduled", + "value": "Scheduled", + "description": "Operations that have been scheduled" + }, + { + "name": "PendingExecution", + "value": "PendingExecution", + "description": "Operations that are waiting to be executed" + }, + { + "name": "Executing", + "value": "Executing", + "description": "Operations that are in the process of being executed" + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Operations that suceeded" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Operations that have failed" + }, + { + "name": "Cancelled", + "value": "Cancelled", + "description": "Operations that have been cancelled by the user" + }, + { + "name": "Blocked", + "value": "Blocked", + "description": "Operations that are blocked" + } + ] + }, + "x-ms-enum.modelAsString": true + }, + "timeZone": { + "type": "string", + "description": "Timezone for the operation" + }, + "resourceOperationError": { + "$ref": "#/definitions/ResourceOperationError", + "description": "Operation level errors if they exist" + }, + "completedAt": { + "type": "string", + "format": "date-time", + "description": "Time the operation was complete if errors are null" + }, + "retryPolicy": { + "$ref": "#/definitions/RetryPolicy", + "description": "Retry policy the user can pass" + } + }, + "required": [ + "operationId", + "resourceId", + "opType", + "subscriptionId", + "deadline", + "deadlineType", + "state" + ] + }, + "ResourceOperationError": { + "type": "object", + "description": "These describe errors that occur at the resource level", + "properties": { + "errorCode": { + "type": "string", + "description": "Code for the error eg 404, 500" + }, + "errorDetails": { + "type": "string", + "description": "Detailed message about the error" + } + }, + "required": [ + "errorCode", + "errorDetails" + ] + }, + "ResourceOperationType": { + "type": "string", + "description": "The kind of operation types that can be performed on resources using ScheduledActions", + "enum": [ + "Unknown", + "Start", + "Deallocate", + "Hibernate" + ], + "x-ms-enum": { + "name": "ResourceOperationType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "The default value for this enum type" + }, + { + "name": "Start", + "value": "Start", + "description": "Start operations on the resources" + }, + { + "name": "Deallocate", + "value": "Deallocate", + "description": "Deallocate operations on the resources" + }, + { + "name": "Hibernate", + "value": "Hibernate", + "description": "Hibernate operations on the resources" + } + ] + } + }, + "Resources": { + "type": "object", + "description": "The resources needed for the user request", + "properties": { + "ids": { + "type": "array", + "description": "The resource ids used for the request", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource." + } + } + }, + "required": [ + "ids" + ] + }, + "RetryPolicy": { + "type": "object", + "description": "The retry policy for the user request", + "properties": { + "retryCount": { + "type": "integer", + "format": "int32", + "description": "Retry count for user request" + }, + "retryWindowInMinutes": { + "type": "integer", + "format": "int32", + "description": "Retry window in minutes for user request" + } + } + }, + "Schedule": { + "type": "object", + "description": "The schedule details for the user request", + "properties": { + "deadLine": { + "type": "string", + "format": "date-time", + "description": "The deadline for the operation" + }, + "timeZone": { + "type": "string", + "description": "The timezone for the operation" + }, + "deadlineType": { + "type": "string", + "description": "The deadlinetype of the operation, this can either be InitiateAt or CompleteBy", + "default": "Unknown", + "enum": [ + "Unknown", + "InitiateAt", + "CompleteBy" + ], + "x-ms-enum": { + "name": "DeadlineType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Default value of Unknown." + }, + { + "name": "InitiateAt", + "value": "InitiateAt", + "description": "Initiate the operation at the given deadline." + }, + { + "name": "CompleteBy", + "value": "CompleteBy", + "description": "Complete the operation by the given deadline." + } + ] + }, + "x-ms-enum.modelAsString": true + } + }, + "required": [ + "deadLine", + "timeZone", + "deadlineType" + ] + }, + "StartResourceOperationResponse": { + "type": "object", + "description": "The response from a start request", + "properties": { + "description": { + "type": "string", + "description": "The description of the operation response" + }, + "type": { + "type": "string", + "description": "The type of resources used in the start request eg virtual machines" + }, + "location": { + "type": "string", + "description": "The location of the start request eg westus", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "results": { + "type": "array", + "description": "The results from the start request if no errors exist", + "items": { + "$ref": "#/definitions/ResourceOperation" + }, + "x-ms-identifiers": [ + "resourceId" + ] + } + }, + "required": [ + "description", + "type", + "location" + ] + }, + "SubmitDeallocateRequest": { + "type": "object", + "description": "The deallocate request for resources", + "properties": { + "schedule": { + "$ref": "#/definitions/Schedule", + "description": "The schedule for the request" + }, + "executionParameters": { + "$ref": "#/definitions/ExecutionParameters", + "description": "The execution parameters for the request" + }, + "resources": { + "$ref": "#/definitions/Resources", + "description": "The resources for the request" + }, + "correlationid": { + "type": "string", + "description": "Correlationid item" + } + }, + "required": [ + "schedule", + "executionParameters", + "resources", + "correlationid" + ] + }, + "SubmitHibernateRequest": { + "type": "object", + "description": "This is the request for hibernate", + "properties": { + "schedule": { + "$ref": "#/definitions/Schedule", + "description": "The schedule for the request" + }, + "executionParameters": { + "$ref": "#/definitions/ExecutionParameters", + "description": "The execution parameters for the request" + }, + "resources": { + "$ref": "#/definitions/Resources", + "description": "The resources for the request" + }, + "correlationid": { + "type": "string", + "description": "Correlationid item" + } + }, + "required": [ + "schedule", + "executionParameters", + "resources", + "correlationid" + ] + }, + "SubmitStartRequest": { + "type": "object", + "description": "This is the request for start", + "properties": { + "schedule": { + "$ref": "#/definitions/Schedule", + "description": "The schedule for the request" + }, + "executionParameters": { + "$ref": "#/definitions/ExecutionParameters", + "description": "The execution parameters for the request" + }, + "resources": { + "$ref": "#/definitions/Resources", + "description": "The resources for the request" + }, + "correlationid": { + "type": "string", + "description": "Correlationid item" + } + }, + "required": [ + "schedule", + "executionParameters", + "resources", + "correlationid" + ] + } + }, + "parameters": {} +} diff --git a/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/Operations_List_MaximumSet_Gen.json b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..611fd9cdde51 --- /dev/null +++ b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_ListMax - generated by [MaximumSet] rule", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ennucrkvxylbsli", + "isDataAction": true, + "display": { + "provider": "brssqjspiggui", + "resource": "aujpznmlzjgsyynq", + "operation": "sjldnlycokfcufegoktphlwpvxkx", + "description": "deurosfshmtoujzbhldvflxxkz" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/Operations_List_MinimumSet_Gen.json b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/Operations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..a354a7ed854b --- /dev/null +++ b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/Operations_List_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Operations_ListMax - generated by [MinimumSet] rule", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesCancelOperations_MaximumSet_Gen.json b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesCancelOperations_MaximumSet_Gen.json new file mode 100644 index 000000000000..f55b5052cb2d --- /dev/null +++ b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesCancelOperations_MaximumSet_Gen.json @@ -0,0 +1,47 @@ +{ + "title": "ScheduledActions_VirtualMachinesCancelOperations - generated by [MaximumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesCancelOperations", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "juzzyocyywfxwakqmgahb", + "requestBody": { + "operationIds": [ + "23480d2f-1dca-4610-afb4-dd25eec1f34r" + ], + "correlationid": "01080d2f-1dca-4610-afb4-dd25eec1f3c1" + } + }, + "responses": { + "200": { + "body": { + "results": [ + { + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource1", + "errorCode": "pliurpaykwv", + "errorDetails": "mbqwkpxl", + "operation": { + "operationId": "23480d2f-1dca-4610-afb4-dd25eec1f34", + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource1", + "opType": "Unknown", + "subscriptionId": "52C81249-550F-459E-9B6E-5BAB6EE62227", + "deadline": "2024-07-12T18:06:52.974Z", + "deadlineType": "Unknown", + "state": "Unknown", + "timeZone": "lsoalxijilbrqum", + "resourceOperationError": { + "errorCode": "fticyqukvkillwd", + "errorDetails": "yimgxqrkp" + }, + "completedAt": "2024-07-12T18:06:52.974Z", + "retryPolicy": { + "retryCount": 30, + "retryWindowInMinutes": 27 + } + } + } + ] + } + } + } +} diff --git a/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesCancelOperations_MinimumSet_Gen.json b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesCancelOperations_MinimumSet_Gen.json new file mode 100644 index 000000000000..de6dac36c786 --- /dev/null +++ b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesCancelOperations_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "ScheduledActions_VirtualMachinesCancelOperations - generated by [MinimumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesCancelOperations", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "lzrfledwkzrp", + "requestBody": { + "operationIds": [ + "01080d2f-1dca-4610-afb4-dd25eec1f3df" + ], + "correlationid": "01080d2f-1dca-4610-afb4-dd25eec1f3c1" + } + }, + "responses": { + "200": { + "body": { + "results": [ + {} + ] + } + } + } +} diff --git a/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesExecuteDeallocate_MaximumSet_Gen.json b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesExecuteDeallocate_MaximumSet_Gen.json new file mode 100644 index 000000000000..9e5039c4a1cb --- /dev/null +++ b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesExecuteDeallocate_MaximumSet_Gen.json @@ -0,0 +1,59 @@ +{ + "title": "ScheduledActions_VirtualMachinesExecuteDeallocate - generated by [MaximumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesExecuteDeallocate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "dspazcfydfdhxer", + "requestBody": { + "executionParameters": { + "optimizationPreference": "Cost", + "retryPolicy": { + "retryCount": 30, + "retryWindowInMinutes": 27 + } + }, + "resources": { + "ids": [ + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource2" + ] + }, + "correlationid": "01080d2f-1dca-4610-afb4-dd25eddf1f3c1" + } + }, + "responses": { + "200": { + "body": { + "type": "eokrhxypminzcgplibblmwojvjd", + "location": "qbbvrdisvjgxirnzdvdsodkt", + "results": [ + { + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource2", + "errorCode": "pliurpaykwv", + "errorDetails": "mbqwkpxl", + "operation": { + "operationId": "23480d2f-1dca-4610-afb4-dd25eec1f34", + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource2", + "opType": "Unknown", + "subscriptionId": "52C81249-550F-459E-9B6E-5BAB6EE62227", + "deadline": "2024-07-12T18:06:52.974Z", + "deadlineType": "Unknown", + "state": "Unknown", + "timeZone": "lsoalxijilbrqum", + "resourceOperationError": { + "errorCode": "fticyqukvkillwd", + "errorDetails": "yimgxqrkp" + }, + "completedAt": "2024-07-12T18:06:52.974Z", + "retryPolicy": { + "retryCount": 30, + "retryWindowInMinutes": 27 + } + } + } + ], + "description": "lydvixvsrotpqrztll" + } + } + } +} diff --git a/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesExecuteDeallocate_MinimumSet_Gen.json b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesExecuteDeallocate_MinimumSet_Gen.json new file mode 100644 index 000000000000..a7b15939d228 --- /dev/null +++ b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesExecuteDeallocate_MinimumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "title": "ScheduledActions_VirtualMachinesExecuteDeallocate - generated by [MinimumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesExecuteDeallocate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "zanmxbtvfqzqqtywqtnslqxfk", + "requestBody": { + "executionParameters": {}, + "resources": { + "ids": [ + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource2" + ] + }, + "correlationid": "01080d2f-1dca-4610-afb4-dd25eec1f3c1" + } + }, + "responses": { + "200": { + "body": { + "type": "eokrhxypminzcgplibblmwojvjd", + "location": "qbbvrdisvjgxirnzdvdsodkt", + "description": "anxrfkvievuotqdlmowhn" + } + } + } +} diff --git a/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesExecuteHibernate_MaximumSet_Gen.json b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesExecuteHibernate_MaximumSet_Gen.json new file mode 100644 index 000000000000..31c5212a8a00 --- /dev/null +++ b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesExecuteHibernate_MaximumSet_Gen.json @@ -0,0 +1,59 @@ +{ + "title": "ScheduledActions_VirtualMachinesExecuteHibernate - generated by [MaximumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesExecuteHibernate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "az", + "requestBody": { + "executionParameters": { + "optimizationPreference": "Cost", + "retryPolicy": { + "retryCount": 30, + "retryWindowInMinutes": 27 + } + }, + "resources": { + "ids": [ + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3" + ] + }, + "correlationid": "01080d2f-1dca-4610-afb4-dd25eec1f3c1" + } + }, + "responses": { + "200": { + "body": { + "type": "mkmgbfpkiudefzhdppgjmqztx", + "location": "rvlnzczpesuvusbmbcjctzcinzlr", + "results": [ + { + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3", + "errorCode": "pliurpaykwv", + "errorDetails": "mbqwkpxl", + "operation": { + "operationId": "23480d2f-1dca-4610-afb4-dd25eec1f34", + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3", + "opType": "Unknown", + "subscriptionId": "52C81249-550F-459E-9B6E-5BAB6EE62227", + "deadline": "2024-07-12T18:06:52.974Z", + "deadlineType": "Unknown", + "state": "Unknown", + "timeZone": "lsoalxijilbrqum", + "resourceOperationError": { + "errorCode": "fticyqukvkillwd", + "errorDetails": "yimgxqrkp" + }, + "completedAt": "2024-07-12T18:06:52.974Z", + "retryPolicy": { + "retryCount": 30, + "retryWindowInMinutes": 27 + } + } + } + ], + "description": "hnyafndkyssbbeyjzhndexmhwdqe" + } + } + } +} diff --git a/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesExecuteHibernate_MinimumSet_Gen.json b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesExecuteHibernate_MinimumSet_Gen.json new file mode 100644 index 000000000000..f4a339a0a496 --- /dev/null +++ b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesExecuteHibernate_MinimumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "title": "ScheduledActions_VirtualMachinesExecuteHibernate - generated by [MinimumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesExecuteHibernate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "oowpasegipasucmq", + "requestBody": { + "executionParameters": {}, + "resources": { + "ids": [ + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3" + ] + }, + "correlationid": "01080d2f-1dca-4610-afb4-dd25eec1f3c1" + } + }, + "responses": { + "200": { + "body": { + "type": "mkmgbfpkiudefzhdppgjmqztx", + "location": "rvlnzczpesuvusbmbcjctzcinzlr", + "description": "dgliqjj" + } + } + } +} diff --git a/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesExecuteStart_MaximumSet_Gen.json b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesExecuteStart_MaximumSet_Gen.json new file mode 100644 index 000000000000..e7da1e9585f3 --- /dev/null +++ b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesExecuteStart_MaximumSet_Gen.json @@ -0,0 +1,59 @@ +{ + "title": "ScheduledActions_VirtualMachinesExecuteStart - generated by [MaximumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesExecuteStart", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "cwkjesffxrcxaxbnvqumkjbbymwlpe", + "requestBody": { + "executionParameters": { + "optimizationPreference": "Cost", + "retryPolicy": { + "retryCount": 30, + "retryWindowInMinutes": 27 + } + }, + "resources": { + "ids": [ + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource4" + ] + }, + "correlationid": "23230d2f-1dca-4610-afb4-dd25eec1f34" + } + }, + "responses": { + "200": { + "body": { + "type": "gxmnjtgu", + "location": "uvlidhowwv", + "results": [ + { + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource4", + "errorCode": "pliurpaykwv", + "errorDetails": "mbqwkpxl", + "operation": { + "operationId": "23480d2f-1dca-4610-afb4-dd25eec1f34", + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource4", + "opType": "Unknown", + "subscriptionId": "52C81249-550F-459E-9B6E-5BAB6EE62227", + "deadline": "2024-07-12T18:06:52.974Z", + "deadlineType": "Unknown", + "state": "Unknown", + "timeZone": "lsoalxijilbrqum", + "resourceOperationError": { + "errorCode": "fticyqukvkillwd", + "errorDetails": "yimgxqrkp" + }, + "completedAt": "2024-07-12T18:06:52.974Z", + "retryPolicy": { + "retryCount": 30, + "retryWindowInMinutes": 27 + } + } + } + ], + "description": "dtwditzxiiwiqvbaylczcfnvo" + } + } + } +} diff --git a/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesExecuteStart_MinimumSet_Gen.json b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesExecuteStart_MinimumSet_Gen.json new file mode 100644 index 000000000000..24c06ac07b57 --- /dev/null +++ b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesExecuteStart_MinimumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "title": "ScheduledActions_VirtualMachinesExecuteStart - generated by [MinimumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesExecuteStart", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "puguskuewwqfrdkmwrnzb", + "requestBody": { + "executionParameters": {}, + "resources": { + "ids": [ + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource4" + ] + }, + "correlationid": "01080d2f-1dca-4610-afb4-dd25eec1f3c1" + } + }, + "responses": { + "200": { + "body": { + "type": "gxmnjtgu", + "location": "uvlidhowwv", + "description": "p" + } + } + } +} diff --git a/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesGetOperationStatus_MaximumSet_Gen.json b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesGetOperationStatus_MaximumSet_Gen.json new file mode 100644 index 000000000000..d06fa9e2558a --- /dev/null +++ b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesGetOperationStatus_MaximumSet_Gen.json @@ -0,0 +1,47 @@ +{ + "title": "ScheduledActions_VirtualMachinesGetOperationStatus - generated by [MaximumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesGetOperationStatus", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "lfmx", + "requestBody": { + "operationIds": [ + "23480d2f-1dca-4610-afb4-dd25eec1f34" + ], + "correlationid": "23519o2f-1dca-4610-afb4-dd25eec1f34" + } + }, + "responses": { + "200": { + "body": { + "results": [ + { + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource5", + "errorCode": "pliurpaykwv", + "errorDetails": "mbqwkpxl", + "operation": { + "operationId": "23480d2f-1dca-4610-afb4-dd25eec1f34", + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource5", + "opType": "Unknown", + "subscriptionId": "52C81249-550F-459E-9B6E-5BAB6EE62227", + "deadline": "2024-07-12T18:06:52.974Z", + "deadlineType": "Unknown", + "state": "Unknown", + "timeZone": "lsoalxijilbrqum", + "resourceOperationError": { + "errorCode": "fticyqukvkillwd", + "errorDetails": "yimgxqrkp" + }, + "completedAt": "2024-07-12T18:06:52.974Z", + "retryPolicy": { + "retryCount": 30, + "retryWindowInMinutes": 27 + } + } + } + ] + } + } + } +} diff --git a/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesGetOperationStatus_MinimumSet_Gen.json b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesGetOperationStatus_MinimumSet_Gen.json new file mode 100644 index 000000000000..33b3e6f2b009 --- /dev/null +++ b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesGetOperationStatus_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "ScheduledActions_VirtualMachinesGetOperationStatus - generated by [MinimumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesGetOperationStatus", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "csay", + "requestBody": { + "operationIds": [ + "01080d2f-1dca-4610-afb4-dd25eec1f3df" + ], + "correlationid": "01080d2f-1dca-4610-afb4-dd25eec1f3c1" + } + }, + "responses": { + "200": { + "body": { + "results": [ + {} + ] + } + } + } +} diff --git a/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesSubmitDeallocate_MaximumSet_Gen.json b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesSubmitDeallocate_MaximumSet_Gen.json new file mode 100644 index 000000000000..ec877e8801b9 --- /dev/null +++ b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesSubmitDeallocate_MaximumSet_Gen.json @@ -0,0 +1,64 @@ +{ + "title": "ScheduledActions_VirtualMachinesSubmitDeallocate - generated by [MaximumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesSubmitDeallocate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "nynqafujbcjyrtqve", + "requestBody": { + "schedule": { + "deadLine": "2024-07-12T18:06:53.361Z", + "timeZone": "zlcujrtgxtgyik", + "deadlineType": "Unknown" + }, + "executionParameters": { + "optimizationPreference": "Cost", + "retryPolicy": { + "retryCount": 30, + "retryWindowInMinutes": 27 + } + }, + "resources": { + "ids": [ + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource2" + ] + }, + "correlationid": "23519o2f-1dca-4610-afb4-dd25eec1f34" + } + }, + "responses": { + "200": { + "body": { + "type": "eokrhxypminzcgplibblmwojvjd", + "location": "qbbvrdisvjgxirnzdvdsodkt", + "results": [ + { + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource2", + "errorCode": "pliurpaykwv", + "errorDetails": "mbqwkpxl", + "operation": { + "operationId": "23480d2f-1dca-4610-afb4-dd25eec1f34", + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource2", + "opType": "Unknown", + "subscriptionId": "52C81249-550F-459E-9B6E-5BAB6EE62227", + "deadline": "2024-07-12T18:06:52.974Z", + "deadlineType": "Unknown", + "state": "Unknown", + "timeZone": "lsoalxijilbrqum", + "resourceOperationError": { + "errorCode": "fticyqukvkillwd", + "errorDetails": "yimgxqrkp" + }, + "completedAt": "2024-07-12T18:06:52.974Z", + "retryPolicy": { + "retryCount": 30, + "retryWindowInMinutes": 27 + } + } + } + ], + "description": "lydvixvsrotpqrztll" + } + } + } +} diff --git a/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesSubmitDeallocate_MinimumSet_Gen.json b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesSubmitDeallocate_MinimumSet_Gen.json new file mode 100644 index 000000000000..41abbf5b1906 --- /dev/null +++ b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesSubmitDeallocate_MinimumSet_Gen.json @@ -0,0 +1,32 @@ +{ + "title": "ScheduledActions_VirtualMachinesSubmitDeallocate - generated by [MinimumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesSubmitDeallocate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "gfuns", + "requestBody": { + "schedule": { + "deadLine": "2024-07-12T18:06:53.361Z", + "timeZone": "zlcujrtgxtgyik", + "deadlineType": "Unknown" + }, + "executionParameters": {}, + "resources": { + "ids": [ + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource2" + ] + }, + "correlationid": "01080d2f-1dca-4610-afb4-dd25eec1f3c1" + } + }, + "responses": { + "200": { + "body": { + "type": "eokrhxypminzcgplibblmwojvjd", + "location": "qbbvrdisvjgxirnzdvdsodkt", + "description": "anxrfkvievuotqdlmowhn" + } + } + } +} diff --git a/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesSubmitHibernate_MaximumSet_Gen.json b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesSubmitHibernate_MaximumSet_Gen.json new file mode 100644 index 000000000000..638ac84434bd --- /dev/null +++ b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesSubmitHibernate_MaximumSet_Gen.json @@ -0,0 +1,64 @@ +{ + "title": "ScheduledActions_VirtualMachinesSubmitHibernate - generated by [MaximumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesSubmitHibernate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "jrulwh", + "requestBody": { + "schedule": { + "deadLine": "2024-07-12T18:06:53.361Z", + "timeZone": "zlcujrtgxtgyik", + "deadlineType": "Unknown" + }, + "executionParameters": { + "optimizationPreference": "Cost", + "retryPolicy": { + "retryCount": 30, + "retryWindowInMinutes": 27 + } + }, + "resources": { + "ids": [ + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3" + ] + }, + "correlationid": "23519o2f-1dca-4610-afb4-dd25eec1f34" + } + }, + "responses": { + "200": { + "body": { + "type": "mkmgbfpkiudefzhdppgjmqztx", + "location": "rvlnzczpesuvusbmbcjctzcinzlr", + "results": [ + { + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3", + "errorCode": "pliurpaykwv", + "errorDetails": "mbqwkpxl", + "operation": { + "operationId": "01080d2f-1dca-4610-afb4-dd25eec1f3c1", + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3", + "opType": "Unknown", + "subscriptionId": "52C81249-550F-459E-9B6E-5BAB6EE62227", + "deadline": "2024-07-12T18:06:52.974Z", + "deadlineType": "Unknown", + "state": "Unknown", + "timeZone": "lsoalxijilbrqum", + "resourceOperationError": { + "errorCode": "fticyqukvkillwd", + "errorDetails": "yimgxqrkp" + }, + "completedAt": "2024-07-12T18:06:52.974Z", + "retryPolicy": { + "retryCount": 30, + "retryWindowInMinutes": 27 + } + } + } + ], + "description": "hnyafndkyssbbeyjzhndexmhwdqe" + } + } + } +} diff --git a/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesSubmitHibernate_MinimumSet_Gen.json b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesSubmitHibernate_MinimumSet_Gen.json new file mode 100644 index 000000000000..ecca9d847c66 --- /dev/null +++ b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesSubmitHibernate_MinimumSet_Gen.json @@ -0,0 +1,32 @@ +{ + "title": "ScheduledActions_VirtualMachinesSubmitHibernate - generated by [MinimumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesSubmitHibernate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "pgedjeucp", + "requestBody": { + "schedule": { + "deadLine": "2024-07-12T18:06:53.361Z", + "timeZone": "zlcujrtgxtgyik", + "deadlineType": "Unknown" + }, + "executionParameters": {}, + "resources": { + "ids": [ + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource3" + ] + }, + "correlationid": "01080d2f-1dca-4610-afb4-dd25eec1f3c1" + } + }, + "responses": { + "200": { + "body": { + "type": "mkmgbfpkiudefzhdppgjmqztx", + "location": "rvlnzczpesuvusbmbcjctzcinzlr", + "description": "dgliqjj" + } + } + } +} diff --git a/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesSubmitStart_MaximumSet_Gen.json b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesSubmitStart_MaximumSet_Gen.json new file mode 100644 index 000000000000..00a63cb04d9e --- /dev/null +++ b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesSubmitStart_MaximumSet_Gen.json @@ -0,0 +1,64 @@ +{ + "title": "ScheduledActions_VirtualMachinesSubmitStart - generated by [MaximumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesSubmitStart", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "pxbvjarpyzhastophdyu", + "requestBody": { + "schedule": { + "deadLine": "2024-07-12T18:06:53.361Z", + "timeZone": "zlcujrtgxtgyik", + "deadlineType": "Unknown" + }, + "executionParameters": { + "optimizationPreference": "Cost", + "retryPolicy": { + "retryCount": 30, + "retryWindowInMinutes": 27 + } + }, + "resources": { + "ids": [ + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource4" + ] + }, + "correlationid": "23480d2f-1dca-4610-afb4-dd25eec1f34" + } + }, + "responses": { + "200": { + "body": { + "type": "gxmnjtgu", + "location": "uvlidhowwv", + "results": [ + { + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource4", + "errorCode": "pliurpaykwv", + "errorDetails": "mbqwkpxl", + "operation": { + "operationId": "01080d2f-1dca-4610-afb4-dd25eec1f3c1", + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource4", + "opType": "Unknown", + "subscriptionId": "52C81249-550F-459E-9B6E-5BAB6EE62227", + "deadline": "2024-07-12T18:06:52.974Z", + "deadlineType": "Unknown", + "state": "Unknown", + "timeZone": "lsoalxijilbrqum", + "resourceOperationError": { + "errorCode": "fticyqukvkillwd", + "errorDetails": "yimgxqrkp" + }, + "completedAt": "2024-07-12T18:06:52.974Z", + "retryPolicy": { + "retryCount": 30, + "retryWindowInMinutes": 27 + } + } + } + ], + "description": "dtwditzxiiwiqvbaylczcfnvo" + } + } + } +} diff --git a/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesSubmitStart_MinimumSet_Gen.json b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesSubmitStart_MinimumSet_Gen.json new file mode 100644 index 000000000000..0715b595ba59 --- /dev/null +++ b/specification/computeschedule/resource-manager/Microsoft.ComputeSchedule/preview/2024-06-01-preview/examples/ScheduledActions_VirtualMachinesSubmitStart_MinimumSet_Gen.json @@ -0,0 +1,32 @@ +{ + "title": "ScheduledActions_VirtualMachinesSubmitStart - generated by [MinimumSet] rule", + "operationId": "ScheduledActions_VirtualMachinesSubmitStart", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "DE84A209-5715-43E7-BC76-3E208A9A82C5", + "locationparameter": "vkrnfmvxrtbzgeyqmhtney", + "requestBody": { + "schedule": { + "deadLine": "2024-07-12T18:06:53.361Z", + "timeZone": "zlcujrtgxtgyik", + "deadlineType": "Unknown" + }, + "executionParameters": {}, + "resources": { + "ids": [ + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Compute/virtualMachines/testResource4" + ] + }, + "correlationid": "01080d2f-1dca-4610-afb4-dd25eec1f3c1" + } + }, + "responses": { + "200": { + "body": { + "type": "gxmnjtgu", + "location": "uvlidhowwv", + "description": "p" + } + } + } +} diff --git a/specification/computeschedule/resource-manager/readme.az.md b/specification/computeschedule/resource-manager/readme.az.md new file mode 100644 index 000000000000..54e21d2d72a0 --- /dev/null +++ b/specification/computeschedule/resource-manager/readme.az.md @@ -0,0 +1,28 @@ +## AZ + +These settings apply only when `--az` is specified on the command line. + +For new Resource Provider. It is highly recommended to onboard Azure CLI extensions. There's no differences in terms of customer usage. + +``` yaml $(az) && $(target-mode) != 'core' +az: + extensions: computeschedule + namespace: azure.mgmt.computeschedule + package-name: azure-mgmt-computeschedule +az-output-folder: $(azure-cli-extension-folder)/src/computeschedule +python-sdk-output-folder: "$(az-output-folder)/azext_computeschedule/vendored_sdks/computeschedule" +# add additional configuration here specific for Azure CLI +# refer to the faq.md for more details +``` + + + +This is for command modules that already in azure cli main repo. +``` yaml $(az) && $(target-mode) == 'core' +az: + extensions: computeschedule + namespace: azure.mgmt.computeschedule + package-name: azure-mgmt-computeschedule +az-output-folder: $(azure-cli-folder)/src/azure-cli/azure/cli/command_modules/computeschedule +python-sdk-output-folder: "$(az-output-folder)/vendored_sdks/computeschedule" +``` \ No newline at end of file diff --git a/specification/computeschedule/resource-manager/readme.cli.md b/specification/computeschedule/resource-manager/readme.cli.md new file mode 100644 index 000000000000..c6cf6ad37ea4 --- /dev/null +++ b/specification/computeschedule/resource-manager/readme.cli.md @@ -0,0 +1 @@ +## CLI Common Settings for all the command line tools \ No newline at end of file diff --git a/specification/computeschedule/resource-manager/readme.csharp.md b/specification/computeschedule/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..9c41bc65fbab --- /dev/null +++ b/specification/computeschedule/resource-manager/readme.csharp.md @@ -0,0 +1,15 @@ +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true + client-side-validation: false + namespace: Microsoft.ComputeSchedule + output-folder: $(csharp-sdks-folder)/computeschedule/management/Microsoft.ComputeSchedule/GeneratedProtocol +``` diff --git a/specification/computeschedule/resource-manager/readme.go.md b/specification/computeschedule/resource-manager/readme.go.md new file mode 100644 index 000000000000..1e706f6a8ae5 --- /dev/null +++ b/specification/computeschedule/resource-manager/readme.go.md @@ -0,0 +1,11 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) && $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/resourcemanager/computeschedule/armcomputeschedule +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) +``` diff --git a/specification/computeschedule/resource-manager/readme.md b/specification/computeschedule/resource-manager/readme.md new file mode 100644 index 000000000000..f11f9d858d3d --- /dev/null +++ b/specification/computeschedule/resource-manager/readme.md @@ -0,0 +1,79 @@ +# computeschedule + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for computeschedule. + +## Getting Started + +To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: + +> `autorest readme.md` + +To see additional help and options, run: + +> `autorest --help` + +For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. + +--- + +## Configuration + +### Basic Information + +These are the global settings for the computeschedule. + +```yaml +openapi-subtype: rpaas +openapi-type: arm +tag: package-2024-06-01-preview +``` + +### Tag: package-2024-06-01-preview + +These settings apply only when `--tag=package-2024-06-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-06-01-preview' +input-file: + - Microsoft.ComputeSchedule/preview/2024-06-01-preview/computeschedule.json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-resource-manager-schemas + - repo: azure-cli-extensions + - repo: azure-powershell +``` +## Az + +See configuration in [readme.az.md](./readme.az.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) diff --git a/specification/computeschedule/resource-manager/readme.python.md b/specification/computeschedule/resource-manager/readme.python.md new file mode 100644 index 000000000000..3ee8a4d6ec4a --- /dev/null +++ b/specification/computeschedule/resource-manager/readme.python.md @@ -0,0 +1,18 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(python) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-computeschedule +namespace: azure.mgmt.computeschedule +package-version: 1.0.0b1 +clear-output-folder: true +``` + +``` yaml $(python) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/computeschedule/azure-mgmt-computeschedule/azure/mgmt/computeschedule +``` diff --git a/specification/computeschedule/resource-manager/readme.typescript.md b/specification/computeschedule/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..c784c6bcfc8b --- /dev/null +++ b/specification/computeschedule/resource-manager/readme.typescript.md @@ -0,0 +1,14 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/arm-computeschedule" + output-folder: "$(typescript-sdks-folder)/sdk/computeschedule/arm-computeschedule" + payload-flattening-threshold: 1 + clear-output-folder: true + generate-metadata: true +``` diff --git a/specification/containerservice/Fleet.Management/fleetmember.tsp b/specification/containerservice/Fleet.Management/fleetmember.tsp index 970f6dd7cd42..2efbbc15380f 100644 --- a/specification/containerservice/Fleet.Management/fleetmember.tsp +++ b/specification/containerservice/Fleet.Management/fleetmember.tsp @@ -90,9 +90,12 @@ interface FleetMembers { @sharedRoute @added(Versions.v2023_03_15_preview) @removed(Versions.v2023_06_15_preview) - update is ArmResourcePatchSync< + update is ArmCustomPatchSync< FleetMember, - FleetMemberProperties, + Azure.ResourceManager.Foundations.ResourceUpdateModel< + FleetMember, + FleetMemberProperties + >, Azure.ResourceManager.Foundations.BaseParameters & IfMatchParameters >; @@ -107,9 +110,12 @@ interface FleetMembers { `final-state-via`: "original-uri", } ) - updateAsync is ArmResourcePatchAsync< + updateAsync is ArmCustomPatchAsync< FleetMember, - FleetMemberProperties, + Azure.ResourceManager.Foundations.ResourceUpdateModel< + FleetMember, + FleetMemberProperties + >, Azure.ResourceManager.Foundations.BaseParameters & IfMatchParameters >; @@ -124,5 +130,6 @@ interface FleetMembers { IfMatchParameters >; - listByParent is ArmResourceListByParent; + /** List FleetMember resources by Fleet */ + listByFleet is ArmResourceListByParent; } diff --git a/specification/containerservice/Fleet.Management/tspconfig.yaml b/specification/containerservice/Fleet.Management/tspconfig.yaml index b644283a6ff6..d689f8d54806 100644 --- a/specification/containerservice/Fleet.Management/tspconfig.yaml +++ b/specification/containerservice/Fleet.Management/tspconfig.yaml @@ -8,6 +8,9 @@ linter: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true emitter-output-dir: "{project-root}/.." arm-types-dir: "{project-root}/../../common-types/resource-management" examples-directory: "{project-root}/examples" diff --git a/specification/containerservice/Fleet.Management/update/run.tsp b/specification/containerservice/Fleet.Management/update/run.tsp index 004f32fcca0c..68e7fd57ac39 100644 --- a/specification/containerservice/Fleet.Management/update/run.tsp +++ b/specification/containerservice/Fleet.Management/update/run.tsp @@ -352,7 +352,8 @@ interface UpdateRuns { IfMatchParameters >; - listByParent is ArmResourceListByParent; + /** List UpdateRun resources by Fleet */ + listByFleet is ArmResourceListByParent; #suppress "@azure-tools/typespec-azure-resource-manager/arm-post-operation-response-codes" "Existing API" @doc("Starts an UpdateRun.") diff --git a/specification/containerservice/Fleet.Management/update/strategy.tsp b/specification/containerservice/Fleet.Management/update/strategy.tsp index 6e44e7ee30ff..27989dbd0c8b 100644 --- a/specification/containerservice/Fleet.Management/update/strategy.tsp +++ b/specification/containerservice/Fleet.Management/update/strategy.tsp @@ -79,5 +79,6 @@ interface FleetUpdateStrategies { IfMatchParameters >; - listByParent is ArmResourceListByParent; + /** List FleetUpdateStrategy resources by Fleet */ + listByFleet is ArmResourceListByParent; } diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsAbortOperation.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsAbortOperation.json new file mode 100644 index 000000000000..da5c78dddbf0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsAbortOperation.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2017-08-31", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsAssociate_CRG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsAssociate_CRG.json new file mode 100644 index 000000000000..48521bd0b98d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsAssociate_CRG.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_CustomNodeConfig.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_CustomNodeConfig.json new file mode 100644 index 000000000000..c213b2748f53 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_CustomNodeConfig.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_DedicatedHostGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_DedicatedHostGroup.json new file mode 100644 index 000000000000..942b34be8416 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_DedicatedHostGroup.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_EnableCustomCATrust.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_EnableCustomCATrust.json new file mode 100644 index 000000000000..04e3222688be --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_EnableCustomCATrust.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableCustomCATrust": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableCustomCATrust": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableCustomCATrust": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_EnableEncryptionAtHost.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_EnableEncryptionAtHost.json new file mode 100644 index 000000000000..579747d696eb --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_EnableEncryptionAtHost.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_EnableFIPS.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_EnableFIPS.json new file mode 100644 index 000000000000..9a625477daa9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_EnableFIPS.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableFIPS": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_EnableUltraSSD.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_EnableUltraSSD.json new file mode 100644 index 000000000000..fc7968b6b806 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_EnableUltraSSD.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableUltraSSD": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableUltraSSD": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableUltraSSD": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_Ephemeral.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_Ephemeral.json new file mode 100644 index 000000000000..375aa2da3f87 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_Ephemeral.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osDiskType": "Ephemeral", + "osDiskSizeGB": 64 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskType": "Ephemeral", + "osDiskSizeGB": 64 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskType": "Ephemeral", + "kubeletDiskType": "OS", + "osDiskSizeGB": 64 + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_GPUMIG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_GPUMIG.json new file mode 100644 index 000000000000..532fea069f81 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_GPUMIG.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_MessageOfTheDay.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_MessageOfTheDay.json new file mode 100644 index 000000000000..f47449dfce0c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_MessageOfTheDay.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "messageOfTheDay": "Zm9vCg==" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "messageOfTheDay": "Zm9vCg==" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "messageOfTheDay": "Zm9vCg==" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_OSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_OSSKU.json new file mode 100644 index 000000000000..438b9663c1e8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_OSSKU.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osSKU": "AzureLinux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_PPG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_PPG.json new file mode 100644 index 000000000000..8b3c87b08094 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_PPG.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_Snapshot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_Snapshot.json new file mode 100644 index 000000000000..a3309374323e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_Snapshot.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_Spot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_Spot.json new file mode 100644 index 000000000000..45be071815f4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_Spot.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "spotMaxPrice": -1 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "spotMaxPrice": -1 + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_TypeVirtualMachines.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_TypeVirtualMachines.json new file mode 100644 index 000000000000..a25e2fc8a1da --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_TypeVirtualMachines.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "1.9.6", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "type": "VirtualMachines", + "virtualMachinesProfile": { + "scale": { + "manual": [ + { + "sizes": [ + "Standard_D2_v2", + "Standard_D2_v3" + ], + "count": 5 + } + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "type": "VirtualMachines", + "virtualMachinesProfile": { + "scale": { + "manual": [ + { + "sizes": [ + "Standard_D2_v2", + "Standard_D2_v3" + ], + "count": 5 + } + ] + } + }, + "virtualMachineNodesStatus": [ + { + "size": "Standard_D2_v2", + "count": 3 + }, + { + "size": "Standard_D2_v3", + "count": 2 + } + ], + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "type": "VirtualMachines", + "virtualMachinesProfile": { + "scale": { + "manual": [ + { + "sizes": [ + "Standard_D2_v2", + "Standard_D2_v3" + ], + "count": 5 + } + ] + } + }, + "virtualMachineNodesStatus": [ + { + "size": "Standard_D2_v2", + "count": 3 + }, + { + "size": "Standard_D2_v3", + "count": 2 + } + ], + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_TypeVirtualMachines_Autoscale.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_TypeVirtualMachines_Autoscale.json new file mode 100644 index 000000000000..e2efbf88026f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_TypeVirtualMachines_Autoscale.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "1.29.0", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "type": "VirtualMachines", + "virtualMachinesProfile": { + "scale": { + "autoscale": [ + { + "sizes": [ + "Standard_D2_v2", + "Standard_D2_v3" + ], + "minCount": 1, + "maxCount": 5 + } + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.29.0", + "currentOrchestratorVersion": "1.29.0", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "type": "VirtualMachines", + "virtualMachinesProfile": { + "scale": { + "autoscale": [ + { + "sizes": [ + "Standard_D2_v2", + "Standard_D2_v3" + ], + "minCount": 1, + "maxCount": 5 + } + ] + } + }, + "virtualMachineNodesStatus": [ + { + "size": "Standard_D2_v2", + "count": 1 + }, + { + "size": "Standard_D2_v3", + "count": 2 + } + ], + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.29.0", + "currentOrchestratorVersion": "1.29.0", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "type": "VirtualMachines", + "virtualMachinesProfile": { + "scale": { + "autoscale": [ + { + "sizes": [ + "Standard_D2_v2", + "Standard_D2_v3" + ], + "minCount": 1, + "maxCount": 5 + } + ] + } + }, + "virtualMachineNodesStatus": [ + { + "size": "Standard_D2_v2", + "count": 1 + }, + { + "size": "Standard_D2_v3", + "count": 2 + } + ], + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_Update.json new file mode 100644 index 000000000000..736e9e825bab --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_Update.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_WasmWasi.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_WasmWasi.json new file mode 100644 index 000000000000..94ec8e2b454b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_WasmWasi.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "workloadRuntime": "WasmWasi" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "workloadRuntime": "WasmWasi" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "workloadRuntime": "WasmWasi" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json new file mode 100644 index 000000000000..10307a70dc5c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "wnp2", + "parameters": { + "properties": { + "orchestratorVersion": "1.23.8", + "count": 3, + "vmSize": "Standard_D4s_v3", + "osType": "Windows", + "osSKU": "Windows2022", + "windowsProfile": { + "disableOutboundNat": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.23.8", + "currentOrchestratorVersion": "1.23.8", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022", + "windowsProfile": { + "disableOutboundNat": true + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.23.8", + "currentOrchestratorVersion": "1.23.8", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022", + "windowsProfile": { + "disableOutboundNat": true + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_WindowsOSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_WindowsOSSKU.json new file mode 100644 index 000000000000..82f4968f38c4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsCreate_WindowsOSSKU.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "wnp2", + "parameters": { + "properties": { + "orchestratorVersion": "1.23.3", + "count": 3, + "vmSize": "Standard_D4s_v3", + "osType": "Windows", + "osSKU": "Windows2022" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.23.3", + "currentOrchestratorVersion": "1.23.3", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.23.3", + "currentOrchestratorVersion": "1.23.3", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsDelete.json new file mode 100644 index 000000000000..0e5c1c9493c0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsDeleteMachines.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsDeleteMachines.json new file mode 100644 index 000000000000..605f8db4bd18 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsDeleteMachines.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "machines": { + "machineNames": [ + "aks-nodepool1-42263519-vmss00000a", + "aks-nodepool1-42263519-vmss00000b" + ] + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsDelete_IgnorePodDisruptionBudget.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsDelete_IgnorePodDisruptionBudget.json new file mode 100644 index 000000000000..01b2677676dd --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsDelete_IgnorePodDisruptionBudget.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "ignorePodDisruptionBudget": true + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsGet.json new file mode 100644 index 000000000000..a9c60ed3b091 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "eTag": "ebwiyfneowv", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsGetAgentPoolAvailableVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsGetAgentPoolAvailableVersions.json new file mode 100644 index 000000000000..08fd67c4d178 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsGetAgentPoolAvailableVersions.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/availableagentpoolversions", + "name": "default", + "properties": { + "agentPoolVersions": [ + { + "kubernetesVersion": "1.12.7" + }, + { + "kubernetesVersion": "1.12.8" + }, + { + "default": true, + "kubernetesVersion": "1.13.5", + "isPreview": true + } + ] + }, + "type": "Microsoft.ContainerService/managedClusters/availableAgentpoolVersions" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsGetUpgradeProfile.json new file mode 100644 index 000000000000..61a238246827 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsGetUpgradeProfile.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/upgradeprofiles/default", + "name": "default", + "properties": { + "kubernetesVersion": "1.12.8", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.13.5" + } + ], + "latestNodeImageVersion": "AKSUbuntu:1604:2020.03.11" + }, + "type": "Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsList.json new file mode 100644 index 000000000000..9d66444af769 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "eTag": "ewnfuib" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsUpgradeNodeImageVersion.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsUpgradeNodeImageVersion.json new file mode 100644 index 000000000000..7c688c339970 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPoolsUpgradeNodeImageVersion.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.ContainerService/locations/westus/operations/00000000-0000-0000-0000-000000000000?api-version=2018-07-31" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "UpgradingNodeImageVersion", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu-1604-2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPools_Start.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPools_Start.json new file mode 100644 index 000000000000..da813aebf582 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPools_Start.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "powerState": { + "code": "Running" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Starting", + "count": 50, + "enableAutoScaling": true, + "minCount": 3, + "maxCount": 55, + "powerState": { + "code": "Running" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Starting", + "count": 50, + "enableAutoScaling": true, + "minCount": 3, + "maxCount": 55, + "powerState": { + "code": "Running" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPools_Stop.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPools_Stop.json new file mode 100644 index 000000000000..4abb01dc50ce --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPools_Stop.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "powerState": { + "code": "Stopped" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Stopping", + "count": 0, + "enableAutoScaling": false, + "minCount": null, + "maxCount": null, + "powerState": { + "code": "Stopped" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Stopping", + "count": 0, + "enableAutoScaling": false, + "minCount": null, + "maxCount": null, + "powerState": { + "code": "Stopped" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPools_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPools_Update.json new file mode 100644 index 000000000000..8e196f3cad01 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/AgentPools_Update.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Updating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/GetGuardrailsVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/GetGuardrailsVersions.json new file mode 100644 index 000000000000..a075ca707cf7 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/GetGuardrailsVersions.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1", + "version": "v1.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/guardrailsVersions/v1.0.0", + "type": "Microsoft.ContainerService/locations/guardrailsVersions", + "name": "v1.0.0", + "properties": { + "isDefaultVersion": true, + "support": "Preview" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/GetSafeguardsVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/GetSafeguardsVersions.json new file mode 100644 index 000000000000..d438e6636b17 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/GetSafeguardsVersions.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1", + "version": "v1.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/safeguardsVersions/v1.0.0", + "type": "Microsoft.ContainerService/locations/safeguardsVersions", + "name": "v1.0.0", + "properties": { + "isDefaultVersion": true, + "support": "Preview" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/KubernetesVersions_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/KubernetesVersions_List.json new file mode 100644 index 000000000000..bb4fbeb965a4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/KubernetesVersions_List.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "values": [ + { + "version": "1.23", + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.23.12": { + "upgrades": [ + "1.23.15", + "1.24.6", + "1.24.9" + ] + }, + "1.23.15": { + "upgrades": [ + "1.24.6", + "1.24.9" + ] + } + } + }, + { + "version": "1.24", + "isDefault": true, + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.24.6": { + "upgrades": [ + "1.24.9", + "1.25.4", + "1.25.5" + ] + }, + "1.24.9": { + "upgrades": [ + "1.25.4", + "1.25.5" + ] + } + } + }, + { + "version": "1.25", + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.25.4": { + "upgrades": [ + "1.25.5", + "1.26.0" + ] + }, + "1.25.5": { + "upgrades": [ + "1.26.0" + ] + } + } + }, + { + "version": "1.26", + "isPreview": true, + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.26.0": { + "upgrades": [] + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ListGuardrailsVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ListGuardrailsVersions.json new file mode 100644 index 000000000000..228ec3356b33 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ListGuardrailsVersions.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/guardrailsVersions/v1.0.0", + "type": "Microsoft.ContainerService/locations/guardrailsVersions", + "name": "v1.0.0", + "properties": { + "isDefaultVersion": true, + "support": "Preview" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ListSafeguardsVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ListSafeguardsVersions.json new file mode 100644 index 000000000000..b85dc0f89a66 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ListSafeguardsVersions.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/safeguardsVersions/v1.0.0", + "type": "Microsoft.ContainerService/locations/safeguardsVersions", + "name": "v1.0.0", + "properties": { + "isDefaultVersion": true, + "support": "Preview" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/LoadBalancers_Create_Or_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/LoadBalancers_Create_Or_Update.json new file mode 100644 index 000000000000..5bb7f8325ef4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/LoadBalancers_Create_Or_Update.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "loadBalancerName": "kubernetes", + "parameters": { + "properties": { + "name": "kubernetes", + "primaryAgentPoolName": "agentpool1", + "allowServicePlacement": true + } + } + }, + "responses": { + "200": { + "body": { + "name": "kubernetes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/loadBalancers/kubernetes", + "properties": { + "name": "kubernetes", + "primaryAgentPoolName": "agentPool1", + "allowServicePlacement": true, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "kubernetes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/loadBalancers/kubernetes", + "properties": { + "name": "kubernetes", + "primaryAgentPoolName": "agentPool1", + "allowServicePlacement": true, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/LoadBalancers_Delete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/LoadBalancers_Delete.json new file mode 100644 index 000000000000..7e831f47caba --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/LoadBalancers_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "loadBalancerName": "kubernetes" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-05-02-preview" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/LoadBalancers_Get.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/LoadBalancers_Get.json new file mode 100644 index 000000000000..6702e6d9407b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/LoadBalancers_Get.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "loadBalancerName": "kubernetes" + }, + "responses": { + "200": { + "body": { + "name": "kubernetes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/loadBalancers/kubernetes", + "properties": { + "name": "kubernetes", + "primaryAgentPoolName": "agentPool1", + "allowServicePlacement": true, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/LoadBalancers_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/LoadBalancers_List.json new file mode 100644 index 000000000000..790b1bf00536 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/LoadBalancers_List.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "kubernetes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/loadBalancers/kubernetes", + "properties": { + "name": "kubernetes", + "primaryAgentPoolName": "agentPool1", + "allowServicePlacement": true, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/LoadBalancers_Rebalance.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/LoadBalancers_Rebalance.json new file mode 100644 index 000000000000..bba49f16d7e0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/LoadBalancers_Rebalance.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "loadBalancerNames": [ + "kubernetes" + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-05-02-preview" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/MachineGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/MachineGet.json new file mode 100644 index 000000000000..11f019f98117 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/MachineGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "machineName": "aks-nodepool1-42263519-vmss00000t" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/26fe00f8-9173-4872-9134-bb1d2e00343a/resourceGroups/dummyRG/providers/Microsoft.ContainerService/managedClusters/round/agentPools/nodepool1/machines/aks-nodepool1-25481572-vmss000000", + "name": "aks-nodepool1-25481572-vmss000000", + "type": "Microsoft.ContainerService/managedClusters/agentPools/machines", + "properties": { + "network": { + "ipAddresses": [ + { + "ip": "172.20.2.4", + "family": "IPv4" + }, + { + "ip": "10.0.0.1", + "family": "IPv4" + } + ] + }, + "resourceId": "/subscriptions/26fe00f8-9173-4872-9134-bb1d2e00343a/resourceGroups/dummyRG/providers/Microsoft.Compute/virtualMachineScaleSets/aks-nodepool1-25481572-vmss/virtualMachines/0" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/MachineList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/MachineList.json new file mode 100644 index 000000000000..bb20863b1ec0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/MachineList.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/26fe00f8-9173-4872-9134-bb1d2e00343a/resourceGroups/dummyRG/providers/Microsoft.ContainerService/managedClusters/round/agentPools/nodepool1/machines/aks-nodepool1-25481572-vmss000000", + "name": "aks-nodepool1-25481572-vmss000000", + "type": "Microsoft.ContainerService/managedClusters/agentPools/machines", + "properties": { + "network": { + "ipAddresses": [ + { + "ip": "172.20.2.4", + "family": "IPv4" + }, + { + "ip": "10.0.0.1", + "family": "IPv4" + } + ] + }, + "resourceId": "/subscriptions/26fe00f8-9173-4872-9134-bb1d2e00343a/resourceGroups/dummyRG/providers/Microsoft.Compute/virtualMachineScaleSets/aks-nodepool1-25481572-vmss/virtualMachines/0" + } + } + ], + "nextLink": "http://xxxx.azure.com?encodedToken=c2tpcFRva2VuPTE" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/MaintenanceConfigurationsCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/MaintenanceConfigurationsCreate_Update.json new file mode 100644 index 000000000000..c5a29dbc5290 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/MaintenanceConfigurationsCreate_Update.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default", + "parameters": { + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json new file mode 100644 index 000000000000..b4cf93e16413 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "aksManagedAutoUpgradeSchedule", + "parameters": { + "properties": { + "maintenanceWindow": { + "schedule": { + "relativeMonthly": { + "intervalMonths": 3, + "weekIndex": "First", + "dayOfWeek": "Monday" + } + }, + "durationHours": 10, + "utcOffset": "+05:30", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations", + "name": "aksManagedAutoUpgradeSchedule", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "maintenanceWindow": { + "schedule": { + "weekly": { + "intervalWeeks": 3, + "dayOfWeek": "Monday" + } + }, + "durationHours": 10, + "utcOffset": "+05:30", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations", + "name": "aksManagedAutoUpgradeSchedule", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "maintenanceWindow": { + "schedule": { + "weekly": { + "intervalWeeks": 3, + "dayOfWeek": "Monday" + } + }, + "durationHours": 10, + "utcOffset": "+05:30", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/MaintenanceConfigurationsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/MaintenanceConfigurationsDelete.json new file mode 100644 index 000000000000..d088c41f5a79 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/MaintenanceConfigurationsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json new file mode 100644 index 000000000000..4a309b64fa64 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "aksManagedNodeOSUpgradeSchedule" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/MaintenanceConfigurationsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/MaintenanceConfigurationsGet.json new file mode 100644 index 000000000000..02c7f7910e73 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/MaintenanceConfigurationsGet.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json new file mode 100644 index 000000000000..118e55bd463a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "aksManagedNodeOSUpgradeSchedule" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "aksManagedNodeOSUpgradeSchedule", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "maintenanceWindow": { + "schedule": { + "daily": { + "intervalDays": 3 + } + }, + "durationHours": 4, + "utcOffset": "-07:00", + "startDate": "2023-01-01", + "startTime": "09:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/MaintenanceConfigurationsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/MaintenanceConfigurationsList.json new file mode 100644 index 000000000000..88ccc71571d0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/MaintenanceConfigurationsList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "default", + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/MaintenanceConfigurationsList_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/MaintenanceConfigurationsList_MaintenanceWindow.json new file mode 100644 index 000000000000..73577c52e250 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/MaintenanceConfigurationsList_MaintenanceWindow.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "aksManagedNodeOSUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "daily": { + "intervalDays": 5 + } + }, + "durationHours": 10, + "utcOffset": "-07:00", + "startDate": "2023-01-01", + "startTime": "13:30" + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "aksManagedAutoUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "absoluteMonthly": { + "intervalMonths": 3, + "dayOfMonth": 15 + } + }, + "durationHours": 5, + "utcOffset": "+00:00", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClusterSnapshotsCreate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClusterSnapshotsCreate.json new file mode 100644 index 000000000000..80125d00c831 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClusterSnapshotsCreate.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1", + "parameters": { + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1", + "type": "Microsoft.ContainerService/ManagedClusterSnapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "snapshotType": "ManagedCluster", + "managedClusterPropertiesReadOnly": { + "kubernetesVersion": "1.20.5", + "sku": { + "name": "Basic", + "tier": "Free" + }, + "enableRbac": true, + "networkProfile": { + "networkPlugin": "kubenet", + "networkPolicy": "calico", + "networkMode": "bridge", + "loadBalancerSku": "standard" + } + } + } + } + }, + "201": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1", + "type": "Microsoft.ContainerService/ManagedClusterSnapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "snapshotType": "ManagedCluster", + "managedClusterPropertiesReadOnly": { + "kubernetesVersion": "1.20.5", + "sku": { + "name": "Basic", + "tier": "Free" + }, + "enableRbac": true, + "networkProfile": { + "networkPlugin": "kubenet", + "networkPolicy": "calico", + "networkMode": "bridge", + "loadBalancerSku": "standard" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClusterSnapshotsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClusterSnapshotsDelete.json new file mode 100644 index 000000000000..1717f59ac0d2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClusterSnapshotsDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClusterSnapshotsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClusterSnapshotsGet.json new file mode 100644 index 000000000000..4feff9f5148d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClusterSnapshotsGet.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1" + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1", + "type": "Microsoft.ContainerService/ManagedClusterSnapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "snapshotType": "ManagedCluster", + "managedClusterPropertiesReadOnly": { + "kubernetesVersion": "1.20.5", + "sku": { + "name": "Basic", + "tier": "Free" + }, + "enableRbac": true, + "networkProfile": { + "networkPlugin": "kubenet", + "networkPolicy": "calico", + "networkMode": "bridge", + "loadBalancerSku": "standard" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClusterSnapshotsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClusterSnapshotsList.json new file mode 100644 index 000000000000..94b3a67cfd3b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClusterSnapshotsList.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1", + "type": "Microsoft.ContainerService/ManagedClusterSnapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "snapshotType": "ManagedCluster", + "managedClusterPropertiesReadOnly": { + "kubernetesVersion": "1.20.5", + "sku": { + "name": "Basic", + "tier": "Free" + }, + "enableRbac": true, + "networkProfile": { + "networkPlugin": "kubenet", + "networkPolicy": "calico", + "networkMode": "bridge", + "loadBalancerSku": "standard" + } + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClusterSnapshotsListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClusterSnapshotsListByResourceGroup.json new file mode 100644 index 000000000000..4a7f7f22f7cf --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClusterSnapshotsListByResourceGroup.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1", + "type": "Microsoft.ContainerService/ManagedClusterSnapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "snapshotType": "ManagedCluster", + "managedClusterPropertiesReadOnly": { + "kubernetesVersion": "1.20.5", + "sku": { + "name": "Basic", + "tier": "Free" + }, + "enableRbac": true, + "networkProfile": { + "networkPlugin": "kubenet", + "networkPolicy": "calico", + "networkMode": "bridge", + "loadBalancerSku": "standard" + } + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClusterSnapshotsUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClusterSnapshotsUpdateTags.json new file mode 100644 index 000000000000..b4a1409cb7f7 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClusterSnapshotsUpdateTags.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1", + "parameters": { + "tags": { + "key2": "new-val2", + "key3": "val3" + } + } + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1", + "type": "Microsoft.ContainerService/ManagedClusterSnapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "snapshotType": "ManagedCluster", + "managedClusterPropertiesReadOnly": { + "kubernetesVersion": "1.20.5", + "sku": { + "name": "Basic", + "tier": "Free" + }, + "enableRbac": true, + "networkProfile": { + "networkPlugin": "kubenet", + "networkPolicy": "calico", + "networkMode": "bridge", + "loadBalancerSku": "standard" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersAbortOperation.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersAbortOperation.json new file mode 100644 index 000000000000..06bcd1290a7c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersAbortOperation.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2017-08-31", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersAssociate_CRG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersAssociate_CRG.json new file mode 100644 index 000000000000..a676b19e96b1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersAssociate_CRG.json @@ -0,0 +1,254 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/capacityReservationGroups/crg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/capacityReservationGroups/crg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json new file mode 100644 index 000000000000..3457229a6e2b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json @@ -0,0 +1,259 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_AzureServiceMesh.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_AzureServiceMesh.json new file mode 100644 index 000000000000..4b9a53bd90df --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_AzureServiceMesh.json @@ -0,0 +1,346 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "serviceMeshProfile": { + "mode": "Istio", + "istio": { + "components": { + "ingressGateways": [ + { + "enabled": true, + "mode": "Internal" + } + ], + "egressGateways": [ + { + "enabled": true + } + ] + }, + "certificateAuthority": { + "plugin": { + "keyVaultId": "/subscriptions/854c9ddb-fe9e-4aea-8d58-99ed88282881/resourceGroups/ddama-test/providers/Microsoft.KeyVault/vaults/my-akv", + "certObjectName": "ca-cert", + "keyObjectName": "ca-key", + "rootCertObjectName": "root-cert", + "certChainObjectName": "cert-chain" + } + } + } + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "serviceMeshProfile": { + "mode": "Istio", + "istio": { + "components": { + "ingressGateways": [ + { + "enabled": true, + "mode": "Internal" + } + ], + "egressGateways": [ + { + "enabled": true + } + ] + }, + "certificateAuthority": { + "plugin": { + "keyVaultId": "/subscriptions/854c9ddb-fe9e-4aea-8d58-99ed88282881/resourceGroups/ddama-test/providers/Microsoft.KeyVault/vaults/my-akv", + "certObjectName": "ca-cert", + "keyObjectName": "ca-key", + "rootCertObjectName": "root-cert", + "certChainObjectName": "cert-chain" + } + }, + "revisions": [ + "asm-1-17" + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "serviceMeshProfile": { + "mode": "Istio", + "istio": { + "components": { + "ingressGateways": [ + { + "enabled": true, + "mode": "Internal" + } + ], + "egressGateways": [ + { + "enabled": true + } + ] + }, + "certificateAuthority": { + "plugin": { + "keyVaultId": "/subscriptions/854c9ddb-fe9e-4aea-8d58-99ed88282881/resourceGroups/ddama-test/providers/Microsoft.KeyVault/vaults/my-akv", + "certObjectName": "ca-cert", + "keyObjectName": "ca-key", + "rootCertObjectName": "root-cert", + "certChainObjectName": "cert-chain" + } + }, + "revisions": [ + "asm-1-17" + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_DedicatedHostGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_DedicatedHostGroup.json new file mode 100644 index 000000000000..3748014a2964 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_DedicatedHostGroup.json @@ -0,0 +1,251 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_DisableRunCommand.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_DisableRunCommand.json new file mode 100644 index 000000000000..e6acfc65cf16 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_DisableRunCommand.json @@ -0,0 +1,265 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "KubernetesOfficial" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "KubernetesOfficial" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_DualStackNetworking.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_DualStackNetworking.json new file mode 100644 index 000000000000..6b286c9125c5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_DualStackNetworking.json @@ -0,0 +1,321 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + }, + "ipFamilies": [ + "IPv4", + "IPv6" + ] + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16", + "fd11:1234::/64" + ], + "serviceCidrs": [ + "10.0.0.0/16", + "fd00:1234::/108" + ], + "ipFamilies": [ + "IPv4", + "IPv6" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2, + "countIPv6": 1 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip3-ipv6" + } + ] + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16", + "fd11:1234::/64" + ], + "serviceCidrs": [ + "10.0.0.0/16", + "fd00:1234::/108" + ], + "ipFamilies": [ + "IPv4", + "IPv6" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2, + "countIPv6": 1 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip3-ipv6" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_EnableAIToolchainOperator.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_EnableAIToolchainOperator.json new file mode 100644 index 000000000000..b5b3d4968355 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_EnableAIToolchainOperator.json @@ -0,0 +1,236 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "networkPlugin": "azure", + "networkPluginMode": "overlay", + "networkDataplane": "cilium", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "aiToolchainOperatorProfile": { + "enabled": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "networkPlugin": "azure", + "networkPluginMode": "overlay", + "networkDataplane": "cilium", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aiToolchainOperatorProfile": { + "enabled": true + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "networkPlugin": "azure", + "networkPluginMode": "overlay", + "networkDataplane": "cilium", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aiToolchainOperatorProfile": { + "enabled": true + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_EnableCustomCATrust.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_EnableCustomCATrust.json new file mode 100644 index 000000000000..2b7b7b8ee74a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_EnableCustomCATrust.json @@ -0,0 +1,269 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableCustomCATrust": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "securityProfile": { + "customCATrustCertificates": [ + "ZHVtbXlFeGFtcGxlVGVzdFZhbHVlRm9yQ2VydGlmaWNhdGVUb0JlQWRkZWQ=" + ] + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableCustomCATrust": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "securityProfile": { + "customCATrustCertificates": [ + "ZHVtbXlFeGFtcGxlVGVzdFZhbHVlRm9yQ2VydGlmaWNhdGVUb0JlQWRkZWQ=" + ] + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableCustomCATrust": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "securityProfile": { + "customCATrustCertificates": [ + "ZHVtbXlFeGFtcGxlVGVzdFZhbHVlRm9yQ2VydGlmaWNhdGVUb0JlQWRkZWQ=" + ] + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_EnableEncryptionAtHost.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_EnableEncryptionAtHost.json new file mode 100644 index 000000000000..a53309b6b121 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_EnableEncryptionAtHost.json @@ -0,0 +1,254 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_EnableUltraSSD.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_EnableUltraSSD.json new file mode 100644 index 000000000000..16580d864ecd --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_EnableUltraSSD.json @@ -0,0 +1,254 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_EnabledFIPS.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_EnabledFIPS.json new file mode 100644 index 000000000000..b63cfe170cd6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_EnabledFIPS.json @@ -0,0 +1,254 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_GPUMIG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_GPUMIG.json new file mode 100644 index 000000000000..1d4bfb7d185e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_GPUMIG.json @@ -0,0 +1,281 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_HTTPProxy.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_HTTPProxy.json new file mode 100644 index 000000000000..6ebc29afe522 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_HTTPProxy.json @@ -0,0 +1,278 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json new file mode 100644 index 000000000000..b4d901b5017e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json @@ -0,0 +1,249 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "ingressProfile": { + "webAppRouting": { + "enabled": true, + "dnsZoneResourceIds": [ + "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME" + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "ingressProfile": { + "webAppRouting": { + "enabled": true, + "dnsZoneResourceIds": [ + "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME" + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "ingressProfile": { + "webAppRouting": { + "enabled": true, + "dnsZoneResourceIds": [ + "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME" + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_MCSnapshot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_MCSnapshot.json new file mode 100644 index 000000000000..4bd2f7d832d4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_MCSnapshot.json @@ -0,0 +1,222 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1" + }, + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1" + }, + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1" + }, + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_ManagedNATGateway.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_ManagedNATGateway.json new file mode 100644 index 000000000000..935ba20186d6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_ManagedNATGateway.json @@ -0,0 +1,231 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "managedOutboundIPProfile": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "idleTimeoutInMinutes": 4, + "managedOutboundIPProfile": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "idleTimeoutInMinutes": 4, + "managedOutboundIPProfile": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_NodeAutoProvisioning.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_NodeAutoProvisioning.json new file mode 100644 index 000000000000..32f81cb95c7c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_NodeAutoProvisioning.json @@ -0,0 +1,229 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "networkPlugin": "azure", + "networkPluginMode": "overlay", + "networkDataplane": "cilium", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "networkPlugin": "azure", + "networkPluginMode": "overlay", + "networkDataplane": "cilium", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "networkPlugin": "azure", + "networkPluginMode": "overlay", + "networkDataplane": "cilium", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_NodePublicIPPrefix.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_NodePublicIPPrefix.json new file mode 100644 index 000000000000..8cfd4b893438 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_NodePublicIPPrefix.json @@ -0,0 +1,254 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodePublicIPPrefixID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "nodePublicIPPrefixID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodePublicIPPrefixID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_OSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_OSSKU.json new file mode 100644 index 000000000000..fa5569e98ea7 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_OSSKU.json @@ -0,0 +1,281 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osSKU": "AzureLinux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_PPG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_PPG.json new file mode 100644 index 000000000000..fdefc6e5cead --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_PPG.json @@ -0,0 +1,254 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_PodIdentity.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_PodIdentity.json new file mode 100644 index 000000000000..98754d4fdc62 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_PodIdentity.json @@ -0,0 +1,263 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_Premium.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_Premium.json new file mode 100644 index 000000000000..d1f300998be2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_Premium.json @@ -0,0 +1,270 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Base", + "tier": "Premium" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "supportPlan": "AKSLongTermSupport" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "sku": { + "name": "Base", + "tier": "Premium" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "AKSLongTermSupport" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "AKSLongTermSupport" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json new file mode 100644 index 000000000000..451ed1b6738e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json @@ -0,0 +1,264 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "privateFQDN": "domain1.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "privateFQDN": "domain1.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json new file mode 100644 index 000000000000..3b732c1e5236 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json @@ -0,0 +1,268 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true, + "privateDNSZone": "system" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true, + "privateDNSZone": "system" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_SecurityProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_SecurityProfile.json new file mode 100644 index 000000000000..6aa579b0ca74 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_SecurityProfile.json @@ -0,0 +1,251 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "securityProfile": { + "defender": { + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME", + "securityMonitoring": { + "enabled": true + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "securityProfile": { + "defender": { + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME", + "securityMonitoring": { + "enabled": true + } + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "securityProfile": { + "defender": { + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME", + "securityMonitoring": { + "enabled": true + } + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_Snapshot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_Snapshot.json new file mode 100644 index 000000000000..5df8216d693c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_Snapshot.json @@ -0,0 +1,263 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_Update.json new file mode 100644 index 000000000000..33ee6b9d1d57 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_Update.json @@ -0,0 +1,315 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "upgradeSettings": { + "overrideSettings": { + "forceUpgrade": true, + "until": "2022-11-01T13:00:00Z" + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "upgradeSettings": { + "overrideSettings": { + "forceUpgrade": false, + "until": "2022-11-01T13:00:00Z" + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_UpdateWindowsGmsa.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_UpdateWindowsGmsa.json new file mode 100644 index 000000000000..f44367f19250 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_UpdateWindowsGmsa.json @@ -0,0 +1,299 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$", + "gmsaProfile": { + "enabled": true + } + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "gmsaProfile": { + "enabled": true + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "gmsaProfile": { + "enabled": true + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_UpdateWithAHUB.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_UpdateWithAHUB.json new file mode 100644 index 000000000000..2f57eddb0eb2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_UpdateWithAHUB.json @@ -0,0 +1,293 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json new file mode 100644 index 000000000000..0f2b235444cb --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json @@ -0,0 +1,282 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "aadProfile": { + "managed": true, + "enableAzureRBAC": true + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aadProfile": { + "managed": true, + "adminGroupObjectIDs": null, + "enableAzureRBAC": true, + "tenantID": "tenantID" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aadProfile": { + "managed": true, + "adminGroupObjectIDs": null, + "enableAzureRBAC": true, + "tenantID": "tenantID" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_UpdateWithEnableNamespaceResources.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_UpdateWithEnableNamespaceResources.json new file mode 100644 index 000000000000..2a6a63ef5d35 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_UpdateWithEnableNamespaceResources.json @@ -0,0 +1,269 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "enableNamespaceResources": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "enableNamespaceResources": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "enableNamespaceResources": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_UserAssignedNATGateway.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_UserAssignedNATGateway.json new file mode 100644 index 000000000000..36e650db64fb --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_UserAssignedNATGateway.json @@ -0,0 +1,198 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_VirtualMachines.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_VirtualMachines.json new file mode 100644 index 000000000000..9e1995544b27 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersCreate_VirtualMachines.json @@ -0,0 +1,229 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachines", + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachines", + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachines", + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersDelete.json new file mode 100644 index 000000000000..4e793c60456c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersGet.json new file mode 100644 index 000000000000..b0e287374d31 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersGet.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "eTag": "beywbwei", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "azurePortalFQDN": "dnsprefix1-abcd1234.portal.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "eTag": "nvewbvoi", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "availabilityZones": [ + "1", + "2", + "3" + ], + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "outboundIPs": { + "publicIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip2" + } + ] + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "upgradeSettings": { + "overrideSettings": { + "forceUpgrade": true, + "until": "2022-11-01T13:00:00Z" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersGetAccessProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersGetAccessProfile.json new file mode 100644 index 000000000000..7abbfdd56e0e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersGetAccessProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "roleName": "clusterUser" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/accessProfiles/clusterUser", + "location": "location1", + "name": "clusterUser", + "properties": { + "kubeConfig": "a3ViZUNvbmZpZzE=" + }, + "type": "Microsoft.ContainerService/ManagedClusters/AccessProfiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersGetUpgradeProfile.json new file mode 100644 index 000000000000..11dcae56dff2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersGetUpgradeProfile.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/upgradeprofiles/default", + "name": "default", + "properties": { + "agentPoolProfiles": [ + { + "kubernetesVersion": "1.7.7", + "name": "agent", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.7.9" + }, + { + "kubernetesVersion": "1.7.11", + "isPreview": true + } + ] + } + ], + "controlPlaneProfile": { + "kubernetesVersion": "1.7.7", + "name": "master", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.7.9", + "isPreview": true + }, + { + "kubernetesVersion": "1.7.11" + } + ] + } + }, + "type": "Microsoft.ContainerService/managedClusters/upgradeprofiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersGet_MeshRevisionProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersGet_MeshRevisionProfile.json new file mode 100644 index 000000000000..74b0b336dc33 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersGet_MeshRevisionProfile.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1", + "mode": "istio" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/meshRevisionProfiles/istio", + "type": "Microsoft.ContainerService/locations/meshRevisionProfiles", + "name": "istio", + "properties": { + "meshRevisions": [ + { + "revision": "asm-1-17", + "upgrades": [ + "1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + }, + { + "revision": "asm-1-18", + "upgrades": [], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.24", + "1.25", + "1.26", + "1.27" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersGet_MeshUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersGet_MeshUpgradeProfile.json new file mode 100644 index 000000000000..fccbe0232f72 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersGet_MeshUpgradeProfile.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "mode": "istio" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/meshUpgradeProfiles/istio", + "type": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles", + "name": "istio", + "properties": { + "revision": "asm-1-17", + "upgrades": [ + "1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersList.json new file mode 100644 index 000000000000..1284aa2f7a80 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersList.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "eTag": "nvweuib", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "maxAgentPools": 1, + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "eTag": "byuefvwi" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersListByResourceGroup.json new file mode 100644 index 000000000000..44e502382150 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersListByResourceGroup.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "maxAgentPools": 1, + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersListClusterCredentialResult.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersListClusterCredentialResult.json new file mode 100644 index 000000000000..01ebe8643e76 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersListClusterCredentialResult.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "Y3JlZGVudGlhbFZhbHVlMQ==" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersList_MeshRevisionProfiles.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersList_MeshRevisionProfiles.json new file mode 100644 index 000000000000..9c579abd76a4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersList_MeshRevisionProfiles.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/meshRevisionProfiles/istio", + "type": "Microsoft.ContainerService/locations/meshRevisionProfiles", + "name": "istio", + "properties": { + "meshRevisions": [ + { + "revision": "asm-1-17", + "upgrades": [ + "1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + }, + { + "revision": "asm-1-18", + "upgrades": [], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.24", + "1.25", + "1.26", + "1.27" + ] + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersList_MeshUpgradeProfiles.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersList_MeshUpgradeProfiles.json new file mode 100644 index 000000000000..2be7b6cfa5e6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersList_MeshUpgradeProfiles.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/meshUpgradeProfiles/istio", + "type": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles", + "name": "istio", + "properties": { + "revision": "asm-1-17", + "upgrades": [ + "1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersResetAADProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersResetAADProfile.json new file mode 100644 index 000000000000..32274e4ca065 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersResetAADProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientAppID": "clientappid", + "serverAppID": "serverappid", + "serverAppSecret": "serverappsecret", + "tenantID": "tenantid" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersResetServicePrincipalProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersResetServicePrincipalProfile.json new file mode 100644 index 000000000000..0ca54d27ae54 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersResetServicePrincipalProfile.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientId": "clientid", + "secret": "secret" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersRotateClusterCertificates.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersRotateClusterCertificates.json new file mode 100644 index 000000000000..4e793c60456c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersRotateClusterCertificates.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersRotateServiceAccountSigningKeys.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersRotateServiceAccountSigningKeys.json new file mode 100644 index 000000000000..4e793c60456c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersRotateServiceAccountSigningKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersStart.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersStart.json new file mode 100644 index 000000000000..4e793c60456c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersStart.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersStop.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersStop.json new file mode 100644 index 000000000000..4e793c60456c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersStop.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersUpdateTags.json new file mode 100644 index 000000000000..0cd2d6c115b6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ManagedClustersUpdateTags.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "tags": { + "tier": "testing", + "archv3": "" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv3": "", + "tier": "testing" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/OperationStatusResultGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/OperationStatusResultGet.json new file mode 100644 index 000000000000..d72ecc40152f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/OperationStatusResultGet.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "operationId": "00000000-0000-0000-0000-000000000001" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/operations/00000000-0000-0000-0000-000000000001", + "name": "00000000-0000-0000-0000-000000000001", + "status": "InProgress", + "percentComplete": 40, + "startTime": "2023-07-26T12:14:26.3179428Z" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/OperationStatusResultGetByAgentPool.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/OperationStatusResultGetByAgentPool.json new file mode 100644 index 000000000000..3847c34909fb --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/OperationStatusResultGetByAgentPool.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "operationId": "00000000-0000-0000-0000-000000000001" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/operations/00000000-0000-0000-0000-000000000001", + "name": "00000000-0000-0000-0000-000000000001", + "status": "InProgress", + "percentComplete": 40, + "startTime": "2023-07-26T12:14:26.3179428Z" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/OperationStatusResultList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/OperationStatusResultList.json new file mode 100644 index 000000000000..c613d66ac59c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/OperationStatusResultList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/operations/d11edb09-6e27-429f-9fe5-17baf773bc4a", + "name": "d11edb09-6e27-429f-9fe5-17baf773bc4a", + "status": "InProgress", + "percentComplete": 40, + "startTime": "2023-07-26T12:14:26.3179428Z" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/operations/d11edb09-6e27-429f-9fe5-17baf773bc4b", + "name": "d11edb09-6e27-429f-9fe5-17baf773bc4b", + "status": "Failed", + "startTime": "2023-07-26T12:14:26.3179428Z", + "endTime": "2023-07-26T12:14:50.3179428Z", + "error": { + "code": "ReconcileAgentPoolIdentityError", + "message": "Reconcile agent pool nodepool1 identity failed" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/Operation_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/Operation_List.json new file mode 100644 index 000000000000..b783dd80b33c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/Operation_List.json @@ -0,0 +1,3573 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "display": { + "description": "Gets the status of an asynchronous operation", + "operation": "Get Operation", + "provider": "Microsoft Container Service", + "resource": "Operation" + }, + "name": "Microsoft.ContainerService/locations/operations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Lists the supported orchestrators", + "operation": "List Orchestrators", + "provider": "Microsoft Container Service", + "resource": "Orchestrator" + }, + "name": "Microsoft.ContainerService/locations/orchestrators/read", + "origin": "user,system" + }, + { + "display": { + "description": "Lists operations available on Microsoft.ContainerService resource provider", + "operation": "List Available Container Service Operations", + "provider": "Microsoft Container Service", + "resource": "Available Container Service Operations" + }, + "name": "Microsoft.ContainerService/operations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Registers Subscription with Microsoft.ContainerService resource provider", + "operation": "Register Subscription for Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Service Register Subscription" + }, + "name": "Microsoft.ContainerService/register/action", + "origin": "user,system" + }, + { + "display": { + "description": "Unregisters Subscription with Microsoft.ContainerService resource provider", + "operation": "Unregister Subscription for Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Service Unregister Subscription" + }, + "name": "Microsoft.ContainerService/unregister/action", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the status of an asynchronous operation result", + "operation": "Get Operation Result", + "provider": "Microsoft Container Service", + "resource": "OperationResult" + }, + "name": "Microsoft.ContainerService/locations/operationresults/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get a container service", + "operation": "Get Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Services" + }, + "name": "Microsoft.ContainerService/containerServices/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new container service or updates an existing one", + "operation": "Create or Update Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Services" + }, + "name": "Microsoft.ContainerService/containerServices/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a container service", + "operation": "Delete Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Services" + }, + "name": "Microsoft.ContainerService/containerServices/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Get a managed cluster", + "operation": "Get Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new managed cluster or updates an existing one", + "operation": "Create or Update Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a managed cluster", + "operation": "Delete Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Starts a managed cluster", + "operation": "Start Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/start/action", + "origin": "user,system" + }, + { + "display": { + "description": "Stops a managed cluster", + "operation": "Stop Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/stop/action", + "origin": "user,system" + }, + { + "display": { + "description": "Gets a maintenance configuration", + "operation": "Get a maintenance configuration", + "provider": "Microsoft Container Service", + "resource": "Maintenance Configurations" + }, + "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new MaintenanceConfiguration or updates an existing one", + "operation": "Create or Update maintenance configuratio", + "provider": "Microsoft Container Service", + "resource": "Maintenance Configurations" + }, + "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a maintenance configuration", + "operation": "Delete Maintenance Configuration", + "provider": "Microsoft Container Service", + "resource": "Maintenance Configurations" + }, + "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets an agent pool", + "operation": "Get Agent Pool", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new agent pool or updates an existing one", + "operation": "Create or Update Agent Pool", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes an agent pool", + "operation": "Delete Agent Pool", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the upgrade profile of the Agent Pool", + "operation": "Get Agent Pool UpgradeProfile", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Upgrade the node image version of agent pool", + "operation": "Upgrade agent pool node image version", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/upgradeNodeImageVersion/write", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the available agent pool versions of the cluster", + "operation": "Get Available Agent Pool Versions", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/availableAgentPoolVersions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get a managed cluster access profile by role name", + "operation": "Get Managed Cluster AccessProfile", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/accessProfiles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get a managed cluster access profile by role name using list credential", + "operation": "Get Managed Cluster AccessProfile by List Credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/accessProfiles/listCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the upgrade profile of the cluster", + "operation": "Get UpgradeProfile", + "provider": "Microsoft Container Service", + "resource": "UpgradeProfile" + }, + "name": "Microsoft.ContainerService/managedClusters/upgradeProfiles/read", + "origin": "user,system" + }, + { + "display": { + "description": "List the clusterAdmin credential of a managed cluster", + "operation": "List clusterAdmin credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/listClusterAdminCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "List the clusterUser credential of a managed cluster", + "operation": "List clusterUser credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/listClusterUserCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "List the clusterMonitoringUser credential of a managed cluster", + "operation": "List clusterMonitoringUser credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/listClusterMonitoringUserCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reset the service principal profile of a managed cluster", + "operation": "Reset service principal profile", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/resetServicePrincipalProfile/action", + "origin": "user,system" + }, + { + "display": { + "description": "Resolve the private link service id of a managed cluster", + "operation": "Resolve private link service id", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/resolvePrivateLinkServiceId/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reset the AAD profile of a managed cluster", + "operation": "Reset AAD profile", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/resetAADProfile/action", + "origin": "user,system" + }, + { + "display": { + "description": "Rotate certificates of a managed cluster", + "operation": "Rotate certificates of the cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/rotateClusterCertificates/action", + "origin": "user,system" + }, + { + "display": { + "description": "Run user issued command against managed kubernetes server.", + "operation": "RunCommand", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/runCommand/action", + "origin": "user,system" + }, + { + "display": { + "description": "Retrieve result from previous issued command.", + "operation": "CommandResult", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/commandResults/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get the diagnostic setting for a managed cluster resource", + "operation": "Read Diagnostic Setting", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/diagnosticSettings/read", + "origin": "system" + }, + { + "display": { + "description": "Creates or updates the diagnostic setting for a managed cluster resource", + "operation": "Write Diagnostic Setting", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/diagnosticSettings/write", + "origin": "system" + }, + { + "display": { + "description": "Get Managed Cluster Detector", + "operation": "Get Managed Cluster Detector", + "provider": "Microsoft Container Service", + "resource": "Managed Cluster Detector" + }, + "name": "Microsoft.ContainerService/managedClusters/detectors/read", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the diagnostics state of the cluster", + "operation": "Get Diagnostics State", + "provider": "Microsoft Container Service", + "resource": "Diagnostics State" + }, + "name": "Microsoft.ContainerService/managedClusters/diagnosticsState/read", + "origin": "user,system" + }, + { + "display": { + "description": "Determines if user is allowed to approve a private endpoint connection", + "operation": "Approve Private Endpoint Connections", + "provider": "Microsoft Container Service", + "resource": "Approve Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnectionsApproval/action", + "origin": "user,system" + }, + { + "display": { + "description": "Get private endpoint connection", + "operation": "Get private endpoint connection", + "provider": "Microsoft Container Service", + "resource": "Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/read", + "origin": "user,system" + }, + { + "display": { + "description": "Approve or Reject a private endpoint connection", + "operation": "Update private endpoint connection", + "provider": "Microsoft Container Service", + "resource": "Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/write", + "origin": "user,system" + }, + { + "display": { + "description": "Delete private endpoint connection", + "operation": "Delete private endpoint connection", + "provider": "Microsoft Container Service", + "resource": "Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets an extension addon", + "operation": "Get an extension addon", + "provider": "Microsoft Container Service", + "resource": "ExtensionAddons" + }, + "name": "Microsoft.ContainerService/managedClusters/extensionaddons/read", + "origin": "system" + }, + { + "display": { + "description": "Creates a new extension addon or updates an existing one", + "operation": "Create or Update extension addon", + "provider": "Microsoft Container Service", + "resource": "ExtensionAddons" + }, + "name": "Microsoft.ContainerService/managedClusters/extensionaddons/write", + "origin": "system" + }, + { + "display": { + "description": "Deletes an extension addon", + "operation": "Delete an extension addon", + "provider": "Microsoft Container Service", + "resource": "ExtensionAddons" + }, + "name": "Microsoft.ContainerService/managedClusters/extensionaddons/delete", + "origin": "system" + }, + { + "display": { + "description": "Get a snapshot", + "operation": "Get Snapshot", + "provider": "Microsoft Container Service", + "resource": "Snapshots" + }, + "name": "Microsoft.ContainerService/snapshots/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new snapshot", + "operation": "Create Snapshot", + "provider": "Microsoft Container Service", + "resource": "Snapshots" + }, + "name": "Microsoft.ContainerService/snapshots/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a snapshot", + "operation": "Delete Snapshot", + "provider": "Microsoft Container Service", + "resource": "Snapshots" + }, + "name": "Microsoft.ContainerService/snapshots/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Get eventgrid filter", + "operation": "Get eventgrid filter", + "provider": "Microsoft Container Service", + "resource": "EventGridFilters" + }, + "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/read", + "origin": "system" + }, + { + "display": { + "description": "Create or Update eventgrid filter", + "operation": "Create or Update eventgrid filter", + "provider": "Microsoft Container Service", + "resource": "EventGridFilters" + }, + "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/write", + "origin": "system" + }, + { + "display": { + "description": "Delete an eventgrid filter", + "operation": "Delete an eventgrid filter", + "provider": "Microsoft Container Service", + "resource": "EventGridFilters" + }, + "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/delete", + "origin": "system" + }, + { + "display": { + "description": "Reads initializerconfigurations", + "operation": "Gets/List initializerconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Initializerconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes initializerconfigurations", + "operation": "Creates/Updates initializerconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Initializerconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes/DeletesCollection initializerconfigurations resource", + "operation": "Initializerconfigurations", + "provider": "Microsoft Container Service", + "resource": "Initializerconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads mutatingwebhookconfigurations", + "operation": "Gets/List mutatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Mutatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes mutatingwebhookconfigurations", + "operation": "Creates/Updates mutatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Mutatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes mutatingwebhookconfigurations", + "operation": "Deletes/DeletesCollection mutatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Mutatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads validatingwebhookconfigurations", + "operation": "Gets/List validatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Validatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes validatingwebhookconfigurations", + "operation": "Creates/Updates validatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Validatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes validatingwebhookconfigurations", + "operation": "Deletes/DeletesCollection validatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Validatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads customresourcedefinitions", + "operation": "Gets/List customresourcedefinitions resource", + "provider": "Microsoft Container Service", + "resource": "Customresourcedefinitions" + }, + "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes customresourcedefinitions", + "operation": "Creates/Updates customresourcedefinitions resource", + "provider": "Microsoft Container Service", + "resource": "Customresourcedefinitions" + }, + "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes customresourcedefinitions", + "operation": "Deletes/DeletesCollection customresourcedefinitions resource", + "provider": "Microsoft Container Service", + "resource": "Customresourcedefinitions" + }, + "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservices", + "operation": "Gets/List apiservices resource", + "provider": "Microsoft Container Service", + "resource": "Apiservices" + }, + "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes apiservices", + "operation": "Creates/Updates apiservices resource", + "provider": "Microsoft Container Service", + "resource": "Apiservices" + }, + "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes apiservices", + "operation": "Deletes/DeletesCollection apiservices resource", + "provider": "Microsoft Container Service", + "resource": "Apiservices" + }, + "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads controllerrevisions", + "operation": "Gets/List controllerrevisions resource", + "provider": "Microsoft Container Service", + "resource": "Controllerrevisions" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes controllerrevisions", + "operation": "Creates/Updates controllerrevisions resource", + "provider": "Microsoft Container Service", + "resource": "Controllerrevisions" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes controllerrevisions", + "operation": "Deletes/DeletesCollection controllerrevisions resource", + "provider": "Microsoft Container Service", + "resource": "Controllerrevisions" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads daemonsets", + "operation": "Gets/List daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes daemonsets", + "operation": "Creates/Updates daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes daemonsets", + "operation": "Deletes/DeletesCollection daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads deployments", + "operation": "Gets/List deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/deployments/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes deployments", + "operation": "Creates/Updates deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/deployments/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes deployments", + "operation": "Deletes/DeletesCollection deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/deployments/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads replicasets", + "operation": "Gets/List replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes replicasets", + "operation": "Creates/Updates replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes replicasets", + "operation": "Deletes/DeletesCollection replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads statefulsets", + "operation": "Gets/List statefulsets resource", + "provider": "Microsoft Container Service", + "resource": "Statefulsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes statefulsets", + "operation": "Creates/Updates statefulsets resource", + "provider": "Microsoft Container Service", + "resource": "Statefulsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes statefulsets", + "operation": "Deletes/DeletesCollection statefulsets resource", + "provider": "Microsoft Container Service", + "resource": "Statefulsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Writes tokenreviews", + "operation": "Creates/Updates tokenreviews resource", + "provider": "Microsoft Container Service", + "resource": "Tokenreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authentication.k8s.io/tokenreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes localsubjectaccessreviews", + "operation": "Creates/Updates localsubjectaccessreviews resource", + "provider": "Microsoft Container Service", + "resource": "Localsubjectaccessreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/localsubjectaccessreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes selfsubjectaccessreviews", + "operation": "Creates/Updates selfsubjectaccessreviews resource", + "provider": "Microsoft Container Service", + "resource": "Selfsubjectaccessreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/selfsubjectaccessreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes selfsubjectrulesreviews", + "operation": "Creates/Updates selfsubjectrulesreviews resource", + "provider": "Microsoft Container Service", + "resource": "Selfsubjectrulesreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/selfsubjectrulesreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes subjectaccessreviews", + "operation": "Creates/Updates subjectaccessreviews resource", + "provider": "Microsoft Container Service", + "resource": "Subjectaccessreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/subjectaccessreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Reads horizontalpodautoscalers", + "operation": "Gets/List horizontalpodautoscalers resource", + "provider": "Microsoft Container Service", + "resource": "Horizontalpodautoscalers" + }, + "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes horizontalpodautoscalers", + "operation": "Creates/Updates horizontalpodautoscalers resource", + "provider": "Microsoft Container Service", + "resource": "Horizontalpodautoscalers" + }, + "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes horizontalpodautoscalers", + "operation": "Deletes/DeletesCollection horizontalpodautoscalers resource", + "provider": "Microsoft Container Service", + "resource": "Horizontalpodautoscalers" + }, + "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads cronjobs", + "operation": "Gets/List cronjobs resource", + "provider": "Microsoft Container Service", + "resource": "Cronjobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes cronjobs", + "operation": "Creates/Updates cronjobs resource", + "provider": "Microsoft Container Service", + "resource": "Cronjobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes cronjobs", + "operation": "Deletes/DeletesCollection cronjobs resource", + "provider": "Microsoft Container Service", + "resource": "Cronjobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads jobs", + "operation": "Gets/List jobs resource", + "provider": "Microsoft Container Service", + "resource": "Jobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/jobs/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes jobs", + "operation": "Creates/Updates jobs resource", + "provider": "Microsoft Container Service", + "resource": "Jobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/jobs/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes jobs", + "operation": "Deletes/DeletesCollection jobs resource", + "provider": "Microsoft Container Service", + "resource": "Jobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/jobs/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads certificatesigningrequests", + "operation": "Gets/List certificatesigningrequests resource", + "provider": "Microsoft Container Service", + "resource": "Certificatesigningrequests" + }, + "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes certificatesigningrequests", + "operation": "Creates/Updates certificatesigningrequests resource", + "provider": "Microsoft Container Service", + "resource": "Certificatesigningrequests" + }, + "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes certificatesigningrequests", + "operation": "Deletes/DeletesCollection certificatesigningrequests resource", + "provider": "Microsoft Container Service", + "resource": "Certificatesigningrequests" + }, + "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads leases", + "operation": "Gets/List leases resource", + "provider": "Microsoft Container Service", + "resource": "Leases" + }, + "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes leases", + "operation": "Creates/Updates leases resource", + "provider": "Microsoft Container Service", + "resource": "Leases" + }, + "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes leases", + "operation": "Deletes/DeletesCollection leases resource", + "provider": "Microsoft Container Service", + "resource": "Leases" + }, + "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Writes bindings", + "operation": "Creates/Updates bindings resource", + "provider": "Microsoft Container Service", + "resource": "Bindings" + }, + "name": "Microsoft.ContainerService/managedClusters/bindings/write", + "origin": "user,system" + }, + { + "display": { + "description": "Reads componentstatuses", + "operation": "Gets/List componentstatuses resource", + "provider": "Microsoft Container Service", + "resource": "Componentstatuses" + }, + "name": "Microsoft.ContainerService/managedClusters/componentstatuses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes componentstatuses", + "operation": "Creates/Updates componentstatuses resource", + "provider": "Microsoft Container Service", + "resource": "Componentstatuses" + }, + "name": "Microsoft.ContainerService/managedClusters/componentstatuses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes componentstatuses", + "operation": "Deletes/DeletesCollection componentstatuses resource", + "provider": "Microsoft Container Service", + "resource": "Componentstatuses" + }, + "name": "Microsoft.ContainerService/managedClusters/componentstatuses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads configmaps", + "operation": "Gets/List configmaps resource", + "provider": "Microsoft Container Service", + "resource": "Configmaps" + }, + "name": "Microsoft.ContainerService/managedClusters/configmaps/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes configmaps", + "operation": "Creates/Updates configmaps resource", + "provider": "Microsoft Container Service", + "resource": "Configmaps" + }, + "name": "Microsoft.ContainerService/managedClusters/configmaps/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes configmaps", + "operation": "Deletes/DeletesCollection configmaps resource", + "provider": "Microsoft Container Service", + "resource": "Configmaps" + }, + "name": "Microsoft.ContainerService/managedClusters/configmaps/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads endpoints", + "operation": "Gets/List endpoints resource", + "provider": "Microsoft Container Service", + "resource": "Endpoints" + }, + "name": "Microsoft.ContainerService/managedClusters/endpoints/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes endpoints", + "operation": "Creates/Updates endpoints resource", + "provider": "Microsoft Container Service", + "resource": "Endpoints" + }, + "name": "Microsoft.ContainerService/managedClusters/endpoints/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes endpoints", + "operation": "Deletes/DeletesCollection endpoints resource", + "provider": "Microsoft Container Service", + "resource": "Endpoints" + }, + "name": "Microsoft.ContainerService/managedClusters/endpoints/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events", + "operation": "Gets/List events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes events", + "operation": "Creates/Updates events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes events", + "operation": "Deletes/DeletesCollection events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads limitranges", + "operation": "Gets/List limitranges resource", + "provider": "Microsoft Container Service", + "resource": "Limitranges" + }, + "name": "Microsoft.ContainerService/managedClusters/limitranges/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes limitranges", + "operation": "Creates/Updates limitranges resource", + "provider": "Microsoft Container Service", + "resource": "Limitranges" + }, + "name": "Microsoft.ContainerService/managedClusters/limitranges/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes limitranges", + "operation": "Deletes/DeletesCollection limitranges resource", + "provider": "Microsoft Container Service", + "resource": "Limitranges" + }, + "name": "Microsoft.ContainerService/managedClusters/limitranges/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads namespaces", + "operation": "Gets/List namespaces resource", + "provider": "Microsoft Container Service", + "resource": "Namespaces" + }, + "name": "Microsoft.ContainerService/managedClusters/namespaces/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes namespaces", + "operation": "Creates/Updates namespaces resource", + "provider": "Microsoft Container Service", + "resource": "Namespaces" + }, + "name": "Microsoft.ContainerService/managedClusters/namespaces/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes namespaces", + "operation": "Deletes/DeletesCollection namespaces resource", + "provider": "Microsoft Container Service", + "resource": "Namespaces" + }, + "name": "Microsoft.ContainerService/managedClusters/namespaces/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads nodes", + "operation": "Gets/List nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/nodes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes nodes", + "operation": "Creates/Updates nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/nodes/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes nodes", + "operation": "Deletes/DeletesCollection nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/nodes/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads persistentvolumeclaims", + "operation": "Gets/List persistentvolumeclaims resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumeclaims" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes persistentvolumeclaims", + "operation": "Creates/Updates persistentvolumeclaims resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumeclaims" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes persistentvolumeclaims", + "operation": "Deletes/DeletesCollection persistentvolumeclaims resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumeclaims" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads persistentvolumes", + "operation": "Gets/List persistentvolumes resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumes" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes persistentvolumes", + "operation": "Creates/Updates persistentvolumes resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumes" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes persistentvolumes", + "operation": "Deletes/DeletesCollection persistentvolumes resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumes" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads pods", + "operation": "Gets/List pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes pods", + "operation": "Creates/Updates pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes pods", + "operation": "Deletes/DeletesCollection pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Exec into pods resource", + "operation": "Exec into pods resource ", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/exec/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reads podtemplates", + "operation": "Gets/List podtemplates resource", + "provider": "Microsoft Container Service", + "resource": "Podtemplates" + }, + "name": "Microsoft.ContainerService/managedClusters/podtemplates/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes podtemplates", + "operation": "Creates/Updates podtemplates resource", + "provider": "Microsoft Container Service", + "resource": "Podtemplates" + }, + "name": "Microsoft.ContainerService/managedClusters/podtemplates/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes podtemplates", + "operation": "Deletes/DeletesCollection podtemplates resource", + "provider": "Microsoft Container Service", + "resource": "Podtemplates" + }, + "name": "Microsoft.ContainerService/managedClusters/podtemplates/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads replicationcontrollers", + "operation": "Gets/List replicationcontrollers resource", + "provider": "Microsoft Container Service", + "resource": "Replicationcontrollers" + }, + "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes replicationcontrollers", + "operation": "Creates/Updates replicationcontrollers resource", + "provider": "Microsoft Container Service", + "resource": "Replicationcontrollers" + }, + "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes replicationcontrollers", + "operation": "Deletes/DeletesCollection replicationcontrollers resource", + "provider": "Microsoft Container Service", + "resource": "Replicationcontrollers" + }, + "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads resourcequotas", + "operation": "Gets/List resourcequotas resource", + "provider": "Microsoft Container Service", + "resource": "Resourcequotas" + }, + "name": "Microsoft.ContainerService/managedClusters/resourcequotas/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes resourcequotas", + "operation": "Creates/Updates resourcequotas resource", + "provider": "Microsoft Container Service", + "resource": "Resourcequotas" + }, + "name": "Microsoft.ContainerService/managedClusters/resourcequotas/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes resourcequotas", + "operation": "Deletes/DeletesCollection resourcequotas resource", + "provider": "Microsoft Container Service", + "resource": "Resourcequotas" + }, + "name": "Microsoft.ContainerService/managedClusters/resourcequotas/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads secrets", + "operation": "Gets/List secrets resource", + "provider": "Microsoft Container Service", + "resource": "Secrets" + }, + "name": "Microsoft.ContainerService/managedClusters/secrets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes secrets", + "operation": "Creates/Updates secrets resource", + "provider": "Microsoft Container Service", + "resource": "Secrets" + }, + "name": "Microsoft.ContainerService/managedClusters/secrets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes secrets", + "operation": "Deletes/DeletesCollection secrets resource", + "provider": "Microsoft Container Service", + "resource": "Secrets" + }, + "name": "Microsoft.ContainerService/managedClusters/secrets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads serviceaccounts", + "operation": "Gets/List serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes serviceaccounts", + "operation": "Creates/Updates serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes serviceaccounts", + "operation": "Deletes/DeletesCollection serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads services", + "operation": "Gets/List services resource", + "provider": "Microsoft Container Service", + "resource": "Services" + }, + "name": "Microsoft.ContainerService/managedClusters/services/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes services", + "operation": "Creates/Updates services resource", + "provider": "Microsoft Container Service", + "resource": "Services" + }, + "name": "Microsoft.ContainerService/managedClusters/services/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes services", + "operation": "Deletes/DeletesCollection services resource", + "provider": "Microsoft Container Service", + "resource": "Services" + }, + "name": "Microsoft.ContainerService/managedClusters/services/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events", + "operation": "Gets/List events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes events", + "operation": "Creates/Updates events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes events", + "operation": "Deletes/DeletesCollection events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads daemonsets", + "operation": "Gets/List daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes daemonsets", + "operation": "Creates/Updates daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes daemonsets", + "operation": "Deletes/DeletesCollection daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads deployments", + "operation": "Gets/List deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes deployments", + "operation": "Creates/Updates deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes deployments", + "operation": "Deletes/DeletesCollection deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ingresses", + "operation": "Gets/List ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes ingresses", + "operation": "Creates/Updates ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes ingresses", + "operation": "Deletes/DeletesCollection ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networkpolicies", + "operation": "Gets/List networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes networkpolicies", + "operation": "Creates/Updates networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes networkpolicies", + "operation": "Deletes/DeletesCollection networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads podsecuritypolicies", + "operation": "Gets/List podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes podsecuritypolicies", + "operation": "Creates/Updates podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes podsecuritypolicies", + "operation": "Deletes/DeletesCollection podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads replicasets", + "operation": "Gets/List replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes replicasets", + "operation": "Creates/Updates replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes replicasets", + "operation": "Deletes/DeletesCollection replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads pods", + "operation": "Gets/List pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/metrics.k8s.io/pods/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads nodes", + "operation": "Gets/List nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/metrics.k8s.io/nodes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networkpolicies", + "operation": "Gets/List networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes networkpolicies", + "operation": "Creates/Updates networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes networkpolicies", + "operation": "Deletes/DeletesCollection networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ingresses", + "operation": "Gets/List ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes ingresses", + "operation": "Creates/Updates ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes ingresses", + "operation": "Deletes/DeletesCollection ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads runtimeclasses", + "operation": "Gets/List runtimeclasses resource", + "provider": "Microsoft Container Service", + "resource": "Runtimeclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes runtimeclasses", + "operation": "Creates/Updates runtimeclasses resource", + "provider": "Microsoft Container Service", + "resource": "Runtimeclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes runtimeclasses", + "operation": "Deletes/DeletesCollection runtimeclasses resource", + "provider": "Microsoft Container Service", + "resource": "Runtimeclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads api", + "operation": "Gets/List api resource", + "provider": "Microsoft Container Service", + "resource": "Api" + }, + "name": "Microsoft.ContainerService/managedClusters/api/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads api/v1", + "operation": "Gets/List api/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Api/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/api/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apis", + "operation": "Gets/List apis resource", + "provider": "Microsoft Container Service", + "resource": "Apis" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads admissionregistration.k8s.io", + "operation": "Gets/List admissionregistration.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Admissionregistration.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads admissionregistration.k8s.io/v1", + "operation": "Gets/List admissionregistration.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Admissionregistration.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads admissionregistration.k8s.io/v1beta1", + "operation": "Gets/List admissionregistration.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Admissionregistration.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiextensions.k8s.io", + "operation": "Gets/List apiextensions.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Apiextensions.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiextensions.k8s.io/v1", + "operation": "Gets/List apiextensions.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiextensions.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiextensions.k8s.io/v1beta1", + "operation": "Gets/List apiextensions.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiextensions.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiregistration.k8s.io", + "operation": "Gets/List apiregistration.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Apiregistration.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiregistration.k8s.io/v1", + "operation": "Gets/List apiregistration.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiregistration.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiregistration.k8s.io/v1beta1", + "operation": "Gets/List apiregistration.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiregistration.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps", + "operation": "Gets/List apps resource", + "provider": "Microsoft Container Service", + "resource": "Apps" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps/v1", + "operation": "Gets/List apps/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Apps/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps/v1beta1", + "operation": "Gets/List apps/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Apps/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps/v1beta2", + "operation": "Gets/List apps/v1beta2 resource", + "provider": "Microsoft Container Service", + "resource": "Apps/V1beta2" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1beta2/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authentication.k8s.io", + "operation": "Gets/List authentication.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Authentication.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authentication.k8s.io/v1", + "operation": "Gets/List authentication.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Authentication.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authentication.k8s.io/v1beta1", + "operation": "Gets/List authentication.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Authentication.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authorization.k8s.io", + "operation": "Gets/List authorization.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Authorization.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authorization.k8s.io/v1", + "operation": "Gets/List authorization.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Authorization.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authorization.k8s.io/v1beta1", + "operation": "Gets/List authorization.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Authorization.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling", + "operation": "Gets/List autoscaling resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling/v1", + "operation": "Gets/List autoscaling/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling/v2beta1", + "operation": "Gets/List autoscaling/v2beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling/V2beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v2beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling/v2beta2", + "operation": "Gets/List autoscaling/v2beta2 resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling/V2beta2" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v2beta2/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads batch", + "operation": "Gets/List batch resource", + "provider": "Microsoft Container Service", + "resource": "Batch" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/batch/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads batch/v1", + "operation": "Gets/List batch/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Batch/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/batch/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads batch/v1beta1", + "operation": "Gets/List batch/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Batch/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/batch/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads certificates.k8s.io", + "operation": "Gets/List certificates.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Certificates.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/certificates.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads certificates.k8s.io/v1beta1", + "operation": "Gets/List certificates.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Certificates.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/certificates.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads coordination.k8s.io", + "operation": "Gets/List coordination.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Coordination.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads coordination/v1", + "operation": "Gets/List coordination/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Coordination.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads coordination.k8s.io/v1beta1", + "operation": "Gets/List coordination.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Coordination.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events.k8s.io", + "operation": "Gets/List events.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Events.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/events.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events.k8s.io/v1beta1", + "operation": "Gets/List events.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Events.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/events.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads extensions", + "operation": "Gets/List extensions resource", + "provider": "Microsoft Container Service", + "resource": "Extensions" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/extensions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads extensions/v1beta1", + "operation": "Gets/List extensions/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Extensions/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/extensions/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads metrics.k8s.io", + "operation": "Gets/List metrics.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Metrics.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/metrics.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads metrics.k8s.io/v1beta1", + "operation": "Gets/List metrics.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Metrics.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/metrics.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networking.k8s.io", + "operation": "Gets/List networking.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Networking.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networking/v1", + "operation": "Gets/List networking/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Networking.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networking.k8s.io/v1beta1", + "operation": "Gets/List networking.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Networking.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads node.k8s.io", + "operation": "Gets/List node.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Node.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/node.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads node.k8s.io/v1beta1", + "operation": "Gets/List node.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Node.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/node.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads policy", + "operation": "Gets/List policy resource", + "provider": "Microsoft Container Service", + "resource": "Policy" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/policy/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads policy/v1beta1", + "operation": "Gets/List policy/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Policy/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/policy/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rbac.authorization.k8s.io", + "operation": "Gets/List rbac.authorization.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Rbac.Authorization.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rbac.authorization/v1", + "operation": "Gets/List rbac.authorization/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Rbac.Authorization.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rbac.authorization.k8s.io/v1beta1", + "operation": "Gets/List rbac.authorization.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Rbac.Authorization.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads scheduling.k8s.io", + "operation": "Gets/List scheduling.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Scheduling.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads scheduling/v1", + "operation": "Gets/List scheduling/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Scheduling.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads scheduling.k8s.io/v1beta1", + "operation": "Gets/List scheduling.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Scheduling.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storage.k8s.io", + "operation": "Gets/List storage.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Storage.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storage/v1", + "operation": "Gets/List storage/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Storage.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storage.k8s.io/v1beta1", + "operation": "Gets/List storage.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Storage.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads healthz", + "operation": "Gets/List healthz resource", + "provider": "Microsoft Container Service", + "resource": "Healthz" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoregister-completion", + "operation": "Gets/List autoregister-completion resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Autoregister-Completion" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/autoregister-completion/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads etcd", + "operation": "Gets/List etcd resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Etcd" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/etcd/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads log", + "operation": "Gets/List log resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Log" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/log/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ping", + "operation": "Gets/List ping resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Ping" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/ping/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-openapi-controller", + "operation": "Gets/List apiservice-openapi-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Apiservice-Openapi-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-openapi-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-registration-controller", + "operation": "Gets/List apiservice-registration-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Apiservice-Registration-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-registration-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-status-available-controller", + "operation": "Gets/List apiservice-status-available-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Apiservice-Status-Available-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-status-available-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-controller", + "operation": "Gets/List bootstrap-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Bootstrap-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/bootstrap-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ca-registration", + "operation": "Gets/List ca-registration resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Ca-Registration" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/ca-registration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads crd-informer-synced", + "operation": "Gets/List crd-informer-synced resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Crd-Informer-Synced" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/crd-informer-synced/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads generic-apiserver-start-informers", + "operation": "Gets/List generic-apiserver-start-informers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Generic-Apiserver-Start-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/generic-apiserver-start-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads kube-apiserver-autoregistration", + "operation": "Gets/List kube-apiserver-autoregistration resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Kube-Apiserver-Autoregistration" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/kube-apiserver-autoregistration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-roles", + "operation": "Gets/List bootstrap-roles resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Bootstrap-Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/rbac/bootstrap-roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-system-priority-classes", + "operation": "Gets/List bootstrap-system-priority-classes resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Bootstrap-System-Priority-Classes" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/scheduling/bootstrap-system-priority-classes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-controllers", + "operation": "Gets/List start-apiextensions-controllers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Apiextensions-Controllers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-apiextensions-controllers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-informers", + "operation": "Gets/List start-apiextensions-informers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Apiextensions-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-apiextensions-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-aggregator-informers", + "operation": "Gets/List start-kube-aggregator-informers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Kube-Aggregator-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-kube-aggregator-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-apiserver-admission-initializer", + "operation": "Gets/List start-kube-apiserver-admission-initializer resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Kube-Apiserver-Admission-Initializer" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-kube-apiserver-admission-initializer/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads livez", + "operation": "Gets/List livez resource", + "provider": "Microsoft Container Service", + "resource": "Livez" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoregister-completion", + "operation": "Gets/List autoregister-completion resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Autoregister-Completion" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/autoregister-completion/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads etcd", + "operation": "Gets/List etcd resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Etcd" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/etcd/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads log", + "operation": "Gets/List log resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Log" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/log/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ping", + "operation": "Gets/List ping resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Ping" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/ping/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-openapi-controller", + "operation": "Gets/List apiservice-openapi-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Apiservice-Openapi-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-openapi-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-registration-controller", + "operation": "Gets/List apiservice-registration-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Apiservice-Registration-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-registration-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-status-available-controller", + "operation": "Gets/List apiservice-status-available-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Apiservice-Status-Available-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-status-available-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-controller", + "operation": "Gets/List bootstrap-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Bootstrap-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/bootstrap-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ca-registration", + "operation": "Gets/List ca-registration resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Ca-Registration" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/ca-registration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads crd-informer-synced", + "operation": "Gets/List crd-informer-synced resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Crd-Informer-Synced" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/crd-informer-synced/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads generic-apiserver-start-informers", + "operation": "Gets/List generic-apiserver-start-informers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Generic-Apiserver-Start-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/generic-apiserver-start-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads kube-apiserver-autoregistration", + "operation": "Gets/List kube-apiserver-autoregistration resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Kube-Apiserver-Autoregistration" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/kube-apiserver-autoregistration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-roles", + "operation": "Gets/List bootstrap-roles resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Bootstrap-Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/rbac/bootstrap-roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-system-priority-classes", + "operation": "Gets/List bootstrap-system-priority-classes resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Bootstrap-System-Priority-Classes" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/scheduling/bootstrap-system-priority-classes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-controllers", + "operation": "Gets/List start-apiextensions-controllers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Apiextensions-Controllers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-apiextensions-controllers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-informers", + "operation": "Gets/List start-apiextensions-informers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Apiextensions-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-apiextensions-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-aggregator-informers", + "operation": "Gets/List start-kube-aggregator-informers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Kube-Aggregator-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-kube-aggregator-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-apiserver-admission-initializer", + "operation": "Gets/List start-kube-apiserver-admission-initializer resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Kube-Apiserver-Admission-Initializer" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-kube-apiserver-admission-initializer/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads logs", + "operation": "Gets/List logs resource", + "provider": "Microsoft Container Service", + "resource": "Logs" + }, + "name": "Microsoft.ContainerService/managedClusters/logs/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads metrics", + "operation": "Gets/List metrics resource", + "provider": "Microsoft Container Service", + "resource": "Metrics" + }, + "name": "Microsoft.ContainerService/managedClusters/metrics/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads v2", + "operation": "Gets/List v2 resource", + "provider": "Microsoft Container Service", + "resource": "Openapi/V2" + }, + "name": "Microsoft.ContainerService/managedClusters/openapi/v2/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads readyz", + "operation": "Gets/List readyz resource", + "provider": "Microsoft Container Service", + "resource": "Readyz" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoregister-completion", + "operation": "Gets/List autoregister-completion resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Autoregister-Completion" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/autoregister-completion/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads etcd", + "operation": "Gets/List etcd resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Etcd" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/etcd/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads log", + "operation": "Gets/List log resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Log" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/log/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ping", + "operation": "Gets/List ping resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Ping" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/ping/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-openapi-controller", + "operation": "Gets/List apiservice-openapi-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Apiservice-Openapi-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-openapi-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-registration-controller", + "operation": "Gets/List apiservice-registration-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Apiservice-Registration-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-registration-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-status-available-controller", + "operation": "Gets/List apiservice-status-available-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Apiservice-Status-Available-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-status-available-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-controller", + "operation": "Gets/List bootstrap-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Bootstrap-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/bootstrap-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ca-registration", + "operation": "Gets/List ca-registration resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Ca-Registration" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/ca-registration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads crd-informer-synced", + "operation": "Gets/List crd-informer-synced resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Crd-Informer-Synced" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/crd-informer-synced/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads generic-apiserver-start-informers", + "operation": "Gets/List generic-apiserver-start-informers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Generic-Apiserver-Start-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/generic-apiserver-start-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads kube-apiserver-autoregistration", + "operation": "Gets/List kube-apiserver-autoregistration resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Kube-Apiserver-Autoregistration" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/kube-apiserver-autoregistration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-roles", + "operation": "Gets/List bootstrap-roles resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Bootstrap-Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/rbac/bootstrap-roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-system-priority-classes", + "operation": "Gets/List bootstrap-system-priority-classes resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Bootstrap-System-Priority-Classes" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/scheduling/bootstrap-system-priority-classes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-controllers", + "operation": "Gets/List start-apiextensions-controllers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Apiextensions-Controllers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-apiextensions-controllers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-informers", + "operation": "Gets/List start-apiextensions-informers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Apiextensions-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-apiextensions-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-aggregator-informers", + "operation": "Gets/List start-kube-aggregator-informers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Kube-Aggregator-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-kube-aggregator-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-apiserver-admission-initializer", + "operation": "Gets/List start-kube-apiserver-admission-initializer resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Kube-Apiserver-Admission-Initializer" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-kube-apiserver-admission-initializer/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads shutdown", + "operation": "Gets/List shutdown resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Shutdown" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/shutdown/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads resetMetrics", + "operation": "Gets/List resetMetrics resource", + "provider": "Microsoft Container Service", + "resource": "Resetmetrics" + }, + "name": "Microsoft.ContainerService/managedClusters/resetMetrics/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads swagger-ui", + "operation": "Gets/List swagger-ui resource", + "provider": "Microsoft Container Service", + "resource": "Swagger-Ui" + }, + "name": "Microsoft.ContainerService/managedClusters/swagger-ui/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads swagger-api", + "operation": "Gets/List swagger-api resource", + "provider": "Microsoft Container Service", + "resource": "Swagger-Api" + }, + "name": "Microsoft.ContainerService/managedClusters/swagger-api/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ui", + "operation": "Gets/List ui resource", + "provider": "Microsoft Container Service", + "resource": "Ui" + }, + "name": "Microsoft.ContainerService/managedClusters/ui/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads version", + "operation": "Gets/List version resource", + "provider": "Microsoft Container Service", + "resource": "Version" + }, + "name": "Microsoft.ContainerService/managedClusters/version/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads poddisruptionbudgets", + "operation": "Gets/List poddisruptionbudgets resource", + "provider": "Microsoft Container Service", + "resource": "Poddisruptionbudgets" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes poddisruptionbudgets", + "operation": "Creates/Updates poddisruptionbudgets resource", + "provider": "Microsoft Container Service", + "resource": "Poddisruptionbudgets" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes poddisruptionbudgets", + "operation": "Deletes/DeletesCollection poddisruptionbudgets resource", + "provider": "Microsoft Container Service", + "resource": "Poddisruptionbudgets" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads podsecuritypolicies", + "operation": "Gets/List podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes podsecuritypolicies", + "operation": "Creates/Updates podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes podsecuritypolicies", + "operation": "Deletes/DeletesCollection podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads clusterrolebindings", + "operation": "Gets/List clusterrolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Clusterrolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes clusterrolebindings", + "operation": "Creates/Updates clusterrolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Clusterrolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes clusterrolebindings", + "operation": "Deletes/DeletesCollection clusterrolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Clusterrolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads clusterroles", + "operation": "Gets/List clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes clusterroles", + "operation": "Creates/Updates clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes clusterroles", + "operation": "Deletes/DeletesCollection clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rolebindings", + "operation": "Gets/List rolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Rolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes rolebindings", + "operation": "Creates/Updates rolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Rolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes rolebindings", + "operation": "Deletes/DeletesCollection rolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Rolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads roles", + "operation": "Gets/List roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes roles", + "operation": "Creates/Updates roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes roles", + "operation": "Deletes/DeletesCollection roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads priorityclasses", + "operation": "Gets/List priorityclasses resource", + "provider": "Microsoft Container Service", + "resource": "Priorityclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes priorityclasses", + "operation": "Creates/Updates priorityclasses resource", + "provider": "Microsoft Container Service", + "resource": "Priorityclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes priorityclasses", + "operation": "Deletes/DeletesCollection priorityclasses resource", + "provider": "Microsoft Container Service", + "resource": "Priorityclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Use action on podsecuritypolicies", + "operation": "Use podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/use/action", + "origin": "user,system" + }, + { + "display": { + "description": "Binds clusterroles", + "operation": "Bind clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/bind/action", + "origin": "user,system" + }, + { + "display": { + "description": "Escalates", + "operation": "Escalate clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/escalate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Binds roles", + "operation": "Bind roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/bind/action", + "origin": "user,system" + }, + { + "display": { + "description": "Escalates roles", + "operation": "Escalate roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/escalate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate serviceaccounts", + "operation": "Impersonate serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate users", + "operation": "Impersonate users resource", + "provider": "Microsoft Container Service", + "resource": "Users" + }, + "name": "Microsoft.ContainerService/managedClusters/users/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate groups", + "operation": "Impersonate groups resource", + "provider": "Microsoft Container Service", + "resource": "Groups" + }, + "name": "Microsoft.ContainerService/managedClusters/groups/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate userextras", + "operation": "Impersonate userextras resource", + "provider": "Microsoft Container Service", + "resource": "Userextras" + }, + "name": "Microsoft.ContainerService/managedClusters/authentication.k8s.io/userextras/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storageclasses", + "operation": "Gets/List storageclasses resource", + "provider": "Microsoft Container Service", + "resource": "Storageclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes storageclasses", + "operation": "Creates/Updates storageclasses resource", + "provider": "Microsoft Container Service", + "resource": "Storageclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes storageclasses", + "operation": "Deletes/DeletesCollection storageclasses resource", + "provider": "Microsoft Container Service", + "resource": "Storageclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads volumeattachments", + "operation": "Gets/List volumeattachments resource", + "provider": "Microsoft Container Service", + "resource": "Volumeattachments" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes volumeattachments", + "operation": "Creates/Updates volumeattachments resource", + "provider": "Microsoft Container Service", + "resource": "Volumeattachments" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes volumeattachments", + "operation": "Deletes/DeletesCollection volumeattachments resource", + "provider": "Microsoft Container Service", + "resource": "Volumeattachments" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads csidrivers", + "operation": "Gets/List csidrivers resource", + "provider": "Microsoft Container Service", + "resource": "Csidrivers" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes csidrivers", + "operation": "Creates/Updates csidrivers resource", + "provider": "Microsoft Container Service", + "resource": "Csidrivers" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes csidrivers", + "operation": "Deletes/DeletesCollection csidrivers resource", + "provider": "Microsoft Container Service", + "resource": "Csidrivers" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads csinodes", + "operation": "Gets/List csinodes resource", + "provider": "Microsoft Container Service", + "resource": "Csinodes" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes csinodes", + "operation": "Creates/Updates csinodes resource", + "provider": "Microsoft Container Service", + "resource": "Csinodes" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes csinodes", + "operation": "Deletes/DeletesCollection csinodes resource", + "provider": "Microsoft Container Service", + "resource": "Csinodes" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the available metrics for Managed Cluster", + "operation": "Read Managed Cluster metric definitions", + "provider": "Microsoft Container Service", + "resource": "The metric definition of Managed Cluster" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/metricDefinitions/read", + "origin": "system" + }, + { + "display": { + "description": "Gets the available logs for Managed Cluster", + "operation": "Read Managed Cluster log definitions", + "provider": "Microsoft Container Service", + "resource": "The log definition of Managed Cluster" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/logDefinitions/read", + "origin": "system" + }, + { + "display": { + "description": "Get a Open Shift Managed Cluster", + "operation": "Get Open Shift Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Managed Cluster" + }, + "name": "Microsoft.ContainerService/openShiftManagedClusters/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new Open Shift Managed Cluster or updates an existing one", + "operation": "Create or Update Open Shift Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Managed Cluster" + }, + "name": "Microsoft.ContainerService/openShiftManagedClusters/write", + "origin": "user,system" + }, + { + "display": { + "description": "Delete a Open Shift Managed Cluster", + "operation": "Delete Open Shift Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Managed Cluster" + }, + "name": "Microsoft.ContainerService/openShiftManagedClusters/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Get a Open Shift Cluster", + "operation": "Get Open Shift Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Cluster" + }, + "name": "Microsoft.ContainerService/openShiftClusters/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new Open Shift Cluster or updates an existing one", + "operation": "Create or Update Open Shift Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Cluster" + }, + "name": "Microsoft.ContainerService/openShiftClusters/write", + "origin": "user,system" + }, + { + "display": { + "description": "Delete a Open Shift Cluster", + "operation": "Delete Open Shift Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Cluster" + }, + "name": "Microsoft.ContainerService/openShiftClusters/delete", + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/OutboundNetworkDependenciesEndpointsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/OutboundNetworkDependenciesEndpointsList.json new file mode 100644 index 000000000000..9f65a0068d9d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/OutboundNetworkDependenciesEndpointsList.json @@ -0,0 +1,242 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "management.azure.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "login.microsoftonline.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "images", + "endpoints": [ + { + "domainName": "mcr.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "*.data.mcr.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https", + "description": "mcr cdn" + } + ] + } + ] + }, + { + "category": "artifacts", + "endpoints": [ + { + "domainName": "packages.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "acs-mirror.azureedge.net", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "time-sync", + "endpoints": [ + { + "domainName": "ntp.ubuntu.com", + "endpointDetails": [ + { + "port": 123, + "protocol": "UDP" + } + ] + } + ] + }, + { + "category": "ubuntu-optional", + "endpoints": [ + { + "domainName": "security.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "azure.archive.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "changelogs.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + } + ] + }, + { + "category": "gpu", + "endpoints": [ + { + "domainName": "nvidia.github.io", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "us.download.nvidia.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "apt.dockerproject.org", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "windows", + "endpoints": [ + { + "domainName": "onegetcdn.azureedge.net", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "go.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "*.mp.microsoft.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "www.msftconnecttest.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "ctldl.windowsupdate.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + } + ] + }, + { + "category": "apiserver", + "endpoints": [ + { + "domainName": "*.azmk8s.io", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "tunnel-classic", + "endpoints": [ + { + "domainName": "*.azmk8s.io", + "endpointDetails": [ + { + "port": 9000, + "protocol": "TCP" + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/PrivateEndpointConnectionsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/PrivateEndpointConnectionsDelete.json new file mode 100644 index 000000000000..c00154dc2d00 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/PrivateEndpointConnectionsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/PrivateEndpointConnectionsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/PrivateEndpointConnectionsGet.json new file mode 100644 index 000000000000..fa0578a8ec08 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/PrivateEndpointConnectionsGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/PrivateEndpointConnectionsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/PrivateEndpointConnectionsList.json new file mode 100644 index 000000000000..a5ddc2722077 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/PrivateEndpointConnectionsList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/PrivateEndpointConnectionsUpdate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/PrivateEndpointConnectionsUpdate.json new file mode 100644 index 000000000000..552c16108f57 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/PrivateEndpointConnectionsUpdate.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/PrivateLinkResourcesList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/PrivateLinkResourcesList.json new file mode 100644 index 000000000000..af552cdb134f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/PrivateLinkResourcesList.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "management", + "type": "Microsoft.ContainerService/managedClusters/privateLinkResources", + "groupId": "management", + "requiredMembers": [ + "management" + ], + "privateLinkServiceID": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/plsName" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ResolvePrivateLinkServiceId.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ResolvePrivateLinkServiceId.json new file mode 100644 index 000000000000..30848cd8e0cc --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/ResolvePrivateLinkServiceId.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "name": "management" + } + }, + "responses": { + "200": { + "body": { + "privateLinkServiceID": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/plsName" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/RunCommandRequest.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/RunCommandRequest.json new file mode 100644 index 000000000000..25f3f4e883b8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/RunCommandRequest.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "requestPayload": { + "command": "kubectl apply -f ns.yaml", + "context": "", + "clusterToken": "" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2024-05-02-preview" + } + }, + "200": { + "description": "to mitigate RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE", + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "succeeded", + "exitCode": 0, + "startedAt": "2021-02-17T00:28:20Z", + "finishedAt": "2021-02-17T00:28:33Z", + "logs": "namespace dummy created" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/RunCommandResultFailed.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/RunCommandResultFailed.json new file mode 100644 index 000000000000..66fcd287f894 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/RunCommandResultFailed.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "commandId": "def7b3ea71bd4f7e9d226ddbc0f00ad9" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2024-05-02-preview" + } + }, + "200": { + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "failed", + "reason": "ImagePullBackoff" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/RunCommandResultSucceed.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/RunCommandResultSucceed.json new file mode 100644 index 000000000000..43173b6345ca --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/RunCommandResultSucceed.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "commandId": "def7b3ea71bd4f7e9d226ddbc0f00ad9" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2024-05-02-preview" + } + }, + "200": { + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "succeeded", + "exitCode": 0, + "startedAt": "2021-02-17T00:28:20Z", + "finishedAt": "2021-02-17T00:28:33Z", + "logs": "namespace dummy created" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/SnapshotsCreate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/SnapshotsCreate.json new file mode 100644 index 000000000000..ea0f3097d8a5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/SnapshotsCreate.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1", + "parameters": { + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + }, + "201": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/SnapshotsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/SnapshotsDelete.json new file mode 100644 index 000000000000..1717f59ac0d2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/SnapshotsDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/SnapshotsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/SnapshotsGet.json new file mode 100644 index 000000000000..bc74d957cedb --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/SnapshotsGet.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1" + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/SnapshotsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/SnapshotsList.json new file mode 100644 index 000000000000..3d3b81b5a8f1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/SnapshotsList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/SnapshotsListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/SnapshotsListByResourceGroup.json new file mode 100644 index 000000000000..4031e4135bb0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/SnapshotsListByResourceGroup.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/SnapshotsUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/SnapshotsUpdateTags.json new file mode 100644 index 000000000000..f669e7daeb4a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/SnapshotsUpdateTags.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1", + "parameters": { + "tags": { + "key2": "new-val2", + "key3": "val3" + } + } + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/TrustedAccessRoleBindings_CreateOrUpdate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/TrustedAccessRoleBindings_CreateOrUpdate.json new file mode 100644 index 000000000000..49c72fed7fc7 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/TrustedAccessRoleBindings_CreateOrUpdate.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "trustedAccessRoleBindingName": "binding1", + "trustedAccessRoleBinding": { + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/TrustedAccessRoleBindings_Delete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/TrustedAccessRoleBindings_Delete.json new file mode 100644 index 000000000000..5a129cf29933 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/TrustedAccessRoleBindings_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "trustedAccessRoleBindingName": "binding1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/TrustedAccessRoleBindings_Get.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/TrustedAccessRoleBindings_Get.json new file mode 100644 index 000000000000..00a60484f2b4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/TrustedAccessRoleBindings_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "trustedAccessRoleBindingName": "binding1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/TrustedAccessRoleBindings_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/TrustedAccessRoleBindings_List.json new file mode 100644 index 000000000000..0ff50f642246 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/TrustedAccessRoleBindings_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/TrustedAccessRoles_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/TrustedAccessRoles_List.json new file mode 100644 index 000000000000..760baf109067 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/examples/TrustedAccessRoles_List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-05-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "westus2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sourceResourceType": "Microsoft.MachineLearningServices/workspaces", + "name": "reader", + "rules": [ + { + "verbs": [ + "get" + ], + "apiGroups": [ + "" + ], + "resources": [ + "pods" + ], + "resourceNames": [], + "nonResourceURLs": [] + } + ] + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/managedClusters.json new file mode 100644 index 000000000000..97d66937b363 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2024-05-02-preview/managedClusters.json @@ -0,0 +1,10129 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerServiceClient", + "description": "The Container Service Client.", + "version": "2024-05-02-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.ContainerService/operations": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "Operations_List", + "summary": "Gets a list of operations.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List available operations for the container service resource provider": { + "$ref": "./examples/Operation_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/kubernetesVersions": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListKubernetesVersions", + "summary": "Gets a list of supported Kubernetes versions in the specified subscription.", + "description": "Contains extra metadata on the version, including supported patch versions, capabilities, available upgrades, and details on preview status of the version", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/KubernetesVersionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Kubernetes Versions": { + "$ref": "./examples/KubernetesVersions_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_List", + "summary": "Gets a list of managed clusters in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Managed Clusters": { + "$ref": "./examples/ManagedClustersList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListByResourceGroup", + "summary": "Lists managed clusters in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Managed Clusters by Resource Group": { + "$ref": "./examples/ManagedClustersListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/upgradeProfiles/default": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetUpgradeProfile", + "summary": "Gets the upgrade profile of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Managed Cluster": { + "$ref": "./examples/ManagedClustersGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/accessProfiles/{roleName}/listCredential": { + "post": { + "deprecated": true, + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetAccessProfile", + "summary": "Gets an access profile of a managed cluster.", + "description": "**WARNING**: This API will be deprecated. Instead use [ListClusterUserCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusterusercredentials) or [ListClusterAdminCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusteradmincredentials) .", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "roleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role for managed cluster accessProfile resource." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterAccessProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGetAccessProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterAdminCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterAdminCredentials", + "summary": "Lists the admin credentials of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterCredentialResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterUserCredentials", + "summary": "Lists the user credentials of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + }, + { + "$ref": "#/parameters/CredentialFormatParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterCredentialResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterMonitoringUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterMonitoringUserCredentials", + "summary": "Lists the cluster monitoring user credentials of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterCredentialResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Get", + "summary": "Gets a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_CreateOrUpdate", + "summary": "Creates or updates a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "The managed cluster to create or update." + }, + { + "name": "If-Match", + "in": "header", + "description": "The request should only proceed if an entity matches this string.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "The request should only proceed if no entity matches this string.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + } + ], + "responses": { + "200": { + "description": "The existing managed cluster was successfully updated.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "201": { + "description": "The new managed cluster was successfully created.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Managed Cluster": { + "$ref": "./examples/ManagedClustersCreate_Update.json" + }, + "Create/Update AAD Managed Cluster with EnableAzureRBAC": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json" + }, + "Create/Update Managed Cluster with EnableNamespaceResources": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithEnableNamespaceResources.json" + }, + "Create Managed Cluster with PPG": { + "$ref": "./examples/ManagedClustersCreate_PPG.json" + }, + "Create Managed Cluster with OSSKU": { + "$ref": "./examples/ManagedClustersCreate_OSSKU.json" + }, + "Create Managed Cluster with GPUMIG": { + "$ref": "./examples/ManagedClustersCreate_GPUMIG.json" + }, + "Create/Update Managed Cluster with EnableAHUB": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithAHUB.json" + }, + "Create Managed Cluster with EncryptionAtHost enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableEncryptionAtHost.json" + }, + "Create Managed Cluster with UltraSSD enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableUltraSSD.json" + }, + "Create Managed Cluster with PodIdentity enabled": { + "$ref": "./examples/ManagedClustersCreate_PodIdentity.json" + }, + "Create Managed Private Cluster with fqdn subdomain specified": { + "$ref": "./examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json" + }, + "Create Managed Private Cluster with Public FQDN specified": { + "$ref": "./examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json" + }, + "Create Managed Cluster with RunCommand disabled": { + "$ref": "./examples/ManagedClustersCreate_DisableRunCommand.json" + }, + "Create Managed Cluster with LongTermSupport": { + "$ref": "./examples/ManagedClustersCreate_Premium.json" + }, + "Create Managed Cluster with Node Public IP Prefix": { + "$ref": "./examples/ManagedClustersCreate_NodePublicIPPrefix.json" + }, + "Create Managed Cluster with Azure Key Vault Secrets Provider Addon": { + "$ref": "./examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json" + }, + "Create/Update Managed Cluster with Azure Service Mesh": { + "$ref": "./examples/ManagedClustersCreate_AzureServiceMesh.json" + }, + "Create Managed Cluster with FIPS enabled OS": { + "$ref": "./examples/ManagedClustersCreate_EnabledFIPS.json" + }, + "Create Managed Cluster with HTTP proxy configured": { + "$ref": "./examples/ManagedClustersCreate_HTTPProxy.json" + }, + "Create Managed Cluster with Security Profile configured": { + "$ref": "./examples/ManagedClustersCreate_SecurityProfile.json" + }, + "Create Managed Cluster with Web App Routing Ingress Profile configured": { + "$ref": "./examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json" + }, + "Create Managed Cluster with AKS-managed NAT gateway as outbound type": { + "$ref": "./examples/ManagedClustersCreate_ManagedNATGateway.json" + }, + "Create Managed Cluster with user-assigned NAT gateway as outbound type": { + "$ref": "./examples/ManagedClustersCreate_UserAssignedNATGateway.json" + }, + "Create Managed Cluster using an agent pool snapshot": { + "$ref": "./examples/ManagedClustersCreate_Snapshot.json" + }, + "Create Managed Cluster using a managed cluster snapshot": { + "$ref": "./examples/ManagedClustersCreate_MCSnapshot.json" + }, + "Create/Update Managed Cluster with Windows gMSA enabled": { + "$ref": "./examples/ManagedClustersCreate_UpdateWindowsGmsa.json" + }, + "Create/Update Managed Cluster with dual-stack networking": { + "$ref": "./examples/ManagedClustersCreate_DualStackNetworking.json" + }, + "Associate Managed Cluster with Capacity Reservation Group": { + "$ref": "./examples/ManagedClustersAssociate_CRG.json" + }, + "Create Managed Cluster with Dedicated Host Group": { + "$ref": "./examples/ManagedClustersCreate_DedicatedHostGroup.json" + }, + "Create Managed Cluster with CustomCATrustCertificates populated and CustomCATrust enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableCustomCATrust.json" + }, + "Create Managed Cluster with VirtualMachines pool type": { + "$ref": "./examples/ManagedClustersCreate_VirtualMachines.json" + }, + "Create Managed Cluster with AI Toolchain Operator enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableAIToolchainOperator.json" + }, + "Create Managed Cluster with Node Auto Provisioning": { + "$ref": "./examples/ManagedClustersCreate_NodeAutoProvisioning.json" + } + } + }, + "patch": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_UpdateTags", + "summary": "Updates tags on a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update Managed Cluster Tags operation." + }, + { + "name": "If-Match", + "in": "header", + "description": "The request should only proceed if an entity matches this string.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update Managed Cluster Tags": { + "$ref": "./examples/ManagedClustersUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Delete", + "summary": "Deletes a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/IgnorePodDisruptionBudgetParameter" + }, + { + "name": "If-Match", + "in": "header", + "description": "The request should only proceed if an entity matches this string.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Managed Cluster": { + "$ref": "./examples/ManagedClustersDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations": { + "get": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_ListByManagedCluster", + "summary": "Gets a list of maintenance configurations in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List maintenance configurations by Managed Cluster": { + "$ref": "./examples/MaintenanceConfigurationsList.json" + }, + "List maintenance configurations configured with maintenance window by Managed Cluster": { + "$ref": "./examples/MaintenanceConfigurationsList_MaintenanceWindow.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations/{configName}": { + "get": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_Get", + "summary": "Gets the specified maintenance configuration of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsGet.json" + }, + "Get Maintenance Configuration Configured With Maintenance Window": { + "$ref": "./examples/MaintenanceConfigurationsGet_MaintenanceWindow.json" + } + } + }, + "put": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_CreateOrUpdate", + "summary": "Creates or updates a maintenance configuration in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + }, + "description": "The maintenance configuration to create or update." + } + ], + "responses": { + "200": { + "description": "The existing maintenance configuration was successfully updated.", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "201": { + "description": "The new maintenance configuration was successfully created.", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Create/Update Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsCreate_Update.json" + }, + "Create/Update Maintenance Configuration with Maintenance Window": { + "$ref": "./examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json" + } + } + }, + "delete": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_Delete", + "summary": "Deletes a maintenance configuration.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Delete Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsDelete.json" + }, + "Delete Maintenance Configuration For Node OS Upgrade": { + "$ref": "./examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclusters/{resourceName}/agentPools/{agentPoolName}/abort": { + "post": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_AbortLatestOperation", + "summary": "Aborts last operation running on agent pool.", + "description": "Aborts the currently running operation on the agent pool. The Agent Pool will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, an error is returned.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "location": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Abort operation on agent pool": { + "$ref": "./examples/AgentPoolsAbortOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_List", + "summary": "Gets a list of agent pools in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Agent Pools by Managed Cluster": { + "$ref": "./examples/AgentPoolsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_Get", + "summary": "Gets the specified managed cluster agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Agent Pool": { + "$ref": "./examples/AgentPoolsGet.json" + } + } + }, + "put": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_CreateOrUpdate", + "summary": "Creates or updates an agent pool in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AgentPool" + }, + "description": "The agent pool to create or update." + }, + { + "name": "If-Match", + "in": "header", + "description": "The request should only proceed if an entity matches this string.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "The request should only proceed if no entity matches this string.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + } + ], + "responses": { + "200": { + "description": "The existing agent pool was successfully updated.", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "201": { + "description": "The new agent pool was successfully created.", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Agent Pool": { + "$ref": "./examples/AgentPoolsCreate_Update.json" + }, + "Update Agent Pool": { + "$ref": "./examples/AgentPools_Update.json" + }, + "Create Spot Agent Pool": { + "$ref": "./examples/AgentPoolsCreate_Spot.json" + }, + "Create Agent Pool with PPG": { + "$ref": "./examples/AgentPoolsCreate_PPG.json" + }, + "Create Agent Pool with OSSKU": { + "$ref": "./examples/AgentPoolsCreate_OSSKU.json" + }, + "Create Agent Pool with Windows OSSKU": { + "$ref": "./examples/AgentPoolsCreate_WindowsOSSKU.json" + }, + "Create Windows Agent Pool with disabling OutboundNAT": { + "$ref": "./examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json" + }, + "Create Agent Pool with GPUMIG": { + "$ref": "./examples/AgentPoolsCreate_GPUMIG.json" + }, + "Create Agent Pool with Ephemeral OS Disk": { + "$ref": "./examples/AgentPoolsCreate_Ephemeral.json" + }, + "Create Agent Pool with KubeletConfig and LinuxOSConfig": { + "$ref": "./examples/AgentPoolsCreate_CustomNodeConfig.json" + }, + "Create Agent Pool with EncryptionAtHost enabled": { + "$ref": "./examples/AgentPoolsCreate_EnableEncryptionAtHost.json" + }, + "Create Agent Pool with UltraSSD enabled": { + "$ref": "./examples/AgentPoolsCreate_EnableUltraSSD.json" + }, + "Create Agent Pool with FIPS enabled OS": { + "$ref": "./examples/AgentPoolsCreate_EnableFIPS.json" + }, + "Create Agent Pool using an agent pool snapshot": { + "$ref": "./examples/AgentPoolsCreate_Snapshot.json" + }, + "Create Agent Pool with Krustlet and the WASI runtime": { + "$ref": "./examples/AgentPoolsCreate_WasmWasi.json" + }, + "Create Agent Pool with Message of the Day": { + "$ref": "./examples/AgentPoolsCreate_MessageOfTheDay.json" + }, + "Stop Agent Pool": { + "$ref": "./examples/AgentPools_Stop.json" + }, + "Start Agent Pool": { + "$ref": "./examples/AgentPools_Start.json" + }, + "Associate Agent Pool with Capacity Reservation Group": { + "$ref": "./examples/AgentPoolsAssociate_CRG.json" + }, + "Create Agent Pool with Dedicated Host Group": { + "$ref": "./examples/AgentPoolsCreate_DedicatedHostGroup.json" + }, + "Create Agent Pool with CustomCATrust enabled": { + "$ref": "./examples/AgentPoolsCreate_EnableCustomCATrust.json" + }, + "Create Agent Pool with VirtualMachines pool type": { + "$ref": "./examples/AgentPoolsCreate_TypeVirtualMachines.json" + }, + "Create Agent Pool with VirtualMachines pool type with autoscaling enabled": { + "$ref": "./examples/AgentPoolsCreate_TypeVirtualMachines_Autoscale.json" + } + } + }, + "delete": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_Delete", + "summary": "Deletes an agent pool in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "$ref": "#/parameters/IgnorePodDisruptionBudgetParameter" + }, + { + "name": "If-Match", + "in": "header", + "description": "The request should only proceed if an entity matches this string.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Agent Pool": { + "$ref": "./examples/AgentPoolsDelete.json" + }, + "Delete Agent Pool by ignoring PodDisruptionBudget": { + "$ref": "./examples/AgentPoolsDelete_IgnorePodDisruptionBudget.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeProfiles/default": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_GetUpgradeProfile", + "summary": "Gets the upgrade profile for an agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Agent Pool": { + "$ref": "./examples/AgentPoolsGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/deleteMachines": { + "post": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_DeleteMachines", + "summary": "Deletes specific machines in an agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "name": "machines", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AgentPoolDeleteMachinesParameter" + }, + "description": "A list of machines from the agent pool to be deleted." + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Specific Machines in an Agent Pool": { + "$ref": "./examples/AgentPoolsDeleteMachines.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/machines": { + "get": { + "tags": [ + "Machines" + ], + "operationId": "Machines_List", + "summary": "Gets a list of machines in the specified agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Machines in an Agentpool by Managed Cluster": { + "$ref": "./examples/MachineList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/machines/{machineName}": { + "get": { + "tags": [ + "Machines" + ], + "operationId": "Machines_Get", + "summary": "Get a specific machine in the specified agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "$ref": "#/parameters/MachineNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Machine" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a Machine in an Agent Pools by Managed Cluster": { + "$ref": "./examples/MachineGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/availableAgentPoolVersions": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_GetAvailableAgentPoolVersions", + "summary": "Gets a list of supported Kubernetes versions for the specified agent pool.", + "description": "See [supported Kubernetes versions](https://docs.microsoft.com/azure/aks/supported-kubernetes-versions) for more details about the version lifecycle.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolAvailableVersions" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get available versions for agent pool": { + "$ref": "./examples/AgentPoolsGetAgentPoolAvailableVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetServicePrincipalProfile": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetServicePrincipalProfile", + "summary": "Reset the Service Principal Profile of a managed cluster.", + "description": "This action cannot be performed on a cluster that is not using a service principal", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile" + }, + "description": "The service principal profile to set on the managed cluster." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Reset Service Principal Profile": { + "$ref": "./examples/ManagedClustersResetServicePrincipalProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetAADProfile": { + "post": { + "deprecated": true, + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetAADProfile", + "summary": "Reset the AAD Profile of a managed cluster.", + "description": "**WARNING**: This API will be deprecated. Please see [AKS-managed Azure Active Directory integration](https://aka.ms/aks-managed-aad) to update your cluster with AKS-managed Azure AD.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterAADProfile" + }, + "description": "The AAD profile to set on the Managed Cluster" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Reset AAD Profile": { + "$ref": "./examples/ManagedClustersResetAADProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclusters/{resourceName}/abort": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_AbortLatestOperation", + "summary": "Aborts last operation running on managed cluster.", + "description": "Aborts the currently running operation on the managed cluster. The Managed Cluster will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, an error is returned.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "location": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Abort operation on managed cluster": { + "$ref": "./examples/ManagedClustersAbortOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateClusterCertificates": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RotateClusterCertificates", + "summary": "Rotates the certificates of a managed cluster.", + "description": "See [Certificate rotation](https://docs.microsoft.com/azure/aks/certificate-rotation) for more details about rotating managed cluster certificates.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Rotate Cluster Certificates": { + "$ref": "./examples/ManagedClustersRotateClusterCertificates.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateServiceAccountSigningKeys": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RotateServiceAccountSigningKeys", + "summary": "Rotates the service account signing keys of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Rotate Cluster Service Account Signing Keys": { + "$ref": "./examples/ManagedClustersRotateServiceAccountSigningKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/stop": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Stop", + "summary": "Stops a Managed Cluster", + "description": "This can only be performed on Azure Virtual Machine Scale set backed clusters. Stopping a cluster stops the control plane and agent nodes entirely, while maintaining all object and cluster state. A cluster does not accrue charges while it is stopped. See [stopping a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about stopping a cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Stop Managed Cluster": { + "$ref": "./examples/ManagedClustersStop.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/start": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Start", + "summary": "Starts a previously stopped Managed Cluster", + "description": "See [starting a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about starting a cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Start Managed Cluster": { + "$ref": "./examples/ManagedClustersStart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "summary": "Gets a list of private endpoint connections in the specified managed cluster.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Private Endpoint Connections by Managed Cluster": { + "$ref": "./examples/PrivateEndpointConnectionsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "summary": "Gets the specified private endpoint connection.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Update", + "summary": "Updates a private endpoint connection.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The updated private endpoint connection." + } + ], + "responses": { + "200": { + "description": "The existing private endpoint connection was successfully updated.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "The new private endpoint connection was successfully created.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "summary": "Deletes a private endpoint connection.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content -- The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeNodeImageVersion": { + "post": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_UpgradeNodeImageVersion", + "summary": "Upgrades the node image version of an agent pool to the latest.", + "description": "Upgrading the node image version of an agent pool applies the newest OS and runtime updates to the nodes. AKS provides one new image per week with the latest updates. For more details on node image versions, see: https://docs.microsoft.com/azure/aks/node-image-upgrade", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Upgrade Agent Pool Node Image Version": { + "$ref": "./examples/AgentPoolsUpgradeNodeImageVersion.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "privateLinkResources" + ], + "operationId": "PrivateLinkResources_List", + "summary": "Gets a list of private link resources in the specified managed cluster.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResourcesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Private Link Resources by Managed Cluster": { + "$ref": "./examples/PrivateLinkResourcesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resolvePrivateLinkServiceId": { + "post": { + "tags": [ + "resolvePrivateLinkServiceId" + ], + "operationId": "ResolvePrivateLinkServiceId_POST", + "summary": "Gets the private link service ID for the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "Parameters required in order to resolve a private link service ID." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Resolve the Private Link Service ID for Managed Cluster": { + "$ref": "./examples/ResolvePrivateLinkServiceId.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/runCommand": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RunCommand", + "summary": "Submits a command to run against the Managed Cluster.", + "description": "AKS will create a pod to run the command. This is primarily useful for private clusters. For more information see [AKS Run Command](https://docs.microsoft.com/azure/aks/private-clusters#aks-run-command-preview).", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "requestPayload", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunCommandRequest" + }, + "description": "The run command request" + } + ], + "responses": { + "200": { + "description": "command finished with async pattern, tracking by location header. !!! this is for autorest only, you never get 200 from this api !!!", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "submitNewCommand": { + "$ref": "./examples/RunCommandRequest.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/commandResults/{commandId}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetCommandResult", + "summary": "Gets the results of a command which has been run on the Managed Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "commandId", + "in": "path", + "required": true, + "type": "string", + "description": "Id of the command." + } + ], + "responses": { + "200": { + "description": "command finished", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "202": { + "description": "command running in progress", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "commandSucceedResult": { + "$ref": "./examples/RunCommandResultSucceed.json" + }, + "commandFailedResult": { + "$ref": "./examples/RunCommandResultFailed.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/outboundNetworkDependenciesEndpoints": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListOutboundNetworkDependenciesEndpoints", + "summary": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster.", + "description": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster. The operation returns properties of each egress endpoint.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OutboundEnvironmentEndpointCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List OutboundNetworkDependenciesEndpoints by Managed Cluster": { + "$ref": "./examples/OutboundNetworkDependenciesEndpointsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/operations": { + "get": { + "tags": [ + "OperationStatusResult" + ], + "operationId": "OperationStatusResult_List", + "summary": "Gets a list of operations in the specified managedCluster", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResultList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List of OperationStatusResult": { + "$ref": "./examples/OperationStatusResultList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/operations/{operationId}": { + "get": { + "tags": [ + "OperationStatusResult" + ], + "operationId": "OperationStatusResult_Get", + "summary": "Get the status of a specific operation in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/OperationIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get OperationStatusResult": { + "$ref": "./examples/OperationStatusResultGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/operations/{operationId}": { + "get": { + "tags": [ + "OperationStatusResult" + ], + "operationId": "OperationStatusResult_GetByAgentPool", + "summary": "Get the status of a specific operation in the specified agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/OperationIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get OperationStatusResult": { + "$ref": "./examples/OperationStatusResultGetByAgentPool.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_List", + "summary": "Gets a list of snapshots in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Snapshots": { + "$ref": "./examples/SnapshotsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_ListByResourceGroup", + "summary": "Lists snapshots in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Snapshots by Resource Group": { + "$ref": "./examples/SnapshotsListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots/{resourceName}": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Get", + "summary": "Gets a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Snapshot": { + "$ref": "./examples/SnapshotsGet.json" + } + } + }, + "put": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_CreateOrUpdate", + "summary": "Creates or updates a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Snapshot" + }, + "description": "The snapshot to create or update." + } + ], + "responses": { + "200": { + "description": "The existing snapshot was successfully updated.", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "201": { + "description": "The new snapshot was successfully created.", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create/Update Snapshot": { + "$ref": "./examples/SnapshotsCreate.json" + } + } + }, + "patch": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_UpdateTags", + "summary": "Updates tags on a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update snapshot Tags operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Snapshot Tags": { + "$ref": "./examples/SnapshotsUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Delete", + "summary": "Deletes a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Snapshot": { + "$ref": "./examples/SnapshotsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedclustersnapshots": { + "get": { + "tags": [ + "ManagedClusterSnapshots" + ], + "operationId": "ManagedClusterSnapshots_List", + "summary": "Gets a list of managed cluster snapshots in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshotListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Managed Cluster Snapshots": { + "$ref": "./examples/ManagedClusterSnapshotsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclustersnapshots": { + "get": { + "tags": [ + "ManagedClusterSnapshots" + ], + "operationId": "ManagedClusterSnapshots_ListByResourceGroup", + "summary": "Lists managed cluster snapshots in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshotListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Managed Cluster Snapshots by Resource Group": { + "$ref": "./examples/ManagedClusterSnapshotsListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclustersnapshots/{resourceName}": { + "get": { + "tags": [ + "ManagedClusterSnapshots" + ], + "operationId": "ManagedClusterSnapshots_Get", + "summary": "Gets a managed cluster snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster Snapshot": { + "$ref": "./examples/ManagedClusterSnapshotsGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedClusterSnapshots" + ], + "operationId": "ManagedClusterSnapshots_CreateOrUpdate", + "summary": "Creates or updates a managed cluster snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshot" + }, + "description": "The managed cluster snapshot to create or update." + } + ], + "responses": { + "200": { + "description": "The existing managed cluster snapshot was successfully updated.", + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshot" + } + }, + "201": { + "description": "The new managed cluster snapshot was successfully created.", + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create/Update Managed Cluster Snapshot": { + "$ref": "./examples/ManagedClusterSnapshotsCreate.json" + } + } + }, + "patch": { + "tags": [ + "ManagedClusterSnapshots" + ], + "operationId": "ManagedClusterSnapshots_UpdateTags", + "summary": "Updates tags on a managed cluster snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update managed cluster snapshot Tags operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Managed Cluster Snapshot Tags": { + "$ref": "./examples/ManagedClusterSnapshotsUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "ManagedClusterSnapshots" + ], + "operationId": "ManagedClusterSnapshots_Delete", + "summary": "Deletes a managed cluster snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Managed Cluster Snapshot": { + "$ref": "./examples/ManagedClusterSnapshotsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/trustedAccessRoles": { + "get": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoles_List", + "summary": "List supported trusted access roles.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleListResult" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List trusted access roles": { + "$ref": "./examples/TrustedAccessRoles_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/trustedAccessRoleBindings": { + "get": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_List", + "summary": "List trusted access role bindings.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBindingListResult" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List trusted access role bindings": { + "$ref": "./examples/TrustedAccessRoleBindings_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/trustedAccessRoleBindings/{trustedAccessRoleBindingName}": { + "get": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_Get", + "summary": "Get a trusted access role binding.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/TrustedAccessRoleBindingNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a trusted access role binding": { + "$ref": "./examples/TrustedAccessRoleBindings_Get.json" + } + } + }, + "put": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_CreateOrUpdate", + "summary": "Create or update a trusted access role binding", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/TrustedAccessRoleBindingNameParameter" + }, + { + "name": "trustedAccessRoleBinding", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + }, + "description": "A trusted access role binding" + } + ], + "responses": { + "200": { + "description": "The existing trusted access role binding was successfully updated.", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + } + }, + "201": { + "description": "The new trusted access role binding was successfully created.", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a trusted access role binding": { + "$ref": "./examples/TrustedAccessRoleBindings_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_Delete", + "summary": "Delete a trusted access role binding.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/TrustedAccessRoleBindingNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a trusted access role binding": { + "$ref": "./examples/TrustedAccessRoleBindings_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/guardrailsVersions/{version}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetGuardrailsVersions", + "summary": "Gets supported Guardrails version in the specified subscription and location.", + "description": "Contains Guardrails version along with its support info and whether it is a default version.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/VersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GuardrailsAvailableVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get guardrails available versions": { + "$ref": "./examples/GetGuardrailsVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/guardrailsVersions": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListGuardrailsVersions", + "summary": "Gets a list of supported Guardrails versions in the specified subscription and location.", + "description": "Contains list of Guardrails version along with its support info and whether it is a default version.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GuardrailsAvailableVersionsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Guardrails Versions": { + "$ref": "./examples/ListGuardrailsVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/safeguardsVersions/{version}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetSafeguardsVersions", + "summary": "Gets supported Safeguards version in the specified subscription and location.", + "description": "Contains Safeguards version along with its support info and whether it is a default version.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/VersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SafeguardsAvailableVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Safeguards available versions": { + "$ref": "./examples/GetSafeguardsVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/safeguardsVersions": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListSafeguardsVersions", + "summary": "Gets a list of supported Safeguards versions in the specified subscription and location.", + "description": "Contains list of Safeguards version along with its support info and whether it is a default version.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SafeguardsAvailableVersionsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Safeguards Versions": { + "$ref": "./examples/ListSafeguardsVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/meshRevisionProfiles": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListMeshRevisionProfiles", + "summary": "Lists mesh revision profiles for all meshes in the specified location.", + "description": "Contains extra metadata on each revision, including supported revisions, cluster compatibility and available upgrades", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshRevisionProfileList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List mesh revision profiles in a location": { + "$ref": "./examples/ManagedClustersList_MeshRevisionProfiles.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/meshRevisionProfiles/{mode}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetMeshRevisionProfile", + "summary": "Gets a mesh revision profile for a specified mesh in the specified location.", + "description": "Contains extra metadata on the revision, including supported revisions, cluster compatibility and available upgrades", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/MeshModeParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshRevisionProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a mesh revision profile for a mesh mode": { + "$ref": "./examples/ManagedClustersGet_MeshRevisionProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/meshUpgradeProfiles": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListMeshUpgradeProfiles", + "summary": "Lists available upgrades for all service meshes in a specific cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshUpgradeProfileList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Lists version compatibility and upgrade profile for all service meshes in a cluster": { + "$ref": "./examples/ManagedClustersList_MeshUpgradeProfiles.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/meshUpgradeProfiles/{mode}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetMeshUpgradeProfile", + "summary": "Gets available upgrades for a service mesh in a cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/MeshModeParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gets version compatibility and upgrade profile for a service mesh in a cluster": { + "$ref": "./examples/ManagedClustersGet_MeshUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/loadBalancers": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancers_ListByManagedCluster", + "summary": "Gets a list of load balancers in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LoadBalancerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Load Balancers by Managed Cluster": { + "$ref": "./examples/LoadBalancers_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rebalanceLoadBalancers": { + "post": { + "tags": [ + "LoadBalancers" + ], + "operationId": "ManagedClusters_RebalanceLoadBalancers", + "summary": "Rebalance nodes across specific load balancers.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RebalanceLoadBalancersRequestBody" + }, + "description": "The names of the load balancers to be rebalanced. If set to empty, all load balancers will be rebalanced." + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "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": { + "List Agent Pools by Managed Cluster": { + "$ref": "./examples/LoadBalancers_Rebalance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/loadBalancers/{loadBalancerName}": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancers_Get", + "summary": "Gets the specified load balancer.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/LoadBalancerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LoadBalancer" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Load Balancer": { + "$ref": "./examples/LoadBalancers_Get.json" + } + } + }, + "put": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancers_CreateOrUpdate", + "summary": "Creates or updates a load balancer in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/LoadBalancerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/LoadBalancer" + }, + "description": "The load balancer to create or update." + } + ], + "responses": { + "200": { + "description": "The existing load balancer has been successfully updated", + "schema": { + "$ref": "#/definitions/LoadBalancer" + } + }, + "201": { + "description": "The new load balancer has been successfully created", + "schema": { + "$ref": "#/definitions/LoadBalancer" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Create or update a Load Balancer": { + "$ref": "./examples/LoadBalancers_Create_Or_Update.json" + } + } + }, + "delete": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancers_Delete", + "summary": "Deletes a load balancer in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/LoadBalancerNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a Load Balancer": { + "$ref": "./examples/LoadBalancers_Delete.json" + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OperationValue" + }, + "x-ms-identifiers": [], + "description": "The list of operations" + } + }, + "description": "The List Operation response." + }, + "OperationValue": { + "type": "object", + "properties": { + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of the operation." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the operation." + }, + "display": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationValueDisplay", + "description": "Describes the properties of a Operation Value Display." + } + }, + "description": "Describes the properties of a Operation value." + }, + "OperationValueDisplay": { + "type": "object", + "properties": { + "operation": { + "type": "string", + "readOnly": true, + "description": "The display name of the operation." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "The display name of the resource the operation applies to." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "The description of the operation." + }, + "provider": { + "type": "string", + "readOnly": true, + "description": "The resource provider for the operation." + } + }, + "description": "Describes the properties of a Operation Value Display." + }, + "SubResource": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource ID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + } + }, + "description": "Reference to another subresource.", + "x-ms-azure-resource": true + }, + "TagsObject": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + }, + "ContainerServiceOSDisk": { + "type": "integer", + "format": "int32", + "maximum": 2048, + "minimum": 0, + "description": "OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." + }, + "ManagedClusterServicePrincipalProfile": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "The ID for the service principal." + }, + "secret": { + "type": "string", + "description": "The secret password associated with the service principal in plain text." + } + }, + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs.", + "required": [ + "clientId" + ] + }, + "VirtualMachinesProfile": { + "type": "object", + "properties": { + "scale": { + "$ref": "#/definitions/ScaleProfile", + "description": "Specifications on how to scale a VirtualMachines agent pool." + } + }, + "description": "Specifications on VirtualMachines agent pool." + }, + "ScaleProfile": { + "type": "object", + "properties": { + "manual": { + "type": "array", + "items": { + "$ref": "#/definitions/ManualScaleProfile" + }, + "x-ms-identifiers": [], + "description": "Specifications on how to scale the VirtualMachines agent pool to a fixed size. Currently, at most one ManualScaleProfile is allowed." + }, + "autoscale": { + "type": "array", + "items": { + "$ref": "#/definitions/AutoScaleProfile" + }, + "x-ms-identifiers": [], + "description": "Specifications on how to auto-scale the VirtualMachines agent pool within a predefined size range. Currently, at most one AutoScaleProfile is allowed." + } + }, + "description": "Specifications on how to scale a VirtualMachines agent pool." + }, + "ManualScaleProfile": { + "type": "object", + "properties": { + "sizes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of allowed vm sizes e.g. ['Standard_E4s_v3', 'Standard_E16s_v3', 'Standard_D16s_v5']. AKS will use the first available one when scaling. If a VM size is unavailable (e.g. due to quota or regional capacity reasons), AKS will use the next size." + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Number of nodes." + } + }, + "description": "Specifications on number of machines." + }, + "AutoScaleProfile": { + "type": "object", + "properties": { + "sizes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of allowed vm sizes e.g. ['Standard_E4s_v3', 'Standard_E16s_v3', 'Standard_D16s_v5']. AKS will use the first available one when auto scaling. If a VM size is unavailable (e.g. due to quota or regional capacity reasons), AKS will use the next size." + }, + "minCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of nodes of the specified sizes." + }, + "maxCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of nodes of the specified sizes." + } + }, + "description": "Specifications on auto-scaling." + }, + "VirtualMachineNodesStatus": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineNodes" + }, + "x-ms-identifiers": [], + "description": "The status of nodes in a VirtualMachines agent pool." + }, + "VirtualMachineNodes": { + "type": "object", + "properties": { + "size": { + "type": "string", + "description": "The VM size of the agents used to host this group of nodes." + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Number of nodes." + } + }, + "description": "Current status on a group of nodes of the same vm size." + }, + "ManagedClusterAgentPoolProfileProperties": { + "type": "object", + "properties": { + "eTag": { + "type": "string", + "description": "Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1." + }, + "vmSize": { + "type": "string", + "title": "The size of the agent pool VMs.", + "description": "VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions" + }, + "osDiskSizeGB": { + "$ref": "#/definitions/ContainerServiceOSDisk" + }, + "osDiskType": { + "$ref": "#/definitions/OSDiskType" + }, + "kubeletDiskType": { + "$ref": "#/definitions/KubeletDiskType" + }, + "workloadRuntime": { + "$ref": "#/definitions/WorkloadRuntime" + }, + "messageOfTheDay": { + "type": "string", + "title": "Message of the day for Linux nodes, base64-encoded.", + "description": "A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script)." + }, + "vnetSubnetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + }, + "title": "The ID of the subnet which agent pool nodes and optionally pods will join on startup.", + "description": "If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "podSubnetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + }, + "title": "The ID of the subnet which pods will join when launched.", + "description": "If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "podIPAllocationMode": { + "$ref": "#/definitions/PodIPAllocationMode" + }, + "maxPods": { + "type": "integer", + "format": "int32", + "description": "The maximum number of pods that can run on a node." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "osSKU": { + "$ref": "#/definitions/OSSKU" + }, + "maxCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of nodes for auto-scaling" + }, + "minCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of nodes for auto-scaling" + }, + "enableAutoScaling": { + "type": "boolean", + "description": "Whether to enable auto-scaler" + }, + "scaleDownMode": { + "$ref": "#/definitions/ScaleDownMode", + "title": "The scale down mode to use when scaling the Agent Pool.", + "description": "This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete." + }, + "type": { + "$ref": "#/definitions/AgentPoolType" + }, + "mode": { + "$ref": "#/definitions/AgentPoolMode" + }, + "orchestratorVersion": { + "type": "string", + "title": "The version of Kubernetes specified by the user.", + "description": "Both patch version and are supported. When is specified, the latest supported patch version is chosen automatically. Updating the agent pool with the same once it has been created will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool)." + }, + "currentOrchestratorVersion": { + "readOnly": true, + "type": "string", + "title": "The version of Kubernetes running on the Agent Pool.", + "description": "If orchestratorVersion was a fully specified version , this field will be exactly equal to it. If orchestratorVersion was , this field will contain the full version being used." + }, + "nodeImageVersion": { + "readOnly": true, + "type": "string", + "description": "The version of node image" + }, + "upgradeSettings": { + "$ref": "#/definitions/AgentPoolUpgradeSettings", + "description": "Settings for upgrading the agentpool" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state." + }, + "powerState": { + "title": "Whether the Agent Pool is running or stopped.", + "description": "When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded", + "$ref": "#/definitions/PowerState" + }, + "availabilityZones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'." + }, + "enableNodePublicIP": { + "type": "boolean", + "title": "Whether each node is allocated its own public IP.", + "description": "Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false." + }, + "enableCustomCATrust": { + "type": "boolean", + "title": "Whether to enable Custom CA Trust feature.", + "description": "When set to true, AKS adds a label to the node indicating that the feature is enabled and deploys a daemonset along with host services to sync custom certificate authorities from user-provided list of base64 encoded certificates into node trust stores. Defaults to false." + }, + "nodePublicIPPrefixID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/publicIPPrefixes" + } + ] + }, + "title": "The public IP prefix ID which VM nodes should use IPs from.", + "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "scaleSetPriority": { + "$ref": "#/definitions/ScaleSetPriority", + "description": "The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'." + }, + "scaleSetEvictionPolicy": { + "$ref": "#/definitions/ScaleSetEvictionPolicy", + "title": "The Virtual Machine Scale Set eviction policy to use.", + "description": "This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'." + }, + "spotMaxPrice": { + "$ref": "#/definitions/SpotMaxPrice", + "title": "The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.", + "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags to be persisted on the agent pool virtual machine scale set." + }, + "nodeLabels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The node labels to be persisted across all nodes in agent pool." + }, + "nodeTaints": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule." + }, + "nodeInitializationTaints": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Taints added on the nodes during creation that will not be reconciled by AKS.", + "description": "These taints will not be reconciled by AKS and can be removed with a kubectl call. This field can be modified after node pool is created, but nodes will not be recreated with new taints until another operation that requires recreation (e.g. node image upgrade) happens. These taints allow for required configuration to run before the node is ready to accept workloads, for example 'key1=value1:NoSchedule' that then can be removed with `kubectl taint nodes node1 key1=value1:NoSchedule-`" + }, + "proximityPlacementGroupID": { + "$ref": "#/definitions/ProximityPlacementGroupID", + "description": "The ID for Proximity Placement Group." + }, + "kubeletConfig": { + "$ref": "#/definitions/KubeletConfig", + "description": "The Kubelet configuration on the agent pool nodes." + }, + "linuxOSConfig": { + "$ref": "#/definitions/LinuxOSConfig", + "description": "The OS configuration of Linux agent nodes." + }, + "enableEncryptionAtHost": { + "type": "boolean", + "title": "Whether to enable host based OS and data drive encryption.", + "description": "This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption" + }, + "enableUltraSSD": { + "type": "boolean", + "description": "Whether to enable UltraSSD" + }, + "enableFIPS": { + "type": "boolean", + "title": "Whether to use a FIPS-enabled OS.", + "description": "See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details." + }, + "gpuInstanceProfile": { + "$ref": "#/definitions/GPUInstanceProfile", + "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU." + }, + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot." + }, + "capacityReservationGroupID": { + "$ref": "#/definitions/CapacityReservationGroupID", + "description": "AKS will associate the specified agent pool with the Capacity Reservation Group." + }, + "hostGroupID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/hostGroups" + } + ] + }, + "title": "The fully qualified resource ID of the Dedicated Host Group to provision virtual machines from, used only in creation scenario and not allowed to changed once set.", + "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts)." + }, + "windowsProfile": { + "$ref": "#/definitions/AgentPoolWindowsProfile", + "description": "The Windows agent pool's specific profile." + }, + "networkProfile": { + "$ref": "#/definitions/AgentPoolNetworkProfile", + "description": "Network-related settings of an agent pool." + }, + "securityProfile": { + "$ref": "#/definitions/AgentPoolSecurityProfile", + "description": "The security settings of an agent pool." + }, + "gpuProfile": { + "$ref": "#/definitions/AgentPoolGPUProfile", + "description": "The GPU settings of an agent pool." + }, + "artifactStreamingProfile": { + "$ref": "#/definitions/AgentPoolArtifactStreamingProfile", + "description": "Configuration for using artifact streaming on AKS." + }, + "virtualMachinesProfile": { + "$ref": "#/definitions/VirtualMachinesProfile" + }, + "virtualMachineNodesStatus": { + "$ref": "#/definitions/VirtualMachineNodesStatus" + }, + "gatewayProfile": { + "$ref": "#/definitions/AgentPoolGatewayProfile", + "description": "Profile specific to a managed agent pool in Gateway mode. This field cannot be set if agent pool mode is not Gateway." + } + }, + "description": "Properties for the container service agent pool profile." + }, + "AgentPoolNetworkProfile": { + "type": "object", + "properties": { + "nodePublicIPTags": { + "$ref": "#/definitions/NodePublicIPTags", + "description": "IPTags of instance-level public IPs." + }, + "allowedHostPorts": { + "type": "array", + "description": "The port ranges that are allowed to access. The specified ranges are allowed to overlap.", + "items": { + "$ref": "#/definitions/PortRange" + }, + "x-ms-identifiers": [] + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/applicationSecurityGroups" + } + ] + } + }, + "description": "The IDs of the application security groups which agent pool will associate when created." + } + }, + "description": "Network settings of an agent pool." + }, + "NodePublicIPTags": { + "type": "array", + "items": { + "$ref": "#/definitions/IPTag" + }, + "x-ms-identifiers": [], + "description": "The list of tags associated with the node public IP address." + }, + "IPTag": { + "type": "object", + "properties": { + "ipTagType": { + "type": "string", + "description": "The IP tag type. Example: RoutingPreference." + }, + "tag": { + "type": "string", + "description": "The value of the IP tag associated with the public IP. Example: Internet." + } + }, + "description": "Contains the IPTag associated with the object." + }, + "PortRange": { + "type": "object", + "description": "The port range.", + "properties": { + "portStart": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 65535, + "description": "The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd." + }, + "portEnd": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 65535, + "description": "The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart." + }, + "protocol": { + "type": "string", + "description": "The network protocol of the port.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "Protocol", + "modelAsString": true, + "values": [ + { + "value": "TCP", + "description": "TCP protocol." + }, + { + "value": "UDP", + "description": "UDP protocol." + } + ] + } + } + } + }, + "ManagedClusterAgentPoolProfile": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties" + } + ], + "properties": { + "name": { + "type": "string", + "title": "Unique name of the agent pool profile in the context of the subscription and resource group.", + "description": "Windows agent pool names must be 6 characters or less.", + "pattern": "^[a-z][a-z0-9]{0,11}$" + } + }, + "required": [ + "name" + ], + "description": "Profile for the container service agent pool." + }, + "AgentPoolType": { + "type": "string", + "enum": [ + "VirtualMachineScaleSets", + "AvailabilitySet", + "VirtualMachines" + ], + "x-ms-enum": { + "name": "AgentPoolType", + "modelAsString": true, + "values": [ + { + "value": "VirtualMachineScaleSets", + "description": "Create an Agent Pool backed by a Virtual Machine Scale Set." + }, + { + "value": "AvailabilitySet", + "description": "Use of this is strongly discouraged." + }, + { + "value": "VirtualMachines", + "description": "Create an Agent Pool backed by a Single Instance VM orchestration mode." + } + ] + }, + "description": "The type of Agent Pool." + }, + "AgentPoolMode": { + "type": "string", + "enum": [ + "System", + "User", + "Gateway" + ], + "x-ms-enum": { + "name": "AgentPoolMode", + "modelAsString": true, + "values": [ + { + "value": "System", + "description": "System agent pools are primarily for hosting critical system pods such as CoreDNS and metrics-server. System agent pools osType must be Linux. System agent pools VM SKU must have at least 2vCPUs and 4GB of memory." + }, + { + "value": "User", + "description": "User agent pools are primarily for hosting your application pods." + }, + { + "value": "Gateway", + "description": "Gateway agent pools are dedicated to providing static egress IPs to pods. For more details, see https://aka.ms/aks/static-egress-gateway." + } + ] + }, + "title": "The mode of an agent pool.", + "description": "A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools" + }, + "AgentPoolListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AgentPool" + }, + "description": "The list of agent pools." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of agent pool results.", + "readOnly": true + } + }, + "description": "The response from the List Agent Pools operation." + }, + "AgentPoolUpgradeSettings": { + "type": "object", + "properties": { + "maxSurge": { + "type": "string", + "title": "The maximum number or percentage of nodes that are surged during upgrade.", + "description": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade" + }, + "drainTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 1440, + "minimum": 1, + "title": "The drain timeout for a node", + "description": "The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes." + }, + "nodeSoakDurationInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 30, + "minimum": 0, + "title": "The soak duration for a node", + "description": "The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes." + }, + "undrainableNodeBehavior": { + "type": "string", + "description": "Defines the behavior for undrainable nodes during upgrade. The most common cause of undrainable nodes is Pod Disruption Budgets (PDBs), but other issues, such as pod termination grace period is exceeding the remaining per-node drain timeout or pod is still being in a running state, can also cause undrainable nodes.", + "enum": [ + "Schedule", + "Cordon" + ], + "x-ms-enum": { + "name": "UndrainableNodeBehavior", + "modelAsString": true, + "values": [ + { + "value": "Cordon", + "description": "AKS will cordon the blocked nodes and replace them with surge nodes during upgrade. The blocked nodes will be cordoned and replaced by surge nodes. The blocked nodes will have label 'kubernetes.azure.com/upgrade-status:Quarantined'. A surge node will be retained for each blocked node. A best-effort attempt will be made to delete all other surge nodes. If there are enough surge nodes to replace blocked nodes, then the upgrade operation and the managed cluster will be in failed state. Otherwise, the upgrade operation and the managed cluster will be in canceled state." + }, + { + "value": "Schedule", + "description": "AKS will mark the blocked nodes schedulable, but the blocked nodes are not upgraded. A best-effort attempt will be made to delete all surge nodes. The upgrade operation and the managed cluster will be in failed state if there are any blocked nodes." + } + ] + } + } + }, + "description": "Settings for upgrading an agentpool" + }, + "AgentPool": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "description": "Properties of an agent pool.", + "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties", + "x-ms-client-flatten": true + } + }, + "description": "Agent Pool." + }, + "MachineListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "x-ms-identifiers": [ + "id" + ], + "items": { + "$ref": "#/definitions/Machine" + }, + "description": "The list of Machines in cluster." + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The URL to get the next set of machine results.", + "readOnly": true + } + }, + "description": "The response from the List Machines operation." + }, + "Machine": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MachineProperties", + "description": "The properties of the machine" + } + }, + "description": "A machine. Contains details about the underlying virtual machine. A machine may be visible here but not in kubectl get nodes; if so it may be because the machine has not been registered with the Kubernetes API Server yet." + }, + "MachineProperties": { + "type": "object", + "readOnly": true, + "description": "The properties of the machine", + "properties": { + "network": { + "$ref": "#/definitions/MachineNetworkProperties" + }, + "resourceId": { + "readOnly": true, + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/virtualMachines" + } + ] + }, + "description": "Arm resource id of the machine. It can be used to GET underlying VM Instance" + } + } + }, + "MachineNetworkProperties": { + "type": "object", + "readOnly": true, + "description": "network properties of the machine", + "properties": { + "ipAddresses": { + "type": "array", + "x-ms-identifiers": [], + "readOnly": true, + "description": "IPv4, IPv6 addresses of the machine", + "items": { + "$ref": "#/definitions/MachineIpAddress" + } + } + } + }, + "MachineIpAddress": { + "type": "object", + "readOnly": true, + "description": "The machine IP address details.", + "properties": { + "ip": { + "type": "string", + "readOnly": true, + "description": "IPv4 or IPv6 address of the machine" + }, + "family": { + "$ref": "#/definitions/ipFamily", + "readOnly": true, + "description": "To determine if address belongs IPv4 or IPv6 family." + } + } + }, + "ipFamily": { + "type": "string", + "description": "To determine if address belongs IPv4 or IPv6 family.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "ipFamily", + "modelAsString": true, + "values": [ + { + "value": "IPv4", + "description": "IPv4 family" + }, + { + "value": "IPv6", + "description": "IPv6 family" + } + ] + } + }, + "PodLinkLocalAccess": { + "type": "string", + "description": "Defines access to special link local addresses (Azure Instance Metadata Service, aka IMDS) for pods with hostNetwork=false. If not specified, the default is 'IMDS'.", + "enum": [ + "IMDS", + "None" + ], + "x-ms-enum": { + "name": "PodLinkLocalAccess", + "modelAsString": true, + "values": [ + { + "value": "IMDS", + "description": "Pods with hostNetwork=false can access Azure Instance Metadata Service (IMDS) without restriction." + }, + { + "value": "None", + "description": "Pods with hostNetwork=false cannot access Azure Instance Metadata Service (IMDS)." + } + ] + } + }, + "ManagedClusterWindowsProfile": { + "type": "object", + "properties": { + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

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

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

**Minimum-length:** 1 character

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

**Minimum-length:** 8 characters

**Max-length:** 123 characters

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

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

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

Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster." + } + }, + "description": "Windows gMSA Profile in the managed cluster." + }, + "ContainerServiceLinuxProfile": { + "type": "object", + "properties": { + "adminUsername": { + "type": "string", + "description": "The administrator username to use for Linux VMs.", + "pattern": "^[A-Za-z][-A-Za-z0-9_]*$" + }, + "ssh": { + "$ref": "#/definitions/ContainerServiceSshConfiguration", + "description": "The SSH configuration for Linux-based VMs running on Azure." + } + }, + "required": [ + "adminUsername", + "ssh" + ], + "description": "Profile for Linux VMs in the container service cluster." + }, + "ManagedClusterNodeResourceGroupProfile": { + "type": "object", + "properties": { + "restrictionLevel": { + "type": "string", + "enum": [ + "Unrestricted", + "ReadOnly" + ], + "x-ms-enum": { + "name": "RestrictionLevel", + "modelAsString": true, + "values": [ + { + "value": "Unrestricted", + "description": "All RBAC permissions are allowed on the managed node resource group" + }, + { + "value": "ReadOnly", + "description": "Only */read RBAC permissions allowed on the managed node resource group" + } + ] + }, + "description": "The restriction level applied to the cluster's node resource group" + } + }, + "description": "Node resource group lockdown profile for a managed cluster." + }, + "ContainerServiceNetworkProfile": { + "type": "object", + "properties": { + "networkPlugin": { + "$ref": "#/definitions/NetworkPlugin", + "description": "Network plugin used for building the Kubernetes network." + }, + "networkPluginMode": { + "$ref": "#/definitions/NetworkPluginMode", + "description": "Network plugin mode used for building the Kubernetes network." + }, + "networkPolicy": { + "$ref": "#/definitions/NetworkPolicy", + "description": "Network policy used for building the Kubernetes network." + }, + "networkMode": { + "$ref": "#/definitions/NetworkMode", + "title": "The network mode Azure CNI is configured with.", + "description": "This cannot be specified if networkPlugin is anything other than 'azure'." + }, + "networkDataplane": { + "$ref": "#/definitions/NetworkDataplane", + "description": "Network dataplane used in the Kubernetes cluster." + }, + "podCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.244.0.0/16", + "description": "A CIDR notation IP range from which to assign pod IPs when kubenet is used." + }, + "serviceCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.0.0.0/16", + "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges." + }, + "dnsServiceIP": { + "type": "string", + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "default": "10.0.0.10", + "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr." + }, + "outboundType": { + "type": "string", + "enum": [ + "loadBalancer", + "userDefinedRouting", + "managedNATGateway", + "userAssignedNATGateway", + "none" + ], + "x-ms-enum": { + "name": "outboundType", + "modelAsString": true, + "values": [ + { + "value": "loadBalancer", + "description": "The load balancer is used for egress through an AKS assigned public IP. This supports Kubernetes services of type 'loadBalancer'. For more information see [outbound type loadbalancer](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-loadbalancer)." + }, + { + "value": "userDefinedRouting", + "description": "Egress paths must be defined by the user. This is an advanced scenario and requires proper network configuration. For more information see [outbound type userDefinedRouting](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-userdefinedrouting)." + }, + { + "value": "managedNATGateway", + "description": "The AKS-managed NAT gateway is used for egress." + }, + { + "value": "userAssignedNATGateway", + "description": "The user-assigned NAT gateway associated to the cluster subnet is used for egress. This is an advanced scenario and requires proper network configuration." + }, + { + "value": "none", + "description": "The AKS cluster is not set with any outbound-type. All AKS nodes follows Azure VM default outbound behavior. Please refer to https://azure.microsoft.com/en-us/updates/default-outbound-access-for-vms-in-azure-will-be-retired-transition-to-a-new-method-of-internet-access/" + } + ] + }, + "default": "loadBalancer", + "title": "The outbound (egress) routing method.", + "description": "This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype)." + }, + "loadBalancerSku": { + "$ref": "#/definitions/LoadBalancerSku", + "title": "The load balancer sku for the managed cluster.", + "description": "The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs." + }, + "loadBalancerProfile": { + "$ref": "#/definitions/ManagedClusterLoadBalancerProfile", + "description": "Profile of the cluster load balancer." + }, + "natGatewayProfile": { + "$ref": "#/definitions/ManagedClusterNATGatewayProfile", + "description": "Profile of the cluster NAT gateway." + }, + "staticEgressGatewayProfile": { + "$ref": "#/definitions/ManagedClusterStaticEgressGatewayProfile", + "description": "The profile for Static Egress Gateway addon. For more details about Static Egress Gateway, see https://aka.ms/aks/static-egress-gateway." + }, + "podCidrs": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The CIDR notation IP ranges from which to assign pod IPs.", + "description": "One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking." + }, + "serviceCidrs": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The CIDR notation IP ranges from which to assign service cluster IPs.", + "description": "One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges." + }, + "ipFamilies": { + "type": "array", + "items": { + "$ref": "#/definitions/ipFamily", + "description": "The IP version to use for cluster networking and IP assignment." + }, + "title": "The IP families used to specify IP versions available to the cluster.", + "description": "IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6." + }, + "podLinkLocalAccess": { + "$ref": "#/definitions/PodLinkLocalAccess", + "description": "Defines access to special link local addresses (Azure Instance Metadata Service, aka IMDS) for pods with hostNetwork=false. if not specified, the default is 'IMDS'." + }, + "kubeProxyConfig": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable on kube-proxy on the cluster (if no 'kubeProxyConfig' exists, kube-proxy is enabled in AKS by default without these customizations)." + }, + "mode": { + "type": "string", + "enum": [ + "IPTABLES", + "IPVS" + ], + "x-ms-enum": { + "name": "mode", + "modelAsString": true, + "values": [ + { + "value": "IPTABLES", + "description": "IPTables proxy mode" + }, + { + "value": "IPVS", + "description": "IPVS proxy mode. Must be using Kubernetes version >= 1.22." + } + ] + }, + "description": "Specify which proxy mode to use ('IPTABLES' or 'IPVS')" + }, + "ipvsConfig": { + "type": "object", + "properties": { + "scheduler": { + "type": "string", + "enum": [ + "RoundRobin", + "LeastConnection" + ], + "x-ms-enum": { + "name": "ipvsScheduler", + "modelAsString": true, + "values": [ + { + "value": "RoundRobin", + "description": "Round Robin" + }, + { + "value": "LeastConnection", + "description": "Least Connection" + } + ] + }, + "description": "IPVS scheduler, for more information please see http://www.linuxvirtualserver.org/docs/scheduling.html." + }, + "tcpTimeoutSeconds": { + "type": "integer", + "format": "int32", + "description": "The timeout value used for idle IPVS TCP sessions in seconds. Must be a positive integer value." + }, + "tcpFinTimeoutSeconds": { + "type": "integer", + "format": "int32", + "description": "The timeout value used for IPVS TCP sessions after receiving a FIN in seconds. Must be a positive integer value." + }, + "udpTimeoutSeconds": { + "type": "integer", + "format": "int32", + "description": "The timeout value used for IPVS UDP packets in seconds. Must be a positive integer value." + } + }, + "description": "Holds configuration customizations for IPVS. May only be specified if 'mode' is set to 'IPVS'." + } + }, + "description": "Holds configuration customizations for kube-proxy. Any values not defined will use the kube-proxy defaulting behavior. See https://v.docs.kubernetes.io/docs/reference/command-line-tools-reference/kube-proxy/ where is represented by a - string. Kubernetes version 1.23 would be '1-23'." + }, + "advancedNetworking": { + "$ref": "#/definitions/AdvancedNetworking" + } + }, + "description": "Profile of network configuration." + }, + "MaintenanceConfigurationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MaintenanceConfiguration" + }, + "description": "The list of maintenance configurations." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of maintenance configuration results.", + "readOnly": true + } + }, + "description": "The response from the List maintenance configurations operation." + }, + "MaintenanceConfiguration": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "readOnly": true, + "description": "The system metadata relating to this resource." + }, + "properties": { + "description": "Properties of a default maintenance configuration.", + "$ref": "#/definitions/MaintenanceConfigurationProperties", + "x-ms-client-flatten": true + } + }, + "title": "Planned maintenance configuration, used to configure when updates can be deployed to a Managed Cluster.", + "description": "See [planned maintenance](https://docs.microsoft.com/azure/aks/planned-maintenance) for more information about planned maintenance." + }, + "MaintenanceConfigurationProperties": { + "type": "object", + "properties": { + "timeInWeek": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeInWeek" + }, + "title": "Time slots during the week when planned maintenance is allowed to proceed.", + "x-ms-identifiers": [], + "description": "If two array entries specify the same day of the week, the applied configuration is the union of times in both entries." + }, + "notAllowedTime": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeSpan" + }, + "x-ms-identifiers": [], + "description": "Time slots on which upgrade is not allowed." + }, + "maintenanceWindow": { + "type": "object", + "$ref": "#/definitions/MaintenanceWindow", + "description": "Maintenance window for the maintenance configuration." + } + }, + "description": "Properties used to configure planned maintenance for a Managed Cluster." + }, + "MaintenanceWindow": { + "type": "object", + "properties": { + "schedule": { + "$ref": "#/definitions/Schedule", + "description": "Recurrence schedule for the maintenance window." + }, + "durationHours": { + "type": "integer", + "format": "int32", + "minimum": 4, + "maximum": 24, + "default": 24, + "description": "Length of maintenance window range from 4 to 24 hours." + }, + "utcOffset": { + "type": "string", + "pattern": "^(-|\\+)[0-9]{2}:[0-9]{2}$", + "description": "The UTC offset in format +/-HH:mm. For example, '+05:30' for IST and '-07:00' for PST. If not specified, the default is '+00:00'." + }, + "startDate": { + "type": "string", + "format": "date", + "description": "The date the maintenance window activates. If the current date is before this date, the maintenance window is inactive and will not be used for upgrades. If not specified, the maintenance window will be active right away." + }, + "startTime": { + "type": "string", + "pattern": "^\\d{2}:\\d{2}$", + "description": "The start time of the maintenance window. Accepted values are from '00:00' to '23:59'. 'utcOffset' applies to this field. For example: '02:00' with 'utcOffset: +02:00' means UTC time '00:00'." + }, + "notAllowedDates": { + "type": "array", + "items": { + "$ref": "#/definitions/DateSpan" + }, + "x-ms-identifiers": [], + "description": "Date ranges on which upgrade is not allowed. 'utcOffset' applies to this field. For example, with 'utcOffset: +02:00' and 'dateSpan' being '2022-12-23' to '2023-01-03', maintenance will be blocked from '2022-12-22 22:00' to '2023-01-03 22:00' in UTC time." + } + }, + "description": "Maintenance window used to configure scheduled auto-upgrade for a Managed Cluster.", + "required": [ + "schedule", + "durationHours", + "startTime" + ] + }, + "Schedule": { + "type": "object", + "properties": { + "daily": { + "$ref": "#/definitions/DailySchedule" + }, + "weekly": { + "$ref": "#/definitions/WeeklySchedule" + }, + "absoluteMonthly": { + "$ref": "#/definitions/AbsoluteMonthlySchedule" + }, + "relativeMonthly": { + "$ref": "#/definitions/RelativeMonthlySchedule" + } + }, + "description": "One and only one of the schedule types should be specified. Choose either 'daily', 'weekly', 'absoluteMonthly' or 'relativeMonthly' for your maintenance schedule." + }, + "DailySchedule": { + "type": "object", + "properties": { + "intervalDays": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 7, + "description": "Specifies the number of days between each set of occurrences." + } + }, + "description": "For schedules like: 'recur every day' or 'recur every 3 days'.", + "required": [ + "intervalDays" + ] + }, + "WeeklySchedule": { + "type": "object", + "properties": { + "intervalWeeks": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 4, + "description": "Specifies the number of weeks between each set of occurrences." + }, + "dayOfWeek": { + "$ref": "#/definitions/WeekDay", + "description": "Specifies on which day of the week the maintenance occurs." + } + }, + "description": "For schedules like: 'recur every Monday' or 'recur every 3 weeks on Wednesday'.", + "required": [ + "intervalWeeks", + "dayOfWeek" + ] + }, + "AbsoluteMonthlySchedule": { + "type": "object", + "properties": { + "intervalMonths": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 6, + "description": "Specifies the number of months between each set of occurrences." + }, + "dayOfMonth": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 31, + "description": "The date of the month." + } + }, + "description": "For schedules like: 'recur every month on the 15th' or 'recur every 3 months on the 20th'.", + "required": [ + "intervalMonths", + "dayOfMonth" + ] + }, + "RelativeMonthlySchedule": { + "type": "object", + "properties": { + "intervalMonths": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 6, + "description": "Specifies the number of months between each set of occurrences." + }, + "weekIndex": { + "type": "string", + "enum": [ + "First", + "Second", + "Third", + "Fourth", + "Last" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true, + "values": [ + { + "value": "First", + "description": "First." + }, + { + "value": "Second", + "description": "Second." + }, + { + "value": "Third", + "description": "Third." + }, + { + "value": "Fourth", + "description": "Fourth." + }, + { + "value": "Last", + "description": "Last." + } + ] + }, + "title": "The week index.", + "description": "Specifies on which instance of the allowed days specified in daysOfWeek the maintenance occurs." + }, + "dayOfWeek": { + "$ref": "#/definitions/WeekDay", + "description": "Specifies on which day of the week the maintenance occurs." + } + }, + "description": "For schedules like: 'recur every month on the first Monday' or 'recur every 3 months on last Friday'.", + "required": [ + "intervalMonths", + "weekIndex", + "dayOfWeek" + ] + }, + "DateSpan": { + "type": "object", + "properties": { + "start": { + "type": "string", + "format": "date", + "description": "The start date of the date span." + }, + "end": { + "type": "string", + "format": "date", + "description": "The end date of the date span." + } + }, + "title": "A date range.", + "description": "For example, between '2022-12-23' and '2023-01-05'.", + "required": [ + "start", + "end" + ] + }, + "TimeInWeek": { + "type": "object", + "properties": { + "day": { + "$ref": "#/definitions/WeekDay", + "description": "The day of the week." + }, + "hourSlots": { + "type": "array", + "items": { + "$ref": "#/definitions/HourInDay" + }, + "title": "A list of hours in the day used to identify a time range.", + "description": "Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range." + } + }, + "description": "Time in a week." + }, + "WeekDay": { + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "WeekDay", + "modelAsString": true + }, + "description": "The weekday enum." + }, + "HourInDay": { + "type": "integer", + "format": "int32", + "maximum": 23, + "minimum": 0, + "description": "Hour in a day." + }, + "TimeSpan": { + "type": "object", + "properties": { + "start": { + "type": "string", + "format": "date-time", + "description": "The start of a time span" + }, + "end": { + "type": "string", + "format": "date-time", + "description": "The end of a time span" + } + }, + "title": "A time range.", + "description": "For example, between 2021-05-25T13:00:00Z and 2021-05-25T14:00:00Z." + }, + "RunCommandRequest": { + "type": "object", + "properties": { + "command": { + "type": "string", + "description": "The command to run." + }, + "context": { + "type": "string", + "description": "A base64 encoded zip file containing the files required by the command." + }, + "clusterToken": { + "type": "string", + "description": "AuthToken issued for AKS AAD Server App." + } + }, + "description": "A run command request", + "required": [ + "command" + ] + }, + "RunCommandResult": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The command id.", + "readOnly": true + }, + "properties": { + "description": "Properties of command result.", + "$ref": "#/definitions/CommandResultProperties", + "x-ms-client-flatten": true + } + }, + "description": "run command result." + }, + "CommandResultProperties": { + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "provisioning State" + }, + "exitCode": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The exit code of the command" + }, + "startedAt": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time when the command started." + }, + "finishedAt": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time when the command finished." + }, + "logs": { + "type": "string", + "readOnly": true, + "description": "The command output." + }, + "reason": { + "type": "string", + "readOnly": true, + "description": "An explanation of why provisioningState is set to failed (if so)." + } + }, + "description": "The results of a run command" + }, + "ManagedClusterNATGatewayProfile": { + "type": "object", + "properties": { + "managedOutboundIPProfile": { + "$ref": "#/definitions/ManagedClusterManagedOutboundIPProfile", + "description": "Profile of the managed outbound IP resources of the cluster NAT gateway." + }, + "effectiveOutboundIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "The effective outbound IP resources of the cluster NAT gateway." + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 120, + "minimum": 4, + "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes.", + "default": 4 + } + }, + "description": "Profile of the managed cluster NAT gateway." + }, + "ManagedClusterManagedOutboundIPProfile": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "maximum": 16, + "minimum": 1, + "description": "The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. ", + "default": 1 + } + }, + "description": "Profile of the managed outbound IP resources of the managed cluster." + }, + "ManagedClusterLoadBalancerProfile": { + "type": "object", + "properties": { + "managedOutboundIPs": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 1, + "description": "The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ", + "default": 1 + }, + "countIPv6": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 0, + "description": "The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack. ", + "default": 0 + } + }, + "description": "Desired managed outbound IPs for the cluster load balancer." + }, + "outboundIPPrefixes": { + "type": "object", + "properties": { + "publicIPPrefixes": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP prefix resources." + } + }, + "description": "Desired outbound IP Prefix resources for the cluster load balancer." + }, + "outboundIPs": { + "type": "object", + "properties": { + "publicIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP resources." + } + }, + "description": "Desired outbound IP resources for the cluster load balancer." + }, + "effectiveOutboundIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "The effective outbound IP resources of the cluster load balancer." + }, + "allocatedOutboundPorts": { + "type": "integer", + "format": "int32", + "maximum": 64000, + "minimum": 0, + "description": "The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports.", + "default": 0 + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 120, + "minimum": 4, + "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes.", + "default": 30 + }, + "enableMultipleStandardLoadBalancers": { + "type": "boolean", + "description": "Enable multiple standard load balancers per AKS cluster or not." + }, + "backendPoolType": { + "type": "string", + "x-ms-enum": { + "name": "BackendPoolType", + "modelAsString": true, + "values": [ + { + "value": "NodeIPConfiguration", + "description": "The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend." + }, + { + "value": "NodeIP", + "description": "The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend." + } + ] + }, + "enum": [ + "NodeIPConfiguration", + "NodeIP" + ], + "description": "The type of the managed inbound Load Balancer BackendPool.", + "default": "NodeIPConfiguration" + }, + "clusterServiceLoadBalancerHealthProbeMode": { + "type": "string", + "x-ms-enum": { + "name": "ClusterServiceLoadBalancerHealthProbeMode", + "modelAsString": true, + "values": [ + { + "value": "ServiceNodePort", + "description": "Each External Traffic Policy Cluster service will have its own health probe targeting service nodePort." + }, + { + "value": "Shared", + "description": "All External Traffic Policy Cluster services in a Standard Load Balancer will have a dedicated health probe targeting the backend nodes' kube-proxy health check port 10256." + } + ] + }, + "enum": [ + "ServiceNodePort", + "Shared" + ], + "description": "The health probing behavior for External Traffic Policy Cluster services.", + "default": "ServiceNodePort" + } + }, + "description": "Profile of the managed cluster load balancer." + }, + "ManagedClusterStaticEgressGatewayProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "title": "Enable Static Egress Gateway addon", + "description": "Indicates if Static Egress Gateway addon is enabled or not." + } + }, + "description": "The Static Egress Gateway addon configuration for the cluster." + }, + "ResourceReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The fully qualified Azure resource id." + } + }, + "description": "A reference to an Azure resource." + }, + "ContainerServiceSshConfiguration": { + "type": "object", + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerServiceSshPublicKey" + }, + "x-ms-identifiers": [], + "description": "The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified." + } + }, + "description": "SSH configuration for Linux-based VMs running on Azure.", + "required": [ + "publicKeys" + ] + }, + "ContainerServiceSshPublicKey": { + "type": "object", + "properties": { + "keyData": { + "type": "string", + "description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers." + } + }, + "required": [ + "keyData" + ], + "description": "Contains information about SSH certificate public key data." + }, + "ManagedClusterListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "The list of managed clusters." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of managed cluster results.", + "readOnly": true + } + }, + "description": "The response from the List Managed Clusters operation." + }, + "ManagedCluster": { + "type": "object", + "properties": { + "eTag": { + "type": "string", + "description": "Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention.", + "readOnly": true + }, + "sku": { + "$ref": "#/definitions/ManagedClusterSKU", + "description": "The managed cluster SKU." + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the Virtual Machine." + }, + "identity": { + "$ref": "#/definitions/ManagedClusterIdentity", + "description": "The identity of the managed cluster, if configured." + }, + "properties": { + "description": "Properties of a managed cluster.", + "$ref": "#/definitions/ManagedClusterProperties", + "x-ms-client-flatten": true + }, + "kind": { + "type": "string", + "description": "This is primarily used to expose different UI experiences in the portal for different kinds" + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "Managed cluster." + }, + "ManagedClusterProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current provisioning state." + }, + "powerState": { + "$ref": "#/definitions/PowerState", + "description": "The Power State of the cluster.", + "readOnly": true + }, + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "CreationData to be used to specify the source Snapshot ID if the cluster will be created/upgraded using a snapshot." + }, + "maxAgentPools": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The max number of agent pools for the managed cluster." + }, + "kubernetesVersion": { + "type": "string", + "title": "The version of Kubernetes the Managed Cluster is requested to run.", + "description": "When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details." + }, + "currentKubernetesVersion": { + "readOnly": true, + "type": "string", + "description": "The version of Kubernetes the Managed Cluster is running." + }, + "dnsPrefix": { + "type": "string", + "title": "The DNS prefix of the Managed Cluster.", + "description": "This cannot be updated once the Managed Cluster has been created." + }, + "fqdnSubdomain": { + "type": "string", + "title": "The FQDN subdomain of the private cluster with custom private dns zone.", + "description": "This cannot be updated once the Managed Cluster has been created." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "The FQDN of the master pool." + }, + "privateFQDN": { + "readOnly": true, + "type": "string", + "description": "The FQDN of private cluster." + }, + "azurePortalFQDN": { + "readOnly": true, + "type": "string", + "title": "The special FQDN used by the Azure Portal to access the Managed Cluster. This FQDN is for use only by the Azure Portal and should not be used by other clients.", + "description": "The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterAgentPoolProfile" + }, + "x-ms-identifiers": [], + "description": "The agent pool properties." + }, + "linuxProfile": { + "$ref": "#/definitions/ContainerServiceLinuxProfile", + "description": "The profile for Linux VMs in the Managed Cluster." + }, + "windowsProfile": { + "$ref": "#/definitions/ManagedClusterWindowsProfile", + "description": "The profile for Windows VMs in the Managed Cluster." + }, + "servicePrincipalProfile": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile", + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs." + }, + "addonProfiles": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ManagedClusterAddonProfile" + }, + "description": "The profile of managed cluster add-on." + }, + "podIdentityProfile": { + "$ref": "#/definitions/ManagedClusterPodIdentityProfile", + "title": "The pod identity profile of the Managed Cluster.", + "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on AAD pod identity integration." + }, + "oidcIssuerProfile": { + "$ref": "#/definitions/ManagedClusterOIDCIssuerProfile", + "description": "The OIDC issuer profile of the Managed Cluster." + }, + "nodeResourceGroup": { + "type": "string", + "description": "The name of the resource group containing agent pool nodes." + }, + "nodeResourceGroupProfile": { + "$ref": "#/definitions/ManagedClusterNodeResourceGroupProfile", + "description": "The node resource group configuration profile." + }, + "enableRBAC": { + "type": "boolean", + "description": "Whether to enable Kubernetes Role-Based Access Control." + }, + "supportPlan": { + "$ref": "#/definitions/KubernetesSupportPlan", + "description": "The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'." + }, + "enablePodSecurityPolicy": { + "type": "boolean", + "description": "(DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp." + }, + "enableNamespaceResources": { + "type": "boolean", + "title": "Enable namespace as Azure resource.", + "description": "The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource." + }, + "networkProfile": { + "$ref": "#/definitions/ContainerServiceNetworkProfile", + "description": "The network configuration profile." + }, + "aadProfile": { + "$ref": "#/definitions/ManagedClusterAADProfile", + "description": "The Azure Active Directory configuration." + }, + "autoUpgradeProfile": { + "$ref": "#/definitions/ManagedClusterAutoUpgradeProfile", + "description": "The auto upgrade configuration." + }, + "upgradeSettings": { + "$ref": "#/definitions/ClusterUpgradeSettings", + "description": "Settings for upgrading a cluster." + }, + "autoScalerProfile": { + "type": "object", + "properties": { + "balance-similar-node-groups": { + "type": "string", + "title": "Detects similar node pools and balances the number of nodes between them.", + "description": "Valid values are 'true' and 'false'" + }, + "daemonset-eviction-for-empty-nodes": { + "type": "boolean", + "title": "DaemonSet pods will be gracefully terminated from empty nodes", + "description": "If set to true, all daemonset pods on empty nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted." + }, + "daemonset-eviction-for-occupied-nodes": { + "type": "boolean", + "title": "DaemonSet pods will be gracefully terminated from non-empty nodes", + "description": "If set to true, all daemonset pods on occupied nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted." + }, + "ignore-daemonsets-utilization": { + "type": "boolean", + "title": "Should CA ignore DaemonSet pods when calculating resource utilization for scaling down", + "description": "If set to true, the resources used by daemonset will be taken into account when making scaling down decisions." + }, + "expander": { + "type": "string", + "title": "Type of node group expander to be used in scale up. Set to be deprecated, please use 'expanders' flag in the future.", + "description": "Available values are: 'least-waste', 'most-pods', 'priority', 'random'.", + "$ref": "#/definitions/expander" + }, + "max-empty-bulk-delete": { + "type": "string", + "title": "The maximum number of empty nodes that can be deleted at the same time. This must be a positive integer.", + "description": "The default is 10." + }, + "max-graceful-termination-sec": { + "type": "string", + "title": "The maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node.", + "description": "The default is 600." + }, + "max-node-provision-time": { + "type": "string", + "title": "The maximum time the autoscaler waits for a node to be provisioned.", + "description": "The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "max-total-unready-percentage": { + "type": "string", + "title": "The maximum percentage of unready nodes in the cluster. After this percentage is exceeded, cluster autoscaler halts operations.", + "description": "The default is 45. The maximum is 100 and the minimum is 0." + }, + "new-pod-scale-up-delay": { + "type": "string", + "title": "Ignore unscheduled pods before they're a certain age.", + "description": "For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc)." + }, + "ok-total-unready-count": { + "type": "string", + "title": "The number of allowed unready nodes, irrespective of max-total-unready-percentage.", + "description": "This must be an integer. The default is 3." + }, + "scan-interval": { + "type": "string", + "title": "How often cluster is reevaluated for scale up or down.", + "description": "The default is '10'. Values must be an integer number of seconds." + }, + "scale-down-delay-after-add": { + "type": "string", + "title": "How long after scale up that scale down evaluation resumes", + "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-delay-after-delete": { + "type": "string", + "title": "How long after node deletion that scale down evaluation resumes.", + "description": "The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-delay-after-failure": { + "type": "string", + "title": "How long after scale down failure that scale down evaluation resumes.", + "description": "The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-unneeded-time": { + "type": "string", + "title": "How long a node should be unneeded before it is eligible for scale down.", + "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-unready-time": { + "type": "string", + "title": "How long an unready node should be unneeded before it is eligible for scale down", + "description": "The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-utilization-threshold": { + "type": "string", + "title": "Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down.", + "description": "The default is '0.5'." + }, + "skip-nodes-with-local-storage": { + "type": "string", + "title": "If cluster autoscaler will skip deleting nodes with pods with local storage, for example, EmptyDir or HostPath.", + "description": "The default is true." + }, + "skip-nodes-with-system-pods": { + "type": "string", + "title": "If cluster autoscaler will skip deleting nodes with pods from kube-system (except for DaemonSet or mirror pods)", + "description": "The default is true." + } + }, + "description": "Parameters to be applied to the cluster-autoscaler when enabled" + }, + "apiServerAccessProfile": { + "$ref": "#/definitions/ManagedClusterAPIServerAccessProfile", + "description": "The access profile for managed cluster API server." + }, + "diskEncryptionSetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/diskEncryptionSets" + } + ] + }, + "title": "The Resource ID of the disk encryption set to use for enabling encryption at rest.", + "description": "This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'" + }, + "identityProfile": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + }, + "description": "Identities associated with the cluster." + }, + "privateLinkResources": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "Private link resources associated with the cluster." + }, + "disableLocalAccounts": { + "type": "boolean", + "title": "If local accounts should be disabled on the Managed Cluster.", + "description": "If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview)." + }, + "httpProxyConfig": { + "$ref": "#/definitions/ManagedClusterHTTPProxyConfig", + "description": "Configurations for provisioning the cluster with HTTP proxy servers." + }, + "securityProfile": { + "$ref": "#/definitions/ManagedClusterSecurityProfile", + "description": "Security profile for the managed cluster." + }, + "storageProfile": { + "$ref": "#/definitions/ManagedClusterStorageProfile", + "description": "Storage profile for the managed cluster." + }, + "ingressProfile": { + "$ref": "#/definitions/ManagedClusterIngressProfile", + "description": "Ingress profile for the managed cluster." + }, + "publicNetworkAccess": { + "type": "string", + "enum": [ + "Enabled", + "Disabled", + "SecuredByPerimeter" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Inbound/Outbound to the managedCluster is allowed." + }, + { + "value": "Disabled", + "description": "Inbound traffic to managedCluster is disabled, traffic from managedCluster is allowed." + }, + { + "value": "SecuredByPerimeter", + "description": "Inbound/Outbound traffic is managed by Microsoft.Network/NetworkSecurityPerimeters." + } + ] + }, + "title": "PublicNetworkAccess of the managedCluster", + "description": "Allow or deny public network access for AKS" + }, + "workloadAutoScalerProfile": { + "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfile" + }, + "azureMonitorProfile": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfile" + }, + "safeguardsProfile": { + "$ref": "#/definitions/SafeguardsProfile", + "description": "The Safeguards profile holds all the safeguards information for a given cluster" + }, + "serviceMeshProfile": { + "$ref": "#/definitions/ServiceMeshProfile" + }, + "resourceUID": { + "readOnly": true, + "type": "string", + "description": "The resourceUID uniquely identifies ManagedClusters that reuse ARM ResourceIds (i.e: create, delete, create sequence)" + }, + "metricsProfile": { + "$ref": "#/definitions/ManagedClusterMetricsProfile", + "description": "Optional cluster metrics configuration." + }, + "aiToolchainOperatorProfile": { + "$ref": "#/definitions/ManagedClusterAIToolchainOperatorProfile", + "description": "AI toolchain operator settings that apply to the whole cluster." + }, + "nodeProvisioningProfile": { + "$ref": "#/definitions/ManagedClusterNodeProvisioningProfile", + "description": "Node provisioning settings that apply to the whole cluster." + }, + "bootstrapProfile": { + "$ref": "#/definitions/ManagedClusterBootstrapProfile", + "description": "Profile of the cluster bootstrap configuration." + } + }, + "description": "Properties of the managed cluster." + }, + "PowerState": { + "type": "object", + "description": "Describes the Power State of the cluster", + "properties": { + "code": { + "type": "string", + "description": "Tells whether the cluster is Running or Stopped", + "enum": [ + "Running", + "Stopped" + ], + "x-ms-enum": { + "name": "code", + "modelAsString": true, + "values": [ + { + "value": "Running", + "description": "The cluster is running." + }, + { + "value": "Stopped", + "description": "The cluster is stopped." + } + ] + } + } + } + }, + "expander": { + "type": "string", + "enum": [ + "least-waste", + "most-pods", + "priority", + "random" + ], + "x-ms-enum": { + "name": "expander", + "modelAsString": true, + "values": [ + { + "value": "least-waste", + "description": "Selects the node group that will have the least idle CPU (if tied, unused memory) after scale-up. This is useful when you have different classes of nodes, for example, high CPU or high memory nodes, and only want to expand those when there are pending pods that need a lot of those resources." + }, + { + "value": "most-pods", + "description": "Selects the node group that would be able to schedule the most pods when scaling up. This is useful when you are using nodeSelector to make sure certain pods land on certain nodes. Note that this won't cause the autoscaler to select bigger nodes vs. smaller, as it can add multiple smaller nodes at once." + }, + { + "value": "priority", + "description": "Selects the node group that has the highest priority assigned by the user. It's configuration is described in more details [here](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/expander/priority/readme.md)." + }, + { + "value": "random", + "description": "Used when you don't have a particular need for the node groups to scale differently." + } + ] + }, + "title": "The expander to use when scaling up", + "description": "If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information." + }, + "ManagedClusterAPIServerAccessProfile": { + "type": "object", + "properties": { + "authorizedIPRanges": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The IP ranges authorized to access the Kubernetes API server.", + "description": "IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see [API server authorized IP ranges](https://docs.microsoft.com/azure/aks/api-server-authorized-ip-ranges)." + }, + "enablePrivateCluster": { + "type": "boolean", + "title": "Whether to create the cluster as a private cluster or not.", + "description": "For more details, see [Creating a private AKS cluster](https://docs.microsoft.com/azure/aks/private-clusters)." + }, + "privateDNSZone": { + "type": "string", + "title": "The private DNS zone mode for the cluster.", + "description": "The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'." + }, + "enablePrivateClusterPublicFQDN": { + "type": "boolean", + "description": "Whether to create additional public FQDN for private cluster or not." + }, + "disableRunCommand": { + "type": "boolean", + "description": "Whether to disable run command for the cluster or not." + }, + "enableVnetIntegration": { + "type": "boolean", + "description": "Whether to enable apiserver vnet integration for the cluster or not." + }, + "subnetId": { + "type": "string", + "title": "The subnet to be used when apiserver vnet integration is enabled.", + "description": "It is required when: 1. creating a new cluster with BYO Vnet; 2. updating an existing cluster to enable apiserver vnet integration." + } + }, + "description": "Access profile for managed cluster API server." + }, + "ManagedClusterIdentity": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the system assigned identity which is used by master components." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id of the system assigned identity which is used by master components." + }, + "type": { + "type": "string", + "title": "The type of identity used for the managed cluster.", + "description": "For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity).", + "enum": [ + "SystemAssigned", + "UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false, + "values": [ + { + "value": "SystemAssigned", + "description": "Use an implicitly created system assigned managed identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the system assigned managed identity to manipulate Azure resources." + }, + { + "value": "UserAssigned", + "description": "Use a user-specified identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the specified user assigned managed identity to manipulate Azure resources." + }, + { + "value": "None", + "description": "Do not use a managed identity for the Managed Cluster, service principal will be used instead." + } + ] + } + }, + "delegatedResources": { + "$ref": "../../../../../../common-types/resource-management/v4/managedidentitywithdelegation.json#/definitions/DelegatedResources", + "description": "The delegated identity resources assigned to this managed cluster. This can only be set by another Azure Resource Provider, and managed cluster only accept one delegated identity resource. Internal use only." + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "x-ms-client-name": "ManagedServiceIdentityUserAssignedIdentitiesValue", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "title": "The user identity associated with the managed cluster. This identity will be used in control plane. Only one user assigned identity is allowed.", + "description": "The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the managed cluster." + }, + "UserAssignedIdentity": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ] + }, + "description": "The resource ID of the user assigned identity." + }, + "clientId": { + "type": "string", + "description": "The client ID of the user assigned identity." + }, + "objectId": { + "type": "string", + "description": "The object ID of the user assigned identity." + } + }, + "description": "Details about a user assigned identity." + }, + "ManagedClusterAccessProfile": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "AccessProfile of a managed cluster.", + "$ref": "#/definitions/AccessProfile", + "x-ms-client-flatten": true + } + }, + "description": "Managed cluster Access Profile.", + "x-ms-azure-resource": false + }, + "AccessProfile": { + "type": "object", + "properties": { + "kubeConfig": { + "type": "string", + "format": "byte", + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "Profile for enabling a user to access a managed cluster." + }, + "ManagedClusterPoolUpgradeProfile": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "name": { + "type": "string", + "description": "The Agent Pool name." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether the Kubernetes version is currently in preview." + } + } + }, + "x-ms-identifiers": [], + "description": "List of orchestrator types and versions available for upgrade." + }, + "componentsByReleases": { + "type": "array", + "items": { + "$ref": "#/definitions/ComponentsByRelease" + }, + "x-ms-identifiers": [], + "description": "List of components grouped by kubernetes major.minor version." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "ManagedClusterUpgradeProfileProperties": { + "type": "object", + "properties": { + "controlPlaneProfile": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile", + "description": "The list of available upgrade versions for the control plane." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile" + }, + "x-ms-identifiers": [], + "description": "The list of available upgrade versions for agent pools." + } + }, + "required": [ + "controlPlaneProfile", + "agentPoolProfiles" + ], + "description": "Control plane and agent pool upgrade profiles." + }, + "ManagedClusterAutoUpgradeProfile": { + "type": "object", + "properties": { + "upgradeChannel": { + "type": "string", + "enum": [ + "rapid", + "stable", + "patch", + "node-image", + "none" + ], + "x-ms-enum": { + "name": "upgradeChannel", + "modelAsString": true, + "values": [ + { + "value": "rapid", + "description": "Automatically upgrade the cluster to the latest supported patch release on the latest supported minor version. In cases where the cluster is at a version of Kubernetes that is at an N-2 minor version where N is the latest supported minor version, the cluster first upgrades to the latest supported patch version on N-1 minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster first is upgraded to 1.18.6, then is upgraded to 1.19.1." + }, + { + "value": "stable", + "description": "Automatically upgrade the cluster to the latest supported patch release on minor version N-1, where N is the latest supported minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.18.6." + }, + { + "value": "patch", + "description": "Automatically upgrade the cluster to the latest supported patch version when it becomes available while keeping the minor version the same. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.17.9." + }, + { + "value": "node-image", + "description": "Automatically upgrade the node image to the latest version available. Consider using nodeOSUpgradeChannel instead as that allows you to configure node OS patching separate from Kubernetes version patching" + }, + { + "value": "none", + "description": "Disables auto-upgrades and keeps the cluster at its current version of Kubernetes." + } + ] + }, + "title": "The upgrade channel for auto upgrade. The default is 'none'.", + "description": "For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel)." + }, + "nodeOSUpgradeChannel": { + "type": "string", + "enum": [ + "Unmanaged", + "None", + "SecurityPatch", + "NodeImage" + ], + "x-ms-enum": { + "name": "nodeOSUpgradeChannel", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No attempt to update your machines OS will be made either by OS or by rolling VHDs. This means you are responsible for your security updates" + }, + { + "value": "Unmanaged", + "description": "OS updates will be applied automatically through the OS built-in patching infrastructure. Newly scaled in machines will be unpatched initially, and will be patched at some later time by the OS's infrastructure. Behavior of this option depends on the OS in question. Ubuntu and Mariner apply security patches through unattended upgrade roughly once a day around 06:00 UTC. Windows does not apply security patches automatically and so for them this option is equivalent to None till further notice" + }, + { + "value": "SecurityPatch", + "description": "AKS downloads and updates the nodes with tested security updates. These updates honor the maintenance window settings and produce a new VHD that is used on new nodes. On some occasions it's not possible to apply the updates in place, in such cases the existing nodes will also be re-imaged to the newly produced VHD in order to apply the changes. This option incurs an extra cost of hosting the new Security Patch VHDs in your resource group for just in time consumption." + }, + { + "value": "NodeImage", + "description": "AKS will update the nodes with a newly patched VHD containing security fixes and bugfixes on a weekly cadence. With the VHD update machines will be rolling reimaged to that VHD following maintenance windows and surge settings. No extra VHD cost is incurred when choosing this option as AKS hosts the images." + } + ] + }, + "title": "Manner in which the OS on your nodes is updated", + "description": "The default is Unmanaged, but may change to either NodeImage or SecurityPatch at GA." + } + }, + "description": "Auto upgrade profile for a managed cluster." + }, + "UpgradeOverrideSettings": { + "type": "object", + "properties": { + "forceUpgrade": { + "type": "boolean", + "description": "Whether to force upgrade the cluster. Note that this option instructs upgrade operation to bypass upgrade protections such as checking for deprecated API usage. Enable this option only with caution." + }, + "until": { + "type": "string", + "format": "date-time", + "description": "Until when the overrides are effective. Note that this only matches the start time of an upgrade, and the effectiveness won't change once an upgrade starts even if the `until` expires as upgrade proceeds. This field is not set by default. It must be set for the overrides to take effect." + } + }, + "description": "Settings for overrides when upgrading a cluster." + }, + "ClusterUpgradeSettings": { + "type": "object", + "properties": { + "overrideSettings": { + "$ref": "#/definitions/UpgradeOverrideSettings", + "description": "Settings for overrides." + } + }, + "description": "Settings for upgrading a cluster." + }, + "ManagedClusterAADProfile": { + "type": "object", + "properties": { + "managed": { + "type": "boolean", + "description": "Whether to enable managed AAD." + }, + "enableAzureRBAC": { + "type": "boolean", + "description": "Whether to enable Azure RBAC for Kubernetes authorization." + }, + "adminGroupObjectIDs": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of AAD group object IDs that will have admin role of the cluster." + }, + "clientAppID": { + "type": "string", + "description": "(DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy." + }, + "serverAppID": { + "type": "string", + "description": "(DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy." + }, + "serverAppSecret": { + "type": "string", + "description": "(DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy." + }, + "tenantID": { + "type": "string", + "description": "The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription." + } + }, + "title": "AADProfile specifies attributes for Azure Active Directory integration.", + "description": "For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad)." + }, + "ManagedClusterAddonProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the add-on is enabled or not." + }, + "config": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs for configuring an add-on." + }, + "identity": { + "readOnly": true, + "description": "Information of user assigned identity used by this add-on.", + "allOf": [ + { + "$ref": "#/definitions/UserAssignedIdentity" + } + ] + } + }, + "required": [ + "enabled" + ], + "description": "A Kubernetes add-on profile for a managed cluster." + }, + "ManagedClusterPodIdentity": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the pod identity." + }, + "namespace": { + "type": "string", + "description": "The namespace of the pod identity." + }, + "bindingSelector": { + "type": "string", + "description": "The binding selector to use for the AzureIdentityBinding resource." + }, + "identity": { + "$ref": "#/definitions/UserAssignedIdentity", + "description": "The user assigned identity details." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state of the pod identity.", + "enum": [ + "Assigned", + "Canceled", + "Deleting", + "Failed", + "Succeeded", + "Updating" + ], + "x-ms-enum": { + "name": "ManagedClusterPodIdentityProvisioningState", + "modelAsString": true + } + }, + "provisioningInfo": { + "type": "object", + "readOnly": true, + "properties": { + "error": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningError", + "description": "Pod identity assignment error (if any)." + } + } + } + }, + "required": [ + "name", + "namespace", + "identity" + ], + "description": "Details about the pod identity assigned to the Managed Cluster." + }, + "ManagedClusterPodIdentityProvisioningError": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningErrorBody", + "description": "Details about the error." + } + }, + "description": "An error response from the pod identity provisioning." + }, + "ManagedClusterPodIdentityProvisioningErrorBody": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningErrorBody" + }, + "x-ms-identifiers": [], + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the pod identity provisioning." + }, + "ManagedClusterPodIdentityException": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the pod identity exception." + }, + "namespace": { + "type": "string", + "description": "The namespace of the pod identity exception." + }, + "podLabels": { + "type": "object", + "description": "The pod labels to match.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "name", + "namespace", + "podLabels" + ], + "title": "A pod identity exception, which allows pods with certain labels to access the Azure Instance Metadata Service (IMDS) endpoint without being intercepted by the node-managed identity (NMI) server.", + "description": "See [disable AAD Pod Identity for a specific Pod/Application](https://azure.github.io/aad-pod-identity/docs/configure/application_exception/) for more details." + }, + "ManagedClusterPodIdentityProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the pod identity addon is enabled." + }, + "allowNetworkPluginKubenet": { + "type": "boolean", + "title": "Whether pod identity is allowed to run on clusters with Kubenet networking.", + "description": "Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information." + }, + "userAssignedIdentities": { + "description": "The pod identities to use in the cluster.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentity" + }, + "x-ms-identifiers": [] + }, + "userAssignedIdentityExceptions": { + "description": "The pod identity exceptions to allow.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentityException" + }, + "x-ms-identifiers": [] + } + }, + "title": "The pod identity profile of the Managed Cluster.", + "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration." + }, + "ManagedClusterOIDCIssuerProfile": { + "type": "object", + "properties": { + "issuerURL": { + "readOnly": true, + "type": "string", + "description": "The OIDC issuer url of the Managed Cluster." + }, + "enabled": { + "type": "boolean", + "description": "Whether the OIDC issuer is enabled." + } + }, + "description": "The OIDC issuer profile of the Managed Cluster." + }, + "ManagedClusterUpgradeProfile": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the upgrade profile." + }, + "properties": { + "$ref": "#/definitions/ManagedClusterUpgradeProfileProperties", + "description": "The properties of the upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for compute pools." + }, + "AgentPoolUpgradeProfile": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the agent pool upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the agent pool upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the agent pool upgrade profile." + }, + "properties": { + "$ref": "#/definitions/AgentPoolUpgradeProfileProperties", + "description": "The properties of the agent pool upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for an agent pool." + }, + "AgentPoolUpgradeProfileProperties": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether the Kubernetes version is currently in preview." + } + } + }, + "x-ms-identifiers": [], + "description": "List of orchestrator types and versions available for upgrade." + }, + "componentsByReleases": { + "type": "array", + "items": { + "$ref": "#/definitions/ComponentsByRelease" + }, + "x-ms-identifiers": [], + "description": "List of components grouped by kubernetes major.minor version." + }, + "latestNodeImageVersion": { + "type": "string", + "description": "The latest AKS supported node image version." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "AgentPoolAvailableVersions": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the agent pool version list." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the agent pool version list." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the agent pool version list." + }, + "properties": { + "$ref": "#/definitions/AgentPoolAvailableVersionsProperties", + "description": "Properties of agent pool available versions.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available versions for an agent pool." + }, + "AgentPoolAvailableVersionsProperties": { + "type": "object", + "properties": { + "agentPoolVersions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "default": { + "type": "boolean", + "description": "Whether this version is the default agent pool version." + }, + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether Kubernetes version is currently in preview." + } + } + }, + "x-ms-identifiers": [], + "description": "List of versions available for agent pool." + } + }, + "description": "The list of available agent pool versions." + }, + "PodIPAllocationMode": { + "type": "string", + "enum": [ + "DynamicIndividual", + "StaticBlock" + ], + "x-ms-enum": { + "name": "PodIPAllocationMode", + "modelAsString": true, + "values": [ + { + "value": "DynamicIndividual", + "description": "Each pod gets a single IP address assigned. This is better for maximizing a small to medium subnet of size /16 or smaller. The Azure CNI cluster with dynamic IP allocation defaults to this mode if the customer does not explicitly specify a podIPAllocationMode" + }, + { + "value": "StaticBlock", + "description": "Each node is statically allocated CIDR block(s) of size /28 = 16 IPs per block to satisfy the maxPods per node. Number of CIDR blocks >= (maxPods / 16). The block, rather than a single IP, counts against the Azure Vnet Private IP limit of 65K. Therefore block mode is suitable for running larger workloads with more than the current limit of 65K pods in a cluster. This mode is better suited to scale with larger subnets of /15 or bigger" + } + ] + }, + "title": "Pod IP Allocation Mode", + "description": "The IP allocation mode for pods in the agent pool. Must be used with podSubnetId. The default is 'DynamicIndividual'." + }, + "OSType": { + "type": "string", + "default": "Linux", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": true, + "values": [ + { + "value": "Linux", + "description": "Use Linux." + }, + { + "value": "Windows", + "description": "Use Windows." + } + ] + }, + "description": "The operating system type. The default is Linux." + }, + "OSSKU": { + "type": "string", + "enum": [ + "Ubuntu", + "CBLMariner", + "Mariner", + "AzureLinux", + "Windows2019", + "Windows2022", + "WindowsAnnual" + ], + "x-ms-enum": { + "name": "OSSKU", + "modelAsString": true, + "values": [ + { + "value": "Ubuntu", + "description": "Use Ubuntu as the OS for node images." + }, + { + "value": "Mariner", + "description": "Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead." + }, + { + "value": "AzureLinux", + "description": "Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information." + }, + { + "value": "CBLMariner", + "description": "Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead." + }, + { + "value": "Windows2019", + "description": "Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa." + }, + { + "value": "Windows2022", + "description": "Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa." + }, + { + "value": "WindowsAnnual", + "description": "Use Windows Annual Channel version as the OS for node images. Unsupported for system node pools. Details about supported container images and kubernetes versions under different AKS Annual Channel versions could be seen in https://aka.ms/aks/windows-annual-channel-details." + } + ] + }, + "description": "Specifies the OS SKU used by the agent pool. If not specified, the default is Ubuntu if OSType=Linux or Windows2019 if OSType=Windows. And the default Windows OSSKU will be changed to Windows2022 after Windows2019 is deprecated." + }, + "ScaleSetPriority": { + "type": "string", + "default": "Regular", + "enum": [ + "Spot", + "Regular" + ], + "x-ms-enum": { + "name": "ScaleSetPriority", + "modelAsString": true, + "values": [ + { + "value": "Spot", + "description": "Spot priority VMs will be used. There is no SLA for spot nodes. See [spot on AKS](https://docs.microsoft.com/azure/aks/spot-node-pool) for more information." + }, + { + "value": "Regular", + "description": "Regular VMs will be used." + } + ] + }, + "description": "The Virtual Machine Scale Set priority." + }, + "ScaleSetEvictionPolicy": { + "type": "string", + "default": "Delete", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "ScaleSetEvictionPolicy", + "modelAsString": true, + "values": [ + { + "value": "Delete", + "description": "Nodes in the underlying Scale Set of the node pool are deleted when they're evicted." + }, + { + "value": "Deallocate", + "description": "Nodes in the underlying Scale Set of the node pool are set to the stopped-deallocated state upon eviction. Nodes in the stopped-deallocated state count against your compute quota and can cause issues with cluster scaling or upgrading." + } + ] + }, + "title": "The Virtual Machine Scale Set eviction policy.", + "description": "The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms)" + }, + "SpotMaxPrice": { + "type": "number", + "default": -1, + "title": "The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.", + "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)" + }, + "ScaleDownMode": { + "type": "string", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "ScaleDownMode", + "modelAsString": true, + "values": [ + { + "value": "Delete", + "description": "Create new instances during scale up and remove instances during scale down." + }, + { + "value": "Deallocate", + "description": "Attempt to start deallocated instances (if they exist) during scale up and deallocate instances during scale down." + } + ] + }, + "description": "Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing)." + }, + "ProximityPlacementGroupID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/proximityPlacementGroups" + } + ] + }, + "description": "The ID for Proximity Placement Group." + }, + "CredentialResults": { + "type": "object", + "properties": { + "kubeconfigs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CredentialResult" + }, + "x-ms-identifiers": [], + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The list credential result response." + }, + "CredentialResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the credential." + }, + "value": { + "type": "string", + "format": "byte", + "readOnly": true, + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The credential result response." + }, + "CloudError": { + "type": "object", + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "Details about the error." + } + }, + "description": "An error response from the Container service." + }, + "CloudErrorBody": { + "type": "object", + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "x-ms-identifiers": [], + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Container service." + }, + "ManagedClusterSKU": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of a managed cluster SKU.", + "enum": [ + "Base", + "Automatic" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUName", + "modelAsString": true, + "values": [ + { + "value": "Base", + "description": "Base option for the AKS control plane." + }, + { + "value": "Automatic", + "description": "Automatic clusters are optimized to run most production workloads with configuration that follows AKS best practices and recommendations for cluster and workload setup, scalability, and security. For more details about Automatic clusters see aka.ms/aks/automatic." + } + ] + } + }, + "tier": { + "type": "string", + "title": "The tier of a managed cluster SKU.", + "description": "If not specified, the default is 'Free'. See [AKS Pricing Tier](https://learn.microsoft.com/azure/aks/free-standard-pricing-tiers) for more details.", + "enum": [ + "Premium", + "Standard", + "Free" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUTier", + "modelAsString": true, + "values": [ + { + "value": "Premium", + "description": "Cluster has premium capabilities in addition to all of the capabilities included in 'Standard'. Premium enables selection of LongTermSupport (aka.ms/aks/lts) for certain Kubernetes versions." + }, + { + "value": "Standard", + "description": "Recommended for mission-critical and production workloads. Includes Kubernetes control plane autoscaling, workload-intensive testing, and up to 5,000 nodes per cluster. Guarantees 99.95% availability of the Kubernetes API server endpoint for clusters that use Availability Zones and 99.9% of availability for clusters that don't use Availability Zones." + }, + { + "value": "Free", + "description": "The cluster management is free, but charged for VM, storage, and networking usage. Best for experimenting, learning, simple testing, or workloads with fewer than 10 nodes. Not recommended for production use cases." + } + ] + } + } + }, + "description": "The SKU of a Managed Cluster." + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "A list of private endpoint connections", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the private endpoint connection." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the private endpoint connection.", + "externalDocs": { + "url": "https://aka.ms/search-naming-rules" + } + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The properties of a private endpoint connection.", + "x-ms-client-flatten": true + } + }, + "x-ms-azure-resource": true + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "description": "Properties of a private endpoint connection.", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Canceled", + "Creating", + "Deleting", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private endpoint." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpoint": { + "type": "object", + "description": "Private endpoint which a connection belongs to.", + "properties": { + "id": { + "description": "The resource ID of the private endpoint", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "The state of a private link service connection.", + "type": "object", + "properties": { + "status": { + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "description": "The private link service connection status.", + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + } + }, + "description": { + "type": "string", + "description": "The private link service connection description." + } + } + }, + "PrivateLinkResourcesListResult": { + "type": "object", + "description": "A list of private link resources", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + } + }, + "PrivateLinkResource": { + "description": "A private link resource", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the private link resource." + }, + "name": { + "type": "string", + "description": "The name of the private link resource.", + "externalDocs": { + "url": "https://aka.ms/search-naming-rules" + } + }, + "type": { + "type": "string", + "description": "The resource type." + }, + "groupId": { + "type": "string", + "description": "The group ID of the resource." + }, + "requiredMembers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The RequiredMembers of the resource" + }, + "privateLinkServiceID": { + "readOnly": true, + "type": "string", + "format": "arm-id", + "description": "The private link service ID of the resource, this field is exposed only to NRP internally." + } + } + }, + "OSDiskType": { + "type": "string", + "enum": [ + "Managed", + "Ephemeral" + ], + "x-ms-enum": { + "name": "OSDiskType", + "modelAsString": true, + "values": [ + { + "value": "Managed", + "description": "Azure replicates the operating system disk for a virtual machine to Azure storage to avoid data loss should the VM need to be relocated to another host. Since containers aren't designed to have local state persisted, this behavior offers limited value while providing some drawbacks, including slower node provisioning and higher read/write latency." + }, + { + "value": "Ephemeral", + "description": "Ephemeral OS disks are stored only on the host machine, just like a temporary disk. This provides lower read/write latency, along with faster node scaling and cluster upgrades." + } + ] + }, + "title": "The OS disk type to be used for machines in the agent pool.", + "description": "The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os)." + }, + "KubeletDiskType": { + "type": "string", + "enum": [ + "OS", + "Temporary" + ], + "x-ms-enum": { + "name": "KubeletDiskType", + "modelAsString": true, + "values": [ + { + "value": "OS", + "description": "Kubelet will use the OS disk for its data." + }, + { + "value": "Temporary", + "description": "Kubelet will use the temporary disk for its data." + } + ] + }, + "description": "Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage." + }, + "WorkloadRuntime": { + "type": "string", + "enum": [ + "OCIContainer", + "WasmWasi", + "KataMshvVmIsolation" + ], + "x-ms-enum": { + "name": "WorkloadRuntime", + "modelAsString": true, + "values": [ + { + "value": "OCIContainer", + "description": "Nodes will use Kubelet to run standard OCI container workloads." + }, + { + "value": "WasmWasi", + "description": "Nodes will use Krustlet to run WASM workloads using the WASI provider (Preview)." + }, + { + "value": "KataMshvVmIsolation", + "description": "Nodes can use (Kata + Cloud Hypervisor + Hyper-V) to enable Nested VM-based pods (Preview). Due to the use Hyper-V, AKS node OS itself is a nested VM (the root OS) of Hyper-V. Thus it can only be used with VM series that support Nested Virtualization such as Dv3 series." + } + ] + }, + "description": "Determines the type of workload a node can run." + }, + "KubeletConfig": { + "title": "Kubelet configurations of agent nodes.", + "description": "See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details.", + "type": "object", + "properties": { + "cpuManagerPolicy": { + "type": "string", + "title": "The CPU Manager policy to use.", + "description": "The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'." + }, + "cpuCfsQuota": { + "type": "boolean", + "title": "If CPU CFS quota enforcement is enabled for containers that specify CPU limits.", + "description": "The default is true." + }, + "cpuCfsQuotaPeriod": { + "type": "string", + "title": "The CPU CFS quota period value.", + "description": "The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'." + }, + "imageGcHighThreshold": { + "type": "integer", + "format": "int32", + "title": "The percent of disk usage after which image garbage collection is always run.", + "description": "To disable image garbage collection, set to 100. The default is 85%" + }, + "imageGcLowThreshold": { + "type": "integer", + "format": "int32", + "title": "The percent of disk usage before which image garbage collection is never run.", + "description": "This cannot be set higher than imageGcHighThreshold. The default is 80%" + }, + "topologyManagerPolicy": { + "type": "string", + "title": "The Topology Manager policy to use.", + "description": "For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'." + }, + "allowedUnsafeSysctls": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`)." + }, + "failSwapOn": { + "type": "boolean", + "description": "If set to true it will make the Kubelet fail to start if swap is enabled on the node." + }, + "containerLogMaxSizeMB": { + "type": "integer", + "format": "int32", + "description": "The maximum size (e.g. 10Mi) of container log file before it is rotated." + }, + "containerLogMaxFiles": { + "type": "integer", + "format": "int32", + "description": "The maximum number of container log files that can be present for a container. The number must be ≥ 2.", + "minimum": 2 + }, + "podMaxPids": { + "type": "integer", + "format": "int32", + "description": "The maximum number of processes per pod." + } + } + }, + "LinuxOSConfig": { + "title": "OS configurations of Linux agent nodes.", + "description": "See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details.", + "type": "object", + "properties": { + "sysctls": { + "$ref": "#/definitions/SysctlConfig", + "description": "Sysctl settings for Linux agent nodes." + }, + "transparentHugePageEnabled": { + "type": "string", + "title": "Whether transparent hugepages are enabled.", + "description": "Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)." + }, + "transparentHugePageDefrag": { + "type": "string", + "title": "Whether the kernel should make aggressive use of memory compaction to make more hugepages available.", + "description": "Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)." + }, + "swapFileSizeMB": { + "type": "integer", + "format": "int32", + "description": "The size in MB of a swap file that will be created on each node." + } + } + }, + "AgentPoolWindowsProfile": { + "type": "object", + "description": "The Windows agent pool's specific profile.", + "properties": { + "disableOutboundNat": { + "type": "boolean", + "title": "Whether to disable OutboundNAT in windows nodes", + "description": "The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled." + } + } + }, + "AgentPoolSecurityProfile": { + "type": "object", + "properties": { + "sshAccess": { + "$ref": "#/definitions/AgentPoolSSHAccess", + "description": "SSH access method of an agent pool." + }, + "enableVTPM": { + "type": "boolean", + "description": "vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false." + }, + "enableSecureBoot": { + "type": "boolean", + "description": "Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false." + } + }, + "description": "The security settings of an agent pool." + }, + "AgentPoolGPUProfile": { + "type": "object", + "properties": { + "installGPUDriver": { + "type": "boolean", + "title": "Whether to auto install GPU drivers or not.", + "description": "The default value is true when the vmSize of the agent pool contains a GPU, false otherwise. GPU Driver Installation can only be set true when VM has an associated GPU resource. Setting this field to false prevents automatic GPU driver installation. In that case, in order for the GPU to be usable, the user must perform GPU driver installation themselves." + } + } + }, + "AgentPoolArtifactStreamingProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Artifact streaming speeds up the cold-start of containers on a node through on-demand image loading. To use this feature, container images must also enable artifact streaming on ACR. If not specified, the default is false." + } + } + }, + "AgentPoolSSHAccess": { + "type": "string", + "enum": [ + "LocalUser", + "Disabled" + ], + "x-ms-enum": { + "name": "AgentPoolSSHAccess", + "modelAsString": true, + "values": [ + { + "value": "LocalUser", + "description": "Can SSH onto the node as a local user using private key." + }, + { + "value": "Disabled", + "description": "SSH service will be turned off on the node." + } + ] + }, + "description": "SSH access method of an agent pool." + }, + "AgentPoolGatewayProfile": { + "description": "Profile of the managed cluster gateway agent pool.", + "type": "object", + "properties": { + "publicIPPrefixSize": { + "type": "integer", + "format": "int32", + "maximum": 31, + "minimum": 28, + "description": "The Gateway agent pool associates one public IPPrefix for each static egress gateway to provide public egress. The size of Public IPPrefix should be selected by the user. Each node in the agent pool is assigned with one IP from the IPPrefix. The IPPrefix size thus serves as a cap on the size of the Gateway agent pool. Due to Azure public IPPrefix size limitation, the valid value range is [28, 31] (/31 = 2 nodes/IPs, /30 = 4 nodes/IPs, /29 = 8 nodes/IPs, /28 = 16 nodes/IPs). The default value is 31.", + "default": 31 + } + } + }, + "SysctlConfig": { + "description": "Sysctl settings for Linux agent nodes.", + "type": "object", + "properties": { + "netCoreSomaxconn": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.somaxconn." + }, + "netCoreNetdevMaxBacklog": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.netdev_max_backlog." + }, + "netCoreRmemDefault": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.rmem_default." + }, + "netCoreRmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.rmem_max." + }, + "netCoreWmemDefault": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.wmem_default." + }, + "netCoreWmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.wmem_max." + }, + "netCoreOptmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.optmem_max." + }, + "netIpv4TcpMaxSynBacklog": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_max_syn_backlog." + }, + "netIpv4TcpMaxTwBuckets": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_max_tw_buckets." + }, + "netIpv4TcpFinTimeout": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_fin_timeout." + }, + "netIpv4TcpKeepaliveTime": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_keepalive_time." + }, + "netIpv4TcpKeepaliveProbes": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_keepalive_probes." + }, + "netIpv4TcpkeepaliveIntvl": { + "type": "integer", + "format": "int32", + "minimum": 10, + "maximum": 90, + "description": "Sysctl setting net.ipv4.tcp_keepalive_intvl." + }, + "netIpv4TcpTwReuse": { + "type": "boolean", + "description": "Sysctl setting net.ipv4.tcp_tw_reuse." + }, + "netIpv4IpLocalPortRange": { + "type": "string", + "description": "Sysctl setting net.ipv4.ip_local_port_range." + }, + "netIpv4NeighDefaultGcThresh1": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh1." + }, + "netIpv4NeighDefaultGcThresh2": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh2." + }, + "netIpv4NeighDefaultGcThresh3": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh3." + }, + "netNetfilterNfConntrackMax": { + "type": "integer", + "format": "int32", + "minimum": 131072, + "maximum": 2097152, + "description": "Sysctl setting net.netfilter.nf_conntrack_max." + }, + "netNetfilterNfConntrackBuckets": { + "type": "integer", + "format": "int32", + "minimum": 65536, + "maximum": 524288, + "description": "Sysctl setting net.netfilter.nf_conntrack_buckets." + }, + "fsInotifyMaxUserWatches": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.inotify.max_user_watches." + }, + "fsFileMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.file-max." + }, + "fsAioMaxNr": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.aio-max-nr." + }, + "fsNrOpen": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.nr_open." + }, + "kernelThreadsMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting kernel.threads-max." + }, + "vmMaxMapCount": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.max_map_count." + }, + "vmSwappiness": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.swappiness." + }, + "vmVfsCachePressure": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.vfs_cache_pressure." + } + } + }, + "ManagedClusterHTTPProxyConfig": { + "description": "Cluster HTTP proxy configuration.", + "type": "object", + "properties": { + "httpProxy": { + "type": "string", + "description": "The HTTP proxy server endpoint to use." + }, + "httpsProxy": { + "type": "string", + "description": "The HTTPS proxy server endpoint to use." + }, + "noProxy": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The endpoints that should not go through proxy." + }, + "effectiveNoProxy": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "A read-only list of all endpoints for which traffic should not be sent to the proxy. This list is a superset of noProxy and values injected by AKS." + }, + "trustedCa": { + "type": "string", + "description": "Alternative CA cert to use for connecting to proxy servers." + } + } + }, + "GPUInstanceProfile": { + "type": "string", + "enum": [ + "MIG1g", + "MIG2g", + "MIG3g", + "MIG4g", + "MIG7g" + ], + "x-ms-enum": { + "name": "GPUInstanceProfile ", + "modelAsString": true + }, + "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU." + }, + "ExtendedLocationType": { + "type": "string", + "description": "The type of extendedLocation.", + "enum": [ + "EdgeZone" + ], + "x-ms-enum": { + "name": "ExtendedLocationTypes", + "modelAsString": true + } + }, + "ExtendedLocation": { + "type": "object", + "description": "The complex type of the extended location.", + "properties": { + "name": { + "type": "string", + "description": "The name of the extended location." + }, + "type": { + "$ref": "#/definitions/ExtendedLocationType", + "description": "The type of the extended location." + } + } + }, + "GuardrailsAvailableVersionsProperties": { + "type": "object", + "description": "Whether the version is default or not and support info.", + "properties": { + "isDefaultVersion": { + "type": "boolean", + "readOnly": true + }, + "support": { + "type": "string", + "enum": [ + "Preview", + "Stable" + ], + "x-ms-enum": { + "name": "GuardrailsSupport", + "modelAsString": true, + "values": [ + { + "value": "Preview", + "description": "The version is preview. It is not recommended to use preview versions on critical production clusters. The preview version may not support all use-cases." + }, + { + "value": "Stable", + "description": "The version is stable and can be used on critical production clusters." + } + ] + }, + "description": "Whether the version is preview or stable.", + "readOnly": true + } + } + }, + "GuardrailsAvailableVersion": { + "type": "object", + "description": "Available Guardrails Version", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/GuardrailsAvailableVersionsProperties" + } + }, + "required": [ + "properties" + ] + }, + "GuardrailsAvailableVersionsList": { + "type": "object", + "description": "Hold values properties, which is array of GuardrailsVersions", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GuardrailsAvailableVersion" + }, + "description": "Array of AKS supported Guardrails versions." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next Guardrails available version.", + "readOnly": true + } + } + }, + "SafeguardsAvailableVersionsProperties": { + "type": "object", + "description": "Whether the version is default or not and support info.", + "properties": { + "isDefaultVersion": { + "type": "boolean", + "readOnly": true + }, + "support": { + "type": "string", + "enum": [ + "Preview", + "Stable" + ], + "x-ms-enum": { + "name": "SafeguardsSupport", + "modelAsString": true, + "values": [ + { + "value": "Preview", + "description": "The version is preview. It is not recommended to use preview versions on critical production clusters. The preview version may not support all use-cases." + }, + { + "value": "Stable", + "description": "The version is stable and can be used on critical production clusters." + } + ] + }, + "description": "Whether the version is preview or stable.", + "readOnly": true + } + } + }, + "SafeguardsAvailableVersion": { + "type": "object", + "description": "Available Safeguards Version", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SafeguardsAvailableVersionsProperties" + } + }, + "required": [ + "properties" + ] + }, + "SafeguardsAvailableVersionsList": { + "type": "object", + "description": "Hold values properties, which is array of SafeguardsVersions", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SafeguardsAvailableVersion" + }, + "description": "Array of AKS supported Safeguards versions." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next Safeguards available version.", + "readOnly": true + } + } + }, + "EndpointDependency": { + "description": "A domain name that AKS agent nodes are reaching at.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name of the dependency.", + "type": "string" + }, + "endpointDetails": { + "description": "The Ports and Protocols used when connecting to domainName.", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDetail" + }, + "x-ms-identifiers": [] + } + } + }, + "EndpointDetail": { + "description": "connect information from the AKS agent nodes to a single endpoint.", + "type": "object", + "properties": { + "ipAddress": { + "description": "An IP Address that Domain Name currently resolves to.", + "type": "string" + }, + "port": { + "format": "int32", + "description": "The port an endpoint is connected to.", + "type": "integer" + }, + "protocol": { + "description": "The protocol used for connection", + "type": "string" + }, + "description": { + "description": "Description of the detail", + "type": "string" + } + } + }, + "OutboundEnvironmentEndpoint": { + "description": "Egress endpoints which AKS agent nodes connect to for common purpose.", + "type": "object", + "properties": { + "category": { + "description": "The category of endpoints accessed by the AKS agent node, e.g. azure-resource-management, apiserver, etc.", + "type": "string" + }, + "endpoints": { + "description": "The endpoints that AKS agent nodes connect to", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDependency" + }, + "x-ms-identifiers": [] + } + } + }, + "OutboundEnvironmentEndpointCollection": { + "description": "Collection of OutboundEnvironmentEndpoint", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/OutboundEnvironmentEndpoint" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedClusterSecurityProfile": { + "type": "object", + "properties": { + "defender": { + "$ref": "#/definitions/ManagedClusterSecurityProfileDefender", + "description": "Microsoft Defender settings for the security profile." + }, + "azureKeyVaultKms": { + "$ref": "#/definitions/AzureKeyVaultKms", + "description": "Azure Key Vault [key management service](https://kubernetes.io/docs/tasks/administer-cluster/kms-provider/) settings for the security profile." + }, + "workloadIdentity": { + "$ref": "#/definitions/ManagedClusterSecurityProfileWorkloadIdentity", + "description": "Workload identity settings for the security profile. Workload identity enables Kubernetes applications to access Azure cloud resources securely with Azure AD. See https://aka.ms/aks/wi for more details." + }, + "imageCleaner": { + "$ref": "#/definitions/ManagedClusterSecurityProfileImageCleaner", + "description": "Image Cleaner settings for the security profile." + }, + "imageIntegrity": { + "$ref": "#/definitions/ManagedClusterSecurityProfileImageIntegrity", + "description": "Image integrity is a feature that works with Azure Policy to verify image integrity by signature. This will not have any effect unless Azure Policy is applied to enforce image signatures. See https://aka.ms/aks/image-integrity for how to use this feature via policy." + }, + "nodeRestriction": { + "$ref": "#/definitions/ManagedClusterSecurityProfileNodeRestriction", + "description": "[Node Restriction](https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/#noderestriction) settings for the security profile." + }, + "customCATrustCertificates": { + "$ref": "#/definitions/ManagedClusterSecurityProfileCustomCATrustCertificates", + "description": "A list of up to 10 base64 encoded CAs that will be added to the trust store on nodes with the Custom CA Trust feature enabled. For more information see [Custom CA Trust Certificates](https://learn.microsoft.com/en-us/azure/aks/custom-certificate-authority)" + } + }, + "description": "Security profile for the container service cluster." + }, + "ManagedClusterSecurityProfileDefender": { + "type": "object", + "properties": { + "logAnalyticsWorkspaceResourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.OperationalInsights/workspaces" + } + ] + }, + "description": "Resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty." + }, + "securityMonitoring": { + "$ref": "#/definitions/ManagedClusterSecurityProfileDefenderSecurityMonitoring", + "description": "Microsoft Defender threat detection for Cloud settings for the security profile." + } + }, + "description": "Microsoft Defender settings for the security profile." + }, + "ManagedClusterSecurityProfileDefenderSecurityMonitoring": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Defender threat detection" + } + }, + "description": "Microsoft Defender settings for the security profile threat detection." + }, + "ManagedClusterStorageProfile": { + "type": "object", + "properties": { + "diskCSIDriver": { + "$ref": "#/definitions/ManagedClusterStorageProfileDiskCSIDriver", + "description": "AzureDisk CSI Driver settings for the storage profile." + }, + "fileCSIDriver": { + "$ref": "#/definitions/ManagedClusterStorageProfileFileCSIDriver", + "description": "AzureFile CSI Driver settings for the storage profile." + }, + "snapshotController": { + "$ref": "#/definitions/ManagedClusterStorageProfileSnapshotController", + "description": "Snapshot Controller settings for the storage profile." + }, + "blobCSIDriver": { + "$ref": "#/definitions/ManagedClusterStorageProfileBlobCSIDriver", + "description": "AzureBlob CSI Driver settings for the storage profile." + } + }, + "description": "Storage profile for the container service cluster." + }, + "AzureKeyVaultKms": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Azure Key Vault key management service. The default is false." + }, + "keyId": { + "type": "string", + "description": "Identifier of Azure Key Vault key. See [key identifier format](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#vault-name-and-object-name) for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty." + }, + "keyVaultNetworkAccess": { + "type": "string", + "enum": [ + "Public", + "Private" + ], + "default": "Public", + "x-ms-enum": { + "name": "KeyVaultNetworkAccessTypes", + "modelAsString": true + }, + "title": "Network access of the key vault", + "description": "Network access of key vault. The possible values are `Public` and `Private`. `Public` means the key vault allows public access from all networks. `Private` means the key vault disables public access and enables private link. The default value is `Public`." + }, + "keyVaultResourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + }, + "description": "Resource ID of key vault. When keyVaultNetworkAccess is `Private`, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is `Public`, leave the field empty." + } + }, + "description": "Azure Key Vault key management service settings for the security profile." + }, + "ManagedClusterIngressProfile": { + "type": "object", + "properties": { + "webAppRouting": { + "$ref": "#/definitions/ManagedClusterIngressProfileWebAppRouting", + "description": "Web App Routing settings for the ingress profile." + } + }, + "description": "Ingress profile for the container service cluster." + }, + "ManagedClusterIngressProfileWebAppRouting": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Web App Routing." + }, + "dnsZoneResourceIds": { + "type": "array", + "items": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/dnszones" + }, + { + "type": "Microsoft.Network/privateDnsZones" + } + ] + } + }, + "maxItems": 5, + "description": "Resource IDs of the DNS zones to be associated with the Web App Routing add-on. Used only when Web App Routing is enabled. Public and private DNS zones can be in different resource groups, but all public DNS zones must be in the same resource group and all private DNS zones must be in the same resource group." + }, + "identity": { + "readOnly": true, + "type": "object", + "$ref": "#/definitions/UserAssignedIdentity", + "description": "Managed identity of the Web Application Routing add-on. This is the identity that should be granted permissions, for example, to manage the associated Azure DNS resource and get certificates from Azure Key Vault. See [this overview of the add-on](https://learn.microsoft.com/en-us/azure/aks/web-app-routing?tabs=with-osm) for more instructions." + } + }, + "description": "Web App Routing settings for the ingress profile." + }, + "ManagedClusterSecurityProfileWorkloadIdentity": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable workload identity." + } + }, + "description": "Workload identity settings for the security profile." + }, + "ManagedClusterSecurityProfileImageCleaner": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Image Cleaner on AKS cluster." + }, + "intervalHours": { + "type": "integer", + "format": "int32", + "description": "Image Cleaner scanning interval in hours." + } + }, + "description": "Image Cleaner removes unused images from nodes, freeing up disk space and helping to reduce attack surface area. Here are settings for the security profile." + }, + "ManagedClusterSecurityProfileImageIntegrity": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable image integrity. The default value is false." + } + }, + "description": "Image integrity related settings for the security profile." + }, + "ManagedClusterSecurityProfileNodeRestriction": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Node Restriction" + } + }, + "description": "Node Restriction settings for the security profile." + }, + "ManagedClusterSecurityProfileCustomCATrustCertificates": { + "type": "array", + "items": { + "type": "string", + "format": "byte" + }, + "minItems": 0, + "maxItems": 10, + "title": "The list of base64 encoded certificate strings that will be added to the node trust store. At most 10 strings can be provided.", + "description": "Certificates will only be added to trust stores on node pools that have enableCustomCATrust field set to true. If updated, the new list of certificates will be installed in the trust store in place of the old certificates. The certificates are applied asynchronously and will be available a short time after the list is updated." + }, + "ManagedClusterStorageProfileDiskCSIDriver": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AzureDisk CSI Driver. The default value is true." + }, + "version": { + "type": "string", + "description": "The version of AzureDisk CSI Driver. The default value is v1." + } + }, + "description": "AzureDisk CSI Driver settings for the storage profile." + }, + "ManagedClusterStorageProfileFileCSIDriver": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AzureFile CSI Driver. The default value is true." + } + }, + "description": "AzureFile CSI Driver settings for the storage profile." + }, + "ManagedClusterStorageProfileSnapshotController": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Snapshot Controller. The default value is true." + } + }, + "description": "Snapshot Controller settings for the storage profile." + }, + "ManagedClusterStorageProfileBlobCSIDriver": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AzureBlob CSI Driver. The default value is false." + } + }, + "description": "AzureBlob CSI Driver settings for the storage profile." + }, + "CreationData": { + "description": "Data used when creating a target resource from a source resource.", + "type": "object", + "properties": { + "sourceResourceId": { + "type": "string", + "format": "arm-id", + "description": "This is the ARM ID of the source object to be used to create the target object." + } + } + }, + "SnapshotListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Snapshot" + }, + "description": "The list of snapshots." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of snapshot results.", + "readOnly": true + } + }, + "description": "The response from the List Snapshots operation." + }, + "ManagedClusterSnapshotListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterSnapshot" + }, + "description": "The list of managed cluster snapshots." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of managed cluster snapshot results.", + "readOnly": true + } + }, + "description": "The response from the List Managed Cluster Snapshots operation." + }, + "Snapshot": { + "type": "object", + "properties": { + "properties": { + "description": "Properties of a snapshot.", + "$ref": "#/definitions/SnapshotProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "A node pool snapshot resource." + }, + "ManagedClusterSnapshot": { + "type": "object", + "properties": { + "properties": { + "description": "Properties of a managed cluster snapshot.", + "$ref": "#/definitions/ManagedClusterSnapshotProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "A managed cluster snapshot resource." + }, + "SnapshotProperties": { + "type": "object", + "properties": { + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "CreationData to be used to specify the source agent pool resource ID to create this snapshot." + }, + "snapshotType": { + "$ref": "#/definitions/SnapshotType" + }, + "kubernetesVersion": { + "readOnly": true, + "type": "string", + "description": "The version of Kubernetes." + }, + "nodeImageVersion": { + "readOnly": true, + "type": "string", + "description": "The version of node image." + }, + "osType": { + "readOnly": true, + "$ref": "#/definitions/OSType" + }, + "osSku": { + "readOnly": true, + "$ref": "#/definitions/OSSKU" + }, + "vmSize": { + "readOnly": true, + "type": "string", + "description": "The size of the VM." + }, + "enableFIPS": { + "readOnly": true, + "type": "boolean", + "description": "Whether to use a FIPS-enabled OS." + } + }, + "description": "Properties used to configure a node pool snapshot." + }, + "ManagedClusterSnapshotProperties": { + "type": "object", + "properties": { + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "CreationData to be used to specify the source resource ID to create this snapshot." + }, + "snapshotType": { + "$ref": "#/definitions/SnapshotType" + }, + "managedClusterPropertiesReadOnly": { + "$ref": "#/definitions/ManagedClusterPropertiesForSnapshot", + "description": "What the properties will be showed when getting managed cluster snapshot. Those properties are read-only." + } + }, + "description": "Properties for a managed cluster snapshot." + }, + "ManagedClusterPropertiesForSnapshot": { + "type": "object", + "readOnly": true, + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The current kubernetes version." + }, + "sku": { + "type": "object", + "$ref": "#/definitions/ManagedClusterSKU", + "description": "The current managed cluster sku." + }, + "enableRbac": { + "type": "boolean", + "description": "Whether the cluster has enabled Kubernetes Role-Based Access Control or not." + }, + "networkProfile": { + "type": "object", + "$ref": "#/definitions/NetworkProfileForSnapshot", + "description": "The current network profile." + } + }, + "description": "managed cluster properties for snapshot, these properties are read only." + }, + "NetworkProfileForSnapshot": { + "type": "object", + "readOnly": true, + "properties": { + "networkPlugin": { + "$ref": "#/definitions/NetworkPlugin", + "description": "networkPlugin for managed cluster snapshot." + }, + "networkPluginMode": { + "$ref": "#/definitions/NetworkPluginMode", + "description": "NetworkPluginMode for managed cluster snapshot." + }, + "networkPolicy": { + "$ref": "#/definitions/NetworkPolicy", + "description": "networkPolicy for managed cluster snapshot." + }, + "networkMode": { + "$ref": "#/definitions/NetworkMode", + "description": "networkMode for managed cluster snapshot." + }, + "loadBalancerSku": { + "$ref": "#/definitions/LoadBalancerSku", + "description": "loadBalancerSku for managed cluster snapshot." + } + }, + "description": "network profile for managed cluster snapshot, these properties are read only." + }, + "NetworkPlugin": { + "type": "string", + "enum": [ + "azure", + "kubenet", + "none" + ], + "default": "kubenet", + "x-ms-enum": { + "name": "NetworkPlugin", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Use the Azure CNI network plugin. See [Azure CNI (advanced) networking](https://docs.microsoft.com/azure/aks/concepts-network#azure-cni-advanced-networking) for more information." + }, + { + "value": "kubenet", + "description": "Use the Kubenet network plugin. See [Kubenet (basic) networking](https://docs.microsoft.com/azure/aks/concepts-network#kubenet-basic-networking) for more information." + }, + { + "value": "none", + "description": "Do not use a network plugin. A custom CNI will need to be installed after cluster creation for networking functionality." + } + ] + }, + "description": "Network plugin used for building the Kubernetes network." + }, + "NetworkPluginMode": { + "type": "string", + "enum": [ + "overlay" + ], + "x-ms-enum": { + "name": "NetworkPluginMode", + "modelAsString": true, + "values": [ + { + "value": "overlay", + "description": "Pods are given IPs from the PodCIDR address space but use Azure Routing Domains rather than Kubenet reference plugins host-local and bridge." + } + ] + }, + "description": "The mode the network plugin should use." + }, + "NetworkPolicy": { + "type": "string", + "enum": [ + "none", + "calico", + "azure", + "cilium" + ], + "x-ms-enum": { + "name": "NetworkPolicy", + "modelAsString": true, + "values": [ + { + "value": "none", + "description": "Network policies will not be enforced. This is the default value when NetworkPolicy is not specified." + }, + { + "value": "calico", + "description": "Use Calico network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information." + }, + { + "value": "azure", + "description": "Use Azure network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information." + }, + { + "value": "cilium", + "description": "Use Cilium to enforce network policies. This requires networkDataplane to be 'cilium'." + } + ] + }, + "description": "Network policy used for building the Kubernetes network." + }, + "NetworkMode": { + "type": "string", + "enum": [ + "transparent", + "bridge" + ], + "x-ms-enum": { + "name": "networkMode", + "modelAsString": true, + "values": [ + { + "value": "transparent", + "description": "No bridge is created. Intra-VM Pod to Pod communication is through IP routes created by Azure CNI. See [Transparent Mode](https://docs.microsoft.com/azure/aks/faq#transparent-mode) for more information." + }, + { + "value": "bridge", + "description": "This is no longer supported" + } + ] + }, + "title": "The network mode Azure CNI is configured with.", + "description": "This cannot be specified if networkPlugin is anything other than 'azure'." + }, + "NetworkDataplane": { + "type": "string", + "enum": [ + "azure", + "cilium" + ], + "x-ms-enum": { + "name": "networkDataplane", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Use Azure network dataplane." + }, + { + "value": "cilium", + "description": "Use Cilium network dataplane. See [Azure CNI Powered by Cilium](https://learn.microsoft.com/azure/aks/azure-cni-powered-by-cilium) for more information." + } + ] + }, + "description": "Network dataplane used in the Kubernetes cluster." + }, + "AdvancedNetworking": { + "type": "object", + "description": "Advanced Networking profile for enabling observability on a cluster. Note that enabling advanced networking features may incur additional costs. For more information see aka.ms/aksadvancednetworking.", + "properties": { + "observability": { + "$ref": "#/definitions/AdvancedNetworkingObservability" + } + } + }, + "AdvancedNetworkingObservability": { + "type": "object", + "description": "Observability profile to enable advanced network metrics and flow logs with historical contexts.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates the enablement of Advanced Networking observability functionalities on clusters." + } + } + }, + "LoadBalancerSku": { + "type": "string", + "enum": [ + "standard", + "basic" + ], + "x-ms-enum": { + "name": "loadBalancerSku", + "modelAsString": true, + "values": [ + { + "value": "standard", + "description": "Use a a standard Load Balancer. This is the recommended Load Balancer SKU. For more information about on working with the load balancer in the managed cluster, see the [standard Load Balancer](https://docs.microsoft.com/azure/aks/load-balancer-standard) article." + }, + { + "value": "basic", + "description": "Use a basic Load Balancer with limited functionality." + } + ] + }, + "title": "The load balancer sku for the managed cluster.", + "description": "The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs." + }, + "SnapshotType": { + "type": "string", + "default": "NodePool", + "enum": [ + "NodePool", + "ManagedCluster" + ], + "x-ms-enum": { + "name": "SnapshotType", + "modelAsString": true, + "values": [ + { + "value": "NodePool", + "description": "The snapshot is a snapshot of a node pool." + }, + { + "value": "ManagedCluster", + "description": "The snapshot is a snapshot of a managed cluster." + } + ] + }, + "description": "The type of a snapshot. The default is NodePool." + }, + "CapacityReservationGroupID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/CapacityReservationGroups" + } + ] + }, + "title": "The fully qualified resource ID of the Capacity Reservation Group to provide virtual machines from a reserved group of Virtual Machines.", + "description": "This is of the form: '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Compute/capacityreservationgroups/{capacityReservationGroupName}'. Customers use it to create an agentpool and to update an existing agentpool with a CapacityReservationGroupID. If customers explicitly specify this CapacityReservationGroupID as an empty string, AKS will disassociate the existing CRG from the nodepool. For more information see [Capacity Reservation](https://learn.microsoft.com/en-us/azure/virtual-machines/capacity-reservation-overview)" + }, + "TrustedAccessRoleRule": { + "type": "object", + "description": "Rule for trusted access role", + "properties": { + "verbs": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed verbs" + }, + "apiGroups": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed apiGroups" + }, + "resources": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed resources" + }, + "resourceNames": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed names" + }, + "nonResourceURLs": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed nonResourceURLs" + } + } + }, + "TrustedAccessRole": { + "type": "object", + "description": "Trusted access role definition.", + "properties": { + "sourceResourceType": { + "type": "string", + "readOnly": true, + "description": "Resource type of Azure resource" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Name of role, name is unique under a source resource type" + }, + "rules": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TrustedAccessRoleRule" + }, + "x-ms-identifiers": [], + "description": "List of rules for the role. This maps to 'rules' property of [Kubernetes Cluster Role](https://kubernetes.io/docs/reference/kubernetes-api/authorization-resources/cluster-role-v1/#ClusterRole)." + } + } + }, + "TrustedAccessRoleListResult": { + "type": "object", + "description": "List of trusted access roles", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TrustedAccessRole" + }, + "x-ms-identifiers": [ + "sourceResourceType", + "name" + ], + "description": "Role list" + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "TrustedAccessRoleBindingProperties": { + "type": "object", + "description": "Properties for trusted access role binding", + "required": [ + "sourceResourceId", + "roles" + ], + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state of trusted access role binding.", + "enum": [ + "Canceled", + "Deleting", + "Failed", + "Succeeded", + "Updating" + ], + "x-ms-enum": { + "name": "TrustedAccessRoleBindingProvisioningState", + "modelAsString": true + } + }, + "sourceResourceId": { + "type": "string", + "format": "arm-id", + "description": "The ARM resource ID of source resource that trusted access is configured for." + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of roles to bind, each item is a resource type qualified role name. For example: 'Microsoft.MachineLearningServices/workspaces/reader'." + } + } + }, + "TrustedAccessRoleBinding": { + "type": "object", + "description": "Defines binding between a resource and role", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TrustedAccessRoleBindingProperties", + "x-ms-client-flatten": true + } + } + }, + "TrustedAccessRoleBindingListResult": { + "type": "object", + "description": "List of trusted access role bindings", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + }, + "description": "Role binding list" + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedClusterWorkloadAutoScalerProfile": { + "type": "object", + "description": "Workload Auto-scaler profile for the managed cluster.", + "properties": { + "keda": { + "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfileKeda" + }, + "verticalPodAutoscaler": { + "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler" + } + } + }, + "ManagedClusterWorkloadAutoScalerProfileKeda": { + "type": "object", + "description": "KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable KEDA." + } + }, + "required": [ + "enabled" + ] + }, + "ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable VPA add-on in cluster. Default value is false.", + "default": false + }, + "addonAutoscaling": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "AddonAutoscaling", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Feature to autoscale AKS-managed add-ons is enabled. The default VPA update mode is Initial mode." + }, + { + "value": "Disabled", + "description": "Feature to autoscale AKS-managed add-ons is disabled." + } + ] + }, + "description": "Whether VPA add-on is enabled and configured to scale AKS-managed add-ons.", + "default": "Disabled" + } + }, + "required": [ + "enabled" + ] + }, + "ManagedClusterAzureMonitorProfile": { + "type": "object", + "description": "Prometheus addon profile for the container service cluster", + "properties": { + "metrics": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileMetrics" + }, + "containerInsights": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileContainerInsights" + }, + "appMonitoring": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileAppMonitoring" + } + } + }, + "ManagedClusterAzureMonitorProfileKubeStateMetrics": { + "type": "object", + "description": "Kube State Metrics for prometheus addon profile for the container service cluster", + "properties": { + "metricLabelsAllowlist": { + "type": "string", + "description": "Comma-separated list of Kubernetes annotations keys that will be used in the resource's labels metric. " + }, + "metricAnnotationsAllowList": { + "type": "string", + "description": "Comma-separated list of additional Kubernetes label keys that will be used in the resource's labels metric." + } + } + }, + "ManagedClusterAzureMonitorProfileMetrics": { + "type": "object", + "description": "Metrics profile for the prometheus service addon", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable the Prometheus collector" + }, + "kubeStateMetrics": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileKubeStateMetrics" + } + }, + "required": [ + "enabled" + ] + }, + "SafeguardsProfile": { + "type": "object", + "properties": { + "systemExcludedNamespaces": { + "readOnly": true, + "type": "array", + "description": "List of namespaces specified by AKS to be excluded from Safeguards", + "items": { + "type": "string" + } + }, + "version": { + "type": "string", + "description": "The version of constraints to use" + }, + "level": { + "type": "string", + "enum": [ + "Off", + "Warning", + "Enforcement" + ], + "x-ms-enum": { + "name": "level", + "modelAsString": true + }, + "description": "The Safeguards level to be used. By default, Safeguards is enabled for all namespaces except those that AKS excludes via systemExcludedNamespaces" + }, + "excludedNamespaces": { + "description": "List of namespaces excluded from Safeguards checks", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "level" + ], + "description": "The Safeguards profile." + }, + "ServiceMeshProfile": { + "type": "object", + "description": "Service mesh profile for a managed cluster.", + "properties": { + "mode": { + "type": "string", + "description": "Mode of the service mesh.", + "enum": [ + "Istio", + "Disabled" + ], + "x-ms-enum": { + "name": "ServiceMeshMode", + "modelAsString": true, + "values": [ + { + "value": "Istio", + "description": "Istio deployed as an AKS addon." + }, + { + "value": "Disabled", + "description": "Mesh is disabled." + } + ] + } + }, + "istio": { + "$ref": "#/definitions/IstioServiceMesh" + } + }, + "required": [ + "mode" + ] + }, + "IstioServiceMesh": { + "type": "object", + "description": "Istio service mesh configuration.", + "properties": { + "components": { + "$ref": "#/definitions/IstioComponents" + }, + "certificateAuthority": { + "$ref": "#/definitions/IstioCertificateAuthority" + }, + "revisions": { + "type": "array", + "description": "The list of revisions of the Istio control plane. When an upgrade is not in progress, this holds one value. When canary upgrade is in progress, this can only hold two consecutive values. For more information, see: https://learn.microsoft.com/en-us/azure/aks/istio-upgrade", + "items": { + "type": "string" + }, + "uniqueItems": true, + "maxItems": 2 + } + } + }, + "IstioComponents": { + "type": "object", + "description": "Istio components configuration.", + "properties": { + "ingressGateways": { + "type": "array", + "description": "Istio ingress gateways.", + "items": { + "$ref": "#/definitions/IstioIngressGateway" + }, + "x-ms-identifiers": [] + }, + "egressGateways": { + "type": "array", + "description": "Istio egress gateways.", + "items": { + "$ref": "#/definitions/IstioEgressGateway" + }, + "x-ms-identifiers": [] + } + } + }, + "IstioIngressGateway": { + "type": "object", + "description": "Istio ingress gateway configuration. For now, we support up to one external ingress gateway named `aks-istio-ingressgateway-external` and one internal ingress gateway named `aks-istio-ingressgateway-internal`.", + "properties": { + "mode": { + "type": "string", + "description": "Mode of an ingress gateway.", + "enum": [ + "External", + "Internal" + ], + "x-ms-enum": { + "name": "IstioIngressGatewayMode", + "modelAsString": true, + "values": [ + { + "value": "External", + "description": "The ingress gateway is assigned a public IP address and is publicly accessible." + }, + { + "value": "Internal", + "description": "The ingress gateway is assigned an internal IP address and cannot is accessed publicly." + } + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to enable the ingress gateway." + } + }, + "required": [ + "mode", + "enabled" + ] + }, + "IstioCertificateAuthority": { + "type": "object", + "description": "Istio Service Mesh Certificate Authority (CA) configuration. For now, we only support plugin certificates as described here https://aka.ms/asm-plugin-ca", + "properties": { + "plugin": { + "$ref": "#/definitions/IstioPluginCertificateAuthority" + } + } + }, + "IstioPluginCertificateAuthority": { + "type": "object", + "description": "Plugin certificates information for Service Mesh.", + "properties": { + "keyVaultId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + }, + "description": "The resource ID of the Key Vault." + }, + "certObjectName": { + "type": "string", + "description": "Intermediate certificate object name in Azure Key Vault." + }, + "keyObjectName": { + "type": "string", + "description": "Intermediate certificate private key object name in Azure Key Vault." + }, + "rootCertObjectName": { + "type": "string", + "description": "Root certificate object name in Azure Key Vault." + }, + "certChainObjectName": { + "type": "string", + "description": "Certificate chain object name in Azure Key Vault." + } + } + }, + "IstioEgressGateway": { + "type": "object", + "description": "Istio egress gateway configuration.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable the egress gateway." + } + }, + "required": [ + "enabled" + ] + }, + "MeshRevisionProfileList": { + "type": "object", + "description": "Holds an array of MeshRevisionsProfiles", + "properties": { + "value": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MeshRevisionProfile" + }, + "description": "Array of service mesh add-on revision profiles for all supported mesh modes." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of mesh revision profile.", + "readOnly": true + } + } + }, + "MeshRevisionProfile": { + "type": "object", + "description": "Mesh revision profile for a mesh.", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MeshRevisionProfileProperties" + } + } + }, + "MeshRevisionProfileProperties": { + "type": "object", + "description": "Mesh revision profile properties for a mesh", + "properties": { + "meshRevisions": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MeshRevision" + } + } + } + }, + "MeshUpgradeProfileList": { + "type": "object", + "description": "Holds an array of MeshUpgradeProfiles", + "properties": { + "value": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MeshUpgradeProfile" + }, + "description": "Array of supported service mesh add-on upgrade profiles." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of mesh upgrade profile.", + "readOnly": true + } + } + }, + "MeshUpgradeProfile": { + "type": "object", + "description": "Upgrade profile for given mesh.", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MeshUpgradeProfileProperties" + } + } + }, + "MeshUpgradeProfileProperties": { + "type": "object", + "description": "Mesh upgrade profile properties for a major.minor release.", + "allOf": [ + { + "$ref": "#/definitions/MeshRevision" + } + ] + }, + "MeshRevision": { + "type": "object", + "description": "Holds information on upgrades and compatibility for given major.minor mesh release.", + "properties": { + "revision": { + "type": "string", + "description": "The revision of the mesh release." + }, + "upgrades": { + "type": "array", + "description": "List of revisions available for upgrade of a specific mesh revision", + "items": { + "type": "string", + "description": "An upgradeable mesh revision" + } + }, + "compatibleWith": { + "type": "array", + "description": "List of items this revision of service mesh is compatible with, and their associated versions.", + "items": { + "$ref": "#/definitions/CompatibleVersions" + }, + "x-ms-identifiers": [] + } + } + }, + "CompatibleVersions": { + "type": "object", + "description": "Version information about a product/service that is compatible with a service mesh revision.", + "properties": { + "name": { + "type": "string", + "description": "The product/service name." + }, + "versions": { + "type": "array", + "description": "Product/service versions compatible with a service mesh add-on revision.", + "items": { + "type": "string", + "description": "A compatible product/service version." + } + } + } + }, + "KubernetesSupportPlan": { + "type": "string", + "description": "Different support tiers for AKS managed clusters", + "enum": [ + "KubernetesOfficial", + "AKSLongTermSupport" + ], + "x-ms-enum": { + "name": "KubernetesSupportPlan", + "modelAsString": true, + "values": [ + { + "value": "KubernetesOfficial", + "description": "Support for the version is the same as for the open source Kubernetes offering. Official Kubernetes open source community support versions for 1 year after release." + }, + { + "value": "AKSLongTermSupport", + "description": "Support for the version extended past the KubernetesOfficial support of 1 year. AKS continues to patch CVEs for another 1 year, for a total of 2 years of support." + } + ] + } + }, + "KubernetesVersionCapabilities": { + "type": "object", + "description": "Capabilities on this Kubernetes version.", + "properties": { + "supportPlan": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/KubernetesSupportPlan" + } + } + } + }, + "KubernetesPatchVersion": { + "type": "object", + "description": "Kubernetes patch version profile", + "properties": { + "upgrades": { + "type": "array", + "description": "Possible upgrade path for given patch version", + "x-ms-identifiers": [], + "items": { + "type": "string" + } + } + } + }, + "KubernetesVersion": { + "type": "object", + "description": "Kubernetes version profile for given major.minor release.", + "properties": { + "version": { + "type": "string", + "description": "major.minor version of Kubernetes release" + }, + "capabilities": { + "$ref": "#/definitions/KubernetesVersionCapabilities", + "description": "Capabilities on this Kubernetes version." + }, + "isDefault": { + "type": "boolean", + "description": "Whether this version is default." + }, + "isPreview": { + "type": "boolean", + "description": "Whether this version is in preview mode." + }, + "patchVersions": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/KubernetesPatchVersion" + }, + "description": "Patch versions of Kubernetes release" + } + } + }, + "KubernetesVersionListResult": { + "type": "object", + "description": "Hold values properties, which is array of KubernetesVersion", + "properties": { + "values": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/KubernetesVersion" + }, + "description": "Array of AKS supported Kubernetes versions." + } + } + }, + "ManagedClusterAzureMonitorProfileContainerInsights": { + "type": "object", + "description": "Azure Monitor Container Insights Profile for Kubernetes Events, Inventory and Container stdout & stderr logs etc. See aka.ms/AzureMonitorContainerInsights for an overview.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates if Azure Monitor Container Insights Logs Addon is enabled or not." + }, + "logAnalyticsWorkspaceResourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.OperationalInsights/workspaces" + } + ] + }, + "description": "Fully Qualified ARM Resource Id of Azure Log Analytics Workspace for storing Azure Monitor Container Insights Logs." + }, + "syslogPort": { + "type": "integer", + "format": "int64", + "description": "The syslog host port. If not specified, the default port is 28330." + }, + "disableCustomMetrics": { + "type": "boolean", + "description": "Indicates whether custom metrics collection has to be disabled or not. If not specified the default is false. No custom metrics will be emitted if this field is false but the container insights enabled field is false" + }, + "disablePrometheusMetricsScraping": { + "type": "boolean", + "description": "Indicates whether prometheus metrics scraping is disabled or not. If not specified the default is false. No prometheus metrics will be emitted if this field is false but the container insights enabled field is false" + } + } + }, + "ManagedClusterAzureMonitorProfileAppMonitoring": { + "type": "object", + "description": "Application Monitoring Profile for Kubernetes Application Container. Collects application logs, metrics and traces through auto-instrumentation of the application using Azure Monitor OpenTelemetry based SDKs. See aka.ms/AzureMonitorApplicationMonitoring for an overview.", + "properties": { + "autoInstrumentation": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileAppMonitoringAutoInstrumentation" + }, + "openTelemetryMetrics": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileAppMonitoringOpenTelemetryMetrics" + }, + "openTelemetryLogs": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileAppMonitoringOpenTelemetryLogs" + } + } + }, + "ManagedClusterAzureMonitorProfileAppMonitoringAutoInstrumentation": { + "type": "object", + "description": "Application Monitoring Auto Instrumentation for Kubernetes Application Container. Deploys web hook to auto-instrument Azure Monitor OpenTelemetry based SDKs to collect OpenTelemetry metrics, logs and traces of the application. See aka.ms/AzureMonitorApplicationMonitoring for an overview.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates if Application Monitoring Auto Instrumentation is enabled or not." + } + } + }, + "ManagedClusterAzureMonitorProfileAppMonitoringOpenTelemetryMetrics": { + "type": "object", + "description": "Application Monitoring Open Telemetry Metrics Profile for Kubernetes Application Container Metrics. Collects OpenTelemetry metrics of the application using Azure Monitor OpenTelemetry based SDKs. See aka.ms/AzureMonitorApplicationMonitoring for an overview.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates if Application Monitoring Open Telemetry Metrics is enabled or not." + }, + "port": { + "type": "integer", + "format": "int64", + "description": "The Open Telemetry host port for Open Telemetry metrics. If not specified, the default port is 28333." + } + } + }, + "ManagedClusterAzureMonitorProfileAppMonitoringOpenTelemetryLogs": { + "type": "object", + "description": "Application Monitoring Open Telemetry Metrics Profile for Kubernetes Application Container Logs and Traces. Collects OpenTelemetry logs and traces of the application using Azure Monitor OpenTelemetry based SDKs. See aka.ms/AzureMonitorApplicationMonitoring for an overview.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates if Application Monitoring Open Telemetry Logs and traces is enabled or not." + }, + "port": { + "type": "integer", + "format": "int64", + "description": "The Open Telemetry host port for Open Telemetry logs and traces. If not specified, the default port is 28331." + } + } + }, + "ManagedClusterMetricsProfile": { + "type": "object", + "description": "The metrics profile for the ManagedCluster.", + "properties": { + "costAnalysis": { + "$ref": "#/definitions/ManagedClusterCostAnalysis", + "title": "The configuration for detailed per-Kubernetes resource cost analysis." + } + } + }, + "ManagedClusterCostAnalysis": { + "type": "object", + "description": "The cost analysis configuration for the cluster", + "properties": { + "enabled": { + "type": "boolean", + "title": "Whether to enable cost analysis", + "description": "The Managed Cluster sku.tier must be set to 'Standard' or 'Premium' to enable this feature. Enabling this will add Kubernetes Namespace and Deployment details to the Cost Analysis views in the Azure portal. If not specified, the default is false. For more information see aka.ms/aks/docs/cost-analysis." + } + } + }, + "ManagedClusterAIToolchainOperatorProfile": { + "type": "object", + "description": "When enabling the operator, a set of AKS managed CRDs and controllers will be installed in the cluster. The operator automates the deployment of OSS models for inference and/or training purposes. It provides a set of preset models and enables distributed inference against them.", + "properties": { + "enabled": { + "type": "boolean", + "title": "Whether to enable AI toolchain operator to the cluster", + "description": "Indicates if AI toolchain operator enabled or not." + } + } + }, + "ManagedClusterNodeProvisioningProfile": { + "type": "object", + "properties": { + "mode": { + "type": "string", + "enum": [ + "Manual", + "Auto" + ], + "x-ms-enum": { + "name": "NodeProvisioningMode", + "modelAsString": true, + "values": [ + { + "value": "Manual", + "description": "Nodes are provisioned manually by the user" + }, + { + "value": "Auto", + "description": "Nodes are provisioned automatically by AKS using Karpenter. Fixed size Node Pools can still be created, but autoscaling Node Pools cannot be. (See aka.ms/aks/nap for more details)." + } + ] + }, + "title": "The node provisioning mode. If not specified, the default is Manual.", + "description": "Once the mode it set to Auto, it cannot be changed back to Manual." + } + } + }, + "ManagedClusterBootstrapProfile": { + "description": "The bootstrap profile.", + "properties": { + "artifactSource": { + "type": "string", + "enum": [ + "Direct", + "Cache" + ], + "x-ms-enum": { + "name": "ArtifactSource", + "modelAsString": true, + "values": [ + { + "value": "Cache", + "description": "pull images from Azure Container Registry with cache" + }, + { + "value": "Direct", + "description": "pull images from Microsoft Artifact Registry" + } + ] + }, + "default": "Direct", + "title": "The artifact source.", + "description": "The source where the artifacts are downloaded from." + }, + "containerRegistryId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ContainerRegistry/registries" + } + ] + }, + "description": "The resource Id of Azure Container Registry. The registry must have private network access, premium SKU and zone redundancy." + } + }, + "type": "object" + }, + "AgentPoolDeleteMachinesParameter": { + "type": "object", + "properties": { + "machineNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The agent pool machine names." + } + }, + "required": [ + "machineNames" + ], + "description": "Specifies a list of machine names from the agent pool to be deleted." + }, + "OperationStatusResultList": { + "description": "The operations list. It contains an URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of operations", + "readOnly": true + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "URL to get the next set of operation list results (if there are any).", + "readOnly": true + } + } + }, + "LoadBalancerListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LoadBalancer" + }, + "description": "The list of Load Balancers." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of load balancer results.", + "readOnly": true + } + }, + "description": "The response from the List Load Balancers operation." + }, + "LoadBalancer": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/LoadBalancerProperties", + "description": "The properties of the load balancer.", + "x-ms-client-flatten": true + } + }, + "required": [ + "name" + ], + "description": "The configurations regarding multiple standard load balancers. If not supplied, single load balancer mode will be used. Multiple standard load balancers mode will be used if at lease one configuration is supplied. There has to be a configuration named `kubernetes`." + }, + "LoadBalancerProperties": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the public load balancer. There will be an internal load balancer created if needed, and the name will be `-internal`. The internal lb shares the same configurations as the external one. The internal lbs are not needed to be included in LoadBalancer list. There must be a name of kubernetes in the list." + }, + "primaryAgentPoolName": { + "type": "string", + "description": "Required field. A string value that must specify the ID of an existing agent pool. All nodes in the given pool will always be added to this load balancer. This agent pool must have at least one node and minCount>=1 for autoscaling operations. An agent pool can only be the primary pool for a single load balancer." + }, + "allowServicePlacement": { + "type": "boolean", + "description": "Whether to automatically place services on the load balancer. If not supplied, the default value is true. If set to false manually, both of the external and the internal load balancer will not be selected for services unless they explicitly target it." + }, + "serviceLabelSelector": { + "$ref": "#/definitions/LabelSelector", + "description": "Only services that must match this selector can be placed on this load balancer." + }, + "serviceNamespaceSelector": { + "$ref": "#/definitions/LabelSelector", + "description": "Services created in namespaces that match the selector can be placed on this load balancer." + }, + "nodeSelector": { + "$ref": "#/definitions/LabelSelector", + "description": "Nodes that match this selector will be possible members of this load balancer." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current provisioning state." + } + }, + "required": [ + "name", + "primaryAgentPoolName" + ] + }, + "LabelSelector": { + "type": "object", + "description": "A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.", + "properties": { + "matchLabels": { + "type": "array", + "items": { + "type": "string" + }, + "description": "matchLabels is an array of {key=value} pairs. A single {key=value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is `key`, the operator is `In`, and the values array contains only `value`. The requirements are ANDed." + }, + "matchExpressions": { + "type": "array", + "items": { + "$ref": "#/definitions/LabelSelectorRequirement" + }, + "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed." + } + } + }, + "LabelSelectorRequirement": { + "type": "object", + "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", + "properties": { + "key": { + "type": "string", + "description": "key is the label key that the selector applies to." + }, + "operator": { + "type": "string", + "enum": [ + "In", + "NotIn", + "Exists", + "DoesNotExist" + ], + "x-ms-enum": { + "name": "operator", + "modelAsString": true, + "values": [ + { + "value": "In", + "description": "The value of the key should be in the given list." + }, + { + "value": "NotIn", + "description": "The value of the key should not be in the given list." + }, + { + "value": "Exists", + "description": "The value of the key should exist." + }, + { + "value": "DoesNotExist", + "description": "The value of the key should not exist." + } + ] + }, + "description": "operator represents a key's relationship to a set of values. Valid operators are In and NotIn" + }, + "values": { + "type": "array", + "items": { + "type": "string" + }, + "description": "values is an array of string values, the values array must be non-empty." + } + } + }, + "RebalanceLoadBalancersRequestBody": { + "type": "object", + "properties": { + "loadBalancerNames": { + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [], + "description": "The load balancer names list." + } + }, + "description": "The names of the load balancers to rebalance. If set to empty, all load balancers will be rebalanced." + }, + "Component": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Component name." + }, + "version": { + "type": "string", + "description": "Component version." + }, + "hasBreakingChanges": { + "type": "boolean", + "description": "If upgraded component version contains breaking changes from the current version. To see a detailed description of what the breaking changes are, visit https://learn.microsoft.com/azure/aks/supported-kubernetes-versions?tabs=azure-cli#aks-components-breaking-changes-by-version." + } + } + }, + "ComponentsByRelease": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor)." + }, + "components": { + "type": "array", + "items": { + "$ref": "#/definitions/Component" + }, + "x-ms-identifiers": [], + "description": "components of current or upgraded Kubernetes version in the cluster." + } + }, + "description": "components of given Kubernetes version." + } + }, + "parameters": { + "LoadBalancerNameParameter": { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]{0,11}$", + "minLength": 1, + "maxLength": 12, + "description": "The name of the load balancer.", + "x-ms-parameter-location": "method" + }, + "ResourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "description": "The name of the managed cluster resource.", + "x-ms-parameter-location": "method" + }, + "AgentPoolNameParameter": { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]{0,11}$", + "minLength": 1, + "maxLength": 12, + "description": "The name of the agent pool.", + "x-ms-parameter-location": "method" + }, + "ResourceTypeParameter": { + "name": "resource-type", + "in": "query", + "required": false, + "type": "string", + "description": "The resource type for which the OS options needs to be returned", + "x-ms-parameter-location": "method" + }, + "ServerFqdnParameter": { + "name": "server-fqdn", + "in": "query", + "required": false, + "type": "string", + "description": "server fqdn type for credentials to be returned", + "x-ms-parameter-location": "method" + }, + "CredentialFormatParameter": { + "name": "format", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "exec", + "azure" + ], + "x-ms-enum": { + "name": "format", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Return azure auth-provider kubeconfig. This format is deprecated in v1.22 and will be fully removed in v1.26. See: https://aka.ms/k8s/changes-1-26." + }, + { + "value": "exec", + "description": "Return exec format kubeconfig. This format requires kubelogin binary in the path." + } + ] + }, + "description": "Only apply to AAD clusters, specifies the format of returned kubeconfig. Format 'azure' will return azure auth-provider kubeconfig; format 'exec' will return exec format kubeconfig, which requires kubelogin binary in the path.", + "x-ms-parameter-location": "method" + }, + "IgnorePodDisruptionBudgetParameter": { + "name": "ignore-pod-disruption-budget", + "in": "query", + "required": false, + "type": "boolean", + "description": "ignore-pod-disruption-budget=true to delete those pods on a node without considering Pod Disruption Budget", + "x-ms-parameter-location": "method" + }, + "TrustedAccessRoleBindingNameParameter": { + "name": "trustedAccessRoleBindingName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of trusted access role binding.", + "pattern": "^([A-Za-z0-9-])+$", + "minLength": 1, + "maxLength": 24, + "x-ms-parameter-location": "method" + }, + "MeshModeParameter": { + "name": "mode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "description": "The mode of the mesh.", + "x-ms-parameter-location": "method" + }, + "MachineNameParameter": { + "type": "string", + "description": "host name of the machine", + "name": "machineName", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z0-9][-_a-zA-Z0-9]{0,39}$", + "x-ms-parameter-location": "method" + }, + "VersionParameter": { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 24, + "description": "Safeguards version", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.java.md b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.java.md index 796eab88cc62..48a65138f50f 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.java.md +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.java.md @@ -99,6 +99,34 @@ batch: - tag: package-2024-02 - tag: package-preview-2024-03 - tag: package-preview-2024-04 + - tag: package-preview-2024-05 + - tag: package-2024-05 +``` + +### Tag: package-2024-05 and java + +These settings apply only when `--tag=package-2024-05` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2024-05' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerservice.v2024_05_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/containerservice/mgmt-v2024_05_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-preview-2024-05 and java + +These settings apply only when `--tag=package-preview-2024-05` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-preview-2024-05' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerservice.v2024_05_02_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/containerservice/mgmt-v2024_05_02_preview +regenerate-manager: true +generate-interface: true ``` ### Tag: package-preview-2024-04 and java diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md index 24cc58a27dfa..66d3ac100d1a 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md @@ -34,7 +34,25 @@ These are the global settings for the ContainerServices API. ``` yaml openapi-type: arm -tag: package-preview-2024-04 +tag: package-2024-05 +``` + +### Tag: package-2024-05 + +These settings apply only when `--tag=package-2024-05` is specified on the command line. + +``` yaml $(tag) == 'package-2024-05' +input-file: + - stable/2024-05-01/managedClusters.json +``` + +### Tag: package-preview-2024-05 + +These settings apply only when `--tag=package-preview-2024-05` is specified on the command line. + +``` yaml $(tag) == 'package-preview-2024-05' +input-file: + - preview/2024-05-02-preview/managedClusters.json ``` ### Tag: package-preview-2024-04 diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.python.md b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.python.md index 779869c9f997..8abee1b6c3b4 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.python.md +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.python.md @@ -16,9 +16,11 @@ no-namespace-folders: true Generate all API versions currently shipped for this package ```yaml $(python) -default-api-version: "2024-04-02-preview" +default-api-version: "2024-05-01" multiapi: true batch: + - tag: package-2024-05 + - tag: package-preview-2024-05 - tag: package-preview-2024-04 - tag: package-preview-2024-03 - tag: package-2024-02 @@ -106,6 +108,26 @@ perform-load: false clear-output-folder: false ``` +### Tag: package-2024-05 and python + +These settings apply only when `--tag=package-2024-05 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2024-05' && $(python) +namespace: azure.mgmt.containerservice.v2024_05_01 +output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2024_05_01 +``` + +### Tag: package-preview-2024-05 and python + +These settings apply only when `--tag=package-preview-2024-05 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-preview-2024-05' && $(python) +namespace: azure.mgmt.containerservice.v2024_05_02_preview +output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2024_05_02_preview +``` + ### Tag: package-preview-2024-04 and python These settings apply only when `--tag=package-preview-2024-04 --python` is specified on the command line. diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/sdk-suppressions.yaml b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/sdk-suppressions.yaml index 1ba9d10b7347..cd6278a277a2 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/sdk-suppressions.yaml +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/sdk-suppressions.yaml @@ -2,9 +2,17 @@ suppressions: azure-sdk-for-go: - package: 'sdk/resourcemanager/containerservice/armcontainerservice' breaking-changes: - - Field `NodeSelector` of struct `IstioEgressGateway` has been removed + - Function `*ManagedClustersClient.GetOSOptions` has been removed + - Struct `OSOptionProfile` has been removed + - Struct `OSOptionPropertyList` has been removed + - Struct `OSOptionProperty` has been removed azure-sdk-for-python: - package: azure-mgmt-containerservice breaking-changes: + - Removed operation ManagedClustersOperations.get_os_options - Model ManagedClusterAzureMonitorProfileAppMonitoring no longer has parameter enabled - Model ManagedClusterAzureMonitorProfileContainerInsights no longer has parameter windows_host_logs + azure-sdk-for-js: + - package: '@azure/arm-containerservice' + breaking-changes: + - Removed operation ManagedClusters.getOSOptions diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsAbortOperation.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsAbortOperation.json new file mode 100644 index 000000000000..b88b8c57f71f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsAbortOperation.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-05-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2024-05-01" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_CRG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_CRG.json new file mode 100644 index 000000000000..fb2c21ddb325 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_CRG.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_CustomNodeConfig.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_CustomNodeConfig.json new file mode 100644 index 000000000000..b8f243ebf9df --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_CustomNodeConfig.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_DedicatedHostGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_DedicatedHostGroup.json new file mode 100644 index 000000000000..c37463404e30 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_DedicatedHostGroup.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_EnableEncryptionAtHost.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_EnableEncryptionAtHost.json new file mode 100644 index 000000000000..5bd68158af97 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_EnableEncryptionAtHost.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_EnableFIPS.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_EnableFIPS.json new file mode 100644 index 000000000000..ee3682b035c2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_EnableFIPS.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableFIPS": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_EnableUltraSSD.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_EnableUltraSSD.json new file mode 100644 index 000000000000..64952d67b4ea --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_EnableUltraSSD.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableUltraSSD": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableUltraSSD": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableUltraSSD": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_Ephemeral.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_Ephemeral.json new file mode 100644 index 000000000000..ae3c30e5ef6a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_Ephemeral.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osDiskType": "Ephemeral", + "osDiskSizeGB": 64 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskType": "Ephemeral", + "osDiskSizeGB": 64 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskType": "Ephemeral", + "kubeletDiskType": "OS", + "osDiskSizeGB": 64 + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_GPUMIG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_GPUMIG.json new file mode 100644 index 000000000000..38b3f433a095 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_GPUMIG.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_OSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_OSSKU.json new file mode 100644 index 000000000000..8293e45dbddc --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_OSSKU.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osSKU": "AzureLinux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_PPG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_PPG.json new file mode 100644 index 000000000000..1f010fe9f7fc --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_PPG.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_Snapshot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_Snapshot.json new file mode 100644 index 000000000000..a4f405d908fa --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_Snapshot.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_Spot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_Spot.json new file mode 100644 index 000000000000..150630802fd6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_Spot.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "spotMaxPrice": -1 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "spotMaxPrice": -1 + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_Update.json new file mode 100644 index 000000000000..985d803cc610 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_Update.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_WasmWasi.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_WasmWasi.json new file mode 100644 index 000000000000..92d619cdf8d5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_WasmWasi.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "workloadRuntime": "WasmWasi" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "workloadRuntime": "WasmWasi" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "workloadRuntime": "WasmWasi" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json new file mode 100644 index 000000000000..28ce480e00a5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "wnp2", + "parameters": { + "properties": { + "orchestratorVersion": "1.23.8", + "count": 3, + "vmSize": "Standard_D4s_v3", + "osType": "Windows", + "osSKU": "Windows2022", + "windowsProfile": { + "disableOutboundNat": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.23.8", + "currentOrchestratorVersion": "1.23.8", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022", + "windowsProfile": { + "disableOutboundNat": true + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.23.8", + "currentOrchestratorVersion": "1.23.8", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022", + "windowsProfile": { + "disableOutboundNat": true + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_WindowsOSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_WindowsOSSKU.json new file mode 100644 index 000000000000..aeea79ba266c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsCreate_WindowsOSSKU.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "wnp2", + "parameters": { + "properties": { + "orchestratorVersion": "1.23.3", + "count": 3, + "vmSize": "Standard_D4s_v3", + "osType": "Windows", + "osSKU": "Windows2022" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.23.3", + "currentOrchestratorVersion": "1.23.3", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.23.3", + "currentOrchestratorVersion": "1.23.3", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsDelete.json new file mode 100644 index 000000000000..2892372d6863 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsGet.json new file mode 100644 index 000000000000..48e199f12cc0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json new file mode 100644 index 000000000000..a022b90982ff --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/availableagentpoolversions", + "name": "default", + "properties": { + "agentPoolVersions": [ + { + "kubernetesVersion": "1.12.7" + }, + { + "kubernetesVersion": "1.12.8" + }, + { + "default": true, + "kubernetesVersion": "1.13.5", + "isPreview": true + } + ] + }, + "type": "Microsoft.ContainerService/managedClusters/availableAgentpoolVersions" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsGetUpgradeProfile.json new file mode 100644 index 000000000000..5c0b217bc852 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsGetUpgradeProfile.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/upgradeprofiles/default", + "name": "default", + "properties": { + "kubernetesVersion": "1.12.8", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.13.5" + } + ], + "latestNodeImageVersion": "AKSUbuntu:1604:2020.03.11" + }, + "type": "Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsList.json new file mode 100644 index 000000000000..b1fae2d56a85 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsUpgradeNodeImageVersion.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsUpgradeNodeImageVersion.json new file mode 100644 index 000000000000..fabd67883522 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPoolsUpgradeNodeImageVersion.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.ContainerService/locations/westus/operations/00000000-0000-0000-0000-000000000000?api-version=2018-07-31" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "UpgradingNodeImageVersion", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu-1604-2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPools_Start.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPools_Start.json new file mode 100644 index 000000000000..94461091925f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPools_Start.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "powerState": { + "code": "Running" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Starting", + "count": 50, + "enableAutoScaling": true, + "minCount": 3, + "maxCount": 55, + "powerState": { + "code": "Running" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Starting", + "count": 50, + "enableAutoScaling": true, + "minCount": 3, + "maxCount": 55, + "powerState": { + "code": "Running" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPools_Stop.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPools_Stop.json new file mode 100644 index 000000000000..27fa821a826c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPools_Stop.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "powerState": { + "code": "Stopped" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Stopping", + "count": 0, + "enableAutoScaling": false, + "minCount": null, + "maxCount": null, + "powerState": { + "code": "Stopped" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Stopping", + "count": 0, + "enableAutoScaling": false, + "minCount": null, + "maxCount": null, + "powerState": { + "code": "Stopped" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPools_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPools_Update.json new file mode 100644 index 000000000000..f23a92ee4749 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/AgentPools_Update.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Updating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/KubernetesVersions_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/KubernetesVersions_List.json new file mode 100644 index 000000000000..0e50facef5a4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/KubernetesVersions_List.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "values": [ + { + "version": "1.23", + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.23.12": { + "upgrades": [ + "1.23.15", + "1.24.6", + "1.24.9" + ] + }, + "1.23.15": { + "upgrades": [ + "1.24.6", + "1.24.9" + ] + } + } + }, + { + "version": "1.24", + "isDefault": true, + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.24.6": { + "upgrades": [ + "1.24.9", + "1.25.4", + "1.25.5" + ] + }, + "1.24.9": { + "upgrades": [ + "1.25.4", + "1.25.5" + ] + } + } + }, + { + "version": "1.25", + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.25.4": { + "upgrades": [ + "1.25.5", + "1.26.0" + ] + }, + "1.25.5": { + "upgrades": [ + "1.26.0" + ] + } + } + }, + { + "version": "1.26", + "isPreview": true, + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.26.0": { + "upgrades": [] + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsCreate_Update.json new file mode 100644 index 000000000000..677d9e5b8f42 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsCreate_Update.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default", + "parameters": { + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json new file mode 100644 index 000000000000..e1956d07a8ee --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "aksManagedAutoUpgradeSchedule", + "parameters": { + "properties": { + "maintenanceWindow": { + "schedule": { + "relativeMonthly": { + "intervalMonths": 3, + "weekIndex": "First", + "dayOfWeek": "Monday" + } + }, + "durationHours": 10, + "utcOffset": "+05:30", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedAutoUpgradeSchedule", + "name": "aksManagedAutoUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "weekly": { + "intervalWeeks": 3, + "dayOfWeek": "Monday" + } + }, + "durationHours": 10, + "utcOffset": "+05:30", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedAutoUpgradeSchedule", + "name": "aksManagedAutoUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "weekly": { + "intervalWeeks": 3, + "dayOfWeek": "Monday" + } + }, + "durationHours": 10, + "utcOffset": "+05:30", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsDelete.json new file mode 100644 index 000000000000..9d626e2f47c4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json new file mode 100644 index 000000000000..97f274294cc6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "aksManagedNodeOSUpgradeSchedule" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsGet.json new file mode 100644 index 000000000000..338887b3d6ad --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsGet.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json new file mode 100644 index 000000000000..a82d01f4624a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "aksManagedNodeOSUpgradeSchedule" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedNodeOSUpgradeSchedule", + "name": "aksManagedNodeOSUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "daily": { + "intervalDays": 3 + } + }, + "durationHours": 4, + "utcOffset": "-07:00", + "startDate": "2023-01-01", + "startTime": "09:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsList.json new file mode 100644 index 000000000000..42c8063cbc1e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "default", + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsList_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsList_MaintenanceWindow.json new file mode 100644 index 000000000000..b38c2e3ca3be --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/MaintenanceConfigurationsList_MaintenanceWindow.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedNodeOSUpgradeSchedule", + "name": "aksManagedNodeOSUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "daily": { + "intervalDays": 5 + } + }, + "durationHours": 10, + "utcOffset": "-07:00", + "startDate": "2023-01-01", + "startTime": "13:30" + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedAutoUpgradeSchedule", + "name": "aksManagedAutoUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "absoluteMonthly": { + "intervalMonths": 3, + "dayOfMonth": 15 + } + }, + "durationHours": 5, + "utcOffset": "+00:00", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersAbortOperation.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersAbortOperation.json new file mode 100644 index 000000000000..c99f6ff44ff7 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersAbortOperation.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-05-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2024-05-01" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json new file mode 100644 index 000000000000..812cf2179f29 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json @@ -0,0 +1,259 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_AzureServiceMesh.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_AzureServiceMesh.json new file mode 100644 index 000000000000..35ac459120ba --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_AzureServiceMesh.json @@ -0,0 +1,346 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "serviceMeshProfile": { + "mode": "Istio", + "istio": { + "components": { + "ingressGateways": [ + { + "enabled": true, + "mode": "Internal" + } + ], + "egressGateways": [ + { + "enabled": true + } + ] + }, + "certificateAuthority": { + "plugin": { + "keyVaultId": "/subscriptions/854c9ddb-fe9e-4aea-8d58-99ed88282881/resourceGroups/ddama-test/providers/Microsoft.KeyVault/vaults/my-akv", + "certObjectName": "ca-cert", + "keyObjectName": "ca-key", + "rootCertObjectName": "root-cert", + "certChainObjectName": "cert-chain" + } + } + } + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "serviceMeshProfile": { + "mode": "Istio", + "istio": { + "components": { + "ingressGateways": [ + { + "enabled": true, + "mode": "Internal" + } + ], + "egressGateways": [ + { + "enabled": true + } + ] + }, + "certificateAuthority": { + "plugin": { + "keyVaultId": "/subscriptions/854c9ddb-fe9e-4aea-8d58-99ed88282881/resourceGroups/ddama-test/providers/Microsoft.KeyVault/vaults/my-akv", + "certObjectName": "ca-cert", + "keyObjectName": "ca-key", + "rootCertObjectName": "root-cert", + "certChainObjectName": "cert-chain" + } + }, + "revisions": [ + "asm-1-17" + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "serviceMeshProfile": { + "mode": "Istio", + "istio": { + "components": { + "ingressGateways": [ + { + "enabled": true, + "mode": "Internal" + } + ], + "egressGateways": [ + { + "enabled": true + } + ] + }, + "certificateAuthority": { + "plugin": { + "keyVaultId": "/subscriptions/854c9ddb-fe9e-4aea-8d58-99ed88282881/resourceGroups/ddama-test/providers/Microsoft.KeyVault/vaults/my-akv", + "certObjectName": "ca-cert", + "keyObjectName": "ca-key", + "rootCertObjectName": "root-cert", + "certChainObjectName": "cert-chain" + } + }, + "revisions": [ + "asm-1-17" + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_CRG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_CRG.json new file mode 100644 index 000000000000..271357932088 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_CRG.json @@ -0,0 +1,254 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/capacityReservationGroups/crg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/capacityReservationGroups/crg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/capacityReservationGroups/crg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_DedicatedHostGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_DedicatedHostGroup.json new file mode 100644 index 000000000000..66deb2ffb625 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_DedicatedHostGroup.json @@ -0,0 +1,249 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_DisableRunCommand.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_DisableRunCommand.json new file mode 100644 index 000000000000..ffd5fee9279c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_DisableRunCommand.json @@ -0,0 +1,267 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "KubernetesOfficial" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "KubernetesOfficial" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_DualStackNetworking.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_DualStackNetworking.json new file mode 100644 index 000000000000..ee9e757fe310 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_DualStackNetworking.json @@ -0,0 +1,323 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + }, + "ipFamilies": [ + "IPv4", + "IPv6" + ] + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.22.1", + "currentKubernetesVersion": "1.22.1", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.22.1", + "currentOrchestratorVersion": "1.22.1", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16", + "fd11:1234::/64" + ], + "serviceCidrs": [ + "10.0.0.0/16", + "fd00:1234::/108" + ], + "ipFamilies": [ + "IPv4", + "IPv6" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2, + "countIPv6": 1 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip3-ipv6" + } + ] + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.22.1", + "currentKubernetesVersion": "1.22.1", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.22.1", + "currentOrchestratorVersion": "1.22.1", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16", + "fd11:1234::/64" + ], + "serviceCidrs": [ + "10.0.0.0/16", + "fd00:1234::/108" + ], + "ipFamilies": [ + "IPv4", + "IPv6" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2, + "countIPv6": 1 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip3-ipv6" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_EnableEncryptionAtHost.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_EnableEncryptionAtHost.json new file mode 100644 index 000000000000..36252d8e16a9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_EnableEncryptionAtHost.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_EnableUltraSSD.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_EnableUltraSSD.json new file mode 100644 index 000000000000..53ad25115575 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_EnableUltraSSD.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_EnabledFIPS.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_EnabledFIPS.json new file mode 100644 index 000000000000..24e7cd79bb10 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_EnabledFIPS.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_GPUMIG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_GPUMIG.json new file mode 100644 index 000000000000..b4037e01ad6a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_GPUMIG.json @@ -0,0 +1,283 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_HTTPProxy.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_HTTPProxy.json new file mode 100644 index 000000000000..35ad9b752716 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_HTTPProxy.json @@ -0,0 +1,280 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json new file mode 100644 index 000000000000..45350da37f42 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json @@ -0,0 +1,249 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "ingressProfile": { + "webAppRouting": { + "enabled": true, + "dnsZoneResourceIds": [ + "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME" + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "ingressProfile": { + "webAppRouting": { + "enabled": true, + "dnsZoneResourceIds": [ + "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME" + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "ingressProfile": { + "webAppRouting": { + "enabled": true, + "dnsZoneResourceIds": [ + "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME" + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_ManagedNATGateway.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_ManagedNATGateway.json new file mode 100644 index 000000000000..1e85923c9409 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_ManagedNATGateway.json @@ -0,0 +1,233 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "managedOutboundIPProfile": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "idleTimeoutInMinutes": 4, + "managedOutboundIPProfile": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "idleTimeoutInMinutes": 4, + "managedOutboundIPProfile": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_NodePublicIPPrefix.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_NodePublicIPPrefix.json new file mode 100644 index 000000000000..2f6d6b4421ce --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_NodePublicIPPrefix.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodePublicIPPrefixID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "nodePublicIPPrefixID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodePublicIPPrefixID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_OSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_OSSKU.json new file mode 100644 index 000000000000..7dc6a2139258 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_OSSKU.json @@ -0,0 +1,283 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osSKU": "AzureLinux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_PPG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_PPG.json new file mode 100644 index 000000000000..1f879da395d8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_PPG.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_PodIdentity.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_PodIdentity.json new file mode 100644 index 000000000000..504e354f7299 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_PodIdentity.json @@ -0,0 +1,265 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_Premium.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_Premium.json new file mode 100644 index 000000000000..26565bc83b40 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_Premium.json @@ -0,0 +1,274 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Base", + "tier": "Premium" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "supportPlan": "AKSLongTermSupport" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "sku": { + "name": "Base", + "tier": "Premium" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "AKSLongTermSupport" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "sku": { + "name": "Base", + "tier": "Premium" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "AKSLongTermSupport" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json new file mode 100644 index 000000000000..82d78373b358 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json @@ -0,0 +1,266 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "privateFQDN": "domain1.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "privateFQDN": "domain1.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json new file mode 100644 index 000000000000..5d41f2f960be --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json @@ -0,0 +1,270 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true, + "privateDNSZone": "system" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true, + "privateDNSZone": "system" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_SecurityProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_SecurityProfile.json new file mode 100644 index 000000000000..81e60481f5c4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_SecurityProfile.json @@ -0,0 +1,262 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "securityProfile": { + "defender": { + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME", + "securityMonitoring": { + "enabled": true + } + }, + "workloadIdentity": { + "enabled": true + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "securityProfile": { + "defender": { + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME", + "securityMonitoring": { + "enabled": true + } + }, + "workloadIdentity": { + "enabled": true + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "securityProfile": { + "defender": { + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME", + "securityMonitoring": { + "enabled": true + } + }, + "workloadIdentity": { + "enabled": true + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_Snapshot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_Snapshot.json new file mode 100644 index 000000000000..aad29f3f980e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_Snapshot.json @@ -0,0 +1,265 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_Update.json new file mode 100644 index 000000000000..f1a39b49cda2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_Update.json @@ -0,0 +1,317 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "upgradeSettings": { + "overrideSettings": { + "forceUpgrade": false, + "until": "2022-11-01T13:00:00Z" + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "upgradeSettings": { + "overrideSettings": { + "forceUpgrade": false, + "until": "2022-11-01T13:00:00Z" + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_UpdateWindowsGmsa.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_UpdateWindowsGmsa.json new file mode 100644 index 000000000000..c4cf6fcdcb51 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_UpdateWindowsGmsa.json @@ -0,0 +1,301 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$", + "gmsaProfile": { + "enabled": true + } + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "gmsaProfile": { + "enabled": true + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "gmsaProfile": { + "enabled": true + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_UpdateWithAHUB.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_UpdateWithAHUB.json new file mode 100644 index 000000000000..f0b500dfde91 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_UpdateWithAHUB.json @@ -0,0 +1,295 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json new file mode 100644 index 000000000000..d484d7e3b795 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json @@ -0,0 +1,284 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "aadProfile": { + "managed": true, + "enableAzureRBAC": true + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aadProfile": { + "managed": true, + "adminGroupObjectIDs": null, + "enableAzureRBAC": true, + "tenantID": "tenantID" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aadProfile": { + "managed": true, + "adminGroupObjectIDs": null, + "enableAzureRBAC": true, + "tenantID": "tenantID" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_UserAssignedNATGateway.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_UserAssignedNATGateway.json new file mode 100644 index 000000000000..97c698992812 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersCreate_UserAssignedNATGateway.json @@ -0,0 +1,200 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersDelete.json new file mode 100644 index 000000000000..00252f7e140f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGet.json new file mode 100644 index 000000000000..d0eab49813c5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGet.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "azurePortalFQDN": "dnsprefix1-abcd1234.portal.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "availabilityZones": [ + "1", + "2", + "3" + ], + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "outboundIPs": { + "publicIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip2" + } + ] + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "upgradeSettings": { + "overrideSettings": { + "forceUpgrade": true, + "until": "2022-11-01T13:00:00Z" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGetAccessProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGetAccessProfile.json new file mode 100644 index 000000000000..50b09bfe6b0a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGetAccessProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "roleName": "clusterUser" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/accessProfiles/clusterUser", + "location": "location1", + "name": "clusterUser", + "properties": { + "kubeConfig": "a3ViZUNvbmZpZzE=" + }, + "type": "Microsoft.ContainerService/ManagedClusters/AccessProfiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGetUpgradeProfile.json new file mode 100644 index 000000000000..79bcc25eb8a6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGetUpgradeProfile.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/upgradeprofiles/default", + "name": "default", + "properties": { + "agentPoolProfiles": [ + { + "kubernetesVersion": "1.7.7", + "name": "agent", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.7.9" + }, + { + "kubernetesVersion": "1.7.11", + "isPreview": true + } + ] + } + ], + "controlPlaneProfile": { + "kubernetesVersion": "1.7.7", + "name": "master", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.7.9", + "isPreview": true + }, + { + "kubernetesVersion": "1.7.11" + } + ] + } + }, + "type": "Microsoft.ContainerService/managedClusters/upgradeprofiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGet_MeshRevisionProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGet_MeshRevisionProfile.json new file mode 100644 index 000000000000..ac9d6b1c4f8c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGet_MeshRevisionProfile.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1", + "mode": "istio" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/meshRevisionProfiles/istio", + "type": "Microsoft.ContainerService/locations/meshRevisionProfiles", + "name": "istio", + "properties": { + "meshRevisions": [ + { + "revision": "asm-1-17", + "upgrades": [ + "asm-1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + }, + { + "revision": "asm-1-18", + "upgrades": [], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.24", + "1.25", + "1.26", + "1.27" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGet_MeshUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGet_MeshUpgradeProfile.json new file mode 100644 index 000000000000..cc5ed550d959 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersGet_MeshUpgradeProfile.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "mode": "istio" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/meshUpgradeProfiles/istio", + "type": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles", + "name": "istio", + "properties": { + "revision": "asm-1-17", + "upgrades": [ + "asm-1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersList.json new file mode 100644 index 000000000000..9e9b35630245 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersList.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "maxAgentPools": 1, + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersListByResourceGroup.json new file mode 100644 index 000000000000..cd6087e4a52b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersListByResourceGroup.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "maxAgentPools": 1, + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersListClusterAdminCredentials.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersListClusterAdminCredentials.json new file mode 100644 index 000000000000..52d37c53593b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersListClusterAdminCredentials.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "Y3JlZGVudGlhbFZhbHVlMQ==" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersListClusterMonitoringUserCredentials.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersListClusterMonitoringUserCredentials.json new file mode 100644 index 000000000000..52d37c53593b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersListClusterMonitoringUserCredentials.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "Y3JlZGVudGlhbFZhbHVlMQ==" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersListClusterUserCredentials.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersListClusterUserCredentials.json new file mode 100644 index 000000000000..52d37c53593b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersListClusterUserCredentials.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "Y3JlZGVudGlhbFZhbHVlMQ==" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersList_MeshRevisionProfiles.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersList_MeshRevisionProfiles.json new file mode 100644 index 000000000000..82f4bcafdac2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersList_MeshRevisionProfiles.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/meshRevisionProfiles/istio", + "type": "Microsoft.ContainerService/locations/meshRevisionProfiles", + "name": "istio", + "properties": { + "meshRevisions": [ + { + "revision": "asm-1-17", + "upgrades": [ + "asm-1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + }, + { + "revision": "asm-1-18", + "upgrades": [], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.24", + "1.25", + "1.26", + "1.27" + ] + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersList_MeshUpgradeProfiles.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersList_MeshUpgradeProfiles.json new file mode 100644 index 000000000000..38ab6738ba56 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersList_MeshUpgradeProfiles.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/meshUpgradeProfiles/istio", + "type": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles", + "name": "istio", + "properties": { + "revision": "asm-1-17", + "upgrades": [ + "asm-1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersResetAADProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersResetAADProfile.json new file mode 100644 index 000000000000..7b23c9e3f336 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersResetAADProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientAppID": "clientappid", + "serverAppID": "serverappid", + "serverAppSecret": "serverappsecret", + "tenantID": "tenantid" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersResetServicePrincipalProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersResetServicePrincipalProfile.json new file mode 100644 index 000000000000..2351ae6fa39f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersResetServicePrincipalProfile.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientId": "clientid", + "secret": "secret" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersRotateClusterCertificates.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersRotateClusterCertificates.json new file mode 100644 index 000000000000..00252f7e140f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersRotateClusterCertificates.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersRotateServiceAccountSigningKeys.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersRotateServiceAccountSigningKeys.json new file mode 100644 index 000000000000..00252f7e140f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersRotateServiceAccountSigningKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersStart.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersStart.json new file mode 100644 index 000000000000..00252f7e140f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersStart.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersStop.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersStop.json new file mode 100644 index 000000000000..00252f7e140f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersStop.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersUpdateTags.json new file mode 100644 index 000000000000..3b3d7d1b8e8d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ManagedClustersUpdateTags.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "tags": { + "tier": "testing", + "archv3": "" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv3": "", + "tier": "testing" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/Operation_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/Operation_List.json new file mode 100644 index 000000000000..31883723aed1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/Operation_List.json @@ -0,0 +1,3573 @@ +{ + "parameters": { + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "display": { + "description": "Gets the status of an asynchronous operation", + "operation": "Get Operation", + "provider": "Microsoft Container Service", + "resource": "Operation" + }, + "name": "Microsoft.ContainerService/locations/operations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Lists the supported orchestrators", + "operation": "List Orchestrators", + "provider": "Microsoft Container Service", + "resource": "Orchestrator" + }, + "name": "Microsoft.ContainerService/locations/orchestrators/read", + "origin": "user,system" + }, + { + "display": { + "description": "Lists operations available on Microsoft.ContainerService resource provider", + "operation": "List Available Container Service Operations", + "provider": "Microsoft Container Service", + "resource": "Available Container Service Operations" + }, + "name": "Microsoft.ContainerService/operations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Registers Subscription with Microsoft.ContainerService resource provider", + "operation": "Register Subscription for Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Service Register Subscription" + }, + "name": "Microsoft.ContainerService/register/action", + "origin": "user,system" + }, + { + "display": { + "description": "Unregisters Subscription with Microsoft.ContainerService resource provider", + "operation": "Unregister Subscription for Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Service Unregister Subscription" + }, + "name": "Microsoft.ContainerService/unregister/action", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the status of an asynchronous operation result", + "operation": "Get Operation Result", + "provider": "Microsoft Container Service", + "resource": "OperationResult" + }, + "name": "Microsoft.ContainerService/locations/operationresults/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get a container service", + "operation": "Get Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Services" + }, + "name": "Microsoft.ContainerService/containerServices/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new container service or updates an existing one", + "operation": "Create or Update Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Services" + }, + "name": "Microsoft.ContainerService/containerServices/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a container service", + "operation": "Delete Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Services" + }, + "name": "Microsoft.ContainerService/containerServices/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Get a managed cluster", + "operation": "Get Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new managed cluster or updates an existing one", + "operation": "Create or Update Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a managed cluster", + "operation": "Delete Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Starts a managed cluster", + "operation": "Start Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/start/action", + "origin": "user,system" + }, + { + "display": { + "description": "Stops a managed cluster", + "operation": "Stop Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/stop/action", + "origin": "user,system" + }, + { + "display": { + "description": "Gets a maintenance configuration", + "operation": "Get a maintenance configuration", + "provider": "Microsoft Container Service", + "resource": "Maintenance Configurations" + }, + "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new MaintenanceConfiguration or updates an existing one", + "operation": "Create or Update maintenance configuratio", + "provider": "Microsoft Container Service", + "resource": "Maintenance Configurations" + }, + "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a maintenance configuration", + "operation": "Delete Maintenance Configuration", + "provider": "Microsoft Container Service", + "resource": "Maintenance Configurations" + }, + "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets an agent pool", + "operation": "Get Agent Pool", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new agent pool or updates an existing one", + "operation": "Create or Update Agent Pool", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes an agent pool", + "operation": "Delete Agent Pool", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the upgrade profile of the Agent Pool", + "operation": "Get Agent Pool UpgradeProfile", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Upgrade the node image version of agent pool", + "operation": "Upgrade agent pool node image version", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/upgradeNodeImageVersion/write", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the available agent pool versions of the cluster", + "operation": "Get Available Agent Pool Versions", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/availableAgentPoolVersions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get a managed cluster access profile by role name", + "operation": "Get Managed Cluster AccessProfile", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/accessProfiles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get a managed cluster access profile by role name using list credential", + "operation": "Get Managed Cluster AccessProfile by List Credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/accessProfiles/listCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the upgrade profile of the cluster", + "operation": "Get UpgradeProfile", + "provider": "Microsoft Container Service", + "resource": "UpgradeProfile" + }, + "name": "Microsoft.ContainerService/managedClusters/upgradeProfiles/read", + "origin": "user,system" + }, + { + "display": { + "description": "List the clusterAdmin credential of a managed cluster", + "operation": "List clusterAdmin credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/listClusterAdminCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "List the clusterUser credential of a managed cluster", + "operation": "List clusterUser credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/listClusterUserCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "List the clusterMonitoringUser credential of a managed cluster", + "operation": "List clusterMonitoringUser credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/listClusterMonitoringUserCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reset the service principal profile of a managed cluster", + "operation": "Reset service principal profile", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/resetServicePrincipalProfile/action", + "origin": "user,system" + }, + { + "display": { + "description": "Resolve the private link service id of a managed cluster", + "operation": "Resolve private link service id", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/resolvePrivateLinkServiceId/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reset the AAD profile of a managed cluster", + "operation": "Reset AAD profile", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/resetAADProfile/action", + "origin": "user,system" + }, + { + "display": { + "description": "Rotate certificates of a managed cluster", + "operation": "Rotate certificates of the cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/rotateClusterCertificates/action", + "origin": "user,system" + }, + { + "display": { + "description": "Run user issued command against managed kubernetes server.", + "operation": "RunCommand", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/runCommand/action", + "origin": "user,system" + }, + { + "display": { + "description": "Retrieve result from previous issued command.", + "operation": "CommandResult", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/commandResults/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get the diagnostic setting for a managed cluster resource", + "operation": "Read Diagnostic Setting", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/diagnosticSettings/read", + "origin": "system" + }, + { + "display": { + "description": "Creates or updates the diagnostic setting for a managed cluster resource", + "operation": "Write Diagnostic Setting", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/diagnosticSettings/write", + "origin": "system" + }, + { + "display": { + "description": "Get Managed Cluster Detector", + "operation": "Get Managed Cluster Detector", + "provider": "Microsoft Container Service", + "resource": "Managed Cluster Detector" + }, + "name": "Microsoft.ContainerService/managedClusters/detectors/read", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the diagnostics state of the cluster", + "operation": "Get Diagnostics State", + "provider": "Microsoft Container Service", + "resource": "Diagnostics State" + }, + "name": "Microsoft.ContainerService/managedClusters/diagnosticsState/read", + "origin": "user,system" + }, + { + "display": { + "description": "Determines if user is allowed to approve a private endpoint connection", + "operation": "Approve Private Endpoint Connections", + "provider": "Microsoft Container Service", + "resource": "Approve Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnectionsApproval/action", + "origin": "user,system" + }, + { + "display": { + "description": "Get private endpoint connection", + "operation": "Get private endpoint connection", + "provider": "Microsoft Container Service", + "resource": "Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/read", + "origin": "user,system" + }, + { + "display": { + "description": "Approve or Reject a private endpoint connection", + "operation": "Update private endpoint connection", + "provider": "Microsoft Container Service", + "resource": "Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/write", + "origin": "user,system" + }, + { + "display": { + "description": "Delete private endpoint connection", + "operation": "Delete private endpoint connection", + "provider": "Microsoft Container Service", + "resource": "Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets an extension addon", + "operation": "Get an extension addon", + "provider": "Microsoft Container Service", + "resource": "ExtensionAddons" + }, + "name": "Microsoft.ContainerService/managedClusters/extensionaddons/read", + "origin": "system" + }, + { + "display": { + "description": "Creates a new extension addon or updates an existing one", + "operation": "Create or Update extension addon", + "provider": "Microsoft Container Service", + "resource": "ExtensionAddons" + }, + "name": "Microsoft.ContainerService/managedClusters/extensionaddons/write", + "origin": "system" + }, + { + "display": { + "description": "Deletes an extension addon", + "operation": "Delete an extension addon", + "provider": "Microsoft Container Service", + "resource": "ExtensionAddons" + }, + "name": "Microsoft.ContainerService/managedClusters/extensionaddons/delete", + "origin": "system" + }, + { + "display": { + "description": "Get a snapshot", + "operation": "Get Snapshot", + "provider": "Microsoft Container Service", + "resource": "Snapshots" + }, + "name": "Microsoft.ContainerService/snapshots/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new snapshot", + "operation": "Create Snapshot", + "provider": "Microsoft Container Service", + "resource": "Snapshots" + }, + "name": "Microsoft.ContainerService/snapshots/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a snapshot", + "operation": "Delete Snapshot", + "provider": "Microsoft Container Service", + "resource": "Snapshots" + }, + "name": "Microsoft.ContainerService/snapshots/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Get eventgrid filter", + "operation": "Get eventgrid filter", + "provider": "Microsoft Container Service", + "resource": "EventGridFilters" + }, + "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/read", + "origin": "system" + }, + { + "display": { + "description": "Create or Update eventgrid filter", + "operation": "Create or Update eventgrid filter", + "provider": "Microsoft Container Service", + "resource": "EventGridFilters" + }, + "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/write", + "origin": "system" + }, + { + "display": { + "description": "Delete an eventgrid filter", + "operation": "Delete an eventgrid filter", + "provider": "Microsoft Container Service", + "resource": "EventGridFilters" + }, + "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/delete", + "origin": "system" + }, + { + "display": { + "description": "Reads initializerconfigurations", + "operation": "Gets/List initializerconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Initializerconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes initializerconfigurations", + "operation": "Creates/Updates initializerconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Initializerconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes/DeletesCollection initializerconfigurations resource", + "operation": "Initializerconfigurations", + "provider": "Microsoft Container Service", + "resource": "Initializerconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads mutatingwebhookconfigurations", + "operation": "Gets/List mutatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Mutatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes mutatingwebhookconfigurations", + "operation": "Creates/Updates mutatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Mutatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes mutatingwebhookconfigurations", + "operation": "Deletes/DeletesCollection mutatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Mutatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads validatingwebhookconfigurations", + "operation": "Gets/List validatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Validatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes validatingwebhookconfigurations", + "operation": "Creates/Updates validatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Validatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes validatingwebhookconfigurations", + "operation": "Deletes/DeletesCollection validatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Validatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads customresourcedefinitions", + "operation": "Gets/List customresourcedefinitions resource", + "provider": "Microsoft Container Service", + "resource": "Customresourcedefinitions" + }, + "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes customresourcedefinitions", + "operation": "Creates/Updates customresourcedefinitions resource", + "provider": "Microsoft Container Service", + "resource": "Customresourcedefinitions" + }, + "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes customresourcedefinitions", + "operation": "Deletes/DeletesCollection customresourcedefinitions resource", + "provider": "Microsoft Container Service", + "resource": "Customresourcedefinitions" + }, + "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservices", + "operation": "Gets/List apiservices resource", + "provider": "Microsoft Container Service", + "resource": "Apiservices" + }, + "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes apiservices", + "operation": "Creates/Updates apiservices resource", + "provider": "Microsoft Container Service", + "resource": "Apiservices" + }, + "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes apiservices", + "operation": "Deletes/DeletesCollection apiservices resource", + "provider": "Microsoft Container Service", + "resource": "Apiservices" + }, + "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads controllerrevisions", + "operation": "Gets/List controllerrevisions resource", + "provider": "Microsoft Container Service", + "resource": "Controllerrevisions" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes controllerrevisions", + "operation": "Creates/Updates controllerrevisions resource", + "provider": "Microsoft Container Service", + "resource": "Controllerrevisions" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes controllerrevisions", + "operation": "Deletes/DeletesCollection controllerrevisions resource", + "provider": "Microsoft Container Service", + "resource": "Controllerrevisions" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads daemonsets", + "operation": "Gets/List daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes daemonsets", + "operation": "Creates/Updates daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes daemonsets", + "operation": "Deletes/DeletesCollection daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads deployments", + "operation": "Gets/List deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/deployments/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes deployments", + "operation": "Creates/Updates deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/deployments/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes deployments", + "operation": "Deletes/DeletesCollection deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/deployments/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads replicasets", + "operation": "Gets/List replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes replicasets", + "operation": "Creates/Updates replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes replicasets", + "operation": "Deletes/DeletesCollection replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads statefulsets", + "operation": "Gets/List statefulsets resource", + "provider": "Microsoft Container Service", + "resource": "Statefulsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes statefulsets", + "operation": "Creates/Updates statefulsets resource", + "provider": "Microsoft Container Service", + "resource": "Statefulsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes statefulsets", + "operation": "Deletes/DeletesCollection statefulsets resource", + "provider": "Microsoft Container Service", + "resource": "Statefulsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Writes tokenreviews", + "operation": "Creates/Updates tokenreviews resource", + "provider": "Microsoft Container Service", + "resource": "Tokenreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authentication.k8s.io/tokenreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes localsubjectaccessreviews", + "operation": "Creates/Updates localsubjectaccessreviews resource", + "provider": "Microsoft Container Service", + "resource": "Localsubjectaccessreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/localsubjectaccessreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes selfsubjectaccessreviews", + "operation": "Creates/Updates selfsubjectaccessreviews resource", + "provider": "Microsoft Container Service", + "resource": "Selfsubjectaccessreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/selfsubjectaccessreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes selfsubjectrulesreviews", + "operation": "Creates/Updates selfsubjectrulesreviews resource", + "provider": "Microsoft Container Service", + "resource": "Selfsubjectrulesreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/selfsubjectrulesreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes subjectaccessreviews", + "operation": "Creates/Updates subjectaccessreviews resource", + "provider": "Microsoft Container Service", + "resource": "Subjectaccessreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/subjectaccessreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Reads horizontalpodautoscalers", + "operation": "Gets/List horizontalpodautoscalers resource", + "provider": "Microsoft Container Service", + "resource": "Horizontalpodautoscalers" + }, + "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes horizontalpodautoscalers", + "operation": "Creates/Updates horizontalpodautoscalers resource", + "provider": "Microsoft Container Service", + "resource": "Horizontalpodautoscalers" + }, + "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes horizontalpodautoscalers", + "operation": "Deletes/DeletesCollection horizontalpodautoscalers resource", + "provider": "Microsoft Container Service", + "resource": "Horizontalpodautoscalers" + }, + "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads cronjobs", + "operation": "Gets/List cronjobs resource", + "provider": "Microsoft Container Service", + "resource": "Cronjobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes cronjobs", + "operation": "Creates/Updates cronjobs resource", + "provider": "Microsoft Container Service", + "resource": "Cronjobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes cronjobs", + "operation": "Deletes/DeletesCollection cronjobs resource", + "provider": "Microsoft Container Service", + "resource": "Cronjobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads jobs", + "operation": "Gets/List jobs resource", + "provider": "Microsoft Container Service", + "resource": "Jobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/jobs/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes jobs", + "operation": "Creates/Updates jobs resource", + "provider": "Microsoft Container Service", + "resource": "Jobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/jobs/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes jobs", + "operation": "Deletes/DeletesCollection jobs resource", + "provider": "Microsoft Container Service", + "resource": "Jobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/jobs/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads certificatesigningrequests", + "operation": "Gets/List certificatesigningrequests resource", + "provider": "Microsoft Container Service", + "resource": "Certificatesigningrequests" + }, + "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes certificatesigningrequests", + "operation": "Creates/Updates certificatesigningrequests resource", + "provider": "Microsoft Container Service", + "resource": "Certificatesigningrequests" + }, + "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes certificatesigningrequests", + "operation": "Deletes/DeletesCollection certificatesigningrequests resource", + "provider": "Microsoft Container Service", + "resource": "Certificatesigningrequests" + }, + "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads leases", + "operation": "Gets/List leases resource", + "provider": "Microsoft Container Service", + "resource": "Leases" + }, + "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes leases", + "operation": "Creates/Updates leases resource", + "provider": "Microsoft Container Service", + "resource": "Leases" + }, + "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes leases", + "operation": "Deletes/DeletesCollection leases resource", + "provider": "Microsoft Container Service", + "resource": "Leases" + }, + "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Writes bindings", + "operation": "Creates/Updates bindings resource", + "provider": "Microsoft Container Service", + "resource": "Bindings" + }, + "name": "Microsoft.ContainerService/managedClusters/bindings/write", + "origin": "user,system" + }, + { + "display": { + "description": "Reads componentstatuses", + "operation": "Gets/List componentstatuses resource", + "provider": "Microsoft Container Service", + "resource": "Componentstatuses" + }, + "name": "Microsoft.ContainerService/managedClusters/componentstatuses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes componentstatuses", + "operation": "Creates/Updates componentstatuses resource", + "provider": "Microsoft Container Service", + "resource": "Componentstatuses" + }, + "name": "Microsoft.ContainerService/managedClusters/componentstatuses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes componentstatuses", + "operation": "Deletes/DeletesCollection componentstatuses resource", + "provider": "Microsoft Container Service", + "resource": "Componentstatuses" + }, + "name": "Microsoft.ContainerService/managedClusters/componentstatuses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads configmaps", + "operation": "Gets/List configmaps resource", + "provider": "Microsoft Container Service", + "resource": "Configmaps" + }, + "name": "Microsoft.ContainerService/managedClusters/configmaps/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes configmaps", + "operation": "Creates/Updates configmaps resource", + "provider": "Microsoft Container Service", + "resource": "Configmaps" + }, + "name": "Microsoft.ContainerService/managedClusters/configmaps/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes configmaps", + "operation": "Deletes/DeletesCollection configmaps resource", + "provider": "Microsoft Container Service", + "resource": "Configmaps" + }, + "name": "Microsoft.ContainerService/managedClusters/configmaps/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads endpoints", + "operation": "Gets/List endpoints resource", + "provider": "Microsoft Container Service", + "resource": "Endpoints" + }, + "name": "Microsoft.ContainerService/managedClusters/endpoints/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes endpoints", + "operation": "Creates/Updates endpoints resource", + "provider": "Microsoft Container Service", + "resource": "Endpoints" + }, + "name": "Microsoft.ContainerService/managedClusters/endpoints/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes endpoints", + "operation": "Deletes/DeletesCollection endpoints resource", + "provider": "Microsoft Container Service", + "resource": "Endpoints" + }, + "name": "Microsoft.ContainerService/managedClusters/endpoints/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events", + "operation": "Gets/List events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes events", + "operation": "Creates/Updates events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes events", + "operation": "Deletes/DeletesCollection events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads limitranges", + "operation": "Gets/List limitranges resource", + "provider": "Microsoft Container Service", + "resource": "Limitranges" + }, + "name": "Microsoft.ContainerService/managedClusters/limitranges/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes limitranges", + "operation": "Creates/Updates limitranges resource", + "provider": "Microsoft Container Service", + "resource": "Limitranges" + }, + "name": "Microsoft.ContainerService/managedClusters/limitranges/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes limitranges", + "operation": "Deletes/DeletesCollection limitranges resource", + "provider": "Microsoft Container Service", + "resource": "Limitranges" + }, + "name": "Microsoft.ContainerService/managedClusters/limitranges/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads namespaces", + "operation": "Gets/List namespaces resource", + "provider": "Microsoft Container Service", + "resource": "Namespaces" + }, + "name": "Microsoft.ContainerService/managedClusters/namespaces/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes namespaces", + "operation": "Creates/Updates namespaces resource", + "provider": "Microsoft Container Service", + "resource": "Namespaces" + }, + "name": "Microsoft.ContainerService/managedClusters/namespaces/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes namespaces", + "operation": "Deletes/DeletesCollection namespaces resource", + "provider": "Microsoft Container Service", + "resource": "Namespaces" + }, + "name": "Microsoft.ContainerService/managedClusters/namespaces/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads nodes", + "operation": "Gets/List nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/nodes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes nodes", + "operation": "Creates/Updates nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/nodes/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes nodes", + "operation": "Deletes/DeletesCollection nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/nodes/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads persistentvolumeclaims", + "operation": "Gets/List persistentvolumeclaims resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumeclaims" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes persistentvolumeclaims", + "operation": "Creates/Updates persistentvolumeclaims resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumeclaims" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes persistentvolumeclaims", + "operation": "Deletes/DeletesCollection persistentvolumeclaims resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumeclaims" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads persistentvolumes", + "operation": "Gets/List persistentvolumes resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumes" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes persistentvolumes", + "operation": "Creates/Updates persistentvolumes resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumes" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes persistentvolumes", + "operation": "Deletes/DeletesCollection persistentvolumes resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumes" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads pods", + "operation": "Gets/List pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes pods", + "operation": "Creates/Updates pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes pods", + "operation": "Deletes/DeletesCollection pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Exec into pods resource", + "operation": "Exec into pods resource ", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/exec/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reads podtemplates", + "operation": "Gets/List podtemplates resource", + "provider": "Microsoft Container Service", + "resource": "Podtemplates" + }, + "name": "Microsoft.ContainerService/managedClusters/podtemplates/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes podtemplates", + "operation": "Creates/Updates podtemplates resource", + "provider": "Microsoft Container Service", + "resource": "Podtemplates" + }, + "name": "Microsoft.ContainerService/managedClusters/podtemplates/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes podtemplates", + "operation": "Deletes/DeletesCollection podtemplates resource", + "provider": "Microsoft Container Service", + "resource": "Podtemplates" + }, + "name": "Microsoft.ContainerService/managedClusters/podtemplates/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads replicationcontrollers", + "operation": "Gets/List replicationcontrollers resource", + "provider": "Microsoft Container Service", + "resource": "Replicationcontrollers" + }, + "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes replicationcontrollers", + "operation": "Creates/Updates replicationcontrollers resource", + "provider": "Microsoft Container Service", + "resource": "Replicationcontrollers" + }, + "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes replicationcontrollers", + "operation": "Deletes/DeletesCollection replicationcontrollers resource", + "provider": "Microsoft Container Service", + "resource": "Replicationcontrollers" + }, + "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads resourcequotas", + "operation": "Gets/List resourcequotas resource", + "provider": "Microsoft Container Service", + "resource": "Resourcequotas" + }, + "name": "Microsoft.ContainerService/managedClusters/resourcequotas/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes resourcequotas", + "operation": "Creates/Updates resourcequotas resource", + "provider": "Microsoft Container Service", + "resource": "Resourcequotas" + }, + "name": "Microsoft.ContainerService/managedClusters/resourcequotas/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes resourcequotas", + "operation": "Deletes/DeletesCollection resourcequotas resource", + "provider": "Microsoft Container Service", + "resource": "Resourcequotas" + }, + "name": "Microsoft.ContainerService/managedClusters/resourcequotas/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads secrets", + "operation": "Gets/List secrets resource", + "provider": "Microsoft Container Service", + "resource": "Secrets" + }, + "name": "Microsoft.ContainerService/managedClusters/secrets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes secrets", + "operation": "Creates/Updates secrets resource", + "provider": "Microsoft Container Service", + "resource": "Secrets" + }, + "name": "Microsoft.ContainerService/managedClusters/secrets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes secrets", + "operation": "Deletes/DeletesCollection secrets resource", + "provider": "Microsoft Container Service", + "resource": "Secrets" + }, + "name": "Microsoft.ContainerService/managedClusters/secrets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads serviceaccounts", + "operation": "Gets/List serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes serviceaccounts", + "operation": "Creates/Updates serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes serviceaccounts", + "operation": "Deletes/DeletesCollection serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads services", + "operation": "Gets/List services resource", + "provider": "Microsoft Container Service", + "resource": "Services" + }, + "name": "Microsoft.ContainerService/managedClusters/services/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes services", + "operation": "Creates/Updates services resource", + "provider": "Microsoft Container Service", + "resource": "Services" + }, + "name": "Microsoft.ContainerService/managedClusters/services/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes services", + "operation": "Deletes/DeletesCollection services resource", + "provider": "Microsoft Container Service", + "resource": "Services" + }, + "name": "Microsoft.ContainerService/managedClusters/services/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events", + "operation": "Gets/List events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes events", + "operation": "Creates/Updates events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes events", + "operation": "Deletes/DeletesCollection events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads daemonsets", + "operation": "Gets/List daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes daemonsets", + "operation": "Creates/Updates daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes daemonsets", + "operation": "Deletes/DeletesCollection daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads deployments", + "operation": "Gets/List deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes deployments", + "operation": "Creates/Updates deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes deployments", + "operation": "Deletes/DeletesCollection deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ingresses", + "operation": "Gets/List ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes ingresses", + "operation": "Creates/Updates ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes ingresses", + "operation": "Deletes/DeletesCollection ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networkpolicies", + "operation": "Gets/List networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes networkpolicies", + "operation": "Creates/Updates networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes networkpolicies", + "operation": "Deletes/DeletesCollection networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads podsecuritypolicies", + "operation": "Gets/List podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes podsecuritypolicies", + "operation": "Creates/Updates podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes podsecuritypolicies", + "operation": "Deletes/DeletesCollection podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads replicasets", + "operation": "Gets/List replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes replicasets", + "operation": "Creates/Updates replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes replicasets", + "operation": "Deletes/DeletesCollection replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads pods", + "operation": "Gets/List pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/metrics.k8s.io/pods/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads nodes", + "operation": "Gets/List nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/metrics.k8s.io/nodes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networkpolicies", + "operation": "Gets/List networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes networkpolicies", + "operation": "Creates/Updates networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes networkpolicies", + "operation": "Deletes/DeletesCollection networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ingresses", + "operation": "Gets/List ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes ingresses", + "operation": "Creates/Updates ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes ingresses", + "operation": "Deletes/DeletesCollection ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads runtimeclasses", + "operation": "Gets/List runtimeclasses resource", + "provider": "Microsoft Container Service", + "resource": "Runtimeclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes runtimeclasses", + "operation": "Creates/Updates runtimeclasses resource", + "provider": "Microsoft Container Service", + "resource": "Runtimeclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes runtimeclasses", + "operation": "Deletes/DeletesCollection runtimeclasses resource", + "provider": "Microsoft Container Service", + "resource": "Runtimeclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads api", + "operation": "Gets/List api resource", + "provider": "Microsoft Container Service", + "resource": "Api" + }, + "name": "Microsoft.ContainerService/managedClusters/api/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads api/v1", + "operation": "Gets/List api/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Api/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/api/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apis", + "operation": "Gets/List apis resource", + "provider": "Microsoft Container Service", + "resource": "Apis" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads admissionregistration.k8s.io", + "operation": "Gets/List admissionregistration.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Admissionregistration.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads admissionregistration.k8s.io/v1", + "operation": "Gets/List admissionregistration.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Admissionregistration.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads admissionregistration.k8s.io/v1beta1", + "operation": "Gets/List admissionregistration.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Admissionregistration.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiextensions.k8s.io", + "operation": "Gets/List apiextensions.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Apiextensions.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiextensions.k8s.io/v1", + "operation": "Gets/List apiextensions.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiextensions.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiextensions.k8s.io/v1beta1", + "operation": "Gets/List apiextensions.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiextensions.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiregistration.k8s.io", + "operation": "Gets/List apiregistration.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Apiregistration.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiregistration.k8s.io/v1", + "operation": "Gets/List apiregistration.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiregistration.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiregistration.k8s.io/v1beta1", + "operation": "Gets/List apiregistration.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiregistration.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps", + "operation": "Gets/List apps resource", + "provider": "Microsoft Container Service", + "resource": "Apps" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps/v1", + "operation": "Gets/List apps/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Apps/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps/v1beta1", + "operation": "Gets/List apps/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Apps/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps/v1beta2", + "operation": "Gets/List apps/v1beta2 resource", + "provider": "Microsoft Container Service", + "resource": "Apps/V1beta2" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1beta2/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authentication.k8s.io", + "operation": "Gets/List authentication.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Authentication.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authentication.k8s.io/v1", + "operation": "Gets/List authentication.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Authentication.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authentication.k8s.io/v1beta1", + "operation": "Gets/List authentication.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Authentication.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authorization.k8s.io", + "operation": "Gets/List authorization.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Authorization.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authorization.k8s.io/v1", + "operation": "Gets/List authorization.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Authorization.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authorization.k8s.io/v1beta1", + "operation": "Gets/List authorization.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Authorization.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling", + "operation": "Gets/List autoscaling resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling/v1", + "operation": "Gets/List autoscaling/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling/v2beta1", + "operation": "Gets/List autoscaling/v2beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling/V2beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v2beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling/v2beta2", + "operation": "Gets/List autoscaling/v2beta2 resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling/V2beta2" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v2beta2/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads batch", + "operation": "Gets/List batch resource", + "provider": "Microsoft Container Service", + "resource": "Batch" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/batch/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads batch/v1", + "operation": "Gets/List batch/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Batch/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/batch/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads batch/v1beta1", + "operation": "Gets/List batch/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Batch/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/batch/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads certificates.k8s.io", + "operation": "Gets/List certificates.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Certificates.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/certificates.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads certificates.k8s.io/v1beta1", + "operation": "Gets/List certificates.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Certificates.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/certificates.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads coordination.k8s.io", + "operation": "Gets/List coordination.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Coordination.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads coordination/v1", + "operation": "Gets/List coordination/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Coordination.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads coordination.k8s.io/v1beta1", + "operation": "Gets/List coordination.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Coordination.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events.k8s.io", + "operation": "Gets/List events.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Events.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/events.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events.k8s.io/v1beta1", + "operation": "Gets/List events.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Events.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/events.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads extensions", + "operation": "Gets/List extensions resource", + "provider": "Microsoft Container Service", + "resource": "Extensions" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/extensions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads extensions/v1beta1", + "operation": "Gets/List extensions/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Extensions/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/extensions/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads metrics.k8s.io", + "operation": "Gets/List metrics.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Metrics.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/metrics.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads metrics.k8s.io/v1beta1", + "operation": "Gets/List metrics.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Metrics.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/metrics.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networking.k8s.io", + "operation": "Gets/List networking.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Networking.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networking/v1", + "operation": "Gets/List networking/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Networking.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networking.k8s.io/v1beta1", + "operation": "Gets/List networking.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Networking.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads node.k8s.io", + "operation": "Gets/List node.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Node.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/node.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads node.k8s.io/v1beta1", + "operation": "Gets/List node.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Node.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/node.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads policy", + "operation": "Gets/List policy resource", + "provider": "Microsoft Container Service", + "resource": "Policy" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/policy/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads policy/v1beta1", + "operation": "Gets/List policy/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Policy/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/policy/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rbac.authorization.k8s.io", + "operation": "Gets/List rbac.authorization.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Rbac.Authorization.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rbac.authorization/v1", + "operation": "Gets/List rbac.authorization/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Rbac.Authorization.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rbac.authorization.k8s.io/v1beta1", + "operation": "Gets/List rbac.authorization.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Rbac.Authorization.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads scheduling.k8s.io", + "operation": "Gets/List scheduling.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Scheduling.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads scheduling/v1", + "operation": "Gets/List scheduling/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Scheduling.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads scheduling.k8s.io/v1beta1", + "operation": "Gets/List scheduling.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Scheduling.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storage.k8s.io", + "operation": "Gets/List storage.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Storage.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storage/v1", + "operation": "Gets/List storage/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Storage.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storage.k8s.io/v1beta1", + "operation": "Gets/List storage.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Storage.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads healthz", + "operation": "Gets/List healthz resource", + "provider": "Microsoft Container Service", + "resource": "Healthz" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoregister-completion", + "operation": "Gets/List autoregister-completion resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Autoregister-Completion" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/autoregister-completion/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads etcd", + "operation": "Gets/List etcd resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Etcd" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/etcd/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads log", + "operation": "Gets/List log resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Log" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/log/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ping", + "operation": "Gets/List ping resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Ping" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/ping/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-openapi-controller", + "operation": "Gets/List apiservice-openapi-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Apiservice-Openapi-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-openapi-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-registration-controller", + "operation": "Gets/List apiservice-registration-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Apiservice-Registration-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-registration-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-status-available-controller", + "operation": "Gets/List apiservice-status-available-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Apiservice-Status-Available-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-status-available-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-controller", + "operation": "Gets/List bootstrap-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Bootstrap-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/bootstrap-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ca-registration", + "operation": "Gets/List ca-registration resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Ca-Registration" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/ca-registration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads crd-informer-synced", + "operation": "Gets/List crd-informer-synced resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Crd-Informer-Synced" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/crd-informer-synced/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads generic-apiserver-start-informers", + "operation": "Gets/List generic-apiserver-start-informers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Generic-Apiserver-Start-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/generic-apiserver-start-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads kube-apiserver-autoregistration", + "operation": "Gets/List kube-apiserver-autoregistration resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Kube-Apiserver-Autoregistration" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/kube-apiserver-autoregistration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-roles", + "operation": "Gets/List bootstrap-roles resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Bootstrap-Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/rbac/bootstrap-roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-system-priority-classes", + "operation": "Gets/List bootstrap-system-priority-classes resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Bootstrap-System-Priority-Classes" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/scheduling/bootstrap-system-priority-classes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-controllers", + "operation": "Gets/List start-apiextensions-controllers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Apiextensions-Controllers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-apiextensions-controllers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-informers", + "operation": "Gets/List start-apiextensions-informers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Apiextensions-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-apiextensions-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-aggregator-informers", + "operation": "Gets/List start-kube-aggregator-informers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Kube-Aggregator-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-kube-aggregator-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-apiserver-admission-initializer", + "operation": "Gets/List start-kube-apiserver-admission-initializer resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Kube-Apiserver-Admission-Initializer" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-kube-apiserver-admission-initializer/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads livez", + "operation": "Gets/List livez resource", + "provider": "Microsoft Container Service", + "resource": "Livez" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoregister-completion", + "operation": "Gets/List autoregister-completion resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Autoregister-Completion" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/autoregister-completion/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads etcd", + "operation": "Gets/List etcd resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Etcd" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/etcd/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads log", + "operation": "Gets/List log resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Log" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/log/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ping", + "operation": "Gets/List ping resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Ping" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/ping/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-openapi-controller", + "operation": "Gets/List apiservice-openapi-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Apiservice-Openapi-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-openapi-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-registration-controller", + "operation": "Gets/List apiservice-registration-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Apiservice-Registration-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-registration-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-status-available-controller", + "operation": "Gets/List apiservice-status-available-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Apiservice-Status-Available-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-status-available-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-controller", + "operation": "Gets/List bootstrap-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Bootstrap-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/bootstrap-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ca-registration", + "operation": "Gets/List ca-registration resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Ca-Registration" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/ca-registration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads crd-informer-synced", + "operation": "Gets/List crd-informer-synced resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Crd-Informer-Synced" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/crd-informer-synced/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads generic-apiserver-start-informers", + "operation": "Gets/List generic-apiserver-start-informers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Generic-Apiserver-Start-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/generic-apiserver-start-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads kube-apiserver-autoregistration", + "operation": "Gets/List kube-apiserver-autoregistration resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Kube-Apiserver-Autoregistration" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/kube-apiserver-autoregistration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-roles", + "operation": "Gets/List bootstrap-roles resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Bootstrap-Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/rbac/bootstrap-roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-system-priority-classes", + "operation": "Gets/List bootstrap-system-priority-classes resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Bootstrap-System-Priority-Classes" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/scheduling/bootstrap-system-priority-classes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-controllers", + "operation": "Gets/List start-apiextensions-controllers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Apiextensions-Controllers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-apiextensions-controllers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-informers", + "operation": "Gets/List start-apiextensions-informers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Apiextensions-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-apiextensions-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-aggregator-informers", + "operation": "Gets/List start-kube-aggregator-informers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Kube-Aggregator-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-kube-aggregator-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-apiserver-admission-initializer", + "operation": "Gets/List start-kube-apiserver-admission-initializer resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Kube-Apiserver-Admission-Initializer" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-kube-apiserver-admission-initializer/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads logs", + "operation": "Gets/List logs resource", + "provider": "Microsoft Container Service", + "resource": "Logs" + }, + "name": "Microsoft.ContainerService/managedClusters/logs/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads metrics", + "operation": "Gets/List metrics resource", + "provider": "Microsoft Container Service", + "resource": "Metrics" + }, + "name": "Microsoft.ContainerService/managedClusters/metrics/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads v2", + "operation": "Gets/List v2 resource", + "provider": "Microsoft Container Service", + "resource": "Openapi/V2" + }, + "name": "Microsoft.ContainerService/managedClusters/openapi/v2/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads readyz", + "operation": "Gets/List readyz resource", + "provider": "Microsoft Container Service", + "resource": "Readyz" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoregister-completion", + "operation": "Gets/List autoregister-completion resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Autoregister-Completion" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/autoregister-completion/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads etcd", + "operation": "Gets/List etcd resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Etcd" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/etcd/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads log", + "operation": "Gets/List log resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Log" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/log/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ping", + "operation": "Gets/List ping resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Ping" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/ping/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-openapi-controller", + "operation": "Gets/List apiservice-openapi-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Apiservice-Openapi-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-openapi-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-registration-controller", + "operation": "Gets/List apiservice-registration-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Apiservice-Registration-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-registration-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-status-available-controller", + "operation": "Gets/List apiservice-status-available-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Apiservice-Status-Available-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-status-available-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-controller", + "operation": "Gets/List bootstrap-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Bootstrap-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/bootstrap-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ca-registration", + "operation": "Gets/List ca-registration resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Ca-Registration" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/ca-registration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads crd-informer-synced", + "operation": "Gets/List crd-informer-synced resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Crd-Informer-Synced" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/crd-informer-synced/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads generic-apiserver-start-informers", + "operation": "Gets/List generic-apiserver-start-informers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Generic-Apiserver-Start-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/generic-apiserver-start-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads kube-apiserver-autoregistration", + "operation": "Gets/List kube-apiserver-autoregistration resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Kube-Apiserver-Autoregistration" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/kube-apiserver-autoregistration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-roles", + "operation": "Gets/List bootstrap-roles resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Bootstrap-Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/rbac/bootstrap-roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-system-priority-classes", + "operation": "Gets/List bootstrap-system-priority-classes resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Bootstrap-System-Priority-Classes" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/scheduling/bootstrap-system-priority-classes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-controllers", + "operation": "Gets/List start-apiextensions-controllers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Apiextensions-Controllers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-apiextensions-controllers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-informers", + "operation": "Gets/List start-apiextensions-informers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Apiextensions-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-apiextensions-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-aggregator-informers", + "operation": "Gets/List start-kube-aggregator-informers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Kube-Aggregator-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-kube-aggregator-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-apiserver-admission-initializer", + "operation": "Gets/List start-kube-apiserver-admission-initializer resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Kube-Apiserver-Admission-Initializer" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-kube-apiserver-admission-initializer/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads shutdown", + "operation": "Gets/List shutdown resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Shutdown" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/shutdown/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads resetMetrics", + "operation": "Gets/List resetMetrics resource", + "provider": "Microsoft Container Service", + "resource": "Resetmetrics" + }, + "name": "Microsoft.ContainerService/managedClusters/resetMetrics/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads swagger-ui", + "operation": "Gets/List swagger-ui resource", + "provider": "Microsoft Container Service", + "resource": "Swagger-Ui" + }, + "name": "Microsoft.ContainerService/managedClusters/swagger-ui/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads swagger-api", + "operation": "Gets/List swagger-api resource", + "provider": "Microsoft Container Service", + "resource": "Swagger-Api" + }, + "name": "Microsoft.ContainerService/managedClusters/swagger-api/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ui", + "operation": "Gets/List ui resource", + "provider": "Microsoft Container Service", + "resource": "Ui" + }, + "name": "Microsoft.ContainerService/managedClusters/ui/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads version", + "operation": "Gets/List version resource", + "provider": "Microsoft Container Service", + "resource": "Version" + }, + "name": "Microsoft.ContainerService/managedClusters/version/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads poddisruptionbudgets", + "operation": "Gets/List poddisruptionbudgets resource", + "provider": "Microsoft Container Service", + "resource": "Poddisruptionbudgets" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes poddisruptionbudgets", + "operation": "Creates/Updates poddisruptionbudgets resource", + "provider": "Microsoft Container Service", + "resource": "Poddisruptionbudgets" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes poddisruptionbudgets", + "operation": "Deletes/DeletesCollection poddisruptionbudgets resource", + "provider": "Microsoft Container Service", + "resource": "Poddisruptionbudgets" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads podsecuritypolicies", + "operation": "Gets/List podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes podsecuritypolicies", + "operation": "Creates/Updates podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes podsecuritypolicies", + "operation": "Deletes/DeletesCollection podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads clusterrolebindings", + "operation": "Gets/List clusterrolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Clusterrolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes clusterrolebindings", + "operation": "Creates/Updates clusterrolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Clusterrolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes clusterrolebindings", + "operation": "Deletes/DeletesCollection clusterrolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Clusterrolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads clusterroles", + "operation": "Gets/List clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes clusterroles", + "operation": "Creates/Updates clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes clusterroles", + "operation": "Deletes/DeletesCollection clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rolebindings", + "operation": "Gets/List rolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Rolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes rolebindings", + "operation": "Creates/Updates rolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Rolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes rolebindings", + "operation": "Deletes/DeletesCollection rolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Rolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads roles", + "operation": "Gets/List roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes roles", + "operation": "Creates/Updates roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes roles", + "operation": "Deletes/DeletesCollection roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads priorityclasses", + "operation": "Gets/List priorityclasses resource", + "provider": "Microsoft Container Service", + "resource": "Priorityclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes priorityclasses", + "operation": "Creates/Updates priorityclasses resource", + "provider": "Microsoft Container Service", + "resource": "Priorityclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes priorityclasses", + "operation": "Deletes/DeletesCollection priorityclasses resource", + "provider": "Microsoft Container Service", + "resource": "Priorityclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Use action on podsecuritypolicies", + "operation": "Use podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/use/action", + "origin": "user,system" + }, + { + "display": { + "description": "Binds clusterroles", + "operation": "Bind clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/bind/action", + "origin": "user,system" + }, + { + "display": { + "description": "Escalates", + "operation": "Escalate clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/escalate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Binds roles", + "operation": "Bind roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/bind/action", + "origin": "user,system" + }, + { + "display": { + "description": "Escalates roles", + "operation": "Escalate roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/escalate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate serviceaccounts", + "operation": "Impersonate serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate users", + "operation": "Impersonate users resource", + "provider": "Microsoft Container Service", + "resource": "Users" + }, + "name": "Microsoft.ContainerService/managedClusters/users/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate groups", + "operation": "Impersonate groups resource", + "provider": "Microsoft Container Service", + "resource": "Groups" + }, + "name": "Microsoft.ContainerService/managedClusters/groups/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate userextras", + "operation": "Impersonate userextras resource", + "provider": "Microsoft Container Service", + "resource": "Userextras" + }, + "name": "Microsoft.ContainerService/managedClusters/authentication.k8s.io/userextras/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storageclasses", + "operation": "Gets/List storageclasses resource", + "provider": "Microsoft Container Service", + "resource": "Storageclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes storageclasses", + "operation": "Creates/Updates storageclasses resource", + "provider": "Microsoft Container Service", + "resource": "Storageclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes storageclasses", + "operation": "Deletes/DeletesCollection storageclasses resource", + "provider": "Microsoft Container Service", + "resource": "Storageclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads volumeattachments", + "operation": "Gets/List volumeattachments resource", + "provider": "Microsoft Container Service", + "resource": "Volumeattachments" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes volumeattachments", + "operation": "Creates/Updates volumeattachments resource", + "provider": "Microsoft Container Service", + "resource": "Volumeattachments" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes volumeattachments", + "operation": "Deletes/DeletesCollection volumeattachments resource", + "provider": "Microsoft Container Service", + "resource": "Volumeattachments" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads csidrivers", + "operation": "Gets/List csidrivers resource", + "provider": "Microsoft Container Service", + "resource": "Csidrivers" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes csidrivers", + "operation": "Creates/Updates csidrivers resource", + "provider": "Microsoft Container Service", + "resource": "Csidrivers" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes csidrivers", + "operation": "Deletes/DeletesCollection csidrivers resource", + "provider": "Microsoft Container Service", + "resource": "Csidrivers" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads csinodes", + "operation": "Gets/List csinodes resource", + "provider": "Microsoft Container Service", + "resource": "Csinodes" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes csinodes", + "operation": "Creates/Updates csinodes resource", + "provider": "Microsoft Container Service", + "resource": "Csinodes" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes csinodes", + "operation": "Deletes/DeletesCollection csinodes resource", + "provider": "Microsoft Container Service", + "resource": "Csinodes" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the available metrics for Managed Cluster", + "operation": "Read Managed Cluster metric definitions", + "provider": "Microsoft Container Service", + "resource": "The metric definition of Managed Cluster" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/metricDefinitions/read", + "origin": "system" + }, + { + "display": { + "description": "Gets the available logs for Managed Cluster", + "operation": "Read Managed Cluster log definitions", + "provider": "Microsoft Container Service", + "resource": "The log definition of Managed Cluster" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/logDefinitions/read", + "origin": "system" + }, + { + "display": { + "description": "Get a Open Shift Managed Cluster", + "operation": "Get Open Shift Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Managed Cluster" + }, + "name": "Microsoft.ContainerService/openShiftManagedClusters/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new Open Shift Managed Cluster or updates an existing one", + "operation": "Create or Update Open Shift Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Managed Cluster" + }, + "name": "Microsoft.ContainerService/openShiftManagedClusters/write", + "origin": "user,system" + }, + { + "display": { + "description": "Delete a Open Shift Managed Cluster", + "operation": "Delete Open Shift Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Managed Cluster" + }, + "name": "Microsoft.ContainerService/openShiftManagedClusters/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Get a Open Shift Cluster", + "operation": "Get Open Shift Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Cluster" + }, + "name": "Microsoft.ContainerService/openShiftClusters/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new Open Shift Cluster or updates an existing one", + "operation": "Create or Update Open Shift Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Cluster" + }, + "name": "Microsoft.ContainerService/openShiftClusters/write", + "origin": "user,system" + }, + { + "display": { + "description": "Delete a Open Shift Cluster", + "operation": "Delete Open Shift Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Cluster" + }, + "name": "Microsoft.ContainerService/openShiftClusters/delete", + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/OutboundNetworkDependenciesEndpointsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/OutboundNetworkDependenciesEndpointsList.json new file mode 100644 index 000000000000..450c9b895bd8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/OutboundNetworkDependenciesEndpointsList.json @@ -0,0 +1,242 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "management.azure.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "login.microsoftonline.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "images", + "endpoints": [ + { + "domainName": "mcr.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "*.data.mcr.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https", + "description": "mcr cdn" + } + ] + } + ] + }, + { + "category": "artifacts", + "endpoints": [ + { + "domainName": "packages.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "acs-mirror.azureedge.net", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "time-sync", + "endpoints": [ + { + "domainName": "ntp.ubuntu.com", + "endpointDetails": [ + { + "port": 123, + "protocol": "UDP" + } + ] + } + ] + }, + { + "category": "ubuntu-optional", + "endpoints": [ + { + "domainName": "security.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "azure.archive.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "changelogs.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + } + ] + }, + { + "category": "gpu", + "endpoints": [ + { + "domainName": "nvidia.github.io", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "us.download.nvidia.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "apt.dockerproject.org", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "windows", + "endpoints": [ + { + "domainName": "onegetcdn.azureedge.net", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "go.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "*.mp.microsoft.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "www.msftconnecttest.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "ctldl.windowsupdate.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + } + ] + }, + { + "category": "apiserver", + "endpoints": [ + { + "domainName": "*.azmk8s.io", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "tunnel-classic", + "endpoints": [ + { + "domainName": "*.azmk8s.io", + "endpointDetails": [ + { + "port": 9000, + "protocol": "TCP" + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateEndpointConnectionsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateEndpointConnectionsDelete.json new file mode 100644 index 000000000000..d07c1a5f48b7 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateEndpointConnectionsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateEndpointConnectionsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateEndpointConnectionsGet.json new file mode 100644 index 000000000000..fda0a3ea9f55 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateEndpointConnectionsGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateEndpointConnectionsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateEndpointConnectionsList.json new file mode 100644 index 000000000000..fd101e0c65ef --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateEndpointConnectionsList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateEndpointConnectionsUpdate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateEndpointConnectionsUpdate.json new file mode 100644 index 000000000000..db74932b9817 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateEndpointConnectionsUpdate.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateLinkResourcesList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateLinkResourcesList.json new file mode 100644 index 000000000000..30fe25014187 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/PrivateLinkResourcesList.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "management", + "type": "Microsoft.ContainerService/managedClusters/privateLinkResources", + "groupId": "management", + "requiredMembers": [ + "management" + ], + "privateLinkServiceID": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/plsName" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ResolvePrivateLinkServiceId.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ResolvePrivateLinkServiceId.json new file mode 100644 index 000000000000..48bbee588d78 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/ResolvePrivateLinkServiceId.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "name": "management" + } + }, + "responses": { + "200": { + "body": { + "privateLinkServiceID": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/plsName" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/RunCommandRequest.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/RunCommandRequest.json new file mode 100644 index 000000000000..8dc8a5cc9c72 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/RunCommandRequest.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "requestPayload": { + "command": "kubectl apply -f ns.yaml", + "context": "", + "clusterToken": "" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2024-05-01" + } + }, + "200": { + "description": "to mitigate RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE", + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "succeeded", + "exitCode": 0, + "startedAt": "2021-02-17T00:28:20Z", + "finishedAt": "2021-02-17T00:28:33Z", + "logs": "namespace dummy created" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/RunCommandResultFailed.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/RunCommandResultFailed.json new file mode 100644 index 000000000000..1da30c39fe25 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/RunCommandResultFailed.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "commandId": "def7b3ea71bd4f7e9d226ddbc0f00ad9" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2024-05-01" + } + }, + "200": { + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "failed", + "reason": "ImagePullBackoff" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/RunCommandResultSucceed.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/RunCommandResultSucceed.json new file mode 100644 index 000000000000..60260ab5b794 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/RunCommandResultSucceed.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "commandId": "def7b3ea71bd4f7e9d226ddbc0f00ad9" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2024-05-01" + } + }, + "200": { + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "succeeded", + "exitCode": 0, + "startedAt": "2021-02-17T00:28:20Z", + "finishedAt": "2021-02-17T00:28:33Z", + "logs": "namespace dummy created" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsCreate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsCreate.json new file mode 100644 index 000000000000..0e4131560ea9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsCreate.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1", + "parameters": { + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + }, + "201": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsDelete.json new file mode 100644 index 000000000000..e4c48ede811f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsGet.json new file mode 100644 index 000000000000..a79152e6a0d7 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsGet.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1" + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsList.json new file mode 100644 index 000000000000..16df653f1e68 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsListByResourceGroup.json new file mode 100644 index 000000000000..ae4f982c0c8b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsListByResourceGroup.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsUpdateTags.json new file mode 100644 index 000000000000..ee0886b11ce9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/SnapshotsUpdateTags.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1", + "parameters": { + "tags": { + "key2": "new-val2", + "key3": "val3" + } + } + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoleBindings_CreateOrUpdate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoleBindings_CreateOrUpdate.json new file mode 100644 index 000000000000..220bd4c574fb --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoleBindings_CreateOrUpdate.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "trustedAccessRoleBindingName": "binding1", + "trustedAccessRoleBinding": { + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoleBindings_Delete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoleBindings_Delete.json new file mode 100644 index 000000000000..b38a7391b657 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoleBindings_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "trustedAccessRoleBindingName": "binding1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoleBindings_Get.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoleBindings_Get.json new file mode 100644 index 000000000000..1f42bc9440b6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoleBindings_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "trustedAccessRoleBindingName": "binding1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoleBindings_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoleBindings_List.json new file mode 100644 index 000000000000..f06156f21379 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoleBindings_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoles_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoles_List.json new file mode 100644 index 000000000000..e3668e2f5d1c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/examples/TrustedAccessRoles_List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "westus2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sourceResourceType": "Microsoft.MachineLearningServices/workspaces", + "name": "reader", + "rules": [ + { + "verbs": [ + "get" + ], + "apiGroups": [ + "" + ], + "resources": [ + "pods" + ], + "resourceNames": [], + "nonResourceURLs": [] + } + ] + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/managedClusters.json new file mode 100644 index 000000000000..5faa5bdb79a5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-05-01/managedClusters.json @@ -0,0 +1,7536 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerServiceClient", + "description": "The Container Service Client.", + "version": "2024-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.ContainerService/operations": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "Operations_List", + "summary": "Gets a list of operations.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List available operations for the container service resource provider": { + "$ref": "./examples/Operation_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/kubernetesVersions": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListKubernetesVersions", + "summary": "Gets a list of supported Kubernetes versions in the specified subscription.", + "description": "Contains extra metadata on the version, including supported patch versions, capabilities, available upgrades, and details on preview status of the version", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/KubernetesVersionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Kubernetes Versions": { + "$ref": "./examples/KubernetesVersions_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_List", + "summary": "Gets a list of managed clusters in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Managed Clusters": { + "$ref": "./examples/ManagedClustersList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListByResourceGroup", + "summary": "Lists managed clusters in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Managed Clusters by Resource Group": { + "$ref": "./examples/ManagedClustersListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/upgradeProfiles/default": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetUpgradeProfile", + "summary": "Gets the upgrade profile of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Managed Cluster": { + "$ref": "./examples/ManagedClustersGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/accessProfiles/{roleName}/listCredential": { + "post": { + "deprecated": true, + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetAccessProfile", + "summary": "Gets an access profile of a managed cluster.", + "description": "**WARNING**: This API will be deprecated. Instead use [ListClusterUserCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusterusercredentials) or [ListClusterAdminCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusteradmincredentials) .", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "roleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role for managed cluster accessProfile resource." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterAccessProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGetAccessProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterAdminCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterAdminCredentials", + "summary": "Lists the admin credentials of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterAdminCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterUserCredentials", + "summary": "Lists the user credentials of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + }, + { + "$ref": "#/parameters/CredentialFormatParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterUserCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterMonitoringUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterMonitoringUserCredentials", + "summary": "Lists the cluster monitoring user credentials of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterMonitoringUserCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Get", + "summary": "Gets a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_CreateOrUpdate", + "summary": "Creates or updates a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "The managed cluster to create or update." + } + ], + "responses": { + "200": { + "description": "The existing managed cluster was successfully updated.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "201": { + "description": "The new managed cluster was successfully created.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Managed Cluster": { + "$ref": "./examples/ManagedClustersCreate_Update.json" + }, + "Create/Update AAD Managed Cluster with EnableAzureRBAC": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json" + }, + "Create Managed Cluster with PPG": { + "$ref": "./examples/ManagedClustersCreate_PPG.json" + }, + "Create Managed Cluster with OSSKU": { + "$ref": "./examples/ManagedClustersCreate_OSSKU.json" + }, + "Create Managed Cluster with GPUMIG": { + "$ref": "./examples/ManagedClustersCreate_GPUMIG.json" + }, + "Create/Update Managed Cluster with EnableAHUB": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithAHUB.json" + }, + "Create Managed Cluster with EncryptionAtHost enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableEncryptionAtHost.json" + }, + "Create Managed Cluster with UltraSSD enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableUltraSSD.json" + }, + "Create Managed Cluster with PodIdentity enabled": { + "$ref": "./examples/ManagedClustersCreate_PodIdentity.json" + }, + "Create Managed Private Cluster with fqdn subdomain specified": { + "$ref": "./examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json" + }, + "Create Managed Private Cluster with Public FQDN specified": { + "$ref": "./examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json" + }, + "Create Managed Cluster with RunCommand disabled": { + "$ref": "./examples/ManagedClustersCreate_DisableRunCommand.json" + }, + "Create Managed Cluster with LongTermSupport": { + "$ref": "./examples/ManagedClustersCreate_Premium.json" + }, + "Create Managed Cluster with Node Public IP Prefix": { + "$ref": "./examples/ManagedClustersCreate_NodePublicIPPrefix.json" + }, + "Create Managed Cluster with Azure KeyVault Secrets Provider Addon": { + "$ref": "./examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json" + }, + "Create Managed Cluster with FIPS enabled OS": { + "$ref": "./examples/ManagedClustersCreate_EnabledFIPS.json" + }, + "Create Managed Cluster with HTTP proxy configured": { + "$ref": "./examples/ManagedClustersCreate_HTTPProxy.json" + }, + "Create Managed Cluster with Security Profile configured": { + "$ref": "./examples/ManagedClustersCreate_SecurityProfile.json" + }, + "Create Managed Cluster with Web App Routing Ingress Profile configured": { + "$ref": "./examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json" + }, + "Create Managed Cluster with AKS-managed NAT gateway as outbound type": { + "$ref": "./examples/ManagedClustersCreate_ManagedNATGateway.json" + }, + "Create Managed Cluster with user-assigned NAT gateway as outbound type": { + "$ref": "./examples/ManagedClustersCreate_UserAssignedNATGateway.json" + }, + "Create Managed Cluster using an agent pool snapshot": { + "$ref": "./examples/ManagedClustersCreate_Snapshot.json" + }, + "Create/Update Managed Cluster with Windows gMSA enabled": { + "$ref": "./examples/ManagedClustersCreate_UpdateWindowsGmsa.json" + }, + "Create/Update Managed Cluster with dual-stack networking": { + "$ref": "./examples/ManagedClustersCreate_DualStackNetworking.json" + }, + "Create Managed Cluster with Capacity Reservation Group": { + "$ref": "./examples/ManagedClustersCreate_CRG.json" + }, + "Create Managed Cluster with Dedicated Host Group": { + "$ref": "./examples/ManagedClustersCreate_DedicatedHostGroup.json" + }, + "Create/Update Managed Cluster with Azure Service Mesh": { + "$ref": "./examples/ManagedClustersCreate_AzureServiceMesh.json" + } + } + }, + "patch": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_UpdateTags", + "summary": "Updates tags on a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update Managed Cluster Tags operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update Managed Cluster Tags": { + "$ref": "./examples/ManagedClustersUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Delete", + "summary": "Deletes a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Managed Cluster": { + "$ref": "./examples/ManagedClustersDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations": { + "get": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_ListByManagedCluster", + "summary": "Gets a list of maintenance configurations in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List maintenance configurations by Managed Cluster": { + "$ref": "./examples/MaintenanceConfigurationsList.json" + }, + "List maintenance configurations configured with maintenance window by Managed Cluster": { + "$ref": "./examples/MaintenanceConfigurationsList_MaintenanceWindow.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations/{configName}": { + "get": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_Get", + "summary": "Gets the specified maintenance configuration of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsGet.json" + }, + "Get Maintenance Configuration Configured With Maintenance Window": { + "$ref": "./examples/MaintenanceConfigurationsGet_MaintenanceWindow.json" + } + } + }, + "put": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_CreateOrUpdate", + "summary": "Creates or updates a maintenance configuration in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + }, + "description": "The maintenance configuration to create or update." + } + ], + "responses": { + "200": { + "description": "The existing maintenance configuration was successfully updated.", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "201": { + "description": "The new maintenance configuration was successfully created.", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Create/Update Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsCreate_Update.json" + }, + "Create/Update Maintenance Configuration with Maintenance Window": { + "$ref": "./examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json" + } + } + }, + "delete": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_Delete", + "summary": "Deletes a maintenance configuration.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Delete Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsDelete.json" + }, + "Delete Maintenance Configuration For Node OS Upgrade": { + "$ref": "./examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclusters/{resourceName}/agentPools/{agentPoolName}/abort": { + "post": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_AbortLatestOperation", + "summary": "Aborts last operation running on agent pool.", + "description": "Aborts the currently running operation on the agent pool. The Agent Pool will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, a 409 error code is returned.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "202": { + "description": "Accepted", + "headers": { + "location": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Abort operation on agent pool": { + "$ref": "./examples/AgentPoolsAbortOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_List", + "summary": "Gets a list of agent pools in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Agent Pools by Managed Cluster": { + "$ref": "./examples/AgentPoolsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_Get", + "summary": "Gets the specified managed cluster agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Agent Pool": { + "$ref": "./examples/AgentPoolsGet.json" + } + } + }, + "put": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_CreateOrUpdate", + "summary": "Creates or updates an agent pool in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AgentPool" + }, + "description": "The agent pool to create or update." + } + ], + "responses": { + "200": { + "description": "The existing agent pool was successfully updated.", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "201": { + "description": "The new agent pool was successfully created.", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Agent Pool": { + "$ref": "./examples/AgentPoolsCreate_Update.json" + }, + "Update Agent Pool": { + "$ref": "./examples/AgentPools_Update.json" + }, + "Create Spot Agent Pool": { + "$ref": "./examples/AgentPoolsCreate_Spot.json" + }, + "Create Agent Pool with PPG": { + "$ref": "./examples/AgentPoolsCreate_PPG.json" + }, + "Create Agent Pool with OSSKU": { + "$ref": "./examples/AgentPoolsCreate_OSSKU.json" + }, + "Create Agent Pool with Windows OSSKU": { + "$ref": "./examples/AgentPoolsCreate_WindowsOSSKU.json" + }, + "Create Windows Agent Pool with disabling OutboundNAT": { + "$ref": "./examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json" + }, + "Create Agent Pool with GPUMIG": { + "$ref": "./examples/AgentPoolsCreate_GPUMIG.json" + }, + "Create Agent Pool with Ephemeral OS Disk": { + "$ref": "./examples/AgentPoolsCreate_Ephemeral.json" + }, + "Create Agent Pool with KubeletConfig and LinuxOSConfig": { + "$ref": "./examples/AgentPoolsCreate_CustomNodeConfig.json" + }, + "Create Agent Pool with EncryptionAtHost enabled": { + "$ref": "./examples/AgentPoolsCreate_EnableEncryptionAtHost.json" + }, + "Create Agent Pool with UltraSSD enabled": { + "$ref": "./examples/AgentPoolsCreate_EnableUltraSSD.json" + }, + "Create Agent Pool with FIPS enabled OS": { + "$ref": "./examples/AgentPoolsCreate_EnableFIPS.json" + }, + "Create Agent Pool using an agent pool snapshot": { + "$ref": "./examples/AgentPoolsCreate_Snapshot.json" + }, + "Create Agent Pool with Krustlet and the WASI runtime": { + "$ref": "./examples/AgentPoolsCreate_WasmWasi.json" + }, + "Stop Agent Pool": { + "$ref": "./examples/AgentPools_Stop.json" + }, + "Start Agent Pool": { + "$ref": "./examples/AgentPools_Start.json" + }, + "Create Agent Pool with Capacity Reservation Group": { + "$ref": "./examples/AgentPoolsCreate_CRG.json" + }, + "Create Agent Pool with Dedicated Host Group": { + "$ref": "./examples/AgentPoolsCreate_DedicatedHostGroup.json" + } + } + }, + "delete": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_Delete", + "summary": "Deletes an agent pool in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Agent Pool": { + "$ref": "./examples/AgentPoolsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeProfiles/default": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_GetUpgradeProfile", + "summary": "Gets the upgrade profile for an agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Agent Pool": { + "$ref": "./examples/AgentPoolsGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/availableAgentPoolVersions": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_GetAvailableAgentPoolVersions", + "summary": "Gets a list of supported Kubernetes versions for the specified agent pool.", + "description": "See [supported Kubernetes versions](https://docs.microsoft.com/azure/aks/supported-kubernetes-versions) for more details about the version lifecycle.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolAvailableVersions" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get available versions for agent pool": { + "$ref": "./examples/AgentPoolsGetAgentPoolAvailableVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetServicePrincipalProfile": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetServicePrincipalProfile", + "summary": "Reset the Service Principal Profile of a managed cluster.", + "description": "This action cannot be performed on a cluster that is not using a service principal", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile" + }, + "description": "The service principal profile to set on the managed cluster." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Reset Service Principal Profile": { + "$ref": "./examples/ManagedClustersResetServicePrincipalProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetAADProfile": { + "post": { + "deprecated": true, + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetAADProfile", + "summary": "Reset the AAD Profile of a managed cluster.", + "description": "**WARNING**: This API will be deprecated. Please see [AKS-managed Azure Active Directory integration](https://aka.ms/aks-managed-aad) to update your cluster with AKS-managed Azure AD.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterAADProfile" + }, + "description": "The AAD profile to set on the Managed Cluster" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Reset AAD Profile": { + "$ref": "./examples/ManagedClustersResetAADProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateClusterCertificates": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RotateClusterCertificates", + "summary": "Rotates the certificates of a managed cluster.", + "description": "See [Certificate rotation](https://docs.microsoft.com/azure/aks/certificate-rotation) for more details about rotating managed cluster certificates.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Rotate Cluster Certificates": { + "$ref": "./examples/ManagedClustersRotateClusterCertificates.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclusters/{resourceName}/abort": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_AbortLatestOperation", + "summary": "Aborts last operation running on managed cluster.", + "description": "Aborts the currently running operation on the managed cluster. The Managed Cluster will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, a 409 error code is returned.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "202": { + "description": "Accepted", + "headers": { + "location": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Abort operation on managed cluster": { + "$ref": "./examples/ManagedClustersAbortOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateServiceAccountSigningKeys": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RotateServiceAccountSigningKeys", + "summary": "Rotates the service account signing keys of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Rotate Cluster Service Account Signing Keys": { + "$ref": "./examples/ManagedClustersRotateServiceAccountSigningKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/stop": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Stop", + "summary": "Stops a Managed Cluster", + "description": "This can only be performed on Azure Virtual Machine Scale set backed clusters. Stopping a cluster stops the control plane and agent nodes entirely, while maintaining all object and cluster state. A cluster does not accrue charges while it is stopped. See [stopping a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about stopping a cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Stop Managed Cluster": { + "$ref": "./examples/ManagedClustersStop.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/start": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Start", + "summary": "Starts a previously stopped Managed Cluster", + "description": "See [starting a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about starting a cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Start Managed Cluster": { + "$ref": "./examples/ManagedClustersStart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "summary": "Gets a list of private endpoint connections in the specified managed cluster.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Private Endpoint Connections by Managed Cluster": { + "$ref": "./examples/PrivateEndpointConnectionsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "summary": "Gets the specified private endpoint connection.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Update", + "summary": "Updates a private endpoint connection.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The updated private endpoint connection." + } + ], + "responses": { + "200": { + "description": "The existing private endpoint connection was successfully updated.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "The new private endpoint connection was successfully created.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "summary": "Deletes a private endpoint connection.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content -- The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeNodeImageVersion": { + "post": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_UpgradeNodeImageVersion", + "summary": "Upgrades the node image version of an agent pool to the latest.", + "description": "Upgrading the node image version of an agent pool applies the newest OS and runtime updates to the nodes. AKS provides one new image per week with the latest updates. For more details on node image versions, see: https://docs.microsoft.com/azure/aks/node-image-upgrade", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Upgrade Agent Pool Node Image Version": { + "$ref": "./examples/AgentPoolsUpgradeNodeImageVersion.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "privateLinkResources" + ], + "operationId": "PrivateLinkResources_List", + "summary": "Gets a list of private link resources in the specified managed cluster.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResourcesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Private Link Resources by Managed Cluster": { + "$ref": "./examples/PrivateLinkResourcesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resolvePrivateLinkServiceId": { + "post": { + "tags": [ + "resolvePrivateLinkServiceId" + ], + "operationId": "ResolvePrivateLinkServiceId_POST", + "summary": "Gets the private link service ID for the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "Parameters required in order to resolve a private link service ID." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Resolve the Private Link Service ID for Managed Cluster": { + "$ref": "./examples/ResolvePrivateLinkServiceId.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/runCommand": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RunCommand", + "summary": "Submits a command to run against the Managed Cluster.", + "description": "AKS will create a pod to run the command. This is primarily useful for private clusters. For more information see [AKS Run Command](https://docs.microsoft.com/azure/aks/private-clusters#aks-run-command-preview).", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "requestPayload", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunCommandRequest" + }, + "description": "The run command request" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "200": { + "description": "command finished with async pattern, tracking by location header. !!! this is for autorest only, you never get 200 from this api !!!", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "submitNewCommand": { + "$ref": "./examples/RunCommandRequest.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/commandResults/{commandId}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetCommandResult", + "summary": "Gets the results of a command which has been run on the Managed Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "commandId", + "in": "path", + "required": true, + "type": "string", + "description": "Id of the command." + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "200": { + "description": "command finished", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "commandSucceedResult": { + "$ref": "./examples/RunCommandResultSucceed.json" + }, + "commandFailedResult": { + "$ref": "./examples/RunCommandResultFailed.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/outboundNetworkDependenciesEndpoints": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListOutboundNetworkDependenciesEndpoints", + "summary": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster.", + "description": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster. The operation returns properties of each egress endpoint.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OutboundEnvironmentEndpointCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List OutboundNetworkDependenciesEndpoints by Managed Cluster": { + "$ref": "./examples/OutboundNetworkDependenciesEndpointsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_List", + "summary": "Gets a list of snapshots in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Snapshots": { + "$ref": "./examples/SnapshotsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_ListByResourceGroup", + "summary": "Lists snapshots in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Snapshots by Resource Group": { + "$ref": "./examples/SnapshotsListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots/{resourceName}": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Get", + "summary": "Gets a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Snapshot": { + "$ref": "./examples/SnapshotsGet.json" + } + } + }, + "put": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_CreateOrUpdate", + "summary": "Creates or updates a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Snapshot" + }, + "description": "The snapshot to create or update." + } + ], + "responses": { + "200": { + "description": "The existing snapshot was successfully updated.", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "201": { + "description": "The new snapshot was successfully created.", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create/Update Snapshot": { + "$ref": "./examples/SnapshotsCreate.json" + } + } + }, + "patch": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_UpdateTags", + "summary": "Updates tags on a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update snapshot Tags operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Snapshot Tags": { + "$ref": "./examples/SnapshotsUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Delete", + "summary": "Deletes a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Snapshot": { + "$ref": "./examples/SnapshotsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/meshRevisionProfiles": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListMeshRevisionProfiles", + "summary": "Lists mesh revision profiles for all meshes in the specified location.", + "description": "Contains extra metadata on each revision, including supported revisions, cluster compatibility and available upgrades", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshRevisionProfileList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List mesh revision profiles in a location": { + "$ref": "./examples/ManagedClustersList_MeshRevisionProfiles.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/meshRevisionProfiles/{mode}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetMeshRevisionProfile", + "summary": "Gets a mesh revision profile for a specified mesh in the specified location.", + "description": "Contains extra metadata on the revision, including supported revisions, cluster compatibility and available upgrades", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/MeshModeParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshRevisionProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a mesh revision profile for a mesh mode": { + "$ref": "./examples/ManagedClustersGet_MeshRevisionProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/meshUpgradeProfiles": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListMeshUpgradeProfiles", + "summary": "Lists available upgrades for all service meshes in a specific cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshUpgradeProfileList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Lists version compatibility and upgrade profile for all service meshes in a cluster": { + "$ref": "./examples/ManagedClustersList_MeshUpgradeProfiles.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/meshUpgradeProfiles/{mode}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetMeshUpgradeProfile", + "summary": "Gets available upgrades for a service mesh in a cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/MeshModeParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gets version compatibility and upgrade profile for a service mesh in a cluster": { + "$ref": "./examples/ManagedClustersGet_MeshUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/trustedAccessRoleBindings": { + "get": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_List", + "summary": "List trusted access role bindings.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBindingListResult" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List trusted access role bindings": { + "$ref": "./examples/TrustedAccessRoleBindings_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/trustedAccessRoleBindings/{trustedAccessRoleBindingName}": { + "get": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_Get", + "summary": "Get a trusted access role binding.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/TrustedAccessRoleBindingNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a trusted access role binding": { + "$ref": "./examples/TrustedAccessRoleBindings_Get.json" + } + } + }, + "put": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_CreateOrUpdate", + "summary": "Create or update a trusted access role binding", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/TrustedAccessRoleBindingNameParameter" + }, + { + "name": "trustedAccessRoleBinding", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + }, + "description": "A trusted access role binding" + } + ], + "responses": { + "200": { + "description": "The existing trusted access role binding was successfully updated.", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + } + }, + "201": { + "description": "The new trusted access role binding was successfully created.", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a trusted access role binding": { + "$ref": "./examples/TrustedAccessRoleBindings_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_Delete", + "summary": "Delete a trusted access role binding.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/TrustedAccessRoleBindingNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a trusted access role binding": { + "$ref": "./examples/TrustedAccessRoleBindings_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/trustedAccessRoles": { + "get": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoles_List", + "summary": "List supported trusted access roles.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleListResult" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List trusted access roles": { + "$ref": "./examples/TrustedAccessRoles_List.json" + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OperationValue" + }, + "x-ms-identifiers": [], + "description": "The list of operations" + } + }, + "description": "The List Operation response." + }, + "OperationValue": { + "type": "object", + "properties": { + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of the operation." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the operation." + }, + "display": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationValueDisplay", + "description": "Describes the properties of a Operation Value Display." + } + }, + "description": "Describes the properties of a Operation value." + }, + "OperationValueDisplay": { + "type": "object", + "properties": { + "operation": { + "type": "string", + "readOnly": true, + "description": "The display name of the operation." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "The display name of the resource the operation applies to." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "The description of the operation." + }, + "provider": { + "type": "string", + "readOnly": true, + "description": "The resource provider for the operation." + } + }, + "description": "Describes the properties of a Operation Value Display." + }, + "SubResource": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource ID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + } + }, + "description": "Reference to another subresource.", + "x-ms-azure-resource": true + }, + "TagsObject": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + }, + "ContainerServiceOSDisk": { + "type": "integer", + "format": "int32", + "maximum": 2048, + "minimum": 0, + "description": "OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." + }, + "ManagedClusterServicePrincipalProfile": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "The ID for the service principal." + }, + "secret": { + "type": "string", + "description": "The secret password associated with the service principal in plain text." + } + }, + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs.", + "required": [ + "clientId" + ] + }, + "ManagedClusterAgentPoolProfileProperties": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1." + }, + "vmSize": { + "type": "string", + "title": "The size of the agent pool VMs.", + "description": "VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions" + }, + "osDiskSizeGB": { + "$ref": "#/definitions/ContainerServiceOSDisk" + }, + "osDiskType": { + "$ref": "#/definitions/OSDiskType" + }, + "kubeletDiskType": { + "$ref": "#/definitions/KubeletDiskType" + }, + "workloadRuntime": { + "$ref": "#/definitions/WorkloadRuntime" + }, + "vnetSubnetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + }, + "title": "The ID of the subnet which agent pool nodes and optionally pods will join on startup.", + "description": "If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "podSubnetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + }, + "title": "The ID of the subnet which pods will join when launched.", + "description": "If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "maxPods": { + "type": "integer", + "format": "int32", + "description": "The maximum number of pods that can run on a node." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "osSKU": { + "$ref": "#/definitions/OSSKU" + }, + "maxCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of nodes for auto-scaling" + }, + "minCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of nodes for auto-scaling" + }, + "enableAutoScaling": { + "type": "boolean", + "description": "Whether to enable auto-scaler" + }, + "scaleDownMode": { + "$ref": "#/definitions/ScaleDownMode", + "title": "The scale down mode to use when scaling the Agent Pool.", + "description": "This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete." + }, + "type": { + "$ref": "#/definitions/AgentPoolType" + }, + "mode": { + "$ref": "#/definitions/AgentPoolMode" + }, + "orchestratorVersion": { + "type": "string", + "title": "The version of Kubernetes specified by the user.", + "description": "Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool)." + }, + "currentOrchestratorVersion": { + "readOnly": true, + "type": "string", + "title": "The version of Kubernetes the Agent Pool is running.", + "description": "If orchestratorVersion is a fully specified version , this field will be exactly equal to it. If orchestratorVersion is , this field will contain the full version being used." + }, + "nodeImageVersion": { + "readOnly": true, + "type": "string", + "description": "The version of node image" + }, + "upgradeSettings": { + "$ref": "#/definitions/AgentPoolUpgradeSettings", + "description": "Settings for upgrading the agentpool" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state." + }, + "powerState": { + "title": "Whether the Agent Pool is running or stopped.", + "description": "When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded", + "$ref": "#/definitions/PowerState" + }, + "availabilityZones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'." + }, + "enableNodePublicIP": { + "type": "boolean", + "title": "Whether each node is allocated its own public IP.", + "description": "Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false." + }, + "nodePublicIPPrefixID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/publicIPPrefixes" + } + ] + }, + "title": "The public IP prefix ID which VM nodes should use IPs from.", + "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "scaleSetPriority": { + "$ref": "#/definitions/ScaleSetPriority", + "description": "The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'." + }, + "scaleSetEvictionPolicy": { + "$ref": "#/definitions/ScaleSetEvictionPolicy", + "title": "The Virtual Machine Scale Set eviction policy to use.", + "description": "This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'." + }, + "spotMaxPrice": { + "$ref": "#/definitions/SpotMaxPrice", + "title": "The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.", + "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags to be persisted on the agent pool virtual machine scale set." + }, + "nodeLabels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The node labels to be persisted across all nodes in agent pool." + }, + "nodeTaints": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule." + }, + "proximityPlacementGroupID": { + "$ref": "#/definitions/ProximityPlacementGroupID", + "description": "The ID for Proximity Placement Group." + }, + "kubeletConfig": { + "$ref": "#/definitions/KubeletConfig", + "description": "The Kubelet configuration on the agent pool nodes." + }, + "linuxOSConfig": { + "$ref": "#/definitions/LinuxOSConfig", + "description": "The OS configuration of Linux agent nodes." + }, + "enableEncryptionAtHost": { + "type": "boolean", + "title": "Whether to enable host based OS and data drive encryption.", + "description": "This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption" + }, + "enableUltraSSD": { + "type": "boolean", + "description": "Whether to enable UltraSSD" + }, + "enableFIPS": { + "type": "boolean", + "title": "Whether to use a FIPS-enabled OS.", + "description": "See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details." + }, + "gpuInstanceProfile": { + "$ref": "#/definitions/GPUInstanceProfile", + "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU." + }, + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot." + }, + "capacityReservationGroupID": { + "$ref": "#/definitions/CapacityReservationGroupID", + "description": "AKS will associate the specified agent pool with the Capacity Reservation Group." + }, + "hostGroupID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/hostGroups" + } + ] + }, + "title": "The fully qualified resource ID of the Dedicated Host Group to provision virtual machines from, used only in creation scenario and not allowed to changed once set.", + "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts)." + }, + "networkProfile": { + "$ref": "#/definitions/AgentPoolNetworkProfile", + "description": "Network-related settings of an agent pool." + }, + "windowsProfile": { + "$ref": "#/definitions/AgentPoolWindowsProfile", + "description": "The Windows agent pool's specific profile." + } + }, + "description": "Properties for the container service agent pool profile." + }, + "AgentPoolNetworkProfile": { + "type": "object", + "properties": { + "nodePublicIPTags": { + "$ref": "#/definitions/NodePublicIPTags", + "description": "IPTags of instance-level public IPs." + }, + "allowedHostPorts": { + "type": "array", + "description": "The port ranges that are allowed to access. The specified ranges are allowed to overlap.", + "items": { + "$ref": "#/definitions/PortRange" + }, + "x-ms-identifiers": [] + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/applicationSecurityGroups" + } + ] + } + }, + "description": "The IDs of the application security groups which agent pool will associate when created." + } + }, + "description": "Network settings of an agent pool." + }, + "NodePublicIPTags": { + "type": "array", + "items": { + "$ref": "#/definitions/IPTag" + }, + "x-ms-identifiers": [], + "description": "The list of tags associated with the node public IP address." + }, + "IPTag": { + "type": "object", + "properties": { + "ipTagType": { + "type": "string", + "description": "The IP tag type. Example: RoutingPreference." + }, + "tag": { + "type": "string", + "description": "The value of the IP tag associated with the public IP. Example: Internet." + } + }, + "description": "Contains the IPTag associated with the object." + }, + "PortRange": { + "type": "object", + "description": "The port range.", + "properties": { + "portStart": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 65535, + "description": "The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd." + }, + "portEnd": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 65535, + "description": "The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart." + }, + "protocol": { + "type": "string", + "description": "The network protocol of the port.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "Protocol", + "modelAsString": true, + "values": [ + { + "value": "TCP", + "description": "TCP protocol." + }, + { + "value": "UDP", + "description": "UDP protocol." + } + ] + } + } + } + }, + "ManagedClusterAgentPoolProfile": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties" + } + ], + "properties": { + "name": { + "type": "string", + "title": "Unique name of the agent pool profile in the context of the subscription and resource group.", + "description": "Windows agent pool names must be 6 characters or less.", + "pattern": "^[a-z][a-z0-9]{0,11}$" + } + }, + "required": [ + "name" + ], + "description": "Profile for the container service agent pool." + }, + "AgentPoolType": { + "type": "string", + "enum": [ + "VirtualMachineScaleSets", + "AvailabilitySet" + ], + "x-ms-enum": { + "name": "AgentPoolType", + "modelAsString": true, + "values": [ + { + "value": "VirtualMachineScaleSets", + "description": "Create an Agent Pool backed by a Virtual Machine Scale Set." + }, + { + "value": "AvailabilitySet", + "description": "Use of this is strongly discouraged." + } + ] + }, + "description": "The type of Agent Pool." + }, + "AgentPoolMode": { + "type": "string", + "enum": [ + "System", + "User" + ], + "x-ms-enum": { + "name": "AgentPoolMode", + "modelAsString": true, + "values": [ + { + "value": "System", + "description": "System agent pools are primarily for hosting critical system pods such as CoreDNS and metrics-server. System agent pools osType must be Linux. System agent pools VM SKU must have at least 2vCPUs and 4GB of memory." + }, + { + "value": "User", + "description": "User agent pools are primarily for hosting your application pods." + } + ] + }, + "title": "The mode of an agent pool.", + "description": "A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools" + }, + "AgentPoolListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AgentPool" + }, + "description": "The list of agent pools." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of agent pool results.", + "readOnly": true + } + }, + "description": "The response from the List Agent Pools operation." + }, + "AgentPoolUpgradeSettings": { + "type": "object", + "properties": { + "maxSurge": { + "type": "string", + "title": "The maximum number or percentage of nodes that are surged during upgrade.", + "description": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade" + }, + "drainTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 1440, + "minimum": 1, + "title": "The drain timeout for a node", + "description": "The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes." + }, + "nodeSoakDurationInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 30, + "minimum": 0, + "title": "The soak duration for a node", + "description": "The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes." + } + }, + "description": "Settings for upgrading an agentpool" + }, + "AgentPool": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "description": "Properties of an agent pool.", + "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties", + "x-ms-client-flatten": true + } + }, + "description": "Agent Pool." + }, + "ManagedClusterWindowsProfile": { + "type": "object", + "properties": { + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

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

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

**Minimum-length:** 1 character

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

**Minimum-length:** 8 characters

**Max-length:** 123 characters

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

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

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

Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster." + } + }, + "description": "Windows gMSA Profile in the managed cluster." + }, + "ContainerServiceLinuxProfile": { + "type": "object", + "properties": { + "adminUsername": { + "type": "string", + "description": "The administrator username to use for Linux VMs.", + "pattern": "^[A-Za-z][-A-Za-z0-9_]*$" + }, + "ssh": { + "$ref": "#/definitions/ContainerServiceSshConfiguration", + "description": "The SSH configuration for Linux-based VMs running on Azure." + } + }, + "required": [ + "adminUsername", + "ssh" + ], + "description": "Profile for Linux VMs in the container service cluster." + }, + "ContainerServiceNetworkProfile": { + "type": "object", + "properties": { + "networkPlugin": { + "type": "string", + "enum": [ + "azure", + "kubenet", + "none" + ], + "default": "kubenet", + "x-ms-enum": { + "name": "NetworkPlugin", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Use the Azure CNI network plugin. See [Azure CNI (advanced) networking](https://docs.microsoft.com/azure/aks/concepts-network#azure-cni-advanced-networking) for more information." + }, + { + "value": "kubenet", + "description": "Use the Kubenet network plugin. See [Kubenet (basic) networking](https://docs.microsoft.com/azure/aks/concepts-network#kubenet-basic-networking) for more information." + }, + { + "value": "none", + "description": "No CNI plugin is pre-installed. See [BYO CNI](https://docs.microsoft.com/en-us/azure/aks/use-byo-cni) for more information." + } + ] + }, + "description": "Network plugin used for building the Kubernetes network." + }, + "networkPluginMode": { + "type": "string", + "enum": [ + "overlay" + ], + "x-ms-enum": { + "name": "NetworkPluginMode", + "modelAsString": true, + "values": [ + { + "value": "overlay", + "description": "Used with networkPlugin=azure, pods are given IPs from the PodCIDR address space but use Azure Routing Domains rather than Kubenet's method of route tables. For more information visit https://aka.ms/aks/azure-cni-overlay." + } + ] + }, + "description": "The mode the network plugin should use." + }, + "networkPolicy": { + "type": "string", + "enum": [ + "none", + "calico", + "azure", + "cilium" + ], + "x-ms-enum": { + "name": "NetworkPolicy", + "modelAsString": true, + "values": [ + { + "value": "none", + "description": "Network policies will not be enforced. This is the default value when NetworkPolicy is not specified." + }, + { + "value": "calico", + "description": "Use Calico network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information." + }, + { + "value": "azure", + "description": "Use Azure network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information." + }, + { + "value": "cilium", + "description": "Use Cilium to enforce network policies. This requires networkDataplane to be 'cilium'." + } + ] + }, + "description": "Network policy used for building the Kubernetes network." + }, + "networkMode": { + "type": "string", + "enum": [ + "transparent", + "bridge" + ], + "x-ms-enum": { + "name": "networkMode", + "modelAsString": true, + "values": [ + { + "value": "transparent", + "description": "No bridge is created. Intra-VM Pod to Pod communication is through IP routes created by Azure CNI. See [Transparent Mode](https://docs.microsoft.com/azure/aks/faq#transparent-mode) for more information." + }, + { + "value": "bridge", + "description": "This is no longer supported" + } + ] + }, + "title": "The network mode Azure CNI is configured with.", + "description": "This cannot be specified if networkPlugin is anything other than 'azure'." + }, + "networkDataplane": { + "type": "string", + "enum": [ + "azure", + "cilium" + ], + "x-ms-enum": { + "name": "networkDataplane", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Use Azure network dataplane." + }, + { + "value": "cilium", + "description": "Use Cilium network dataplane. See [Azure CNI Powered by Cilium](https://learn.microsoft.com/azure/aks/azure-cni-powered-by-cilium) for more information." + } + ] + }, + "description": "Network dataplane used in the Kubernetes cluster." + }, + "podCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.244.0.0/16", + "description": "A CIDR notation IP range from which to assign pod IPs when kubenet is used." + }, + "serviceCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.0.0.0/16", + "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges." + }, + "dnsServiceIP": { + "type": "string", + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "default": "10.0.0.10", + "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr." + }, + "outboundType": { + "type": "string", + "enum": [ + "loadBalancer", + "userDefinedRouting", + "managedNATGateway", + "userAssignedNATGateway" + ], + "x-ms-enum": { + "name": "outboundType", + "modelAsString": true, + "values": [ + { + "value": "loadBalancer", + "description": "The load balancer is used for egress through an AKS assigned public IP. This supports Kubernetes services of type 'loadBalancer'. For more information see [outbound type loadbalancer](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-loadbalancer)." + }, + { + "value": "userDefinedRouting", + "description": "Egress paths must be defined by the user. This is an advanced scenario and requires proper network configuration. For more information see [outbound type userDefinedRouting](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-userdefinedrouting)." + }, + { + "value": "managedNATGateway", + "description": "The AKS-managed NAT gateway is used for egress." + }, + { + "value": "userAssignedNATGateway", + "description": "The user-assigned NAT gateway associated to the cluster subnet is used for egress. This is an advanced scenario and requires proper network configuration." + } + ] + }, + "default": "loadBalancer", + "title": "The outbound (egress) routing method.", + "description": "This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype)." + }, + "loadBalancerSku": { + "type": "string", + "enum": [ + "standard", + "basic" + ], + "x-ms-enum": { + "name": "loadBalancerSku", + "modelAsString": true, + "values": [ + { + "value": "standard", + "description": "Use a a standard Load Balancer. This is the recommended Load Balancer SKU. For more information about on working with the load balancer in the managed cluster, see the [standard Load Balancer](https://docs.microsoft.com/azure/aks/load-balancer-standard) article." + }, + { + "value": "basic", + "description": "Use a basic Load Balancer with limited functionality." + } + ] + }, + "title": "The load balancer sku for the managed cluster.", + "description": "The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs." + }, + "loadBalancerProfile": { + "$ref": "#/definitions/ManagedClusterLoadBalancerProfile", + "description": "Profile of the cluster load balancer." + }, + "natGatewayProfile": { + "$ref": "#/definitions/ManagedClusterNATGatewayProfile", + "description": "Profile of the cluster NAT gateway." + }, + "podCidrs": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The CIDR notation IP ranges from which to assign pod IPs.", + "description": "One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking." + }, + "serviceCidrs": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The CIDR notation IP ranges from which to assign service cluster IPs.", + "description": "One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges." + }, + "ipFamilies": { + "type": "array", + "items": { + "type": "string", + "description": "The IP version to use for cluster networking and IP assignment.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "ipFamily", + "modelAsString": true + } + }, + "title": "The IP families used to specify IP versions available to the cluster.", + "description": "IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6." + } + }, + "description": "Profile of network configuration." + }, + "MaintenanceConfigurationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MaintenanceConfiguration" + }, + "description": "The list of maintenance configurations." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of maintenance configuration results.", + "readOnly": true + } + }, + "description": "The response from the List maintenance configurations operation." + }, + "MaintenanceConfiguration": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "readOnly": true, + "description": "The system metadata relating to this resource." + }, + "properties": { + "description": "Properties of a default maintenance configuration.", + "$ref": "#/definitions/MaintenanceConfigurationProperties", + "x-ms-client-flatten": true + } + }, + "title": "Planned maintenance configuration, used to configure when updates can be deployed to a Managed Cluster.", + "description": "See [planned maintenance](https://docs.microsoft.com/azure/aks/planned-maintenance) for more information about planned maintenance." + }, + "MaintenanceConfigurationProperties": { + "type": "object", + "properties": { + "timeInWeek": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeInWeek" + }, + "x-ms-identifiers": [], + "title": "Time slots during the week when planned maintenance is allowed to proceed.", + "description": "If two array entries specify the same day of the week, the applied configuration is the union of times in both entries." + }, + "notAllowedTime": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeSpan" + }, + "x-ms-identifiers": [], + "description": "Time slots on which upgrade is not allowed." + }, + "maintenanceWindow": { + "type": "object", + "$ref": "#/definitions/MaintenanceWindow", + "description": "Maintenance window for the maintenance configuration." + } + }, + "description": "Properties used to configure planned maintenance for a Managed Cluster." + }, + "MaintenanceWindow": { + "type": "object", + "properties": { + "schedule": { + "$ref": "#/definitions/Schedule", + "description": "Recurrence schedule for the maintenance window." + }, + "durationHours": { + "type": "integer", + "format": "int32", + "minimum": 4, + "maximum": 24, + "default": 24, + "description": "Length of maintenance window range from 4 to 24 hours." + }, + "utcOffset": { + "type": "string", + "pattern": "^(-|\\+)[0-9]{2}:[0-9]{2}$", + "description": "The UTC offset in format +/-HH:mm. For example, '+05:30' for IST and '-07:00' for PST. If not specified, the default is '+00:00'." + }, + "startDate": { + "type": "string", + "format": "date", + "description": "The date the maintenance window activates. If the current date is before this date, the maintenance window is inactive and will not be used for upgrades. If not specified, the maintenance window will be active right away." + }, + "startTime": { + "type": "string", + "pattern": "^\\d{2}:\\d{2}$", + "description": "The start time of the maintenance window. Accepted values are from '00:00' to '23:59'. 'utcOffset' applies to this field. For example: '02:00' with 'utcOffset: +02:00' means UTC time '00:00'." + }, + "notAllowedDates": { + "type": "array", + "items": { + "$ref": "#/definitions/DateSpan" + }, + "x-ms-identifiers": [], + "description": "Date ranges on which upgrade is not allowed. 'utcOffset' applies to this field. For example, with 'utcOffset: +02:00' and 'dateSpan' being '2022-12-23' to '2023-01-03', maintenance will be blocked from '2022-12-22 22:00' to '2023-01-03 22:00' in UTC time." + } + }, + "description": "Maintenance window used to configure scheduled auto-upgrade for a Managed Cluster.", + "required": [ + "schedule", + "durationHours", + "startTime" + ] + }, + "Schedule": { + "type": "object", + "properties": { + "daily": { + "$ref": "#/definitions/DailySchedule" + }, + "weekly": { + "$ref": "#/definitions/WeeklySchedule" + }, + "absoluteMonthly": { + "$ref": "#/definitions/AbsoluteMonthlySchedule" + }, + "relativeMonthly": { + "$ref": "#/definitions/RelativeMonthlySchedule" + } + }, + "description": "One and only one of the schedule types should be specified. Choose either 'daily', 'weekly', 'absoluteMonthly' or 'relativeMonthly' for your maintenance schedule." + }, + "DailySchedule": { + "type": "object", + "properties": { + "intervalDays": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 7, + "description": "Specifies the number of days between each set of occurrences." + } + }, + "description": "For schedules like: 'recur every day' or 'recur every 3 days'.", + "required": [ + "intervalDays" + ] + }, + "WeeklySchedule": { + "type": "object", + "properties": { + "intervalWeeks": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 4, + "description": "Specifies the number of weeks between each set of occurrences." + }, + "dayOfWeek": { + "$ref": "#/definitions/WeekDay", + "description": "Specifies on which day of the week the maintenance occurs." + } + }, + "description": "For schedules like: 'recur every Monday' or 'recur every 3 weeks on Wednesday'.", + "required": [ + "intervalWeeks", + "dayOfWeek" + ] + }, + "AbsoluteMonthlySchedule": { + "type": "object", + "properties": { + "intervalMonths": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 6, + "description": "Specifies the number of months between each set of occurrences." + }, + "dayOfMonth": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 31, + "description": "The date of the month." + } + }, + "description": "For schedules like: 'recur every month on the 15th' or 'recur every 3 months on the 20th'.", + "required": [ + "intervalMonths", + "dayOfMonth" + ] + }, + "RelativeMonthlySchedule": { + "type": "object", + "properties": { + "intervalMonths": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 6, + "description": "Specifies the number of months between each set of occurrences." + }, + "weekIndex": { + "type": "string", + "enum": [ + "First", + "Second", + "Third", + "Fourth", + "Last" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true, + "values": [ + { + "value": "First", + "description": "First week of the month." + }, + { + "value": "Second", + "description": "Second week of the month." + }, + { + "value": "Third", + "description": "Third week of the month." + }, + { + "value": "Fourth", + "description": "Fourth week of the month." + }, + { + "value": "Last", + "description": "Last week of the month." + } + ] + }, + "title": "The week index.", + "description": "Specifies on which week of the month the dayOfWeek applies." + }, + "dayOfWeek": { + "$ref": "#/definitions/WeekDay", + "description": "Specifies on which day of the week the maintenance occurs." + } + }, + "description": "For schedules like: 'recur every month on the first Monday' or 'recur every 3 months on last Friday'.", + "required": [ + "intervalMonths", + "weekIndex", + "dayOfWeek" + ] + }, + "DateSpan": { + "type": "object", + "properties": { + "start": { + "type": "string", + "format": "date", + "description": "The start date of the date span." + }, + "end": { + "type": "string", + "format": "date", + "description": "The end date of the date span." + } + }, + "title": "A date range.", + "description": "For example, between '2022-12-23' and '2023-01-05'.", + "required": [ + "start", + "end" + ] + }, + "TimeInWeek": { + "type": "object", + "properties": { + "day": { + "$ref": "#/definitions/WeekDay", + "description": "The day of the week." + }, + "hourSlots": { + "type": "array", + "items": { + "$ref": "#/definitions/HourInDay" + }, + "title": "A list of hours in the day used to identify a time range.", + "description": "Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range." + } + }, + "description": "Time in a week." + }, + "WeekDay": { + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "WeekDay", + "modelAsString": true + }, + "description": "The weekday enum." + }, + "HourInDay": { + "type": "integer", + "format": "int32", + "maximum": 23, + "minimum": 0, + "description": "Hour in a day." + }, + "TimeSpan": { + "type": "object", + "properties": { + "start": { + "type": "string", + "format": "date-time", + "description": "The start of a time span" + }, + "end": { + "type": "string", + "format": "date-time", + "description": "The end of a time span" + } + }, + "title": "A time range.", + "description": "For example, between 2021-05-25T13:00:00Z and 2021-05-25T14:00:00Z." + }, + "RunCommandRequest": { + "type": "object", + "properties": { + "command": { + "type": "string", + "description": "The command to run." + }, + "context": { + "type": "string", + "description": "A base64 encoded zip file containing the files required by the command." + }, + "clusterToken": { + "type": "string", + "description": "AuthToken issued for AKS AAD Server App." + } + }, + "description": "A run command request", + "required": [ + "command" + ] + }, + "RunCommandResult": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The command id.", + "readOnly": true + }, + "properties": { + "description": "Properties of command result.", + "$ref": "#/definitions/CommandResultProperties", + "x-ms-client-flatten": true + } + }, + "description": "run command result." + }, + "CommandResultProperties": { + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "provisioning State" + }, + "exitCode": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The exit code of the command" + }, + "startedAt": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time when the command started." + }, + "finishedAt": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time when the command finished." + }, + "logs": { + "type": "string", + "readOnly": true, + "description": "The command output." + }, + "reason": { + "type": "string", + "readOnly": true, + "description": "An explanation of why provisioningState is set to failed (if so)." + } + }, + "description": "The results of a run command" + }, + "ManagedClusterNATGatewayProfile": { + "type": "object", + "properties": { + "managedOutboundIPProfile": { + "$ref": "#/definitions/ManagedClusterManagedOutboundIPProfile", + "description": "Profile of the managed outbound IP resources of the cluster NAT gateway." + }, + "effectiveOutboundIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "The effective outbound IP resources of the cluster NAT gateway." + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 120, + "minimum": 4, + "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes.", + "default": 4 + } + }, + "description": "Profile of the managed cluster NAT gateway." + }, + "ManagedClusterManagedOutboundIPProfile": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "maximum": 16, + "minimum": 1, + "description": "The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. ", + "default": 1 + } + }, + "description": "Profile of the managed outbound IP resources of the managed cluster." + }, + "ManagedClusterLoadBalancerProfile": { + "type": "object", + "properties": { + "managedOutboundIPs": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 1, + "description": "The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ", + "default": 1 + }, + "countIPv6": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 0, + "description": "The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack. ", + "default": 0 + } + }, + "description": "Desired managed outbound IPs for the cluster load balancer." + }, + "outboundIPPrefixes": { + "type": "object", + "properties": { + "publicIPPrefixes": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP prefix resources." + } + }, + "description": "Desired outbound IP Prefix resources for the cluster load balancer." + }, + "outboundIPs": { + "type": "object", + "properties": { + "publicIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP resources." + } + }, + "description": "Desired outbound IP resources for the cluster load balancer." + }, + "effectiveOutboundIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "The effective outbound IP resources of the cluster load balancer." + }, + "allocatedOutboundPorts": { + "type": "integer", + "format": "int32", + "maximum": 64000, + "minimum": 0, + "description": "The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports.", + "default": 0 + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 120, + "minimum": 4, + "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes.", + "default": 30 + }, + "enableMultipleStandardLoadBalancers": { + "type": "boolean", + "description": "Enable multiple standard load balancers per AKS cluster or not." + }, + "backendPoolType": { + "type": "string", + "x-ms-enum": { + "name": "BackendPoolType", + "modelAsString": true, + "values": [ + { + "value": "NodeIPConfiguration", + "description": "The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend." + }, + { + "value": "NodeIP", + "description": "The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend." + } + ] + }, + "enum": [ + "NodeIPConfiguration", + "NodeIP" + ], + "description": "The type of the managed inbound Load Balancer BackendPool.", + "default": "NodeIPConfiguration" + } + }, + "description": "Profile of the managed cluster load balancer." + }, + "ResourceReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The fully qualified Azure resource id." + } + }, + "description": "A reference to an Azure resource." + }, + "ContainerServiceSshConfiguration": { + "type": "object", + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerServiceSshPublicKey" + }, + "x-ms-identifiers": [], + "description": "The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified." + } + }, + "description": "SSH configuration for Linux-based VMs running on Azure.", + "required": [ + "publicKeys" + ] + }, + "ContainerServiceSshPublicKey": { + "type": "object", + "properties": { + "keyData": { + "type": "string", + "description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers." + } + }, + "required": [ + "keyData" + ], + "description": "Contains information about SSH certificate public key data." + }, + "ManagedClusterListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "The list of managed clusters." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of managed cluster results.", + "readOnly": true + } + }, + "description": "The response from the List Managed Clusters operation." + }, + "ManagedCluster": { + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/ManagedClusterSKU", + "description": "The managed cluster SKU." + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the Virtual Machine." + }, + "identity": { + "$ref": "#/definitions/ManagedClusterIdentity", + "description": "The identity of the managed cluster, if configured." + }, + "properties": { + "description": "Properties of a managed cluster.", + "$ref": "#/definitions/ManagedClusterProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "Managed cluster." + }, + "ManagedClusterProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current provisioning state." + }, + "powerState": { + "$ref": "#/definitions/PowerState", + "description": "The Power State of the cluster.", + "readOnly": true + }, + "maxAgentPools": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The max number of agent pools for the managed cluster." + }, + "kubernetesVersion": { + "type": "string", + "title": "The version of Kubernetes specified by the user.", + "description": "Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details." + }, + "currentKubernetesVersion": { + "readOnly": true, + "type": "string", + "title": "The version of Kubernetes the Managed Cluster is running.", + "description": "If kubernetesVersion was a fully specified version , this field will be exactly equal to it. If kubernetesVersion was , this field will contain the full version being used." + }, + "dnsPrefix": { + "type": "string", + "title": "The DNS prefix of the Managed Cluster.", + "description": "This cannot be updated once the Managed Cluster has been created." + }, + "fqdnSubdomain": { + "type": "string", + "title": "The FQDN subdomain of the private cluster with custom private dns zone.", + "description": "This cannot be updated once the Managed Cluster has been created." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "The FQDN of the master pool." + }, + "privateFQDN": { + "readOnly": true, + "type": "string", + "description": "The FQDN of private cluster." + }, + "azurePortalFQDN": { + "readOnly": true, + "type": "string", + "title": "The special FQDN used by the Azure Portal to access the Managed Cluster. This FQDN is for use only by the Azure Portal and should not be used by other clients.", + "description": "The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterAgentPoolProfile" + }, + "x-ms-identifiers": [], + "description": "The agent pool properties." + }, + "linuxProfile": { + "$ref": "#/definitions/ContainerServiceLinuxProfile", + "description": "The profile for Linux VMs in the Managed Cluster." + }, + "windowsProfile": { + "$ref": "#/definitions/ManagedClusterWindowsProfile", + "description": "The profile for Windows VMs in the Managed Cluster." + }, + "servicePrincipalProfile": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile", + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs." + }, + "addonProfiles": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ManagedClusterAddonProfile" + }, + "description": "The profile of managed cluster add-on." + }, + "podIdentityProfile": { + "$ref": "#/definitions/ManagedClusterPodIdentityProfile", + "title": "The pod identity profile of the Managed Cluster.", + "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on AAD pod identity integration." + }, + "oidcIssuerProfile": { + "$ref": "#/definitions/ManagedClusterOIDCIssuerProfile", + "description": "The OIDC issuer profile of the Managed Cluster." + }, + "nodeResourceGroup": { + "type": "string", + "description": "The name of the resource group containing agent pool nodes." + }, + "enableRBAC": { + "type": "boolean", + "description": "Whether to enable Kubernetes Role-Based Access Control." + }, + "supportPlan": { + "$ref": "#/definitions/KubernetesSupportPlan", + "description": "The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'." + }, + "enablePodSecurityPolicy": { + "type": "boolean", + "description": "(DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp." + }, + "networkProfile": { + "$ref": "#/definitions/ContainerServiceNetworkProfile", + "description": "The network configuration profile." + }, + "aadProfile": { + "$ref": "#/definitions/ManagedClusterAADProfile", + "description": "The Azure Active Directory configuration." + }, + "autoUpgradeProfile": { + "$ref": "#/definitions/ManagedClusterAutoUpgradeProfile", + "description": "The auto upgrade configuration." + }, + "upgradeSettings": { + "$ref": "#/definitions/ClusterUpgradeSettings", + "description": "Settings for upgrading a cluster." + }, + "autoScalerProfile": { + "type": "object", + "properties": { + "balance-similar-node-groups": { + "type": "string", + "title": "Detects similar node pools and balances the number of nodes between them.", + "description": "Valid values are 'true' and 'false'" + }, + "daemonset-eviction-for-empty-nodes": { + "type": "boolean", + "title": "DaemonSet pods will be gracefully terminated from empty nodes", + "description": "If set to true, all daemonset pods on empty nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted." + }, + "daemonset-eviction-for-occupied-nodes": { + "type": "boolean", + "title": "DaemonSet pods will be gracefully terminated from non-empty nodes", + "description": "If set to true, all daemonset pods on occupied nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted." + }, + "ignore-daemonsets-utilization": { + "type": "boolean", + "title": "Should CA ignore DaemonSet pods when calculating resource utilization for scaling down", + "description": "If set to true, the resources used by daemonset will be taken into account when making scaling down decisions." + }, + "expander": { + "type": "string", + "enum": [ + "least-waste", + "most-pods", + "priority", + "random" + ], + "x-ms-enum": { + "name": "expander", + "modelAsString": true, + "values": [ + { + "value": "least-waste", + "description": "Selects the node group that will have the least idle CPU (if tied, unused memory) after scale-up. This is useful when you have different classes of nodes, for example, high CPU or high memory nodes, and only want to expand those when there are pending pods that need a lot of those resources." + }, + { + "value": "most-pods", + "description": "Selects the node group that would be able to schedule the most pods when scaling up. This is useful when you are using nodeSelector to make sure certain pods land on certain nodes. Note that this won't cause the autoscaler to select bigger nodes vs. smaller, as it can add multiple smaller nodes at once." + }, + { + "value": "priority", + "description": "Selects the node group that has the highest priority assigned by the user. It's configuration is described in more details [here](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/expander/priority/readme.md)." + }, + { + "value": "random", + "description": "Used when you don't have a particular need for the node groups to scale differently." + } + ] + }, + "title": "The expander to use when scaling up", + "description": "If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information." + }, + "max-empty-bulk-delete": { + "type": "string", + "title": "The maximum number of empty nodes that can be deleted at the same time. This must be a positive integer.", + "description": "The default is 10." + }, + "max-graceful-termination-sec": { + "type": "string", + "title": "The maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node.", + "description": "The default is 600." + }, + "max-node-provision-time": { + "type": "string", + "title": "The maximum time the autoscaler waits for a node to be provisioned.", + "description": "The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "max-total-unready-percentage": { + "type": "string", + "title": "The maximum percentage of unready nodes in the cluster. After this percentage is exceeded, cluster autoscaler halts operations.", + "description": "The default is 45. The maximum is 100 and the minimum is 0." + }, + "new-pod-scale-up-delay": { + "type": "string", + "title": "Ignore unscheduled pods before they're a certain age.", + "description": "For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc)." + }, + "ok-total-unready-count": { + "type": "string", + "title": "The number of allowed unready nodes, irrespective of max-total-unready-percentage.", + "description": "This must be an integer. The default is 3." + }, + "scan-interval": { + "type": "string", + "title": "How often cluster is reevaluated for scale up or down.", + "description": "The default is '10'. Values must be an integer number of seconds." + }, + "scale-down-delay-after-add": { + "type": "string", + "title": "How long after scale up that scale down evaluation resumes", + "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-delay-after-delete": { + "type": "string", + "title": "How long after node deletion that scale down evaluation resumes.", + "description": "The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-delay-after-failure": { + "type": "string", + "title": "How long after scale down failure that scale down evaluation resumes.", + "description": "The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-unneeded-time": { + "type": "string", + "title": "How long a node should be unneeded before it is eligible for scale down.", + "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-unready-time": { + "type": "string", + "title": "How long an unready node should be unneeded before it is eligible for scale down", + "description": "The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-utilization-threshold": { + "type": "string", + "title": "Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down.", + "description": "The default is '0.5'." + }, + "skip-nodes-with-local-storage": { + "type": "string", + "title": "If cluster autoscaler will skip deleting nodes with pods with local storage, for example, EmptyDir or HostPath.", + "description": "The default is true." + }, + "skip-nodes-with-system-pods": { + "type": "string", + "title": "If cluster autoscaler will skip deleting nodes with pods from kube-system (except for DaemonSet or mirror pods)", + "description": "The default is true." + } + }, + "description": "Parameters to be applied to the cluster-autoscaler when enabled" + }, + "apiServerAccessProfile": { + "$ref": "#/definitions/ManagedClusterAPIServerAccessProfile", + "description": "The access profile for managed cluster API server." + }, + "diskEncryptionSetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/diskEncryptionSets" + } + ] + }, + "title": "The Resource ID of the disk encryption set to use for enabling encryption at rest.", + "description": "This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'" + }, + "identityProfile": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + }, + "description": "Identities associated with the cluster." + }, + "privateLinkResources": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "Private link resources associated with the cluster." + }, + "disableLocalAccounts": { + "type": "boolean", + "title": "If local accounts should be disabled on the Managed Cluster.", + "description": "If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview)." + }, + "httpProxyConfig": { + "$ref": "#/definitions/ManagedClusterHTTPProxyConfig", + "description": "Configurations for provisioning the cluster with HTTP proxy servers." + }, + "securityProfile": { + "$ref": "#/definitions/ManagedClusterSecurityProfile", + "description": "Security profile for the managed cluster." + }, + "storageProfile": { + "$ref": "#/definitions/ManagedClusterStorageProfile", + "description": "Storage profile for the managed cluster." + }, + "ingressProfile": { + "$ref": "#/definitions/ManagedClusterIngressProfile", + "description": "Ingress profile for the managed cluster." + }, + "publicNetworkAccess": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + }, + "title": "PublicNetworkAccess of the managedCluster", + "description": "Allow or deny public network access for AKS" + }, + "workloadAutoScalerProfile": { + "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfile" + }, + "azureMonitorProfile": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfile" + }, + "serviceMeshProfile": { + "$ref": "#/definitions/ServiceMeshProfile" + }, + "resourceUID": { + "readOnly": true, + "type": "string", + "description": "The resourceUID uniquely identifies ManagedClusters that reuse ARM ResourceIds (i.e: create, delete, create sequence)" + }, + "metricsProfile": { + "$ref": "#/definitions/ManagedClusterMetricsProfile", + "description": "Optional cluster metrics configuration." + } + }, + "description": "Properties of the managed cluster." + }, + "PowerState": { + "type": "object", + "description": "Describes the Power State of the cluster", + "properties": { + "code": { + "type": "string", + "description": "Tells whether the cluster is Running or Stopped", + "enum": [ + "Running", + "Stopped" + ], + "x-ms-enum": { + "name": "code", + "modelAsString": true, + "values": [ + { + "value": "Running", + "description": "The cluster is running." + }, + { + "value": "Stopped", + "description": "The cluster is stopped." + } + ] + } + } + } + }, + "ManagedClusterAPIServerAccessProfile": { + "type": "object", + "properties": { + "authorizedIPRanges": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The IP ranges authorized to access the Kubernetes API server.", + "description": "IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see [API server authorized IP ranges](https://docs.microsoft.com/azure/aks/api-server-authorized-ip-ranges)." + }, + "enablePrivateCluster": { + "type": "boolean", + "title": "Whether to create the cluster as a private cluster or not.", + "description": "For more details, see [Creating a private AKS cluster](https://docs.microsoft.com/azure/aks/private-clusters)." + }, + "privateDNSZone": { + "type": "string", + "title": "The private DNS zone mode for the cluster.", + "description": "The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'." + }, + "enablePrivateClusterPublicFQDN": { + "type": "boolean", + "description": "Whether to create additional public FQDN for private cluster or not." + }, + "disableRunCommand": { + "type": "boolean", + "description": "Whether to disable run command for the cluster or not." + } + }, + "description": "Access profile for managed cluster API server." + }, + "ManagedClusterIdentity": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the system assigned identity which is used by master components." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id of the system assigned identity which is used by master components." + }, + "type": { + "type": "string", + "title": "The type of identity used for the managed cluster.", + "description": "For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity).", + "enum": [ + "SystemAssigned", + "UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false, + "values": [ + { + "value": "SystemAssigned", + "description": "Use an implicitly created system assigned managed identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the system assigned managed identity to manipulate Azure resources." + }, + { + "value": "UserAssigned", + "description": "Use a user-specified identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the specified user assigned managed identity to manipulate Azure resources." + }, + { + "value": "None", + "description": "Do not use a managed identity for the Managed Cluster, service principal will be used instead." + } + ] + } + }, + "delegatedResources": { + "$ref": "../../../../../../common-types/resource-management/v4/managedidentitywithdelegation.json#/definitions/DelegatedResources", + "description": "The delegated identity resources assigned to this managed cluster. This can only be set by another Azure Resource Provider, and managed cluster only accept one delegated identity resource. Internal use only." + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "x-ms-client-name": "ManagedServiceIdentityUserAssignedIdentitiesValue", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "title": "The user identity associated with the managed cluster. This identity will be used in control plane. Only one user assigned identity is allowed.", + "description": "The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the managed cluster." + }, + "UserAssignedIdentity": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ] + }, + "description": "The resource ID of the user assigned identity." + }, + "clientId": { + "type": "string", + "description": "The client ID of the user assigned identity." + }, + "objectId": { + "type": "string", + "description": "The object ID of the user assigned identity." + } + }, + "description": "Details about a user assigned identity." + }, + "ManagedClusterAccessProfile": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "AccessProfile of a managed cluster.", + "$ref": "#/definitions/AccessProfile", + "x-ms-client-flatten": true + } + }, + "description": "Managed cluster Access Profile.", + "x-ms-azure-resource": false + }, + "AccessProfile": { + "type": "object", + "properties": { + "kubeConfig": { + "type": "string", + "format": "byte", + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "Profile for enabling a user to access a managed cluster." + }, + "ManagedClusterPoolUpgradeProfile": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "name": { + "type": "string", + "description": "The Agent Pool name." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether the Kubernetes version is currently in preview." + } + } + }, + "x-ms-identifiers": [], + "description": "List of orchestrator types and versions available for upgrade." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "ManagedClusterUpgradeProfileProperties": { + "type": "object", + "properties": { + "controlPlaneProfile": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile", + "description": "The list of available upgrade versions for the control plane." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile" + }, + "x-ms-identifiers": [], + "description": "The list of available upgrade versions for agent pools." + } + }, + "required": [ + "controlPlaneProfile", + "agentPoolProfiles" + ], + "description": "Control plane and agent pool upgrade profiles." + }, + "ManagedClusterAutoUpgradeProfile": { + "type": "object", + "properties": { + "upgradeChannel": { + "type": "string", + "enum": [ + "rapid", + "stable", + "patch", + "node-image", + "none" + ], + "x-ms-enum": { + "name": "upgradeChannel", + "modelAsString": true, + "values": [ + { + "value": "rapid", + "description": "Automatically upgrade the cluster to the latest supported patch release on the latest supported minor version. In cases where the cluster is at a version of Kubernetes that is at an N-2 minor version where N is the latest supported minor version, the cluster first upgrades to the latest supported patch version on N-1 minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster first is upgraded to 1.18.6, then is upgraded to 1.19.1." + }, + { + "value": "stable", + "description": "Automatically upgrade the cluster to the latest supported patch release on minor version N-1, where N is the latest supported minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.18.6." + }, + { + "value": "patch", + "description": "Automatically upgrade the cluster to the latest supported patch version when it becomes available while keeping the minor version the same. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.17.9." + }, + { + "value": "node-image", + "description": "Automatically upgrade the node image to the latest version available. Consider using nodeOSUpgradeChannel instead as that allows you to configure node OS patching separate from Kubernetes version patching" + }, + { + "value": "none", + "description": "Disables auto-upgrades and keeps the cluster at its current version of Kubernetes." + } + ] + }, + "title": "The upgrade channel for auto upgrade. The default is 'none'.", + "description": "For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel)." + }, + "nodeOSUpgradeChannel": { + "type": "string", + "enum": [ + "Unmanaged", + "None", + "NodeImage", + "SecurityPatch" + ], + "x-ms-enum": { + "name": "nodeOSUpgradeChannel", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No attempt to update your machines OS will be made either by OS or by rolling VHDs. This means you are responsible for your security updates" + }, + { + "value": "Unmanaged", + "description": "OS updates will be applied automatically through the OS built-in patching infrastructure. Newly scaled in machines will be unpatched initially and will be patched at some point by the OS's infrastructure. Behavior of this option depends on the OS in question. Ubuntu and Mariner apply security patches through unattended upgrade roughly once a day around 06:00 UTC. Windows does not apply security patches automatically and so for them this option is equivalent to None till further notice" + }, + { + "value": "NodeImage", + "description": "AKS will update the nodes with a newly patched VHD containing security fixes and bugfixes on a weekly cadence. With the VHD update machines will be rolling reimaged to that VHD following maintenance windows and surge settings. No extra VHD cost is incurred when choosing this option as AKS hosts the images." + }, + { + "value": "SecurityPatch", + "description": "AKS downloads and updates the nodes with tested security updates. These updates honor the maintenance window settings and produce a new VHD that is used on new nodes. On some occasions it's not possible to apply the updates in place, in such cases the existing nodes will also be re-imaged to the newly produced VHD in order to apply the changes. This option incurs an extra cost of hosting the new Security Patch VHDs in your resource group for just in time consumption." + } + ] + }, + "title": "Node OS Upgrade Channel", + "description": "Manner in which the OS on your nodes is updated. The default is NodeImage." + } + }, + "description": "Auto upgrade profile for a managed cluster." + }, + "UpgradeOverrideSettings": { + "type": "object", + "properties": { + "forceUpgrade": { + "type": "boolean", + "description": "Whether to force upgrade the cluster. Note that this option instructs upgrade operation to bypass upgrade protections such as checking for deprecated API usage. Enable this option only with caution." + }, + "until": { + "type": "string", + "format": "date-time", + "description": "Until when the overrides are effective. Note that this only matches the start time of an upgrade, and the effectiveness won't change once an upgrade starts even if the `until` expires as upgrade proceeds. This field is not set by default. It must be set for the overrides to take effect." + } + }, + "description": "Settings for overrides when upgrading a cluster." + }, + "ClusterUpgradeSettings": { + "type": "object", + "properties": { + "overrideSettings": { + "$ref": "#/definitions/UpgradeOverrideSettings", + "description": "Settings for overrides." + } + }, + "description": "Settings for upgrading a cluster." + }, + "ManagedClusterAADProfile": { + "type": "object", + "properties": { + "managed": { + "type": "boolean", + "description": "Whether to enable managed AAD." + }, + "enableAzureRBAC": { + "type": "boolean", + "description": "Whether to enable Azure RBAC for Kubernetes authorization." + }, + "adminGroupObjectIDs": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of AAD group object IDs that will have admin role of the cluster." + }, + "clientAppID": { + "type": "string", + "description": "(DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy." + }, + "serverAppID": { + "type": "string", + "description": "(DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy." + }, + "serverAppSecret": { + "type": "string", + "description": "(DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy." + }, + "tenantID": { + "type": "string", + "description": "The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription." + } + }, + "title": "AADProfile specifies attributes for Azure Active Directory integration.", + "description": "For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad)." + }, + "ManagedClusterAddonProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the add-on is enabled or not." + }, + "config": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs for configuring an add-on." + }, + "identity": { + "readOnly": true, + "description": "Information of user assigned identity used by this add-on.", + "allOf": [ + { + "$ref": "#/definitions/UserAssignedIdentity" + } + ] + } + }, + "required": [ + "enabled" + ], + "description": "A Kubernetes add-on profile for a managed cluster." + }, + "ManagedClusterPodIdentity": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the pod identity." + }, + "namespace": { + "type": "string", + "description": "The namespace of the pod identity." + }, + "bindingSelector": { + "type": "string", + "description": "The binding selector to use for the AzureIdentityBinding resource." + }, + "identity": { + "$ref": "#/definitions/UserAssignedIdentity", + "description": "The user assigned identity details." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state of the pod identity.", + "enum": [ + "Assigned", + "Canceled", + "Deleting", + "Failed", + "Succeeded", + "Updating" + ], + "x-ms-enum": { + "name": "ManagedClusterPodIdentityProvisioningState", + "modelAsString": true + } + }, + "provisioningInfo": { + "type": "object", + "readOnly": true, + "properties": { + "error": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningError", + "description": "Pod identity assignment error (if any)." + } + } + } + }, + "required": [ + "name", + "namespace", + "identity" + ], + "description": "Details about the pod identity assigned to the Managed Cluster." + }, + "ManagedClusterPodIdentityProvisioningError": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningErrorBody", + "description": "Details about the error." + } + }, + "description": "An error response from the pod identity provisioning." + }, + "ManagedClusterPodIdentityProvisioningErrorBody": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningErrorBody" + }, + "x-ms-identifiers": [], + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the pod identity provisioning." + }, + "ManagedClusterPodIdentityException": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the pod identity exception." + }, + "namespace": { + "type": "string", + "description": "The namespace of the pod identity exception." + }, + "podLabels": { + "type": "object", + "description": "The pod labels to match.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "name", + "namespace", + "podLabels" + ], + "title": "A pod identity exception, which allows pods with certain labels to access the Azure Instance Metadata Service (IMDS) endpoint without being intercepted by the node-managed identity (NMI) server.", + "description": "See [disable AAD Pod Identity for a specific Pod/Application](https://azure.github.io/aad-pod-identity/docs/configure/application_exception/) for more details." + }, + "ManagedClusterPodIdentityProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the pod identity addon is enabled." + }, + "allowNetworkPluginKubenet": { + "type": "boolean", + "title": "Whether pod identity is allowed to run on clusters with Kubenet networking.", + "description": "Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information." + }, + "userAssignedIdentities": { + "description": "The pod identities to use in the cluster.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentity" + }, + "x-ms-identifiers": [] + }, + "userAssignedIdentityExceptions": { + "description": "The pod identity exceptions to allow.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentityException" + }, + "x-ms-identifiers": [] + } + }, + "title": "The pod identity profile of the Managed Cluster.", + "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration." + }, + "ManagedClusterOIDCIssuerProfile": { + "type": "object", + "properties": { + "issuerURL": { + "readOnly": true, + "type": "string", + "description": "The OIDC issuer url of the Managed Cluster." + }, + "enabled": { + "type": "boolean", + "description": "Whether the OIDC issuer is enabled." + } + }, + "description": "The OIDC issuer profile of the Managed Cluster." + }, + "ManagedClusterUpgradeProfile": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the upgrade profile." + }, + "properties": { + "$ref": "#/definitions/ManagedClusterUpgradeProfileProperties", + "description": "The properties of the upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for compute pools." + }, + "AgentPoolUpgradeProfile": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the agent pool upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the agent pool upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the agent pool upgrade profile." + }, + "properties": { + "$ref": "#/definitions/AgentPoolUpgradeProfileProperties", + "description": "The properties of the agent pool upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for an agent pool." + }, + "AgentPoolUpgradeProfileProperties": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether the Kubernetes version is currently in preview." + } + } + }, + "x-ms-identifiers": [], + "description": "List of orchestrator types and versions available for upgrade." + }, + "latestNodeImageVersion": { + "type": "string", + "description": "The latest AKS supported node image version." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "AgentPoolAvailableVersions": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the agent pool version list." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the agent pool version list." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the agent pool version list." + }, + "properties": { + "$ref": "#/definitions/AgentPoolAvailableVersionsProperties", + "description": "Properties of agent pool available versions.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available versions for an agent pool." + }, + "AgentPoolAvailableVersionsProperties": { + "type": "object", + "properties": { + "agentPoolVersions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "default": { + "type": "boolean", + "description": "Whether this version is the default agent pool version." + }, + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether Kubernetes version is currently in preview." + } + } + }, + "x-ms-identifiers": [], + "description": "List of versions available for agent pool." + } + }, + "description": "The list of available agent pool versions." + }, + "OSType": { + "type": "string", + "default": "Linux", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": true, + "values": [ + { + "value": "Linux", + "description": "Use Linux." + }, + { + "value": "Windows", + "description": "Use Windows." + } + ] + }, + "description": "The operating system type. The default is Linux." + }, + "OSSKU": { + "type": "string", + "enum": [ + "Ubuntu", + "CBLMariner", + "AzureLinux", + "Windows2019", + "Windows2022" + ], + "x-ms-enum": { + "name": "OSSKU", + "modelAsString": true, + "values": [ + { + "value": "Ubuntu", + "description": "Use Ubuntu as the OS for node images." + }, + { + "value": "AzureLinux", + "description": "Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information." + }, + { + "value": "CBLMariner", + "description": "Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead." + }, + { + "value": "Windows2019", + "description": "Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa." + }, + { + "value": "Windows2022", + "description": "Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa." + } + ] + }, + "description": "Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows." + }, + "ScaleSetPriority": { + "type": "string", + "default": "Regular", + "enum": [ + "Spot", + "Regular" + ], + "x-ms-enum": { + "name": "ScaleSetPriority", + "modelAsString": true, + "values": [ + { + "value": "Spot", + "description": "Spot priority VMs will be used. There is no SLA for spot nodes. See [spot on AKS](https://docs.microsoft.com/azure/aks/spot-node-pool) for more information." + }, + { + "value": "Regular", + "description": "Regular VMs will be used." + } + ] + }, + "description": "The Virtual Machine Scale Set priority." + }, + "ScaleSetEvictionPolicy": { + "type": "string", + "default": "Delete", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "ScaleSetEvictionPolicy", + "modelAsString": true, + "values": [ + { + "value": "Delete", + "description": "Nodes in the underlying Scale Set of the node pool are deleted when they're evicted." + }, + { + "value": "Deallocate", + "description": "Nodes in the underlying Scale Set of the node pool are set to the stopped-deallocated state upon eviction. Nodes in the stopped-deallocated state count against your compute quota and can cause issues with cluster scaling or upgrading." + } + ] + }, + "title": "The Virtual Machine Scale Set eviction policy.", + "description": "The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms)" + }, + "SpotMaxPrice": { + "type": "number", + "default": -1, + "title": "The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.", + "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)" + }, + "ScaleDownMode": { + "type": "string", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "ScaleDownMode", + "modelAsString": true, + "values": [ + { + "value": "Delete", + "description": "Create new instances during scale up and remove instances during scale down." + }, + { + "value": "Deallocate", + "description": "Attempt to start deallocated instances (if they exist) during scale up and deallocate instances during scale down." + } + ] + }, + "description": "Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing)." + }, + "ProximityPlacementGroupID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/proximityPlacementGroups" + } + ] + }, + "description": "The ID for Proximity Placement Group." + }, + "CredentialResults": { + "type": "object", + "properties": { + "kubeconfigs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CredentialResult" + }, + "x-ms-identifiers": [], + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The list credential result response." + }, + "CredentialResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the credential." + }, + "value": { + "type": "string", + "format": "byte", + "readOnly": true, + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The credential result response." + }, + "CloudError": { + "type": "object", + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "Details about the error." + } + }, + "description": "An error response from the Container service." + }, + "CloudErrorBody": { + "type": "object", + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "x-ms-identifiers": [], + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Container service." + }, + "ManagedClusterSKU": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of a managed cluster SKU.", + "enum": [ + "Base" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUName", + "modelAsString": true, + "values": [ + { + "value": "Base", + "description": "Base option for the AKS control plane." + } + ] + } + }, + "tier": { + "type": "string", + "title": "The tier of a managed cluster SKU.", + "description": "If not specified, the default is 'Free'. See [AKS Pricing Tier](https://learn.microsoft.com/azure/aks/free-standard-pricing-tiers) for more details.", + "enum": [ + "Standard", + "Free", + "Premium" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUTier", + "modelAsString": true, + "values": [ + { + "value": "Premium", + "description": "Cluster has premium capabilities in addition to all of the capabilities included in 'Standard'. Premium enables selection of LongTermSupport (aka.ms/aks/lts) for certain Kubernetes versions." + }, + { + "value": "Standard", + "description": "Recommended for mission-critical and production workloads. Includes Kubernetes control plane autoscaling, workload-intensive testing, and up to 5,000 nodes per cluster. Guarantees 99.95% availability of the Kubernetes API server endpoint for clusters that use Availability Zones and 99.9% of availability for clusters that don't use Availability Zones." + }, + { + "value": "Free", + "description": "The cluster management is free, but charged for VM, storage, and networking usage. Best for experimenting, learning, simple testing, or workloads with fewer than 10 nodes. Not recommended for production use cases." + } + ] + } + } + }, + "description": "The SKU of a Managed Cluster." + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "A list of private endpoint connections", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the private endpoint connection." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the private endpoint connection.", + "externalDocs": { + "url": "https://aka.ms/search-naming-rules" + } + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The properties of a private endpoint connection.", + "x-ms-client-flatten": true + } + }, + "x-ms-azure-resource": true + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "description": "Properties of a private endpoint connection.", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Canceled", + "Creating", + "Deleting", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private endpoint." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpoint": { + "type": "object", + "description": "Private endpoint which a connection belongs to.", + "properties": { + "id": { + "description": "The resource ID of the private endpoint", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "The state of a private link service connection.", + "type": "object", + "properties": { + "status": { + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "description": "The private link service connection status.", + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + } + }, + "description": { + "type": "string", + "description": "The private link service connection description." + } + } + }, + "PrivateLinkResourcesListResult": { + "type": "object", + "description": "A list of private link resources", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + } + }, + "PrivateLinkResource": { + "description": "A private link resource", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the private link resource." + }, + "name": { + "type": "string", + "description": "The name of the private link resource.", + "externalDocs": { + "url": "https://aka.ms/search-naming-rules" + } + }, + "type": { + "type": "string", + "description": "The resource type." + }, + "groupId": { + "type": "string", + "description": "The group ID of the resource." + }, + "requiredMembers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The RequiredMembers of the resource" + }, + "privateLinkServiceID": { + "readOnly": true, + "type": "string", + "format": "arm-id", + "description": "The private link service ID of the resource, this field is exposed only to NRP internally." + } + } + }, + "OSDiskType": { + "type": "string", + "enum": [ + "Managed", + "Ephemeral" + ], + "x-ms-enum": { + "name": "OSDiskType", + "modelAsString": true, + "values": [ + { + "value": "Managed", + "description": "Azure replicates the operating system disk for a virtual machine to Azure storage to avoid data loss should the VM need to be relocated to another host. Since containers aren't designed to have local state persisted, this behavior offers limited value while providing some drawbacks, including slower node provisioning and higher read/write latency." + }, + { + "value": "Ephemeral", + "description": "Ephemeral OS disks are stored only on the host machine, just like a temporary disk. This provides lower read/write latency, along with faster node scaling and cluster upgrades." + } + ] + }, + "title": "The OS disk type to be used for machines in the agent pool.", + "description": "The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os)." + }, + "KubeletDiskType": { + "type": "string", + "enum": [ + "OS", + "Temporary" + ], + "x-ms-enum": { + "name": "KubeletDiskType", + "modelAsString": true, + "values": [ + { + "value": "OS", + "description": "Kubelet will use the OS disk for its data." + }, + { + "value": "Temporary", + "description": "Kubelet will use the temporary disk for its data." + } + ] + }, + "description": "Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage." + }, + "WorkloadRuntime": { + "type": "string", + "enum": [ + "OCIContainer", + "WasmWasi" + ], + "x-ms-enum": { + "name": "WorkloadRuntime", + "modelAsString": true, + "values": [ + { + "value": "OCIContainer", + "description": "Nodes will use Kubelet to run standard OCI container workloads." + }, + { + "value": "WasmWasi", + "description": "Nodes will use Krustlet to run WASM workloads using the WASI provider (Preview)." + } + ] + }, + "description": "Determines the type of workload a node can run." + }, + "KubeletConfig": { + "title": "Kubelet configurations of agent nodes.", + "description": "See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details.", + "type": "object", + "properties": { + "cpuManagerPolicy": { + "type": "string", + "title": "The CPU Manager policy to use.", + "description": "The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'." + }, + "cpuCfsQuota": { + "type": "boolean", + "title": "If CPU CFS quota enforcement is enabled for containers that specify CPU limits.", + "description": "The default is true." + }, + "cpuCfsQuotaPeriod": { + "type": "string", + "title": "The CPU CFS quota period value.", + "description": "The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'." + }, + "imageGcHighThreshold": { + "type": "integer", + "format": "int32", + "title": "The percent of disk usage after which image garbage collection is always run.", + "description": "To disable image garbage collection, set to 100. The default is 85%" + }, + "imageGcLowThreshold": { + "type": "integer", + "format": "int32", + "title": "The percent of disk usage before which image garbage collection is never run.", + "description": "This cannot be set higher than imageGcHighThreshold. The default is 80%" + }, + "topologyManagerPolicy": { + "type": "string", + "title": "The Topology Manager policy to use.", + "description": "For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'." + }, + "allowedUnsafeSysctls": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`)." + }, + "failSwapOn": { + "type": "boolean", + "description": "If set to true it will make the Kubelet fail to start if swap is enabled on the node." + }, + "containerLogMaxSizeMB": { + "type": "integer", + "format": "int32", + "description": "The maximum size (e.g. 10Mi) of container log file before it is rotated." + }, + "containerLogMaxFiles": { + "type": "integer", + "format": "int32", + "description": "The maximum number of container log files that can be present for a container. The number must be ≥ 2.", + "minimum": 2 + }, + "podMaxPids": { + "type": "integer", + "format": "int32", + "description": "The maximum number of processes per pod." + } + } + }, + "LinuxOSConfig": { + "title": "OS configurations of Linux agent nodes.", + "description": "See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details.", + "type": "object", + "properties": { + "sysctls": { + "$ref": "#/definitions/SysctlConfig", + "description": "Sysctl settings for Linux agent nodes." + }, + "transparentHugePageEnabled": { + "type": "string", + "title": "Whether transparent hugepages are enabled.", + "description": "Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)." + }, + "transparentHugePageDefrag": { + "type": "string", + "title": "Whether the kernel should make aggressive use of memory compaction to make more hugepages available.", + "description": "Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)." + }, + "swapFileSizeMB": { + "type": "integer", + "format": "int32", + "description": "The size in MB of a swap file that will be created on each node." + } + } + }, + "AgentPoolWindowsProfile": { + "type": "object", + "description": "The Windows agent pool's specific profile.", + "properties": { + "disableOutboundNat": { + "type": "boolean", + "title": "Whether to disable OutboundNAT in windows nodes", + "description": "The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled." + } + } + }, + "SysctlConfig": { + "description": "Sysctl settings for Linux agent nodes.", + "type": "object", + "properties": { + "netCoreSomaxconn": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.somaxconn." + }, + "netCoreNetdevMaxBacklog": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.netdev_max_backlog." + }, + "netCoreRmemDefault": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.rmem_default." + }, + "netCoreRmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.rmem_max." + }, + "netCoreWmemDefault": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.wmem_default." + }, + "netCoreWmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.wmem_max." + }, + "netCoreOptmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.optmem_max." + }, + "netIpv4TcpMaxSynBacklog": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_max_syn_backlog." + }, + "netIpv4TcpMaxTwBuckets": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_max_tw_buckets." + }, + "netIpv4TcpFinTimeout": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_fin_timeout." + }, + "netIpv4TcpKeepaliveTime": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_keepalive_time." + }, + "netIpv4TcpKeepaliveProbes": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_keepalive_probes." + }, + "netIpv4TcpkeepaliveIntvl": { + "type": "integer", + "format": "int32", + "minimum": 10, + "maximum": 90, + "description": "Sysctl setting net.ipv4.tcp_keepalive_intvl." + }, + "netIpv4TcpTwReuse": { + "type": "boolean", + "description": "Sysctl setting net.ipv4.tcp_tw_reuse." + }, + "netIpv4IpLocalPortRange": { + "type": "string", + "description": "Sysctl setting net.ipv4.ip_local_port_range." + }, + "netIpv4NeighDefaultGcThresh1": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh1." + }, + "netIpv4NeighDefaultGcThresh2": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh2." + }, + "netIpv4NeighDefaultGcThresh3": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh3." + }, + "netNetfilterNfConntrackMax": { + "type": "integer", + "format": "int32", + "minimum": 131072, + "maximum": 2097152, + "description": "Sysctl setting net.netfilter.nf_conntrack_max." + }, + "netNetfilterNfConntrackBuckets": { + "type": "integer", + "format": "int32", + "minimum": 65536, + "maximum": 524288, + "description": "Sysctl setting net.netfilter.nf_conntrack_buckets." + }, + "fsInotifyMaxUserWatches": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.inotify.max_user_watches." + }, + "fsFileMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.file-max." + }, + "fsAioMaxNr": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.aio-max-nr." + }, + "fsNrOpen": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.nr_open." + }, + "kernelThreadsMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting kernel.threads-max." + }, + "vmMaxMapCount": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.max_map_count." + }, + "vmSwappiness": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.swappiness." + }, + "vmVfsCachePressure": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.vfs_cache_pressure." + } + } + }, + "ManagedClusterHTTPProxyConfig": { + "description": "Cluster HTTP proxy configuration.", + "type": "object", + "properties": { + "httpProxy": { + "type": "string", + "description": "The HTTP proxy server endpoint to use." + }, + "httpsProxy": { + "type": "string", + "description": "The HTTPS proxy server endpoint to use." + }, + "noProxy": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The endpoints that should not go through proxy." + }, + "trustedCa": { + "type": "string", + "description": "Alternative CA cert to use for connecting to proxy servers." + } + } + }, + "GPUInstanceProfile": { + "type": "string", + "enum": [ + "MIG1g", + "MIG2g", + "MIG3g", + "MIG4g", + "MIG7g" + ], + "x-ms-enum": { + "name": "GPUInstanceProfile ", + "modelAsString": true + }, + "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU." + }, + "ExtendedLocationType": { + "type": "string", + "description": "The type of extendedLocation.", + "enum": [ + "EdgeZone" + ], + "x-ms-enum": { + "name": "ExtendedLocationTypes", + "modelAsString": true + } + }, + "ExtendedLocation": { + "type": "object", + "description": "The complex type of the extended location.", + "properties": { + "name": { + "type": "string", + "description": "The name of the extended location." + }, + "type": { + "$ref": "#/definitions/ExtendedLocationType", + "description": "The type of the extended location." + } + } + }, + "EndpointDependency": { + "description": "A domain name that AKS agent nodes are reaching at.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name of the dependency.", + "type": "string" + }, + "endpointDetails": { + "description": "The Ports and Protocols used when connecting to domainName.", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDetail" + }, + "x-ms-identifiers": [] + } + } + }, + "EndpointDetail": { + "description": "connect information from the AKS agent nodes to a single endpoint.", + "type": "object", + "properties": { + "ipAddress": { + "description": "An IP Address that Domain Name currently resolves to.", + "type": "string" + }, + "port": { + "format": "int32", + "description": "The port an endpoint is connected to.", + "type": "integer" + }, + "protocol": { + "description": "The protocol used for connection", + "type": "string" + }, + "description": { + "description": "Description of the detail", + "type": "string" + } + } + }, + "OutboundEnvironmentEndpoint": { + "description": "Egress endpoints which AKS agent nodes connect to for common purpose.", + "type": "object", + "properties": { + "category": { + "description": "The category of endpoints accessed by the AKS agent node, e.g. azure-resource-management, apiserver, etc.", + "type": "string" + }, + "endpoints": { + "description": "The endpoints that AKS agent nodes connect to", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDependency" + }, + "x-ms-identifiers": [] + } + } + }, + "OutboundEnvironmentEndpointCollection": { + "description": "Collection of OutboundEnvironmentEndpoint", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/OutboundEnvironmentEndpoint" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedClusterIngressProfile": { + "type": "object", + "properties": { + "webAppRouting": { + "$ref": "#/definitions/ManagedClusterIngressProfileWebAppRouting", + "description": "App Routing settings for the ingress profile. You can find an overview and onboarding guide for this feature at https://learn.microsoft.com/en-us/azure/aks/app-routing?tabs=default%2Cdeploy-app-default." + } + }, + "description": "Ingress profile for the container service cluster." + }, + "ManagedClusterIngressProfileWebAppRouting": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable the Application Routing add-on." + }, + "dnsZoneResourceIds": { + "type": "array", + "items": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/dnszones" + }, + { + "type": "Microsoft.Network/privateDnsZones" + } + ] + } + }, + "maxItems": 5, + "description": "Resource IDs of the DNS zones to be associated with the Application Routing add-on. Used only when Application Routing add-on is enabled. Public and private DNS zones can be in different resource groups, but all public DNS zones must be in the same resource group and all private DNS zones must be in the same resource group." + }, + "identity": { + "readOnly": true, + "type": "object", + "$ref": "#/definitions/UserAssignedIdentity", + "description": "Managed identity of the Application Routing add-on. This is the identity that should be granted permissions, for example, to manage the associated Azure DNS resource and get certificates from Azure Key Vault. See [this overview of the add-on](https://learn.microsoft.com/en-us/azure/aks/web-app-routing?tabs=with-osm) for more instructions." + } + }, + "description": "Application Routing add-on settings for the ingress profile." + }, + "ManagedClusterSecurityProfile": { + "type": "object", + "properties": { + "defender": { + "$ref": "#/definitions/ManagedClusterSecurityProfileDefender", + "description": "Microsoft Defender settings for the security profile." + }, + "azureKeyVaultKms": { + "$ref": "#/definitions/AzureKeyVaultKms", + "description": "Azure Key Vault [key management service](https://kubernetes.io/docs/tasks/administer-cluster/kms-provider/) settings for the security profile." + }, + "workloadIdentity": { + "$ref": "#/definitions/ManagedClusterSecurityProfileWorkloadIdentity", + "description": "Workload identity settings for the security profile. Workload identity enables Kubernetes applications to access Azure cloud resources securely with Azure AD. See https://aka.ms/aks/wi for more details." + }, + "imageCleaner": { + "$ref": "#/definitions/ManagedClusterSecurityProfileImageCleaner", + "description": "Image Cleaner settings for the security profile." + } + }, + "description": "Security profile for the container service cluster." + }, + "AzureKeyVaultKms": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Azure Key Vault key management service. The default is false." + }, + "keyId": { + "type": "string", + "description": "Identifier of Azure Key Vault key. See [key identifier format](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#vault-name-and-object-name) for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty." + }, + "keyVaultNetworkAccess": { + "type": "string", + "enum": [ + "Public", + "Private" + ], + "default": "Public", + "x-ms-enum": { + "name": "KeyVaultNetworkAccessTypes", + "modelAsString": true + }, + "title": "Network access of the key vault", + "description": "Network access of key vault. The possible values are `Public` and `Private`. `Public` means the key vault allows public access from all networks. `Private` means the key vault disables public access and enables private link. The default value is `Public`." + }, + "keyVaultResourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + }, + "description": "Resource ID of key vault. When keyVaultNetworkAccess is `Private`, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is `Public`, leave the field empty." + } + }, + "description": "Azure Key Vault key management service settings for the security profile." + }, + "ManagedClusterSecurityProfileWorkloadIdentity": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable workload identity." + } + }, + "description": "Workload identity settings for the security profile." + }, + "ManagedClusterSecurityProfileImageCleaner": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Image Cleaner on AKS cluster." + }, + "intervalHours": { + "type": "integer", + "format": "int32", + "description": "Image Cleaner scanning interval in hours." + } + }, + "description": "Image Cleaner removes unused images from nodes, freeing up disk space and helping to reduce attack surface area. Here are settings for the security profile." + }, + "ManagedClusterStorageProfile": { + "type": "object", + "properties": { + "diskCSIDriver": { + "$ref": "#/definitions/ManagedClusterStorageProfileDiskCSIDriver", + "description": "AzureDisk CSI Driver settings for the storage profile." + }, + "fileCSIDriver": { + "$ref": "#/definitions/ManagedClusterStorageProfileFileCSIDriver", + "description": "AzureFile CSI Driver settings for the storage profile." + }, + "snapshotController": { + "$ref": "#/definitions/ManagedClusterStorageProfileSnapshotController", + "description": "Snapshot Controller settings for the storage profile." + }, + "blobCSIDriver": { + "$ref": "#/definitions/ManagedClusterStorageProfileBlobCSIDriver", + "description": "AzureBlob CSI Driver settings for the storage profile." + } + }, + "description": "Storage profile for the container service cluster." + }, + "ManagedClusterSecurityProfileDefender": { + "type": "object", + "properties": { + "logAnalyticsWorkspaceResourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.OperationalInsights/workspaces" + } + ] + }, + "description": "Resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty." + }, + "securityMonitoring": { + "$ref": "#/definitions/ManagedClusterSecurityProfileDefenderSecurityMonitoring", + "description": "Microsoft Defender threat detection for Cloud settings for the security profile." + } + }, + "description": "Microsoft Defender settings for the security profile." + }, + "ManagedClusterSecurityProfileDefenderSecurityMonitoring": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Defender threat detection" + } + }, + "description": "Microsoft Defender settings for the security profile threat detection." + }, + "ManagedClusterStorageProfileDiskCSIDriver": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AzureDisk CSI Driver. The default value is true." + } + }, + "description": "AzureDisk CSI Driver settings for the storage profile." + }, + "ManagedClusterStorageProfileFileCSIDriver": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AzureFile CSI Driver. The default value is true." + } + }, + "description": "AzureFile CSI Driver settings for the storage profile." + }, + "ManagedClusterStorageProfileSnapshotController": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Snapshot Controller. The default value is true." + } + }, + "description": "Snapshot Controller settings for the storage profile." + }, + "ManagedClusterStorageProfileBlobCSIDriver": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AzureBlob CSI Driver. The default value is false." + } + }, + "description": "AzureBlob CSI Driver settings for the storage profile." + }, + "CreationData": { + "description": "Data used when creating a target resource from a source resource.", + "type": "object", + "properties": { + "sourceResourceId": { + "type": "string", + "format": "arm-id", + "description": "This is the ARM ID of the source object to be used to create the target object." + } + } + }, + "SnapshotListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Snapshot" + }, + "description": "The list of snapshots." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of snapshot results.", + "readOnly": true + } + }, + "description": "The response from the List Snapshots operation." + }, + "Snapshot": { + "type": "object", + "properties": { + "properties": { + "description": "Properties of a snapshot.", + "$ref": "#/definitions/SnapshotProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "A node pool snapshot resource." + }, + "SnapshotProperties": { + "type": "object", + "properties": { + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "CreationData to be used to specify the source agent pool resource ID to create this snapshot." + }, + "snapshotType": { + "$ref": "#/definitions/SnapshotType" + }, + "kubernetesVersion": { + "readOnly": true, + "type": "string", + "description": "The version of Kubernetes." + }, + "nodeImageVersion": { + "readOnly": true, + "type": "string", + "description": "The version of node image." + }, + "osType": { + "readOnly": true, + "$ref": "#/definitions/OSType" + }, + "osSku": { + "readOnly": true, + "$ref": "#/definitions/OSSKU" + }, + "vmSize": { + "readOnly": true, + "type": "string", + "description": "The size of the VM." + }, + "enableFIPS": { + "readOnly": true, + "type": "boolean", + "description": "Whether to use a FIPS-enabled OS." + } + }, + "description": "Properties used to configure a node pool snapshot." + }, + "SnapshotType": { + "type": "string", + "default": "NodePool", + "enum": [ + "NodePool" + ], + "x-ms-enum": { + "name": "SnapshotType", + "modelAsString": true, + "values": [ + { + "value": "NodePool", + "description": "The snapshot is a snapshot of a node pool." + } + ] + }, + "description": "The type of a snapshot. The default is NodePool." + }, + "ManagedClusterWorkloadAutoScalerProfile": { + "type": "object", + "description": "Workload Auto-scaler profile for the managed cluster.", + "properties": { + "keda": { + "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfileKeda" + }, + "verticalPodAutoscaler": { + "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler" + } + } + }, + "ManagedClusterWorkloadAutoScalerProfileKeda": { + "type": "object", + "description": "KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable KEDA." + } + }, + "required": [ + "enabled" + ] + }, + "ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler": { + "type": "object", + "description": "VPA (Vertical Pod Autoscaler) settings for the workload auto-scaler profile.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable VPA. Default value is false.", + "default": false + } + }, + "required": [ + "enabled" + ] + }, + "ManagedClusterAzureMonitorProfile": { + "type": "object", + "description": "Azure Monitor addon profiles for monitoring the managed cluster.", + "properties": { + "metrics": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileMetrics" + } + } + }, + "ManagedClusterAzureMonitorProfileKubeStateMetrics": { + "type": "object", + "description": "Kube State Metrics profile for the Azure Managed Prometheus addon. These optional settings are for the kube-state-metrics pod that is deployed with the addon. See aka.ms/AzureManagedPrometheus-optional-parameters for details.", + "properties": { + "metricLabelsAllowlist": { + "type": "string", + "description": "Comma-separated list of additional Kubernetes label keys that will be used in the resource's labels metric (Example: 'namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...'). By default the metric contains only resource name and namespace labels." + }, + "metricAnnotationsAllowList": { + "type": "string", + "description": "Comma-separated list of Kubernetes annotation keys that will be used in the resource's labels metric (Example: 'namespaces=[kubernetes.io/team,...],pods=[kubernetes.io/team],...'). By default the metric contains only resource name and namespace labels." + } + } + }, + "ManagedClusterAzureMonitorProfileMetrics": { + "type": "object", + "description": "Metrics profile for the Azure Monitor managed service for Prometheus addon. Collect out-of-the-box Kubernetes infrastructure metrics to send to an Azure Monitor Workspace and configure additional scraping for custom targets. See aka.ms/AzureManagedPrometheus for an overview.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable or disable the Azure Managed Prometheus addon for Prometheus monitoring. See aka.ms/AzureManagedPrometheus-aks-enable for details on enabling and disabling." + }, + "kubeStateMetrics": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileKubeStateMetrics" + } + }, + "required": [ + "enabled" + ] + }, + "ServiceMeshProfile": { + "type": "object", + "description": "Service mesh profile for a managed cluster.", + "properties": { + "mode": { + "type": "string", + "description": "Mode of the service mesh.", + "enum": [ + "Istio", + "Disabled" + ], + "x-ms-enum": { + "name": "ServiceMeshMode", + "modelAsString": true, + "values": [ + { + "value": "Istio", + "description": "Istio deployed as an AKS addon." + }, + { + "value": "Disabled", + "description": "Mesh is disabled." + } + ] + } + }, + "istio": { + "$ref": "#/definitions/IstioServiceMesh" + } + }, + "required": [ + "mode" + ] + }, + "IstioServiceMesh": { + "type": "object", + "description": "Istio service mesh configuration.", + "properties": { + "components": { + "$ref": "#/definitions/IstioComponents" + }, + "certificateAuthority": { + "$ref": "#/definitions/IstioCertificateAuthority" + }, + "revisions": { + "type": "array", + "description": "The list of revisions of the Istio control plane. When an upgrade is not in progress, this holds one value. When canary upgrade is in progress, this can only hold two consecutive values. For more information, see: https://learn.microsoft.com/en-us/azure/aks/istio-upgrade", + "items": { + "type": "string" + }, + "uniqueItems": true, + "maxItems": 2 + } + } + }, + "IstioComponents": { + "type": "object", + "description": "Istio components configuration.", + "properties": { + "ingressGateways": { + "type": "array", + "description": "Istio ingress gateways.", + "items": { + "$ref": "#/definitions/IstioIngressGateway" + }, + "x-ms-identifiers": [] + }, + "egressGateways": { + "type": "array", + "description": "Istio egress gateways.", + "items": { + "$ref": "#/definitions/IstioEgressGateway" + }, + "x-ms-identifiers": [] + } + } + }, + "IstioIngressGateway": { + "type": "object", + "description": "Istio ingress gateway configuration. For now, we support up to one external ingress gateway named `aks-istio-ingressgateway-external` and one internal ingress gateway named `aks-istio-ingressgateway-internal`.", + "properties": { + "mode": { + "type": "string", + "description": "Mode of an ingress gateway.", + "enum": [ + "External", + "Internal" + ], + "x-ms-enum": { + "name": "IstioIngressGatewayMode", + "modelAsString": true, + "values": [ + { + "value": "External", + "description": "The ingress gateway is assigned a public IP address and is publicly accessible." + }, + { + "value": "Internal", + "description": "The ingress gateway is assigned an internal IP address and cannot is accessed publicly." + } + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to enable the ingress gateway." + } + }, + "required": [ + "mode", + "enabled" + ] + }, + "IstioCertificateAuthority": { + "type": "object", + "description": "Istio Service Mesh Certificate Authority (CA) configuration. For now, we only support plugin certificates as described here https://aka.ms/asm-plugin-ca", + "properties": { + "plugin": { + "$ref": "#/definitions/IstioPluginCertificateAuthority" + } + } + }, + "IstioPluginCertificateAuthority": { + "type": "object", + "description": "Plugin certificates information for Service Mesh.", + "properties": { + "keyVaultId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + }, + "description": "The resource ID of the Key Vault." + }, + "certObjectName": { + "type": "string", + "description": "Intermediate certificate object name in Azure Key Vault." + }, + "keyObjectName": { + "type": "string", + "description": "Intermediate certificate private key object name in Azure Key Vault." + }, + "rootCertObjectName": { + "type": "string", + "description": "Root certificate object name in Azure Key Vault." + }, + "certChainObjectName": { + "type": "string", + "description": "Certificate chain object name in Azure Key Vault." + } + } + }, + "IstioEgressGateway": { + "type": "object", + "description": "Istio egress gateway configuration.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable the egress gateway." + } + }, + "required": [ + "enabled" + ] + }, + "MeshRevisionProfileList": { + "type": "object", + "description": "Holds an array of MeshRevisionsProfiles", + "properties": { + "value": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MeshRevisionProfile" + }, + "description": "Array of service mesh add-on revision profiles for all supported mesh modes." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of mesh revision profile.", + "readOnly": true + } + } + }, + "MeshRevisionProfile": { + "type": "object", + "description": "Mesh revision profile for a mesh.", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MeshRevisionProfileProperties" + } + } + }, + "MeshRevisionProfileProperties": { + "type": "object", + "description": "Mesh revision profile properties for a mesh", + "properties": { + "meshRevisions": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MeshRevision" + } + } + } + }, + "MeshUpgradeProfileList": { + "type": "object", + "description": "Holds an array of MeshUpgradeProfiles", + "properties": { + "value": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MeshUpgradeProfile" + }, + "description": "Array of supported service mesh add-on upgrade profiles." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of mesh upgrade profile.", + "readOnly": true + } + } + }, + "MeshUpgradeProfile": { + "type": "object", + "description": "Upgrade profile for given mesh.", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MeshUpgradeProfileProperties" + } + } + }, + "MeshUpgradeProfileProperties": { + "type": "object", + "description": "Mesh upgrade profile properties for a major.minor release.", + "allOf": [ + { + "$ref": "#/definitions/MeshRevision" + } + ] + }, + "MeshRevision": { + "type": "object", + "description": "Holds information on upgrades and compatibility for given major.minor mesh release.", + "properties": { + "revision": { + "type": "string", + "description": "The revision of the mesh release." + }, + "upgrades": { + "type": "array", + "description": "List of revisions available for upgrade of a specific mesh revision", + "items": { + "type": "string", + "description": "An upgradeable mesh revision" + } + }, + "compatibleWith": { + "type": "array", + "description": "List of items this revision of service mesh is compatible with, and their associated versions.", + "items": { + "$ref": "#/definitions/CompatibleVersions" + }, + "x-ms-identifiers": [] + } + } + }, + "CompatibleVersions": { + "type": "object", + "description": "Version information about a product/service that is compatible with a service mesh revision.", + "properties": { + "name": { + "type": "string", + "description": "The product/service name." + }, + "versions": { + "type": "array", + "description": "Product/service versions compatible with a service mesh add-on revision.", + "items": { + "type": "string", + "description": "A compatible product/service version." + } + } + } + }, + "KubernetesSupportPlan": { + "type": "string", + "description": "Different support tiers for AKS managed clusters", + "enum": [ + "KubernetesOfficial", + "AKSLongTermSupport" + ], + "x-ms-enum": { + "name": "KubernetesSupportPlan", + "modelAsString": true, + "values": [ + { + "value": "KubernetesOfficial", + "description": "Support for the version is the same as for the open source Kubernetes offering. Official Kubernetes open source community support versions for 1 year after release." + }, + { + "value": "AKSLongTermSupport", + "description": "Support for the version extended past the KubernetesOfficial support of 1 year. AKS continues to patch CVEs for another 1 year, for a total of 2 years of support." + } + ] + } + }, + "KubernetesVersionCapabilities": { + "type": "object", + "description": "Capabilities on this Kubernetes version.", + "properties": { + "supportPlan": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/KubernetesSupportPlan" + } + } + } + }, + "KubernetesPatchVersion": { + "type": "object", + "description": "Kubernetes patch version profile", + "properties": { + "upgrades": { + "type": "array", + "description": "Possible upgrade path for given patch version", + "x-ms-identifiers": [], + "items": { + "type": "string" + } + } + } + }, + "KubernetesVersion": { + "type": "object", + "description": "Kubernetes version profile for given major.minor release.", + "properties": { + "version": { + "type": "string", + "description": "major.minor version of Kubernetes release" + }, + "capabilities": { + "$ref": "#/definitions/KubernetesVersionCapabilities", + "description": "Capabilities on this Kubernetes version." + }, + "isDefault": { + "type": "boolean", + "description": "Whether this version is default." + }, + "isPreview": { + "type": "boolean", + "description": "Whether this version is in preview mode." + }, + "patchVersions": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/KubernetesPatchVersion" + }, + "description": "Patch versions of Kubernetes release" + } + } + }, + "KubernetesVersionListResult": { + "type": "object", + "description": "Hold values properties, which is array of KubernetesVersion", + "properties": { + "values": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/KubernetesVersion" + }, + "description": "Array of AKS supported Kubernetes versions." + } + } + }, + "ManagedClusterMetricsProfile": { + "type": "object", + "description": "The metrics profile for the ManagedCluster.", + "properties": { + "costAnalysis": { + "$ref": "#/definitions/ManagedClusterCostAnalysis", + "title": "The configuration for detailed per-Kubernetes resource cost analysis." + } + } + }, + "ManagedClusterCostAnalysis": { + "type": "object", + "description": "The cost analysis configuration for the cluster", + "properties": { + "enabled": { + "type": "boolean", + "title": "Whether to enable cost analysis", + "description": "The Managed Cluster sku.tier must be set to 'Standard' or 'Premium' to enable this feature. Enabling this will add Kubernetes Namespace and Deployment details to the Cost Analysis views in the Azure portal. If not specified, the default is false. For more information see aka.ms/aks/docs/cost-analysis." + } + } + }, + "TrustedAccessRoleRule": { + "type": "object", + "description": "Rule for trusted access role", + "properties": { + "verbs": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed verbs" + }, + "apiGroups": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed apiGroups" + }, + "resources": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed resources" + }, + "resourceNames": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed names" + }, + "nonResourceURLs": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed nonResourceURLs" + } + } + }, + "TrustedAccessRole": { + "type": "object", + "description": "Trusted access role definition.", + "properties": { + "sourceResourceType": { + "type": "string", + "readOnly": true, + "description": "Resource type of Azure resource" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Name of role, name is unique under a source resource type" + }, + "rules": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TrustedAccessRoleRule" + }, + "x-ms-identifiers": [], + "description": "List of rules for the role. This maps to 'rules' property of [Kubernetes Cluster Role](https://kubernetes.io/docs/reference/kubernetes-api/authorization-resources/cluster-role-v1/#ClusterRole)." + } + } + }, + "TrustedAccessRoleBindingProperties": { + "type": "object", + "description": "Properties for trusted access role binding", + "required": [ + "sourceResourceId", + "roles" + ], + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state of trusted access role binding.", + "enum": [ + "Canceled", + "Deleting", + "Failed", + "Succeeded", + "Updating" + ], + "x-ms-enum": { + "name": "TrustedAccessRoleBindingProvisioningState", + "modelAsString": true + } + }, + "sourceResourceId": { + "type": "string", + "format": "arm-id", + "description": "The ARM resource ID of source resource that trusted access is configured for." + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of roles to bind, each item is a resource type qualified role name. For example: 'Microsoft.MachineLearningServices/workspaces/reader'." + } + } + }, + "TrustedAccessRoleBinding": { + "type": "object", + "description": "Defines binding between a resource and role", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TrustedAccessRoleBindingProperties", + "x-ms-client-flatten": true + } + } + }, + "TrustedAccessRoleBindingListResult": { + "type": "object", + "description": "List of trusted access role bindings", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + }, + "description": "Role binding list" + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "TrustedAccessRoleListResult": { + "type": "object", + "description": "List of trusted access roles", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TrustedAccessRole" + }, + "x-ms-identifiers": [ + "sourceResourceType", + "name" + ], + "description": "Role list" + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "CapacityReservationGroupID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/CapacityReservationGroups" + } + ] + }, + "title": "The fully qualified resource ID of the Capacity Reservation Group to provide virtual machines from a reserved group of Virtual Machines.", + "description": "This is of the form: '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Compute/capacityreservationgroups/{capacityReservationGroupName}' Customers use it to create an agentpool with a specified CRG. For more information see [Capacity Reservation](https://learn.microsoft.com/en-us/azure/virtual-machines/capacity-reservation-overview)" + } + }, + "parameters": { + "ResourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "description": "The name of the managed cluster resource.", + "x-ms-parameter-location": "method" + }, + "AgentPoolNameParameter": { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]{0,11}$", + "minLength": 1, + "maxLength": 12, + "description": "The name of the agent pool.", + "x-ms-parameter-location": "method" + }, + "ResourceTypeParameter": { + "name": "resource-type", + "in": "query", + "required": false, + "type": "string", + "description": "The resource type for which the OS options needs to be returned", + "x-ms-parameter-location": "method" + }, + "ServerFqdnParameter": { + "name": "server-fqdn", + "in": "query", + "required": false, + "type": "string", + "description": "server fqdn type for credentials to be returned", + "x-ms-parameter-location": "method" + }, + "TrustedAccessRoleBindingNameParameter": { + "name": "trustedAccessRoleBindingName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of trusted access role binding.", + "pattern": "^([A-Za-z0-9-])+$", + "minLength": 1, + "maxLength": 24, + "x-ms-parameter-location": "method" + }, + "CredentialFormatParameter": { + "name": "format", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "exec", + "azure" + ], + "x-ms-enum": { + "name": "format", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Return azure auth-provider kubeconfig. This format is deprecated in v1.22 and will be fully removed in v1.26. See: https://aka.ms/k8s/changes-1-26." + }, + { + "value": "exec", + "description": "Return exec format kubeconfig. This format requires kubelogin binary in the path." + } + ] + }, + "description": "Only apply to AAD clusters, specifies the format of returned kubeconfig. Format 'azure' will return azure auth-provider kubeconfig; format 'exec' will return exec format kubeconfig, which requires kubelogin binary in the path.", + "x-ms-parameter-location": "method" + }, + "MeshModeParameter": { + "name": "mode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "description": "The mode of the mesh.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-03-15-preview/fleets.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-03-15-preview/fleets.json index bf1161cc3a11..e417235fe678 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-03-15-preview/fleets.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-03-15-preview/fleets.json @@ -1567,6 +1567,7 @@ "properties": { "properties": { "$ref": "#/definitions/FleetMemberUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-06-15-preview/fleets.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-06-15-preview/fleets.json index ea0d25f30e1d..34920e3e1e53 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-06-15-preview/fleets.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-06-15-preview/fleets.json @@ -1667,6 +1667,7 @@ "properties": { "properties": { "$ref": "#/definitions/FleetMemberUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-08-15-preview/fleets.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-08-15-preview/fleets.json index 783d024a09ab..8e46f5fb8893 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-08-15-preview/fleets.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-08-15-preview/fleets.json @@ -1976,6 +1976,7 @@ "properties": { "properties": { "$ref": "#/definitions/FleetMemberUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2024-02-02-preview/fleets.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2024-02-02-preview/fleets.json index a83cfbde5750..7fb3a46f3a10 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2024-02-02-preview/fleets.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2024-02-02-preview/fleets.json @@ -2070,6 +2070,7 @@ "properties": { "properties": { "$ref": "#/definitions/FleetMemberUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2023-10-15/fleets.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2023-10-15/fleets.json index c184493e1f2d..aa4b4ff1e51f 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2023-10-15/fleets.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2023-10-15/fleets.json @@ -1876,6 +1876,7 @@ "properties": { "properties": { "$ref": "#/definitions/FleetMemberUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2024-04-01/fleets.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2024-04-01/fleets.json index 01ed08549633..ef8fba3a38b8 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2024-04-01/fleets.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2024-04-01/fleets.json @@ -2054,6 +2054,7 @@ "properties": { "properties": { "$ref": "#/definitions/FleetMemberUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } diff --git a/specification/containerstorage/ContainerStorage.Management/pool.tsp b/specification/containerstorage/ContainerStorage.Management/pool.tsp index 662e943c31e3..67ca32577450 100644 --- a/specification/containerstorage/ContainerStorage.Management/pool.tsp +++ b/specification/containerstorage/ContainerStorage.Management/pool.tsp @@ -25,7 +25,10 @@ interface Pools { LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; delete is ArmResourceDeleteWithoutOkAsync; - update is ArmResourcePatchAsync; + update is ArmCustomPatchAsync< + Pool, + Azure.ResourceManager.Foundations.ResourceUpdateModel + >; listByResourceGroup is ArmResourceListByParent; listBySubscription is ArmListBySubscription; } diff --git a/specification/containerstorage/ContainerStorage.Management/tspconfig.yaml b/specification/containerstorage/ContainerStorage.Management/tspconfig.yaml index a8b7fc07b7bd..b4bcbcb76b28 100644 --- a/specification/containerstorage/ContainerStorage.Management/tspconfig.yaml +++ b/specification/containerstorage/ContainerStorage.Management/tspconfig.yaml @@ -8,6 +8,9 @@ linter: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true emitter-output-dir: "{project-root}/.." examples-directory: "{project-root}/examples" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/containerstorage.json" diff --git a/specification/containerstorage/ContainerStorage.Management/volume.tsp b/specification/containerstorage/ContainerStorage.Management/volume.tsp index 4187903a5615..dccfe3cade40 100644 --- a/specification/containerstorage/ContainerStorage.Management/volume.tsp +++ b/specification/containerstorage/ContainerStorage.Management/volume.tsp @@ -25,7 +25,13 @@ interface Volumes { LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; delete is ArmResourceDeleteWithoutOkAsync; - update is ArmResourcePatchAsync; + update is ArmCustomPatchAsync< + Volume, + Azure.ResourceManager.Foundations.ResourceUpdateModel< + Volume, + VolumeProperties + > + >; listByPool is ArmResourceListByParent; } diff --git a/specification/containerstorage/resource-manager/Microsoft.ContainerStorage/preview/2023-07-01-preview/containerstorage.json b/specification/containerstorage/resource-manager/Microsoft.ContainerStorage/preview/2023-07-01-preview/containerstorage.json index 94ead5e8046e..bf51534184d9 100644 --- a/specification/containerstorage/resource-manager/Microsoft.ContainerStorage/preview/2023-07-01-preview/containerstorage.json +++ b/specification/containerstorage/resource-manager/Microsoft.ContainerStorage/preview/2023-07-01-preview/containerstorage.json @@ -1557,6 +1557,7 @@ }, "properties": { "$ref": "#/definitions/PoolUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } @@ -1891,6 +1892,7 @@ "properties": { "properties": { "$ref": "#/definitions/VolumeUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/cosmos-db.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/cosmos-db.json index e9c2fa63c576..0a074ad9a025 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/cosmos-db.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/cosmos-db.json @@ -7031,7 +7031,7 @@ "$ref": "#/definitions/MinimalTlsVersion" }, "enableBurstCapacity": { - "description": "Flag to indicate enabling/disabling of Burst Capacity Preview feature on the account", + "description": "Flag to indicate enabling/disabling of Burst Capacity feature on the account", "type": "boolean" }, "customerManagedKeyStatus": { @@ -7190,7 +7190,7 @@ "$ref": "#/definitions/MinimalTlsVersion" }, "enableBurstCapacity": { - "description": "Flag to indicate enabling/disabling of Burst Capacity Preview feature on the account", + "description": "Flag to indicate enabling/disabling of Burst Capacity feature on the account", "type": "boolean" }, "customerManagedKeyStatus": { @@ -7373,7 +7373,7 @@ "$ref": "#/definitions/MinimalTlsVersion" }, "enableBurstCapacity": { - "description": "Flag to indicate enabling/disabling of Burst Capacity Preview feature on the account", + "description": "Flag to indicate enabling/disabling of Burst Capacity feature on the account", "type": "boolean" }, "customerManagedKeyStatus": { diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/cosmos-db.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/cosmos-db.json index 3099c62c63bf..f49127859c4c 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/cosmos-db.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/cosmos-db.json @@ -7031,7 +7031,7 @@ "$ref": "#/definitions/MinimalTlsVersion" }, "enableBurstCapacity": { - "description": "Flag to indicate enabling/disabling of Burst Capacity Preview feature on the account", + "description": "Flag to indicate enabling/disabling of Burst Capacity feature on the account", "type": "boolean" }, "customerManagedKeyStatus": { @@ -7189,7 +7189,7 @@ "$ref": "#/definitions/MinimalTlsVersion" }, "enableBurstCapacity": { - "description": "Flag to indicate enabling/disabling of Burst Capacity Preview feature on the account", + "description": "Flag to indicate enabling/disabling of Burst Capacity feature on the account", "type": "boolean" }, "customerManagedKeyStatus": { @@ -7371,7 +7371,7 @@ "$ref": "#/definitions/MinimalTlsVersion" }, "enableBurstCapacity": { - "description": "Flag to indicate enabling/disabling of Burst Capacity Preview feature on the account", + "description": "Flag to indicate enabling/disabling of Burst Capacity feature on the account", "type": "boolean" }, "customerManagedKeyStatus": { diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json index 509eaec49551..e4743f826f78 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json @@ -7031,7 +7031,7 @@ "$ref": "#/definitions/MinimalTlsVersion" }, "enableBurstCapacity": { - "description": "Flag to indicate enabling/disabling of Burst Capacity Preview feature on the account", + "description": "Flag to indicate enabling/disabling of Burst Capacity feature on the account", "type": "boolean" }, "customerManagedKeyStatus": { @@ -7189,7 +7189,7 @@ "$ref": "#/definitions/MinimalTlsVersion" }, "enableBurstCapacity": { - "description": "Flag to indicate enabling/disabling of Burst Capacity Preview feature on the account", + "description": "Flag to indicate enabling/disabling of Burst Capacity feature on the account", "type": "boolean" }, "customerManagedKeyStatus": { @@ -7371,7 +7371,7 @@ "$ref": "#/definitions/MinimalTlsVersion" }, "enableBurstCapacity": { - "description": "Flag to indicate enabling/disabling of Burst Capacity Preview feature on the account", + "description": "Flag to indicate enabling/disabling of Burst Capacity feature on the account", "type": "boolean" }, "customerManagedKeyStatus": { diff --git a/specification/databasewatcher/DatabaseWatcher.Management/baseTarget.tsp b/specification/databasewatcher/DatabaseWatcher.Management/baseTarget.tsp index 41140fbc6587..858947f1d82d 100644 --- a/specification/databasewatcher/DatabaseWatcher.Management/baseTarget.tsp +++ b/specification/databasewatcher/DatabaseWatcher.Management/baseTarget.tsp @@ -15,7 +15,7 @@ interface Targets { get is ArmResourceRead; createOrUpdate is ArmResourceCreateOrReplaceSync; delete is ArmResourceDeleteSync; - listByParent is ArmResourceListByParent; + listByWatcher is ArmResourceListByParent; } @parentResource(Watcher) diff --git a/specification/databasewatcher/DatabaseWatcher.Management/sharedPrivateLinkResource.tsp b/specification/databasewatcher/DatabaseWatcher.Management/sharedPrivateLinkResource.tsp index c34f20441d50..f8b631e9dedf 100644 --- a/specification/databasewatcher/DatabaseWatcher.Management/sharedPrivateLinkResource.tsp +++ b/specification/databasewatcher/DatabaseWatcher.Management/sharedPrivateLinkResource.tsp @@ -19,7 +19,7 @@ interface SharedPrivateLinkResources { LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; delete is ArmResourceDeleteWithoutOkAsync; - listByParent is ArmResourceListByParent; + listByWatcher is ArmResourceListByParent; } @parentResource(Watcher) diff --git a/specification/databasewatcher/DatabaseWatcher.Management/tspconfig.yaml b/specification/databasewatcher/DatabaseWatcher.Management/tspconfig.yaml index 9f6f5fd2adb2..7734a098531f 100644 --- a/specification/databasewatcher/DatabaseWatcher.Management/tspconfig.yaml +++ b/specification/databasewatcher/DatabaseWatcher.Management/tspconfig.yaml @@ -4,6 +4,9 @@ options: "@azure-tools/typespec-autorest": emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true examples-directory: "{project-root}/examples" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/Watcher.json" use-read-only-status-schema: true diff --git a/specification/databasewatcher/DatabaseWatcher.Management/watcher.tsp b/specification/databasewatcher/DatabaseWatcher.Management/watcher.tsp index 4d90639e4cf3..778db58f7aa7 100644 --- a/specification/databasewatcher/DatabaseWatcher.Management/watcher.tsp +++ b/specification/databasewatcher/DatabaseWatcher.Management/watcher.tsp @@ -112,7 +112,13 @@ interface Watchers { Watcher, LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; - update is ArmResourcePatchAsync; + update is ArmCustomPatchAsync< + Watcher, + Azure.ResourceManager.Foundations.ResourceUpdateModel< + Watcher, + WatcherProperties + > + >; delete is ArmResourceDeleteWithoutOkAsync; listByResourceGroup is ArmResourceListByParent; listBySubscription is ArmListBySubscription; diff --git a/specification/databasewatcher/resource-manager/Microsoft.DatabaseWatcher/preview/2023-09-01-preview/Watcher.json b/specification/databasewatcher/resource-manager/Microsoft.DatabaseWatcher/preview/2023-09-01-preview/Watcher.json index b0562b8ed9cb..506c64981c78 100644 --- a/specification/databasewatcher/resource-manager/Microsoft.DatabaseWatcher/preview/2023-09-01-preview/Watcher.json +++ b/specification/databasewatcher/resource-manager/Microsoft.DatabaseWatcher/preview/2023-09-01-preview/Watcher.json @@ -1718,6 +1718,7 @@ }, "properties": { "$ref": "#/definitions/WatcherUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } 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 22a1f81ad6e5..8d62b404c159 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 @@ -107,13 +107,33 @@ "typeProperties": { "description": "Azure Table Storage linked service properties.", "x-ms-client-flatten": true, - "$ref": "#/definitions/AzureStorageLinkedServiceTypeProperties" + "$ref": "#/definitions/AzureTableStorageLinkedServiceTypeProperties" } }, "required": [ "typeProperties" ] }, + "AzureTableStorageLinkedServiceTypeProperties": { + "description": "Azure Table Storage linked service properties.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureStorageLinkedServiceTypeProperties" + } + ], + "properties": { + "serviceEndpoint": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Table service endpoint of the Azure Table Storage resource. It is mutually exclusive with connectionString, sasUri property." + }, + "credential": { + "$ref": "../datafactory.json#/definitions/CredentialReference", + "description": "The credential reference containing authentication information." + } + } + }, "AzureStorageLinkedServiceTypeProperties": { "description": "Azure Storage linked service properties.", "type": "object", @@ -1029,7 +1049,12 @@ "authenticationType": { "type": "object", "x-ms-format": "dfe-string", - "description": "The authentication type to connect to Dynamics server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string)." + "description": "The authentication type to connect to Dynamics server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario, 'Active Directory' for Dynamics on-premises with IFD. Type: string (or Expression with resultType string)." + }, + "domain": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The Active Directory domain that will verify user credentials. Type: string (or Expression with resultType string)." }, "username": { "type": "object", @@ -1086,7 +1111,8 @@ "enum": [ "Office365", "Ifd", - "AADServicePrincipal" + "AADServicePrincipal", + "Active Directory" ], "x-ms-enum": { "name": "DynamicsAuthenticationType", @@ -1145,7 +1171,12 @@ "authenticationType": { "type": "object", "x-ms-format": "dfe-string", - "description": "The authentication type to connect to Dynamics CRM server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string)." + "description": "The authentication type to connect to Dynamics CRM server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario, 'Active Directory' for Dynamics on-premises with IFD. Type: string (or Expression with resultType string)." + }, + "domain": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The Active Directory domain that will verify user credentials. Type: string (or Expression with resultType string)." }, "username": { "type": "object", @@ -1248,7 +1279,12 @@ "authenticationType": { "type": "object", "x-ms-format": "dfe-string", - "description": "The authentication type to connect to Common Data Service for Apps server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario. 'AADServicePrincipal' for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string)." + "description": "The authentication type to connect to Common Data Service for Apps server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario. 'AADServicePrincipal' for Server-To-Server authentication in online scenario, 'Active Directory' for Dynamics on-premises with IFD. Type: string (or Expression with resultType string)." + }, + "domain": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The Active Directory domain that will verify user credentials. Type: string (or Expression with resultType string)." }, "username": { "type": "object", @@ -1464,6 +1500,15 @@ "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." + }, + "serviceEndpoint": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "File service endpoint of the Azure File Storage resource. It is mutually exclusive with connectionString, sasUri property." + }, + "credential": { + "$ref": "../datafactory.json#/definitions/CredentialReference", + "description": "The credential reference containing authentication information." } } }, @@ -6710,8 +6755,28 @@ "properties": { "connectionString": { "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "x-ms-format": "dfe-string", + "type": "object" + }, + "server": { "type": "object", - "x-ms-format": "dfe-string" + "x-ms-format": "dfe-string", + "description": "Server name for connection. Type: string." + }, + "port": { + "type": "object", + "x-ms-format": "dfe-int", + "description": "The port for the connection. Type: integer." + }, + "uid": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Username for authentication. Type: string." + }, + "database": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Database name for connection. Type: string." }, "pwd": { "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", diff --git a/specification/datafactory/resource-manager/sdk-suppressions.yaml b/specification/datafactory/resource-manager/sdk-suppressions.yaml index 28a8fe5b1b1c..d72e025afa13 100644 --- a/specification/datafactory/resource-manager/sdk-suppressions.yaml +++ b/specification/datafactory/resource-manager/sdk-suppressions.yaml @@ -7,8 +7,7 @@ suppressions: azure-sdk-for-go: - package: sdk/resourcemanager/datafactory/armdatafactory breaking-changes: - - Enum `ScriptType` has been removed - - Field `Operator` of struct `ExpressionV2` has been removed + - Type of `AzureTableStorageLinkedService.TypeProperties` has been changed from `*AzureStorageLinkedServiceTypeProperties` to `*AzureTableStorageLinkedServiceTypeProperties` azure-sdk-for-js: - package: "@azure/arm-datafactory" breaking-changes: diff --git a/specification/dataprotection/resource-manager/readme.java.md b/specification/dataprotection/resource-manager/readme.java.md index d31e94aab483..e751a276470d 100644 --- a/specification/dataprotection/resource-manager/readme.java.md +++ b/specification/dataprotection/resource-manager/readme.java.md @@ -10,9 +10,57 @@ namespace: com.microsoft.azure.management.dataprotection license-header: MICROSOFT_MIT_NO_CODEGEN payload-flattening-threshold: 1 output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-dataprotection +directive: + - from: dataprotection.json + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}"].put.parameters + transform: > + $.splice(5, 1); + return $; + reason: hide x-ms-authorization-auxiliary header + - from: dataprotection.json + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}"].patch.parameters + transform: > + $.splice(5, 1); + return $; + reason: hide x-ms-authorization-auxiliary header + - from: dataprotection.json + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}"].put.parameters + transform: > + $.splice(6, 1); + return $; + reason: hide x-ms-authorization-auxiliary header + - from: dataprotection.json + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}"].delete.parameters + transform: > + $.splice(5, 1); + return $; + reason: hide x-ms-authorization-auxiliary header + - from: dataprotection.json + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/restore"].post.parameters + transform: > + $.splice(6, 1); + return $; + reason: hide x-ms-authorization-auxiliary header + - from: dataprotection.json + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/stopProtection"].post.parameters + transform: > + $.splice(6, 1); + return $; + reason: hide x-ms-authorization-auxiliary header + - from: dataprotection.json + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/suspendBackups"].post.parameters + transform: > + $.splice(6, 1); + return $; + reason: hide x-ms-authorization-auxiliary header + - from: dataprotection.json + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}/unlockDelete"].post.parameters + transform: > + $.splice(6, 1); + return $; + reason: hide x-ms-authorization-auxiliary header ``` - ### Java multi-api ``` yaml $(java) && $(multiapi) diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json index 49d7de77974b..933181b8c1dc 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json @@ -3354,6 +3354,48 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/listRegistrationTokens": { + "post": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_ListRegistrationTokens", + "description": "Operation to list the RegistrationTokens associated with the HostPool.", + "x-ms-examples": { + "HostPools_ListRegistrationToken_Post": { + "$ref": "./examples/HostPools_ListRegistrationToken_Post.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved host pool in resource group.", + "schema": { + "$ref": "#/definitions/RegistrationTokenList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/userSessions": { "get": { "tags": [ @@ -7171,6 +7213,43 @@ } } }, + "RegistrationTokenList": { + "type": "object", + "title": "RegistrationTokenList", + "description": "List of RegistrationToken definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of RegistrationToken definitions.", + "items": { + "$ref": "#/definitions/RegistrationTokenMinimal" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "RegistrationTokenMinimal": { + "description": "Represents a Minimal set of properties for RegistrationToken definition.", + "type": "object", + "properties": { + "expirationTime": { + "format": "date-time", + "type": "string", + "description": "Expiration time of registration token.", + "x-nullable": true + }, + "token": { + "type": "string", + "description": "The registration token base64 encoded string.", + "x-ms-secret": true + } + } + }, "AgentUpdateProperties": { "description": "The session host configuration for updating agent, monitoring agent, and stack component.", "type": "object", diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPools_ListRegistrationToken_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPools_ListRegistrationToken_Post.json new file mode 100644 index 000000000000..3dfc814df047 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/examples/HostPools_ListRegistrationToken_Post.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-04-08-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token" + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/desktopvirtualization.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/desktopvirtualization.json index 638205c7cab0..c1f9b53a9196 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/desktopvirtualization.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/desktopvirtualization.json @@ -2689,6 +2689,48 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/listRegistrationTokens": { + "post": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_ListRegistrationTokens", + "description": "Operation to list the RegistrationTokens associated with the HostPool", + "x-ms-examples": { + "HostPools_ListRegistrationToken_Post": { + "$ref": "./examples/HostPools_ListRegistrationToken_Post.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved host pool in resource group.", + "schema": { + "$ref": "#/definitions/RegistrationTokenList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/userSessions": { "get": { "tags": [ @@ -5052,6 +5094,43 @@ } } }, + "RegistrationTokenList": { + "type": "object", + "title": "RegistrationTokenList", + "description": "List of RegistrationToken definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of RegistrationToken definitions.", + "items": { + "$ref": "#/definitions/RegistrationTokenMinimal" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "RegistrationTokenMinimal": { + "description": "Represents a Minimal set of properties for RegistrationToken definition.", + "type": "object", + "properties": { + "expirationTime": { + "format": "date-time", + "type": "string", + "description": "Expiration time of registration token.", + "x-nullable": true + }, + "token": { + "type": "string", + "description": "The registration token base64 encoded string.", + "x-ms-secret": true + } + } + }, "AgentUpdateProperties": { "description": "The session host configuration for updating agent, monitoring agent, and stack component.", "type": "object", diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/HostPools_ListRegistrationToken_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/HostPools_ListRegistrationToken_Post.json new file mode 100644 index 000000000000..f080ce5fb3c9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/HostPools_ListRegistrationToken_Post.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-04-03" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token" + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/MsixImage_Expand_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/MsixImage_Expand_Post.json index 8cb3689c4522..57dd4bc83793 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/MsixImage_Expand_Post.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/MsixImage_Expand_Post.json @@ -14,7 +14,7 @@ "value": [ { "name": "hostpool1/expandmsiximage", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostpool1/expandMsixImage", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostpool1/expandMsixImage/msixImage", "type": "Microsoft.DesktopVirtualization/hostpools/expandmsiximage", "properties": { "packageAlias": "msixpackagealias", @@ -44,7 +44,7 @@ }, { "name": "hostpool1/expandmsiximage", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/expandmsiximage", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/expandmsiximage/msixImageURI", "type": "Microsoft.DesktopVirtualization/hostpools/expandmsiximage", "properties": { "packageAlias": "msixpackagealias2", diff --git a/specification/devcenter/DevCenter/DevBox/models.tsp b/specification/devcenter/DevCenter/DevBox/models.tsp index 63b0321adbda..769bc93a6fc5 100644 --- a/specification/devcenter/DevCenter/DevBox/models.tsp +++ b/specification/devcenter/DevCenter/DevBox/models.tsp @@ -790,7 +790,7 @@ model DevBoxRepairOperationResult { } @doc("The Customization Task list result.") -model CustomizationTaskDefinitionResult +model PagedCustomizationTaskDefinition is Azure.Core.Page; @doc("Represents a task to be used in customizing a Dev Box.") diff --git a/specification/devcenter/DevCenter/DevBox/routes.tsp b/specification/devcenter/DevCenter/DevBox/routes.tsp index 7b1b78069f00..8ec6c918d6f6 100644 --- a/specification/devcenter/DevCenter/DevBox/routes.tsp +++ b/specification/devcenter/DevCenter/DevBox/routes.tsp @@ -408,7 +408,7 @@ interface DevBoxes { @path projectName: string; }, - CustomizationTaskDefinitionResult + PagedCustomizationTaskDefinition >; @doc("Gets a customization task.") diff --git a/specification/deviceregistry/DeviceRegistry.Management/assetEndpointProfiles.tsp b/specification/deviceregistry/DeviceRegistry.Management/assetEndpointProfiles.tsp index 6dbe9f00e252..7163dbb8bd22 100644 --- a/specification/deviceregistry/DeviceRegistry.Management/assetEndpointProfiles.tsp +++ b/specification/deviceregistry/DeviceRegistry.Management/assetEndpointProfiles.tsp @@ -127,9 +127,12 @@ interface AssetEndpointProfiles { LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; - update is ArmResourcePatchAsync< + update is ArmCustomPatchAsync< AssetEndpointProfile, - AssetEndpointProfileProperties + Azure.ResourceManager.Foundations.ResourceUpdateModel< + AssetEndpointProfile, + AssetEndpointProfileProperties + > >; delete is ArmResourceDeleteWithoutOkAsync; diff --git a/specification/deviceregistry/DeviceRegistry.Management/assets.tsp b/specification/deviceregistry/DeviceRegistry.Management/assets.tsp index d31b2560f6e9..6a2c3bf87e29 100644 --- a/specification/deviceregistry/DeviceRegistry.Management/assets.tsp +++ b/specification/deviceregistry/DeviceRegistry.Management/assets.tsp @@ -212,7 +212,13 @@ interface Assets { LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; - update is ArmResourcePatchAsync; + update is ArmCustomPatchAsync< + Asset, + Azure.ResourceManager.Foundations.ResourceUpdateModel< + Asset, + AssetProperties + > + >; delete is ArmResourceDeleteWithoutOkAsync; diff --git a/specification/deviceregistry/DeviceRegistry.Management/tspconfig.yaml b/specification/deviceregistry/DeviceRegistry.Management/tspconfig.yaml index 2eb6b856421a..224f19d4bb93 100644 --- a/specification/deviceregistry/DeviceRegistry.Management/tspconfig.yaml +++ b/specification/deviceregistry/DeviceRegistry.Management/tspconfig.yaml @@ -7,6 +7,9 @@ options: "@azure-tools/typespec-autorest": emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/deviceregistry.json" examples-directory: "{project-root}/examples" use-read-only-status-schema: true diff --git a/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json b/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json index 7af2954f4243..875c20e6ebc0 100644 --- a/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json +++ b/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/preview/2023-11-01-preview/deviceregistry.json @@ -944,6 +944,7 @@ }, "properties": { "$ref": "#/definitions/AssetEndpointProfileUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } @@ -1162,6 +1163,7 @@ }, "properties": { "$ref": "#/definitions/AssetUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/client.tsp b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/client.tsp similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/client.tsp rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/client.tsp diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2023-12-13-preview/CreateOrUpdatePool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2023-12-13-preview/CreateOrUpdatePool.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2023-12-13-preview/CreateOrUpdatePool.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2023-12-13-preview/CreateOrUpdatePool.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2023-12-13-preview/DeletePool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2023-12-13-preview/DeletePool.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2023-12-13-preview/DeletePool.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2023-12-13-preview/DeletePool.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2023-12-13-preview/GetPool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2023-12-13-preview/GetPool.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2023-12-13-preview/GetPool.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2023-12-13-preview/GetPool.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2023-12-13-preview/ListOperations.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2023-12-13-preview/ListOperations.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2023-12-13-preview/ListOperations.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2023-12-13-preview/ListOperations.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2023-12-13-preview/ListPoolsBySubscription.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2023-12-13-preview/ListPoolsBySubscription.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2023-12-13-preview/ListPoolsBySubscription.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2023-12-13-preview/ListPoolsBySubscription.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2023-12-13-preview/ListPoolsBySubscriptionAndResourceGroup.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2023-12-13-preview/ListPoolsBySubscriptionAndResourceGroup.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2023-12-13-preview/ListPoolsBySubscriptionAndResourceGroup.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2023-12-13-preview/ListPoolsBySubscriptionAndResourceGroup.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2023-12-13-preview/UpdatePool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2023-12-13-preview/UpdatePool.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2023-12-13-preview/UpdatePool.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2023-12-13-preview/UpdatePool.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/CreateOrUpdatePool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/CreateOrUpdatePool.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/CreateOrUpdatePool.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/CreateOrUpdatePool.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/DeletePool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/DeletePool.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/DeletePool.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/DeletePool.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/GetPool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/GetPool.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/GetPool.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/GetPool.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/ListOperations.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/ListOperations.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/ListOperations.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/ListOperations.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/ListPoolsBySubscription.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/ListPoolsBySubscription.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/ListPoolsBySubscription.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/ListPoolsBySubscription.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/ListPoolsBySubscriptionAndResourceGroup.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/ListPoolsBySubscriptionAndResourceGroup.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/ListPoolsBySubscriptionAndResourceGroup.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/ListPoolsBySubscriptionAndResourceGroup.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/ResourceDetails_ListByPool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/ResourceDetails_ListByPool.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/ResourceDetails_ListByPool.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/ResourceDetails_ListByPool.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/Sku_ListByLocation.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/Sku_ListByLocation.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/Sku_ListByLocation.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/Sku_ListByLocation.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/UpdatePool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/UpdatePool.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-03-26-preview/UpdatePool.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-03-26-preview/UpdatePool.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/CreateOrUpdatePool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/CreateOrUpdatePool.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/CreateOrUpdatePool.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/CreateOrUpdatePool.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/DeletePool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/DeletePool.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/DeletePool.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/DeletePool.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/GetPool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/GetPool.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/GetPool.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/GetPool.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/ImageVersions_ListByImage.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/ImageVersions_ListByImage.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/ImageVersions_ListByImage.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/ImageVersions_ListByImage.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/ListOperations.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/ListOperations.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/ListOperations.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/ListOperations.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/ListPoolsBySubscription.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/ListPoolsBySubscription.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/ListPoolsBySubscription.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/ListPoolsBySubscription.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/ListPoolsBySubscriptionAndResourceGroup.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/ListPoolsBySubscriptionAndResourceGroup.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/ListPoolsBySubscriptionAndResourceGroup.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/ListPoolsBySubscriptionAndResourceGroup.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/ResourceDetails_ListByPool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/ResourceDetails_ListByPool.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/ResourceDetails_ListByPool.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/ResourceDetails_ListByPool.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/Sku_ListByLocation.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/Sku_ListByLocation.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/Sku_ListByLocation.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/Sku_ListByLocation.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/SubscriptionUsages_Usages.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/SubscriptionUsages_Usages.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/SubscriptionUsages_Usages.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/SubscriptionUsages_Usages.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/UpdatePool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/UpdatePool.json similarity index 100% rename from specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/examples/2024-04-04-preview/UpdatePool.json rename to specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-04-04-preview/UpdatePool.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/main.tsp b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/main.tsp new file mode 100644 index 000000000000..43d64ddde184 --- /dev/null +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/main.tsp @@ -0,0 +1,747 @@ +import "@typespec/http"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Http; +using TypeSpec.OpenAPI; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.ResourceManager; + +@armCommonTypesVersion(CommonTypes.Versions.v5) +@armProviderNamespace +@service({ + title: "Managed DevOps Infrastructure", +}) +@versioned(Versions) +namespace Microsoft.DevOpsInfrastructure; + +/** Api versions */ +enum Versions { + /** 2024-04-04-preview preview version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + `2024-04-04-preview`, +} + +model Pool is TrackedResource { + @key("poolName") + @pattern("^[a-zA-Z0-9][a-zA-Z0-9-.]*$") + @path + @segment("pools") + @doc("Name of the pool. It needs to be globally unique.") + name: string; + + ...ManagedServiceIdentityProperty; +} + +@doc("Pool properties") +model PoolProperties { + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "Existing SDK" + @doc("The status of the current operation.") + provisioningState?: ProvisioningState; + + @minValue(1) + @maxValue(10000) + @doc("Defines how many resources can there be created at any given time.") + maximumConcurrency: int32; + + @doc("Defines the organization in which the pool will be used.") + organizationProfile: OrganizationProfile; + + @doc("Defines how the machine will be handled once it executed a job.") + agentProfile: AgentProfile; + + @doc("Defines the type of fabric the agent will run on.") + fabricProfile: FabricProfile; + + @doc("The resource id of the DevCenter Project the pool belongs to.") + devCenterProjectResourceId: string; +} + +#suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" +@doc("Defines the organization in which the pool will be used.") +@discriminator("kind") +model OrganizationProfile {} + +@doc("GitHub organization profile") +model GitHubOrganizationProfile extends OrganizationProfile { + @doc("GitHub organization profile") + kind: "GitHub"; + + @doc("The list of GitHub organizations/repositories the pool should be present in.") + @extension("x-ms-identifiers", []) + organizations: GitHubOrganization[]; +} +@doc("Defines a GitHub organization") +model GitHubOrganization { + @doc("The GitHub organization URL in which the pool should be created.") + url: string; + + @doc("Optional list of repositories in which the pool should be created.") + repositories?: string[]; +} + +@doc("Azure DevOps organization profile") +model AzureDevOpsOrganizationProfile extends OrganizationProfile { + @doc("Azure DevOps organization profile") + kind: "AzureDevOps"; + + @doc("The list of Azure DevOps organizations the pool should be present in.") + @extension("x-ms-identifiers", []) + organizations: Organization[]; + + @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.") + url: string; + + @doc("Optional list of projects in which the pool should be created.") + projects?: string[]; + + @doc("How many machines can be created at maximum in this organization out of the maximumConcurrency of the pool.") + parallelism?: int32; +} +@doc("Defines the type of Azure DevOps pool permission.") +model AzureDevOpsPermissionProfile { + @doc("Determines who has admin permissions to the Azure DevOps pool.") + kind: AzureDevOpsPermissionType; + + @doc("User email addresses") + users?: string[]; + + @doc("Group email addresses") + groups?: string[]; +} +@doc("Determines who has admin permissions to the Azure DevOps pool.") +union AzureDevOpsPermissionType { + string, + + @doc("Pool will inherit permissions from the project or organization.") + "Inherit", + + @doc("Only the pool creator will be an admin of the pool.") + "CreatorOnly", + + @doc("Only the specified accounts will be admins of the pool.") + "SpecificAccounts", +} + +#suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" +@doc("Defines the type of fabric the agent will run on.") +@discriminator("kind") +model FabricProfile {} +@doc("The agents will run on Virtual Machine Scale Sets.") +model VmssFabricProfile extends FabricProfile { + @doc("Virtual Machine Scale Sets") + kind: "Vmss"; + + @doc("The Azure SKU of the machines in the pool.") + sku: DevOpsAzureSku; + + @doc("The VM images of the machines in the pool.") + @extension("x-ms-identifiers", []) + images: PoolImage[]; + + @doc("The OS profile of the machines in the pool.") + osProfile?: OsProfile; + + @doc("The storage profile of the machines in the pool.") + storageProfile?: StorageProfile; + + @doc("The network profile of the machines in the pool.") + networkProfile?: NetworkProfile; +} + +@doc("The Azure SKU of the machines in the pool.") +model DevOpsAzureSku { + @doc("The Azure SKU name of the machines in the pool.") + name: string; +} + +@doc("The storage profile of the VMSS.") +model StorageProfile { + @doc("The Azure SKU name of the machines in the pool.") + osDiskStorageAccountType?: OsDiskStorageAccountType; + + @doc("A list of empty data disks to attach.") + @extension("x-ms-identifiers", []) + dataDisks?: DataDisk[]; +} + +@doc("The data disk of the VMSS.") +model DataDisk { + @doc("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/.") + caching?: CachingType; + + @doc("The initial disk size in gigabytes.") + diskSizeGiB?: int32; + + @doc("The storage Account type to be used for the data disk. If omitted, the default is \"standard_lrs\".") + storageAccountType?: StorageAccountType; + + @doc("The drive letter for the empty data disk. If not specified, it will be the first available letter.") + driveLetter?: string; +} + +@doc("The type of caching in a data disk.") +union CachingType { + string, + + @doc("Don't use host caching.") + "None", + + @doc("For workloads that only do read operations.") + "ReadOnly", + + @doc("For workloads that do a balance of read and write operations.") + "ReadWrite", +} + +@doc("StorageAccountType enums") +union StorageAccountType { + string, + + @doc("The data disk should use standard locally redundant storage.") + StandardLRS: "Standard_LRS", + + @doc("The data disk should use premium locally redundant storage.") + PremiumLRS: "Premium_LRS", + + @doc("The data disk should use standard SSD locally redundant storage.") + StandardSSDLRS: "StandardSSD_LRS", + + @doc("The data disk should use premium SSD zonal redundant storage.") + PremiumZRS: "Premium_ZRS", + + @doc("The data disk should use standard SSD zonal redundant storage.") + StandardSSDZRS: "StandardSSD_ZRS", +} + +@doc("The storage account type of the OS disk.") +union OsDiskStorageAccountType { + string, + + @doc("Standard OS disk type.") + "Standard", + + @doc("Premium OS disk type.") + "Premium", + + @doc("Standard SSD OS disk type.") + "StandardSSD", +} + +@doc("The VM image of the machines in the pool.") +model PoolImage { + @doc("The resource id of the image.") + resourceId?: string; + + @doc("The image to use from a well-known set of images made available to customers.") + wellKnownImageName?: string; + + @doc("List of aliases to reference the image by.") + aliases?: string[]; + + @doc("The percentage of the buffer to be allocated to this image.") + buffer?: string = "*"; +} + +@doc("The OS profile of the machines in the pool.") +model OsProfile { + @doc("The secret management settings of the machines in the pool.") + secretsManagementSettings?: SecretsManagementSettings; + + @doc("Determines how the service should be run. By default, this will be set to Service.") + logonType?: LogonType; +} +@doc("The secret management settings of the machines in the pool.") +model SecretsManagementSettings { + @doc("Where to store certificates on the machine.") + certificateStoreLocation?: string; + + @doc("The list of certificates to install on all machines in the pool.") + observedCertificates: url[]; + + @doc("Defines if the key of the certificates should be exportable.") + keyExportable: boolean; +} +@doc("Determines how the service should be run.") +union LogonType { + string, + + @doc("Run as a service.") + "Service", + + @doc("Run in interactive mode.") + "Interactive", +} + +@doc("The network profile of the machines in the pool.") +model NetworkProfile { + @doc("The subnet id on which to put all machines created in the pool.") + subnetId: string; +} + +#suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" +@doc("The agent profile of the machines in the pool.") +@discriminator("kind") +model AgentProfile { + @doc("Defines pool buffer/stand-by agents.") + resourcePredictions?: ResourcePredictions; + + @doc("Defines how the pool buffer/stand-by agents is provided.") + resourcePredictionsProfile?: ResourcePredictionsProfile; +} +@doc("Stateless profile meaning that the machines will be cleaned up after running a job.") +model StatelessAgentProfile extends AgentProfile { + @doc("Stateless profile meaning that the machines will be cleaned up after running a job.") + kind: "Stateless"; +} +@doc("Stateful profile meaning that the machines will be returned to the pool after running a job.") +model Stateful extends AgentProfile { + @doc("Stateful profile meaning that the machines will be returned to the pool after running a job.") + kind: "Stateful"; + + @doc("How long should stateful machines be kept around. The maximum is one week.") + maxAgentLifetime?: string; + + @doc("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.") + gracePeriodTimeSpan?: string; +} +@doc("Defines pool buffer.") +model ResourcePredictions {} + +@doc("Determines how the stand-by scheme should be provided.") +@discriminator("kind") +model ResourcePredictionsProfile { + @doc("Determines how the stand-by scheme should be provided.") + kind: ResourcePredictionsProfileType; +} + +@doc("Customer provides the stand-by agent scheme.") +model ManualResourcePredictionsProfile extends ResourcePredictionsProfile { + @doc("Customer provides the stand-by agent scheme.") + kind: "Manual"; +} + +@doc("The stand-by agent scheme is determined based on historical demand.") +model AutomaticResourcePredictionsProfile extends ResourcePredictionsProfile { + @doc("The stand-by agent scheme is determined based on historical demand.") + kind: "Automatic"; + + @doc("Determines the balance between cost and performance.") + predictionPreference?: PredictionPreference; +} + +@doc("Determines how the stand-by scheme should be provided.") +union ResourcePredictionsProfileType { + string, + + @doc("Customer provides the stand-by agent scheme.") + "Manual", + + @doc("The stand-by agent scheme is determined based on historical demand.") + "Automatic", +} + +@doc("Determines the balance between cost and performance.") +union PredictionPreference { + string, + + @doc("Balance between cost and performance.") + "Balanced", + + @doc("Optimizes for cost over performance.") + "MostCostEffective", + + @doc("Halfway through cost and balanced.") + "MoreCostEffective", + + @doc("Halfway through balanced and performance.") + "MorePerformance", + + @doc("Optimizes for performance over cost.") + "BestPerformance", +} + +@doc("The status of the current operation.") +union ProvisioningState { + string, + + /** Represents a succeeded operation. */ + Succeeded: "Succeeded", + + /** Represents a failed operation. */ + Failed: "Failed", + + /** Represents a canceled operation. */ + Canceled: "Canceled", + + /** Represents a pending operation. */ + Provisioning: "Provisioning", + + /** Represents a pending operation. */ + Updating: "Updating", + + /** Represents an operation under deletion. */ + Deleting: "Deleting", + + /** Represents an accepted operation. */ + Accepted: "Accepted", +} + +interface Operations extends Azure.ResourceManager.Operations {} + +@armResourceOperations +interface Pools { + get is ArmResourceRead; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + Pool, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; + update is ArmCustomPatchAsync< + Pool, + Azure.ResourceManager.Foundations.ResourceUpdateModel + >; + delete is ArmResourceDeleteWithoutOkAsync; + listByResourceGroup is ArmResourceListByParent; + listBySubscription is ArmListBySubscription; +} + +@parentResource(Pool) +@doc("A ResourceDetailsObject") +model ResourceDetailsObject is ProxyResource { + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-name-pattern" "existing api" + @doc("The name of the resource.") + @key("resourceName") + @segment("resources") + @visibility("read") + @path + name: string; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "No ProvisioningState" +@doc("Details of the ResourceDetailsObject.") +model ResourceDetailsObjectProperties { + @doc("The status of the resource.") + status: ResourceStatus; + + @doc("The image name of the resource.") + image: string; + + @doc("The version of the image running on the resource.") + imageVersion: string; +} + +@doc("The status of the machine resource.") +union ResourceStatus { + string, + + /** Represents a machine resource that is ready. */ + Ready: "Ready", + + /** Represents a machine resource that is not ready. */ + NotReady: "NotReady", + + /** Represents a machine resource that is allocated. */ + Allocated: "Allocated", + + /** Represents a machine resource that is pending return. */ + PendingReturn: "PendingReturn", + + /** Represents a machine resource that is returned. */ + Returned: "Returned", + + /** Represents a machine resource that is leased. */ + Leased: "Leased", + + /** Represents a machine resource that is provisioning. */ + Provisioning: "Provisioning", + + /** Represents a machine resource that is updating. */ + Updating: "Updating", + + /** Represents a machine resource that is starting. */ + Starting: "Starting", + + /** Represents a machine resource that is pending reimage. */ + PendingReimage: "PendingReimage", + + /** Represents a machine resource that is reimaging. */ + Reimaging: "Reimaging", +} + +@armResourceOperations +interface ResourceDetails { + listByPool is ArmResourceListByParent; +} + +/** Represents how SKU capacity scales. */ +union ResourceSkuCapacityScaleType { + string, + + /** Capacity scales automatically. */ + "Automatic", + + /** Capactiy scales manually. */ + "Manual", + + /** Capacity does not scale. */ + "None", +} + +@doc("Describes scaling information of a SKU.") +model ResourceSkuCapacity { + @doc("The minimum capacity of the SKU.") + minimum?: int32; + + @doc("The maximum capacity of the SKU.") + maximum?: int32; + + @doc("The default capacity of the SKU.") + default?: int32; + + @doc("The scale type of the SKU.") + scaleType: ResourceSkuCapacityScaleType; +} + +@doc("Describes The SKU capabilities object.") +model ResourceSkuCapabilities { + @doc("The name of the SKU capability.") + name: string; + + @doc("The value of the SKU capability.") + value: string; +} + +@doc("The restrictions of the SKU.") +model ResourceSkuRestrictions { + @doc("the type of restrictions.") + type?: ResourceSkuRestrictionsType; + + @doc("The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted.") + values: string[]; + + @doc("The information about the restriction where the SKU cannot be used.") + restrictionInfo: ResourceSkuRestrictionInfo; + + @doc("the reason for restriction.") + reasonCode?: ResourceSkuRestrictionsReasonCode; +} + +/** Describes the kind of SKU restrictions that can exist */ +union ResourceSkuRestrictionsType { + string, + + /** SKU restricted by location. */ + "Location", + + /** SKU restricted by availability zone. */ + "Zone", +} + +@doc("Describes an available Compute SKU Restriction Information.") +model ResourceSkuRestrictionInfo { + @doc("Locations where the SKU is restricted") + locations?: string[]; + + @doc("List of availability zones where the SKU is restricted.") + zones?: string[]; +} + +/** Describes the reason for SKU restriction. */ +union ResourceSkuRestrictionsReasonCode { + string, + + /** The restriction is due to exceeding a quota limitation. */ + "QuotaId", + + /** The restriction is not available for this subscription. */ + "NotAvailableForSubscription", +} + +@doc("Describes an available Compute SKU Location Information.") +model ResourceSkuLocationInfo { + @doc("Location of the SKU") + location: string; + + @doc("List of availability zones where the SKU is supported.") + zones: string[]; + + @doc("Gets details of capabilities available to a SKU in specific zones.") + @extension("x-ms-identifiers", []) + zoneDetails: ResourceSkuZoneDetails[]; +} + +@doc("Describes The zonal capabilities of a SKU.") +model ResourceSkuZoneDetails { + @doc("Gets the set of zones that the SKU is available in with the specified capabilities.") + name: string[]; + + @doc("A list of capabilities that are available for the SKU in the specified list of zones.") + @extension("x-ms-identifiers", []) + capabilities: ResourceSkuCapabilities[]; +} + +@doc("A ResourceSku") +@parentResource(Location) +model ResourceSku is ProxyResource { + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-name-pattern" "existing api" + @doc("The name of the SKU.") + @key("skuName") + @segment("skus") + @visibility("read") + @path + name: string; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "No ProvisioningState" +@doc("Properties of a ResourceSku") +model ResourceSkuProperties { + @doc("The type of resource the SKU applies to.") + resourceType: string; + + @doc("The tier of virtual machines in a scale set") + tier: string; + + @doc("The size of the SKU.") + size: string; + + @doc("The family of the SKU.") + family: string; + + @doc("The set of locations that the SKU is available.") + locations: string[]; + + @doc("A list of locations and availability zones in those locations where the SKU is available") + @extension("x-ms-identifiers", []) + locationInfo: ResourceSkuLocationInfo[]; + + @doc("Name value pairs to describe the capability.") + @extension("x-ms-identifiers", []) + capabilities: ResourceSkuCapabilities[]; + + @doc("The restrictions of the SKU.") + @extension("x-ms-identifiers", []) + restrictions: ResourceSkuRestrictions[]; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "No ProvisioningState" +#suppress "@azure-tools/typespec-azure-resource-manager/missing-property" "No Identity" +@doc("An Azure location.") +model Location is ProxyResource { + @key("locationName") + @pattern("^[a-zA-Z0-9][a-zA-Z0-9-.]*$") + @path + @segment("locations") + @doc("Name of the location.") + @visibility("public") + name: string; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "No ProvisioningState" +@doc("Properties of a location.") +model LocationProperties {} + +@armResourceOperations +interface Sku { + listByLocation is ArmListBySubscription; +} + +@armResourceOperations +interface SubscriptionUsages { + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-action-verb" "Actions must be HTTP Post operations." + @action + @armProviderNameValue + @get + @armResourceList(Location) + @doc("List Quota resources by subscription ID") + usages( + ...SubscriptionIdParameter, + ...Azure.ResourceManager.Foundations.DefaultProviderNamespace, + ...LocationParameter, + ...ApiVersionParameter, + ): ArmResponse> | ErrorResponse; +} + +@doc("Describes Resource Quota") +@parentResource(Location) +model Quota { + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-name-pattern" "existing api" + @doc("The name of the quota.") + @segment("usages") + @visibility("read") + @path + name?: QuotaName; + + @doc("Fully qualified ARM resource id") + id: armResourceIdentifier; + + @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; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "No ProvisioningState" +#suppress "@azure-tools/typespec-azure-resource-manager/missing-property" "No Identity" +@doc("An image resource.") +model Image is ProxyResource { + @key("imageName") + @pattern("^[a-zA-Z0-9][a-zA-Z0-9-.]*$") + @path + @segment("images") + @doc("Name of the image.") + @visibility("read") + name: string; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "No ProvisioningState" +@doc("Properties of an image.") +model ImageProperties {} + +@parentResource(Image) +@doc("An image version object") +model ImageVersion is ProxyResource { + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-name-pattern" "existing api" + @doc("The name of the image version.") + @key("imageVersionName") + @segment("versions") + @visibility("read") + @path + name: string; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "No ProvisioningState" +@doc("Details of the ImageVersionProperties.") +model ImageVersionProperties { + @doc("Version of the image.") + version: string; +} + +@armResourceOperations +interface ImageVersions { + listByImage is ArmResourceListByParent; +} diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/tspconfig.yaml b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/tspconfig.yaml new file mode 100644 index 000000000000..9fd78a3ea6bc --- /dev/null +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/tspconfig.yaml @@ -0,0 +1,35 @@ +parameters: + "service-dir": + default: "sdk/devopsinfrastructure" +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" + disable: + "@azure-tools/typespec-azure-resource-manager/arm-common-types-version": "New rule" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + emitter-output-dir: "{project-root}/.." + azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true + examples-directory: "{project-root}/examples" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/devopsinfrastructure.json" + omit-unreachable-types: true + "@azure-tools/typespec-python": + package-dir: "azure-mgmt-devopsinfrastructure" + package-name: "{package-dir}" + flavor: "azure" + "@azure-tools/typespec-java": + package-dir: "azure-resourcemanager-devopsinfrastructure" + flavor: "azure" + namespace: "com.azure.resourcemanager.devopsinfrastructure" + service-name: "DevOps Infrastructure" + examples-directory: "examples" + "@azure-tools/cadl-csharp": + save-inputs: false + clear-output-folder: true + namespace: Microsoft.DevOpsInfrastructure + model-namespace: false diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/main.tsp b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/main.tsp deleted file mode 100644 index a4e453a567fa..000000000000 --- a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/main.tsp +++ /dev/null @@ -1,744 +0,0 @@ -import "@typespec/http"; -import "@typespec/openapi"; -import "@typespec/rest"; -import "@azure-tools/typespec-azure-core"; -import "@azure-tools/typespec-azure-resource-manager"; - -using TypeSpec.Http; -using TypeSpec.OpenAPI; -using TypeSpec.Rest; -using TypeSpec.Versioning; -using Azure.Core; -using Azure.ResourceManager; - -@armCommonTypesVersion(CommonTypes.Versions.v5) -@armProviderNamespace -@service({ - title: "Managed DevOps Infrastructure", -}) -@versioned(Versions) -namespace Microsoft.DevOpsInfrastructure; - -/** Api versions */ -enum Versions { - /** 2024-04-04-preview preview version */ - @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) - @useDependency(Azure.Core.Versions.v1_0_Preview_2) - `2024-04-04-preview`, -} - -model Pool is TrackedResource { - @key("poolName") - @pattern("^[a-zA-Z0-9][a-zA-Z0-9-.]*$") - @path - @segment("pools") - @doc("Name of the pool. It needs to be globally unique.") - name: string; - - ...ManagedServiceIdentityProperty; -} - -@doc("Pool properties") -model PoolProperties { - #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "Existing SDK" - @doc("The status of the current operation.") - provisioningState?: ProvisioningState; - - @minValue(1) - @maxValue(10000) - @doc("Defines how many resources can there be created at any given time.") - maximumConcurrency: int32; - - @doc("Defines the organization in which the pool will be used.") - organizationProfile: OrganizationProfile; - - @doc("Defines how the machine will be handled once it executed a job.") - agentProfile: AgentProfile; - - @doc("Defines the type of fabric the agent will run on.") - fabricProfile: FabricProfile; - - @doc("The resource id of the DevCenter Project the pool belongs to.") - devCenterProjectResourceId: string; -} - -#suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" -@doc("Defines the organization in which the pool will be used.") -@discriminator("kind") -model OrganizationProfile {} - -@doc("GitHub organization profile") -model GitHubOrganizationProfile extends OrganizationProfile { - @doc("GitHub organization profile") - kind: "GitHub"; - - @doc("The list of GitHub organizations/repositories the pool should be present in.") - @extension("x-ms-identifiers", []) - organizations: GitHubOrganization[]; -} -@doc("Defines a GitHub organization") -model GitHubOrganization { - @doc("The GitHub organization URL in which the pool should be created.") - url: string; - - @doc("Optional list of repositories in which the pool should be created.") - repositories?: string[]; -} - -@doc("Azure DevOps organization profile") -model AzureDevOpsOrganizationProfile extends OrganizationProfile { - @doc("Azure DevOps organization profile") - kind: "AzureDevOps"; - - @doc("The list of Azure DevOps organizations the pool should be present in.") - @extension("x-ms-identifiers", []) - organizations: Organization[]; - - @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.") - url: string; - - @doc("Optional list of projects in which the pool should be created.") - projects?: string[]; - - @doc("How many machines can be created at maximum in this organization out of the maximumConcurrency of the pool.") - parallelism?: int32; -} -@doc("Defines the type of Azure DevOps pool permission.") -model AzureDevOpsPermissionProfile { - @doc("Determines who has admin permissions to the Azure DevOps pool.") - kind: AzureDevOpsPermissionType; - - @doc("User email addresses") - users?: string[]; - - @doc("Group email addresses") - groups?: string[]; -} -@doc("Determines who has admin permissions to the Azure DevOps pool.") -union AzureDevOpsPermissionType { - string, - - @doc("Pool will inherit permissions from the project or organization.") - "Inherit", - - @doc("Only the pool creator will be an admin of the pool.") - "CreatorOnly", - - @doc("Only the specified accounts will be admins of the pool.") - "SpecificAccounts", -} - -#suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" -@doc("Defines the type of fabric the agent will run on.") -@discriminator("kind") -model FabricProfile {} -@doc("The agents will run on Virtual Machine Scale Sets.") -model VmssFabricProfile extends FabricProfile { - @doc("Virtual Machine Scale Sets") - kind: "Vmss"; - - @doc("The Azure SKU of the machines in the pool.") - sku: DevOpsAzureSku; - - @doc("The VM images of the machines in the pool.") - @extension("x-ms-identifiers", []) - images: PoolImage[]; - - @doc("The OS profile of the machines in the pool.") - osProfile?: OsProfile; - - @doc("The storage profile of the machines in the pool.") - storageProfile?: StorageProfile; - - @doc("The network profile of the machines in the pool.") - networkProfile?: NetworkProfile; -} - -@doc("The Azure SKU of the machines in the pool.") -model DevOpsAzureSku { - @doc("The Azure SKU name of the machines in the pool.") - name: string; -} - -@doc("The storage profile of the VMSS.") -model StorageProfile { - @doc("The Azure SKU name of the machines in the pool.") - osDiskStorageAccountType?: OsDiskStorageAccountType; - - @doc("A list of empty data disks to attach.") - @extension("x-ms-identifiers", []) - dataDisks?: DataDisk[]; -} - -@doc("The data disk of the VMSS.") -model DataDisk { - @doc("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/.") - caching?: CachingType; - - @doc("The initial disk size in gigabytes.") - diskSizeGiB?: int32; - - @doc("The storage Account type to be used for the data disk. If omitted, the default is \"standard_lrs\".") - storageAccountType?: StorageAccountType; - - @doc("The drive letter for the empty data disk. If not specified, it will be the first available letter.") - driveLetter?: string; -} - -@doc("The type of caching in a data disk.") -union CachingType { - string, - - @doc("Don't use host caching.") - "None", - - @doc("For workloads that only do read operations.") - "ReadOnly", - - @doc("For workloads that do a balance of read and write operations.") - "ReadWrite", -} - -@doc("StorageAccountType enums") -union StorageAccountType { - string, - - @doc("The data disk should use standard locally redundant storage.") - StandardLRS: "Standard_LRS", - - @doc("The data disk should use premium locally redundant storage.") - PremiumLRS: "Premium_LRS", - - @doc("The data disk should use standard SSD locally redundant storage.") - StandardSSDLRS: "StandardSSD_LRS", - - @doc("The data disk should use premium SSD zonal redundant storage.") - PremiumZRS: "Premium_ZRS", - - @doc("The data disk should use standard SSD zonal redundant storage.") - StandardSSDZRS: "StandardSSD_ZRS", -} - -@doc("The storage account type of the OS disk.") -union OsDiskStorageAccountType { - string, - - @doc("Standard OS disk type.") - "Standard", - - @doc("Premium OS disk type.") - "Premium", - - @doc("Standard SSD OS disk type.") - "StandardSSD", -} - -@doc("The VM image of the machines in the pool.") -model PoolImage { - @doc("The resource id of the image.") - resourceId?: string; - - @doc("The image to use from a well-known set of images made available to customers.") - wellKnownImageName?: string; - - @doc("List of aliases to reference the image by.") - aliases?: string[]; - - @doc("The percentage of the buffer to be allocated to this image.") - buffer?: string = "*"; -} - -@doc("The OS profile of the machines in the pool.") -model OsProfile { - @doc("The secret management settings of the machines in the pool.") - secretsManagementSettings?: SecretsManagementSettings; - - @doc("Determines how the service should be run. By default, this will be set to Service.") - logonType?: LogonType; -} -@doc("The secret management settings of the machines in the pool.") -model SecretsManagementSettings { - @doc("Where to store certificates on the machine.") - certificateStoreLocation?: string; - - @doc("The list of certificates to install on all machines in the pool.") - observedCertificates: url[]; - - @doc("Defines if the key of the certificates should be exportable.") - keyExportable: boolean; -} -@doc("Determines how the service should be run.") -union LogonType { - string, - - @doc("Run as a service.") - "Service", - - @doc("Run in interactive mode.") - "Interactive", -} - -@doc("The network profile of the machines in the pool.") -model NetworkProfile { - @doc("The subnet id on which to put all machines created in the pool.") - subnetId: string; -} - -#suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" -@doc("The agent profile of the machines in the pool.") -@discriminator("kind") -model AgentProfile { - @doc("Defines pool buffer/stand-by agents.") - resourcePredictions?: ResourcePredictions; - - @doc("Defines how the pool buffer/stand-by agents is provided.") - resourcePredictionsProfile?: ResourcePredictionsProfile; -} -@doc("Stateless profile meaning that the machines will be cleaned up after running a job.") -model StatelessAgentProfile extends AgentProfile { - @doc("Stateless profile meaning that the machines will be cleaned up after running a job.") - kind: "Stateless"; -} -@doc("Stateful profile meaning that the machines will be returned to the pool after running a job.") -model Stateful extends AgentProfile { - @doc("Stateful profile meaning that the machines will be returned to the pool after running a job.") - kind: "Stateful"; - - @doc("How long should stateful machines be kept around. The maximum is one week.") - maxAgentLifetime?: string; - - @doc("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.") - gracePeriodTimeSpan?: string; -} -@doc("Defines pool buffer.") -model ResourcePredictions {} - -@doc("Determines how the stand-by scheme should be provided.") -@discriminator("kind") -model ResourcePredictionsProfile { - @doc("Determines how the stand-by scheme should be provided.") - kind: ResourcePredictionsProfileType; -} - -@doc("Customer provides the stand-by agent scheme.") -model ManualResourcePredictionsProfile extends ResourcePredictionsProfile { - @doc("Customer provides the stand-by agent scheme.") - kind: "Manual"; -} - -@doc("The stand-by agent scheme is determined based on historical demand.") -model AutomaticResourcePredictionsProfile extends ResourcePredictionsProfile { - @doc("The stand-by agent scheme is determined based on historical demand.") - kind: "Automatic"; - - @doc("Determines the balance between cost and performance.") - predictionPreference?: PredictionPreference; -} - -@doc("Determines how the stand-by scheme should be provided.") -union ResourcePredictionsProfileType { - string, - - @doc("Customer provides the stand-by agent scheme.") - "Manual", - - @doc("The stand-by agent scheme is determined based on historical demand.") - "Automatic", -} - -@doc("Determines the balance between cost and performance.") -union PredictionPreference { - string, - - @doc("Balance between cost and performance.") - "Balanced", - - @doc("Optimizes for cost over performance.") - "MostCostEffective", - - @doc("Halfway through cost and balanced.") - "MoreCostEffective", - - @doc("Halfway through balanced and performance.") - "MorePerformance", - - @doc("Optimizes for performance over cost.") - "BestPerformance", -} - -@doc("The status of the current operation.") -union ProvisioningState { - string, - - /** Represents a succeeded operation. */ - Succeeded: "Succeeded", - - /** Represents a failed operation. */ - Failed: "Failed", - - /** Represents a canceled operation. */ - Canceled: "Canceled", - - /** Represents a pending operation. */ - Provisioning: "Provisioning", - - /** Represents a pending operation. */ - Updating: "Updating", - - /** Represents an operation under deletion. */ - Deleting: "Deleting", - - /** Represents an accepted operation. */ - Accepted: "Accepted", -} - -interface Operations extends Azure.ResourceManager.Operations {} - -@armResourceOperations -interface Pools { - get is ArmResourceRead; - #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" - @Azure.Core.useFinalStateVia("azure-async-operation") - createOrUpdate is ArmResourceCreateOrUpdateAsync< - Pool, - LroHeaders = Azure.Core.Foundations.RetryAfterHeader - >; - update is ArmResourcePatchAsync; - delete is ArmResourceDeleteWithoutOkAsync; - listByResourceGroup is ArmResourceListByParent; - listBySubscription is ArmListBySubscription; -} - -@parentResource(Pool) -@doc("A ResourceDetailsObject") -model ResourceDetailsObject is ProxyResource { - #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-name-pattern" "existing api" - @doc("The name of the resource.") - @key("resourceName") - @segment("resources") - @visibility("read") - @path - name: string; -} - -#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "No ProvisioningState" -@doc("Details of the ResourceDetailsObject.") -model ResourceDetailsObjectProperties { - @doc("The status of the resource.") - status: ResourceStatus; - - @doc("The image name of the resource.") - image: string; - - @doc("The version of the image running on the resource.") - imageVersion: string; -} - -@doc("The status of the machine resource.") -union ResourceStatus { - string, - - /** Represents a machine resource that is ready. */ - Ready: "Ready", - - /** Represents a machine resource that is not ready. */ - NotReady: "NotReady", - - /** Represents a machine resource that is allocated. */ - Allocated: "Allocated", - - /** Represents a machine resource that is pending return. */ - PendingReturn: "PendingReturn", - - /** Represents a machine resource that is returned. */ - Returned: "Returned", - - /** Represents a machine resource that is leased. */ - Leased: "Leased", - - /** Represents a machine resource that is provisioning. */ - Provisioning: "Provisioning", - - /** Represents a machine resource that is updating. */ - Updating: "Updating", - - /** Represents a machine resource that is starting. */ - Starting: "Starting", - - /** Represents a machine resource that is pending reimage. */ - PendingReimage: "PendingReimage", - - /** Represents a machine resource that is reimaging. */ - Reimaging: "Reimaging", -} - -@armResourceOperations -interface ResourceDetails { - listByPool is ArmResourceListByParent; -} - -/** Represents how SKU capacity scales. */ -union ResourceSkuCapacityScaleType { - string, - - /** Capacity scales automatically. */ - "Automatic", - - /** Capactiy scales manually. */ - "Manual", - - /** Capacity does not scale. */ - "None", -} - -@doc("Describes scaling information of a SKU.") -model ResourceSkuCapacity { - @doc("The minimum capacity of the SKU.") - minimum?: int32; - - @doc("The maximum capacity of the SKU.") - maximum?: int32; - - @doc("The default capacity of the SKU.") - default?: int32; - - @doc("The scale type of the SKU.") - scaleType: ResourceSkuCapacityScaleType; -} - -@doc("Describes The SKU capabilities object.") -model ResourceSkuCapabilities { - @doc("The name of the SKU capability.") - name: string; - - @doc("The value of the SKU capability.") - value: string; -} - -@doc("The restrictions of the SKU.") -model ResourceSkuRestrictions { - @doc("the type of restrictions.") - type?: ResourceSkuRestrictionsType; - - @doc("The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted.") - values: string[]; - - @doc("The information about the restriction where the SKU cannot be used.") - restrictionInfo: ResourceSkuRestrictionInfo; - - @doc("the reason for restriction.") - reasonCode?: ResourceSkuRestrictionsReasonCode; -} - -/** Describes the kind of SKU restrictions that can exist */ -union ResourceSkuRestrictionsType { - string, - - /** SKU restricted by location. */ - "Location", - - /** SKU restricted by availability zone. */ - "Zone", -} - -@doc("Describes an available Compute SKU Restriction Information.") -model ResourceSkuRestrictionInfo { - @doc("Locations where the SKU is restricted") - locations?: string[]; - - @doc("List of availability zones where the SKU is restricted.") - zones?: string[]; -} - -/** Describes the reason for SKU restriction. */ -union ResourceSkuRestrictionsReasonCode { - string, - - /** The restriction is due to exceeding a quota limitation. */ - "QuotaId", - - /** The restriction is not available for this subscription. */ - "NotAvailableForSubscription", -} - -@doc("Describes an available Compute SKU Location Information.") -model ResourceSkuLocationInfo { - @doc("Location of the SKU") - location: string; - - @doc("List of availability zones where the SKU is supported.") - zones: string[]; - - @doc("Gets details of capabilities available to a SKU in specific zones.") - @extension("x-ms-identifiers", []) - zoneDetails: ResourceSkuZoneDetails[]; -} - -@doc("Describes The zonal capabilities of a SKU.") -model ResourceSkuZoneDetails { - @doc("Gets the set of zones that the SKU is available in with the specified capabilities.") - name: string[]; - - @doc("A list of capabilities that are available for the SKU in the specified list of zones.") - @extension("x-ms-identifiers", []) - capabilities: ResourceSkuCapabilities[]; -} - -@doc("A ResourceSku") -@parentResource(Location) -model ResourceSku is ProxyResource { - #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-name-pattern" "existing api" - @doc("The name of the SKU.") - @key("skuName") - @segment("skus") - @visibility("read") - @path - name: string; -} - -#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "No ProvisioningState" -@doc("Properties of a ResourceSku") -model ResourceSkuProperties { - @doc("The type of resource the SKU applies to.") - resourceType: string; - - @doc("The tier of virtual machines in a scale set") - tier: string; - - @doc("The size of the SKU.") - size: string; - - @doc("The family of the SKU.") - family: string; - - @doc("The set of locations that the SKU is available.") - locations: string[]; - - @doc("A list of locations and availability zones in those locations where the SKU is available") - @extension("x-ms-identifiers", []) - locationInfo: ResourceSkuLocationInfo[]; - - @doc("Name value pairs to describe the capability.") - @extension("x-ms-identifiers", []) - capabilities: ResourceSkuCapabilities[]; - - @doc("The restrictions of the SKU.") - @extension("x-ms-identifiers", []) - restrictions: ResourceSkuRestrictions[]; -} - -#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "No ProvisioningState" -#suppress "@azure-tools/typespec-azure-resource-manager/missing-property" "No Identity" -@doc("An Azure location.") -model Location is ProxyResource { - @key("locationName") - @pattern("^[a-zA-Z0-9][a-zA-Z0-9-.]*$") - @path - @segment("locations") - @doc("Name of the location.") - @visibility("public") - name: string; -} - -#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "No ProvisioningState" -@doc("Properties of a location.") -model LocationProperties {} - -@armResourceOperations -interface Sku { - listByLocation is ArmListBySubscription; -} - -@armResourceOperations -interface SubscriptionUsages { - #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-action-verb" "Actions must be HTTP Post operations." - @action - @armProviderNameValue - @get - @armResourceList(Location) - @doc("List Quota resources by subscription ID") - usages( - ...SubscriptionIdParameter, - ...Azure.ResourceManager.Foundations.DefaultProviderNamespace, - ...LocationParameter, - ...ApiVersionParameter, - ): ArmResponse> | ErrorResponse; -} - -@doc("Describes Resource Quota") -@parentResource(Location) -model Quota { - #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-name-pattern" "existing api" - @doc("The name of the quota.") - @segment("usages") - @visibility("read") - @path - name?: QuotaName; - - @doc("Fully qualified ARM resource id") - id: armResourceIdentifier; - - @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; -} - -#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "No ProvisioningState" -#suppress "@azure-tools/typespec-azure-resource-manager/missing-property" "No Identity" -@doc("An image resource.") -model Image is ProxyResource { - @key("imageName") - @pattern("^[a-zA-Z0-9][a-zA-Z0-9-.]*$") - @path - @segment("images") - @doc("Name of the image.") - @visibility("read") - name: string; -} - -#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "No ProvisioningState" -@doc("Properties of an image.") -model ImageProperties {} - -@parentResource(Image) -@doc("An image version object") -model ImageVersion is ProxyResource { - #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-name-pattern" "existing api" - @doc("The name of the image version.") - @key("imageVersionName") - @segment("versions") - @visibility("read") - @path - name: string; -} - -#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "No ProvisioningState" -@doc("Details of the ImageVersionProperties.") -model ImageVersionProperties { - @doc("Version of the image.") - version: string; -} - -@armResourceOperations -interface ImageVersions { - listByImage is ArmResourceListByParent; -} diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/tspconfig.yaml b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/tspconfig.yaml deleted file mode 100644 index ce8b87cba68f..000000000000 --- a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/tspconfig.yaml +++ /dev/null @@ -1,32 +0,0 @@ -parameters: - "service-dir": - default: "sdk/devopsinfrastructure" -linter: - extends: - - "@azure-tools/typespec-azure-rulesets/resource-manager" - disable: - "@azure-tools/typespec-azure-resource-manager/arm-common-types-version": "New rule" -emit: - - "@azure-tools/typespec-autorest" -options: - "@azure-tools/typespec-autorest": - emitter-output-dir: "{project-root}/.." - azure-resource-provider-folder: "resource-manager" - examples-directory: "{project-root}/examples" - output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/devopsinfrastructure.json" - omit-unreachable-types: true - "@azure-tools/typespec-python": - package-dir: "azure-mgmt-devopsinfrastructure" - package-name: "{package-dir}" - flavor: "azure" - "@azure-tools/typespec-java": - package-dir: "azure-resourcemanager-devopsinfrastructure" - flavor: "azure" - namespace: "com.azure.resourcemanager.devopsinfrastructure" - service-name: "DevOps Infrastructure" - examples-directory: "examples" - "@azure-tools/cadl-csharp": - save-inputs: false - clear-output-folder: true - namespace: Microsoft.DevOpsInfrastructure - model-namespace: false diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/preview/2024-04-04-preview/devopsinfrastructure.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/preview/2024-04-04-preview/devopsinfrastructure.json index db860f768766..1394d2c7f387 100644 --- a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/preview/2024-04-04-preview/devopsinfrastructure.json +++ b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/preview/2024-04-04-preview/devopsinfrastructure.json @@ -1234,6 +1234,7 @@ }, "properties": { "$ref": "#/definitions/PoolUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } diff --git a/specification/edgezones/EdgeZones.Management/tspconfig.yaml b/specification/edgezones/EdgeZones.Management/tspconfig.yaml index c89f4eb4e50d..69439b5df395 100644 --- a/specification/edgezones/EdgeZones.Management/tspconfig.yaml +++ b/specification/edgezones/EdgeZones.Management/tspconfig.yaml @@ -9,6 +9,9 @@ linter: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true use-read-only-status-schema: true emitter-output-dir: "{project-root}/.." examples-directory: "examples" diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/elasticsan.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/elasticsan.json index 2504c483f15c..50405aedc14a 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/elasticsan.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/elasticsan.json @@ -283,6 +283,9 @@ "x-ms-examples": { "ElasticSans_Create_MaximumSet_Gen": { "$ref": "./examples/ElasticSans_Create_MaximumSet_Gen.json" + }, + "ElasticSans_Create_MinimumSet_Gen": { + "$ref": "./examples/ElasticSans_Create_MinimumSet_Gen.json" } } }, @@ -344,6 +347,9 @@ "x-ms-examples": { "ElasticSans_Update_MaximumSet_Gen": { "$ref": "./examples/ElasticSans_Update_MaximumSet_Gen.json" + }, + "ElasticSans_Update_MinimumSet_Gen": { + "$ref": "./examples/ElasticSans_Update_MinimumSet_Gen.json" } } }, @@ -396,6 +402,9 @@ "x-ms-examples": { "ElasticSans_Delete_MaximumSet_Gen": { "$ref": "./examples/ElasticSans_Delete_MaximumSet_Gen.json" + }, + "ElasticSans_Delete_MinimumSet_Gen": { + "$ref": "./examples/ElasticSans_Delete_MinimumSet_Gen.json" } } }, @@ -436,6 +445,9 @@ "x-ms-examples": { "ElasticSans_Get_MaximumSet_Gen": { "$ref": "./examples/ElasticSans_Get_MaximumSet_Gen.json" + }, + "ElasticSans_Get_MinimumSet_Gen": { + "$ref": "./examples/ElasticSans_Get_MinimumSet_Gen.json" } } } @@ -481,6 +493,9 @@ "x-ms-examples": { "VolumeGroups_ListByElasticSan_MaximumSet_Gen": { "$ref": "./examples/VolumeGroups_ListByElasticSan_MaximumSet_Gen.json" + }, + "VolumeGroups_ListByElasticSan_MinimumSet_Gen": { + "$ref": "./examples/VolumeGroups_ListByElasticSan_MinimumSet_Gen.json" } } } @@ -545,6 +560,9 @@ "x-ms-examples": { "VolumeGroups_Create_MaximumSet_Gen": { "$ref": "./examples/VolumeGroups_Create_MaximumSet_Gen.json" + }, + "VolumeGroups_Create_MinimumSet_Gen": { + "$ref": "./examples/VolumeGroups_Create_MinimumSet_Gen.json" } } }, @@ -609,6 +627,9 @@ "x-ms-examples": { "VolumeGroups_Update_MaximumSet_Gen": { "$ref": "./examples/VolumeGroups_Update_MaximumSet_Gen.json" + }, + "VolumeGroups_Update_MinimumSet_Gen": { + "$ref": "./examples/VolumeGroups_Update_MinimumSet_Gen.json" } } }, @@ -664,6 +685,9 @@ "x-ms-examples": { "VolumeGroups_Delete_MaximumSet_Gen": { "$ref": "./examples/VolumeGroups_Delete_MaximumSet_Gen.json" + }, + "VolumeGroups_Delete_MinimumSet_Gen": { + "$ref": "./examples/VolumeGroups_Delete_MinimumSet_Gen.json" } } }, @@ -707,6 +731,9 @@ "x-ms-examples": { "VolumeGroups_Get_MaximumSet_Gen": { "$ref": "./examples/VolumeGroups_Get_MaximumSet_Gen.json" + }, + "VolumeGroups_Get_MinimumSet_Gen": { + "$ref": "./examples/VolumeGroups_Get_MinimumSet_Gen.json" } } } @@ -774,6 +801,9 @@ "x-ms-examples": { "Volumes_Create_MaximumSet_Gen": { "$ref": "./examples/Volumes_Create_MaximumSet_Gen.json" + }, + "Volumes_Create_MinimumSet_Gen": { + "$ref": "./examples/Volumes_Create_MinimumSet_Gen.json" } } }, @@ -841,6 +871,9 @@ "x-ms-examples": { "Volumes_Update_MaximumSet_Gen": { "$ref": "./examples/Volumes_Update_MaximumSet_Gen.json" + }, + "Volumes_Update_MinimumSet_Gen": { + "$ref": "./examples/Volumes_Update_MinimumSet_Gen.json" } } }, @@ -929,6 +962,9 @@ "x-ms-examples": { "Volumes_Delete_MaximumSet_Gen": { "$ref": "./examples/Volumes_Delete_MaximumSet_Gen.json" + }, + "Volumes_Delete_MinimumSet_Gen": { + "$ref": "./examples/Volumes_Delete_MinimumSet_Gen.json" } } }, @@ -975,6 +1011,9 @@ "x-ms-examples": { "Volumes_Get_MaximumSet_Gen": { "$ref": "./examples/Volumes_Get_MaximumSet_Gen.json" + }, + "Volumes_Get_MinimumSet_Gen": { + "$ref": "./examples/Volumes_Get_MinimumSet_Gen.json" } } } @@ -1023,6 +1062,9 @@ "x-ms-examples": { "Volumes_ListByVolumeGroup_MaximumSet_Gen": { "$ref": "./examples/Volumes_ListByVolumeGroup_MaximumSet_Gen.json" + }, + "Volumes_ListByVolumeGroup_MinimumSet_Gen": { + "$ref": "./examples/Volumes_ListByVolumeGroup_MinimumSet_Gen.json" } } } @@ -1087,6 +1129,9 @@ "x-ms-examples": { "PrivateEndpointConnections_Create_MaximumSet_Gen": { "$ref": "./examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json" + }, + "PrivateEndpointConnections_Create_MinimumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnections_Create_MinimumSet_Gen.json" } } }, @@ -1130,6 +1175,9 @@ "x-ms-examples": { "PrivateEndpointConnections_Get_MaximumSet_Gen": { "$ref": "./examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json" + }, + "PrivateEndpointConnections_Get_MinimumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnections_Get_MinimumSet_Gen.json" } } }, @@ -1185,6 +1233,9 @@ "x-ms-examples": { "PrivateEndpointConnections_Delete_MaximumSet_Gen": { "$ref": "./examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json" + }, + "PrivateEndpointConnections_Delete_MinimumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnections_Delete_MinimumSet_Gen.json" } } } @@ -1230,6 +1281,9 @@ "x-ms-examples": { "PrivateEndpointConnections_List_MaximumSet_Gen": { "$ref": "./examples/PrivateEndpointConnections_List_MaximumSet_Gen.json" + }, + "PrivateEndpointConnections_List_MinimumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnections_List_MinimumSet_Gen.json" } } } @@ -1272,6 +1326,9 @@ "x-ms-examples": { "PrivateLinkResources_ListByElasticSan_MaximumSet_Gen": { "$ref": "./examples/PrivateLinkResources_ListByElasticSan_MaximumSet_Gen.json" + }, + "PrivateLinkResources_ListByElasticSan_MinimumSet_Gen": { + "$ref": "./examples/PrivateLinkResources_ListByElasticSan_MinimumSet_Gen.json" } } } @@ -1327,6 +1384,9 @@ "x-ms-examples": { "VolumeSnapshots_ListByVolumeGroup_MaximumSet_Gen": { "$ref": "./examples/VolumeSnapshots_ListByVolumeGroup_MaximumSet_Gen.json" + }, + "VolumeSnapshots_ListByVolumeGroup_MinimumSet_Gen": { + "$ref": "./examples/VolumeSnapshots_ListByVolumeGroup_MinimumSet_Gen.json" } } } @@ -1394,6 +1454,9 @@ "x-ms-examples": { "VolumeSnapshots_Create_MaximumSet_Gen": { "$ref": "./examples/VolumeSnapshots_Create_MaximumSet_Gen.json" + }, + "VolumeSnapshots_Create_MinimumSet_Gen": { + "$ref": "./examples/VolumeSnapshots_Create_MinimumSet_Gen.json" } } }, @@ -1452,6 +1515,9 @@ "x-ms-examples": { "VolumeSnapshots_Delete_MaximumSet_Gen": { "$ref": "./examples/VolumeSnapshots_Delete_MaximumSet_Gen.json" + }, + "VolumeSnapshots_Delete_MinimumSet_Gen": { + "$ref": "./examples/VolumeSnapshots_Delete_MinimumSet_Gen.json" } } }, @@ -1498,6 +1564,9 @@ "x-ms-examples": { "VolumeSnapshots_Get_MaximumSet_Gen": { "$ref": "./examples/VolumeSnapshots_Get_MaximumSet_Gen.json" + }, + "VolumeSnapshots_Get_MinimumSet_Gen": { + "$ref": "./examples/VolumeSnapshots_Get_MinimumSet_Gen.json" } } } diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Create_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Create_MaximumSet_Gen.json index cbda8291e491..2a097bb1b678 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Create_MaximumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Create_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "ElasticSans_Create_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "ElasticSans_Create", "operationId": "ElasticSans_Create", "parameters": { "subscriptionId": "subscriptionid", @@ -12,14 +12,14 @@ "tier": "Premium" }, "availabilityZones": [ - "bgyobptiableh" + "1" ], - "baseSizeTiB": 9, - "extendedCapacitySizeTiB": 6, + "baseSizeTiB": 5, + "extendedCapacitySizeTiB": 25, "publicNetworkAccess": "Enabled" }, "tags": { - "key8999": "kzpsnqodjgfjyasktlxiboklydek" + "key9316": "ihndtieqibtob" }, "location": "France Central" }, @@ -34,62 +34,33 @@ "tier": "Premium" }, "availabilityZones": [ - "bgyobptiableh" + "1" ], - "provisioningState": "Invalid", - "baseSizeTiB": 9, + "provisioningState": "Succeeded", + "baseSizeTiB": 15, "extendedCapacitySizeTiB": 6, - "totalVolumeSizeGiB": 24, - "volumeGroupCount": 17, - "totalIops": 19, - "totalMBps": 18, - "totalSizeTiB": 26, - "privateEndpointConnections": [ - { - "properties": { - "provisioningState": "Invalid", - "privateEndpoint": { - "id": "pwvla" - }, - "privateLinkServiceConnectionState": { - "status": "Pending", - "description": "iyhfjnligaieovq", - "actionsRequired": "jnyswa" - }, - "groupIds": [ - "szjqerjjtbcxjxsaqlfcexperaoc" - ] - }, - "id": "kjmlgsuyzzimq", - "name": "uolibxojvjdp", - "type": "tlajrvzuisxmtgsswn", - "systemData": { - "createdBy": "cuwjnszrvrxht", - "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", - "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" - } - } - ], + "totalVolumeSizeGiB": 15, + "volumeGroupCount": 24, + "totalIops": 22, + "totalMBps": 4, + "totalSizeTiB": 27, "publicNetworkAccess": "Enabled" }, - "tags": { - "key8999": "kzpsnqodjgfjyasktlxiboklydek" - }, - "location": "vcofgqbwmrplgsmhgz", - "id": "radhnqz", - "name": "amqtxb", - "type": "bvllurxfpbivtswcfgi", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "otfifnrahdshqombvtg", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" - } + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + }, + "tags": { + "key5002": "lhag" + }, + "location": "France Central", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", + "name": "vfoatmakv", + "type": "Microsoft.ElasticSan/ElasticSans" } }, "201": { @@ -103,62 +74,33 @@ "tier": "Premium" }, "availabilityZones": [ - "bgyobptiableh" + "1" ], - "provisioningState": "Invalid", - "baseSizeTiB": 9, + "provisioningState": "Succeeded", + "baseSizeTiB": 15, "extendedCapacitySizeTiB": 6, - "totalVolumeSizeGiB": 24, - "volumeGroupCount": 17, - "totalIops": 19, - "totalMBps": 18, - "totalSizeTiB": 26, - "privateEndpointConnections": [ - { - "properties": { - "provisioningState": "Invalid", - "privateEndpoint": { - "id": "pwvla" - }, - "privateLinkServiceConnectionState": { - "status": "Pending", - "description": "iyhfjnligaieovq", - "actionsRequired": "jnyswa" - }, - "groupIds": [ - "szjqerjjtbcxjxsaqlfcexperaoc" - ] - }, - "id": "kjmlgsuyzzimq", - "name": "uolibxojvjdp", - "type": "tlajrvzuisxmtgsswn", - "systemData": { - "createdBy": "cuwjnszrvrxht", - "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", - "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" - } - } - ], + "totalVolumeSizeGiB": 15, + "volumeGroupCount": 24, + "totalIops": 22, + "totalMBps": 4, + "totalSizeTiB": 27, "publicNetworkAccess": "Enabled" }, - "tags": { - "key8999": "kzpsnqodjgfjyasktlxiboklydek" - }, - "location": "vcofgqbwmrplgsmhgz", - "id": "radhnqz", - "name": "amqtxb", - "type": "bvllurxfpbivtswcfgi", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "otfifnrahdshqombvtg", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" - } + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + }, + "tags": { + "key5002": "lhag" + }, + "location": "France Central", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", + "name": "vfoatmakv", + "type": "Microsoft.ElasticSan/ElasticSans" } } } diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Delete_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Delete_MaximumSet_Gen.json index 599f5cc067e9..258fbf64dc84 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Delete_MaximumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Delete_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "ElasticSans_Delete_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "ElasticSans_Delete", "operationId": "ElasticSans_Delete", "parameters": { "subscriptionId": "subscriptionid", diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Get_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Get_MaximumSet_Gen.json index 10f6eaa79e3e..c0744c9c0d57 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Get_MaximumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Get_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "ElasticSans_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "ElasticSans_Get", "operationId": "ElasticSans_Get", "parameters": { "subscriptionId": "subscriptionid", @@ -16,62 +16,62 @@ "tier": "Premium" }, "availabilityZones": [ - "bgyobptiableh" + "1" ], - "provisioningState": "Invalid", - "baseSizeTiB": 9, + "provisioningState": "Succeeded", + "baseSizeTiB": 15, "extendedCapacitySizeTiB": 6, - "totalVolumeSizeGiB": 24, - "volumeGroupCount": 17, - "totalIops": 19, - "totalMBps": 18, - "totalSizeTiB": 26, + "totalVolumeSizeGiB": 15, + "volumeGroupCount": 24, + "totalIops": 22, + "totalMBps": 4, + "totalSizeTiB": 27, "privateEndpointConnections": [ { "properties": { - "provisioningState": "Invalid", + "provisioningState": "Succeeded", "privateEndpoint": { - "id": "pwvla" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" }, "privateLinkServiceConnectionState": { "status": "Pending", - "description": "iyhfjnligaieovq", - "actionsRequired": "jnyswa" + "description": "Auto-Approved", + "actionsRequired": "None" }, "groupIds": [ - "szjqerjjtbcxjxsaqlfcexperaoc" + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" ] }, - "id": "kjmlgsuyzzimq", - "name": "uolibxojvjdp", - "type": "tlajrvzuisxmtgsswn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "otfifnrahdshqombvtg", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" + "lastModifiedAt": "2023-07-03T09:59:45.919Z" } } ], "publicNetworkAccess": "Enabled" }, - "tags": { - "key8999": "kzpsnqodjgfjyasktlxiboklydek" - }, - "location": "vcofgqbwmrplgsmhgz", - "id": "radhnqz", - "name": "amqtxb", - "type": "bvllurxfpbivtswcfgi", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "otfifnrahdshqombvtg", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" - } + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + }, + "tags": { + "key5002": "lhag" + }, + "location": "France Central", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", + "name": "vfoatmakv", + "type": "Microsoft.ElasticSan/ElasticSans" } } } diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListByResourceGroup_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListByResourceGroup_MaximumSet_Gen.json index f0388a9d742c..0be7609d82ce 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListByResourceGroup_MaximumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListByResourceGroup_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "ElasticSans_ListByResourceGroup_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "ElasticSans_ListByResourceGroup", "operationId": "ElasticSans_ListByResourceGroup", "parameters": { "subscriptionId": "subscriptionid", @@ -17,65 +17,65 @@ "tier": "Premium" }, "availabilityZones": [ - "bgyobptiableh" + "1" ], - "provisioningState": "Invalid", - "baseSizeTiB": 9, + "provisioningState": "Succeeded", + "baseSizeTiB": 15, "extendedCapacitySizeTiB": 6, - "totalVolumeSizeGiB": 24, - "volumeGroupCount": 17, - "totalIops": 19, - "totalMBps": 18, - "totalSizeTiB": 26, + "totalVolumeSizeGiB": 15, + "volumeGroupCount": 24, + "totalIops": 22, + "totalMBps": 4, + "totalSizeTiB": 27, "privateEndpointConnections": [ { "properties": { - "provisioningState": "Invalid", + "provisioningState": "Succeeded", "privateEndpoint": { - "id": "pwvla" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" }, "privateLinkServiceConnectionState": { "status": "Pending", - "description": "iyhfjnligaieovq", - "actionsRequired": "jnyswa" + "description": "Auto-Approved", + "actionsRequired": "None" }, "groupIds": [ - "szjqerjjtbcxjxsaqlfcexperaoc" + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" ] }, - "id": "kjmlgsuyzzimq", - "name": "uolibxojvjdp", - "type": "tlajrvzuisxmtgsswn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "kakcyehdrphqkilgkhpbdtvpupak", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2023-08-23T12:16:10.057Z", + "lastModifiedBy": "bcclmbseed", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" + "lastModifiedAt": "2023-08-23T12:16:10.057Z" } } ], "publicNetworkAccess": "Enabled" }, - "tags": { - "key8999": "kzpsnqodjgfjyasktlxiboklydek" - }, - "location": "vcofgqbwmrplgsmhgz", - "id": "radhnqz", - "name": "amqtxb", - "type": "bvllurxfpbivtswcfgi", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "otfifnrahdshqombvtg", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" - } + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + }, + "tags": { + "key5002": "lhag" + }, + "location": "France Central", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", + "name": "vfoatmakv", + "type": "Microsoft.ElasticSan/ElasticSans" } ], - "nextLink": "xc" + "nextLink": "axgbgugzotxistmtabpjczrkqbfy" } } } diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListByResourceGroup_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListByResourceGroup_MinimumSet_Gen.json index d0c991ddfeea..0be7609d82ce 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListByResourceGroup_MinimumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListByResourceGroup_MinimumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "ElasticSans_ListByResourceGroup_MaximumSet_Gen - generated by [MinimumSet] rule", + "title": "ElasticSans_ListByResourceGroup", "operationId": "ElasticSans_ListByResourceGroup", "parameters": { "subscriptionId": "subscriptionid", @@ -8,7 +8,75 @@ }, "responses": { "200": { - "body": {} + "body": { + "value": [ + { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "1" + ], + "provisioningState": "Succeeded", + "baseSizeTiB": 15, + "extendedCapacitySizeTiB": 6, + "totalVolumeSizeGiB": 15, + "volumeGroupCount": 24, + "totalIops": 22, + "totalMBps": 4, + "totalSizeTiB": 27, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "kakcyehdrphqkilgkhpbdtvpupak", + "createdByType": "User", + "createdAt": "2023-08-23T12:16:10.057Z", + "lastModifiedBy": "bcclmbseed", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-23T12:16:10.057Z" + } + } + ], + "publicNetworkAccess": "Enabled" + }, + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + }, + "tags": { + "key5002": "lhag" + }, + "location": "France Central", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", + "name": "vfoatmakv", + "type": "Microsoft.ElasticSan/ElasticSans" + } + ], + "nextLink": "axgbgugzotxistmtabpjczrkqbfy" + } } } } diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListBySubscription_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListBySubscription_MaximumSet_Gen.json index ae7384dabbce..2d9fda23902d 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListBySubscription_MaximumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListBySubscription_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "ElasticSans_ListBySubscription_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "ElasticSans_ListBySubscription", "operationId": "ElasticSans_ListBySubscription", "parameters": { "subscriptionId": "subscriptionid", @@ -16,65 +16,65 @@ "tier": "Premium" }, "availabilityZones": [ - "bgyobptiableh" + "1" ], - "provisioningState": "Invalid", - "baseSizeTiB": 9, + "provisioningState": "Succeeded", + "baseSizeTiB": 15, "extendedCapacitySizeTiB": 6, - "totalVolumeSizeGiB": 24, - "volumeGroupCount": 17, - "totalIops": 19, - "totalMBps": 18, - "totalSizeTiB": 26, + "totalVolumeSizeGiB": 15, + "volumeGroupCount": 24, + "totalIops": 22, + "totalMBps": 4, + "totalSizeTiB": 27, "privateEndpointConnections": [ { "properties": { - "provisioningState": "Invalid", + "provisioningState": "Succeeded", "privateEndpoint": { - "id": "pwvla" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" }, "privateLinkServiceConnectionState": { "status": "Pending", - "description": "iyhfjnligaieovq", - "actionsRequired": "jnyswa" + "description": "Auto-Approved", + "actionsRequired": "None" }, "groupIds": [ - "szjqerjjtbcxjxsaqlfcexperaoc" + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" ] }, - "id": "kjmlgsuyzzimq", - "name": "uolibxojvjdp", - "type": "tlajrvzuisxmtgsswn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "kakcyehdrphqkilgkhpbdtvpupak", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2023-08-23T12:16:10.057Z", + "lastModifiedBy": "bcclmbseed", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" + "lastModifiedAt": "2023-08-23T12:16:10.057Z" } } ], "publicNetworkAccess": "Enabled" }, - "tags": { - "key8999": "kzpsnqodjgfjyasktlxiboklydek" - }, - "location": "vcofgqbwmrplgsmhgz", - "id": "radhnqz", - "name": "amqtxb", - "type": "bvllurxfpbivtswcfgi", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "otfifnrahdshqombvtg", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" - } + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + }, + "tags": { + "key5002": "lhag" + }, + "location": "France Central", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", + "name": "vfoatmakv", + "type": "Microsoft.ElasticSan/ElasticSans" } ], - "nextLink": "xc" + "nextLink": "axgbgugzotxistmtabpjczrkqbfy" } } } diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListBySubscription_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListBySubscription_MinimumSet_Gen.json index efda0421bf04..2d9fda23902d 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListBySubscription_MinimumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_ListBySubscription_MinimumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "ElasticSans_ListBySubscription_MaximumSet_Gen - generated by [MinimumSet] rule", + "title": "ElasticSans_ListBySubscription", "operationId": "ElasticSans_ListBySubscription", "parameters": { "subscriptionId": "subscriptionid", @@ -7,7 +7,75 @@ }, "responses": { "200": { - "body": {} + "body": { + "value": [ + { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "1" + ], + "provisioningState": "Succeeded", + "baseSizeTiB": 15, + "extendedCapacitySizeTiB": 6, + "totalVolumeSizeGiB": 15, + "volumeGroupCount": 24, + "totalIops": 22, + "totalMBps": 4, + "totalSizeTiB": 27, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "kakcyehdrphqkilgkhpbdtvpupak", + "createdByType": "User", + "createdAt": "2023-08-23T12:16:10.057Z", + "lastModifiedBy": "bcclmbseed", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-08-23T12:16:10.057Z" + } + } + ], + "publicNetworkAccess": "Enabled" + }, + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + }, + "tags": { + "key5002": "lhag" + }, + "location": "France Central", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", + "name": "vfoatmakv", + "type": "Microsoft.ElasticSan/ElasticSans" + } + ], + "nextLink": "axgbgugzotxistmtabpjczrkqbfy" + } } } } diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Update_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Update_MaximumSet_Gen.json index ca05bcb96ae5..5f33eb061bd7 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Update_MaximumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/ElasticSans_Update_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "ElasticSans_Update_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "ElasticSans_Update", "operationId": "ElasticSans_Update", "parameters": { "subscriptionId": "subscriptionid", @@ -7,12 +7,12 @@ "elasticSanName": "elasticsanname", "parameters": { "properties": { - "baseSizeTiB": 28, - "extendedCapacitySizeTiB": 3, + "baseSizeTiB": 13, + "extendedCapacitySizeTiB": 29, "publicNetworkAccess": "Enabled" }, "tags": { - "key6131": "pdmdonshncaahcffdtegnx" + "key1931": "yhjwkgmrrwrcoxblgwgzjqusch" } }, "api-version": "2024-05-01" @@ -26,62 +26,62 @@ "tier": "Premium" }, "availabilityZones": [ - "bgyobptiableh" + "1" ], - "provisioningState": "Invalid", - "baseSizeTiB": 9, + "provisioningState": "Succeeded", + "baseSizeTiB": 15, "extendedCapacitySizeTiB": 6, - "totalVolumeSizeGiB": 24, - "volumeGroupCount": 17, - "totalIops": 19, - "totalMBps": 18, - "totalSizeTiB": 26, + "totalVolumeSizeGiB": 15, + "volumeGroupCount": 24, + "totalIops": 22, + "totalMBps": 4, + "totalSizeTiB": 27, "privateEndpointConnections": [ { "properties": { - "provisioningState": "Invalid", + "provisioningState": "Succeeded", "privateEndpoint": { - "id": "pwvla" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" }, "privateLinkServiceConnectionState": { "status": "Pending", - "description": "iyhfjnligaieovq", - "actionsRequired": "jnyswa" + "description": "Auto-Approved", + "actionsRequired": "None" }, "groupIds": [ - "szjqerjjtbcxjxsaqlfcexperaoc" + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" ] }, - "id": "kjmlgsuyzzimq", - "name": "uolibxojvjdp", - "type": "tlajrvzuisxmtgsswn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "kakcyehdrphqkilgkhpbdtvpupak", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2023-08-23T12:16:10.057Z", + "lastModifiedBy": "bcclmbseed", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" + "lastModifiedAt": "2023-08-23T12:16:10.057Z" } } ], "publicNetworkAccess": "Enabled" }, - "tags": { - "key8999": "kzpsnqodjgfjyasktlxiboklydek" - }, - "location": "vcofgqbwmrplgsmhgz", - "id": "radhnqz", - "name": "amqtxb", - "type": "bvllurxfpbivtswcfgi", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "otfifnrahdshqombvtg", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" - } + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + }, + "tags": { + "key5002": "lhag" + }, + "location": "France Central", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", + "name": "vfoatmakv", + "type": "Microsoft.ElasticSan/ElasticSans" } }, "202": { diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Operations_List_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Operations_List_MaximumSet_Gen.json index 821aa2273048..b996795c65c2 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Operations_List_MaximumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Operations_List_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "Operations_List_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "Operations_List", "operationId": "Operations_List", "parameters": { "api-version": "2024-05-01" @@ -9,19 +9,19 @@ "body": { "value": [ { - "name": "zbrta", + "name": "zgtqmglizaqlsx", "isDataAction": true, "display": { - "provider": "xamdcragdhcamzyzsghhl", - "resource": "dauaewvxffac", - "operation": "poyvvbdqmmmvcufnlywfuqhrgrtr", - "description": "qahdwwduqwmmisgycfpzvlwltpauw" + "provider": "apbqaoiegbmipkbqdczsuvlak", + "resource": "hjyuuxkj", + "operation": "yumtqbnawcvunwda", + "description": "pmkjqzjverubmslnrcadqur" }, "origin": "user", "actionType": "Internal" } ], - "nextLink": "ktcqaydmfmdauponwftdkhcnkmdnso" + "nextLink": "ljqzljjgtxaytxufbermmlkrmpy" } } } diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Operations_List_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Operations_List_MinimumSet_Gen.json index 962f10ce0a4b..75751e3acfeb 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Operations_List_MinimumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Operations_List_MinimumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "Operations_List_MaximumSet_Gen - generated by [MinimumSet] rule", + "title": "Operations_List", "operationId": "Operations_List", "parameters": { "api-version": "2024-05-01" diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json index 2349ba34809e..bc656a11b757 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "PrivateEndpointConnections_Create_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "PrivateEndpointConnections_Create", "operationId": "PrivateEndpointConnections_Create", "parameters": { "subscriptionId": "subscriptionid", @@ -11,11 +11,11 @@ "privateEndpoint": {}, "privateLinkServiceConnectionState": { "status": "Pending", - "description": "iyhfjnligaieovq", - "actionsRequired": "jnyswa" + "description": "dxl", + "actionsRequired": "jhjdpwvyzipggtn" }, "groupIds": [ - "szjqerjjtbcxjxsaqlfcexperaoc" + "jdwrzpemdjrpiwzvy" ] } }, @@ -25,29 +25,29 @@ "200": { "body": { "properties": { - "provisioningState": "Invalid", + "provisioningState": "Succeeded", "privateEndpoint": { - "id": "pwvla" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" }, "privateLinkServiceConnectionState": { "status": "Pending", - "description": "iyhfjnligaieovq", - "actionsRequired": "jnyswa" + "description": "Auto-Approved", + "actionsRequired": "None" }, "groupIds": [ - "szjqerjjtbcxjxsaqlfcexperaoc" + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" ] }, - "id": "kjmlgsuyzzimq", - "name": "uolibxojvjdp", - "type": "tlajrvzuisxmtgsswn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "bgurjvijz", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2023-08-25T17:40:52.453Z", + "lastModifiedBy": "uvexylihjrtinzkeluohusnaxatfqh", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" + "lastModifiedAt": "2023-08-25T17:40:52.453Z" } } }, @@ -57,29 +57,29 @@ }, "body": { "properties": { - "provisioningState": "Invalid", + "provisioningState": "Succeeded", "privateEndpoint": { - "id": "pwvla" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" }, "privateLinkServiceConnectionState": { "status": "Pending", - "description": "iyhfjnligaieovq", - "actionsRequired": "jnyswa" + "description": "Auto-Approved", + "actionsRequired": "None" }, "groupIds": [ - "szjqerjjtbcxjxsaqlfcexperaoc" + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" ] }, - "id": "kjmlgsuyzzimq", - "name": "uolibxojvjdp", - "type": "tlajrvzuisxmtgsswn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "bgurjvijz", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2023-08-25T17:40:52.453Z", + "lastModifiedBy": "uvexylihjrtinzkeluohusnaxatfqh", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" + "lastModifiedAt": "2023-08-25T17:40:52.453Z" } } } diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json index 905b61b01c8a..e5b6f9eaa4bb 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "PrivateEndpointConnections_Delete_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "PrivateEndpointConnections_Delete", "operationId": "PrivateEndpointConnections_Delete", "parameters": { "subscriptionId": "subscriptionid", diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json index 7fc0adef52d6..bb6df8e27c77 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "PrivateEndpointConnections_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "PrivateEndpointConnections_Get", "operationId": "PrivateEndpointConnections_Get", "parameters": { "subscriptionId": "subscriptionid", @@ -12,29 +12,29 @@ "200": { "body": { "properties": { - "provisioningState": "Invalid", + "provisioningState": "Succeeded", "privateEndpoint": { - "id": "pwvla" + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" }, "privateLinkServiceConnectionState": { "status": "Pending", - "description": "iyhfjnligaieovq", - "actionsRequired": "jnyswa" + "description": "Auto-Approved", + "actionsRequired": "None" }, "groupIds": [ - "szjqerjjtbcxjxsaqlfcexperaoc" + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" ] }, - "id": "kjmlgsuyzzimq", - "name": "uolibxojvjdp", - "type": "tlajrvzuisxmtgsswn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "bgurjvijz", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2023-08-25T17:40:52.453Z", + "lastModifiedBy": "uvexylihjrtinzkeluohusnaxatfqh", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" + "lastModifiedAt": "2023-08-25T17:40:52.453Z" } } } diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_List_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_List_MaximumSet_Gen.json index 5071011bfcae..5962929d9309 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_List_MaximumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateEndpointConnections_List_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "PrivateEndpointConnections_List_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "PrivateEndpointConnections_List", "operationId": "PrivateEndpointConnections_List", "parameters": { "subscriptionId": "subscriptionid", @@ -15,31 +15,31 @@ "properties": { "provisioningState": "Invalid", "privateEndpoint": { - "id": "pwvla" + "id": "gktekmqchmjqxhfvywq" }, "privateLinkServiceConnectionState": { "status": "Pending", - "description": "iyhfjnligaieovq", - "actionsRequired": "jnyswa" + "description": "dxl", + "actionsRequired": "jhjdpwvyzipggtn" }, "groupIds": [ - "szjqerjjtbcxjxsaqlfcexperaoc" + "jdwrzpemdjrpiwzvy" ] }, - "id": "kjmlgsuyzzimq", - "name": "uolibxojvjdp", - "type": "tlajrvzuisxmtgsswn", + "id": "ynin", + "name": "vyzqckpcwufpvalbspekxikt", + "type": "ldolsnjwzutewucdfessitnxqb", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "bgurjvijz", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2023-08-25T17:40:52.453Z", + "lastModifiedBy": "uvexylihjrtinzkeluohusnaxatfqh", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" + "lastModifiedAt": "2023-08-25T17:40:52.453Z" } } ], - "nextLink": "vdihsllodbbxlzcfiqszwlrktlwrav" + "nextLink": "ifbpdcl" } } } diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateLinkResources_ListByElasticSan_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateLinkResources_ListByElasticSan_MaximumSet_Gen.json index c053ddc7082b..b80c192ba410 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateLinkResources_ListByElasticSan_MaximumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/PrivateLinkResources_ListByElasticSan_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "PrivateLinkResources_ListByElasticSan_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "PrivateLinkResources_ListByElasticSan", "operationId": "PrivateLinkResources_ListByElasticSan", "parameters": { "subscriptionId": "subscriptionid", @@ -13,28 +13,28 @@ "value": [ { "properties": { - "groupId": "gkbsulftmpqpozh", + "groupId": "mbouakfumvbeqnevmgxpk", "requiredMembers": [ - "szkaywtzokirfvzzjcbgdz" + "wujfilzifgumbvxbdhazmzf" ], "requiredZoneNames": [ - "ywhuefrajpqyjmsc" + "hzxhgoqxxiaf" ] }, - "id": "pnlckzrwuffnjrhcccbnjf", - "name": "nyiyoefzspdzxadboqsllzczkcth", - "type": "xqtfesv", + "id": "iidc", + "name": "ggbyptukibs", + "type": "qrfsowhtanlj", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "bgurjvijz", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2023-08-25T17:40:52.453Z", + "lastModifiedBy": "uvexylihjrtinzkeluohusnaxatfqh", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" + "lastModifiedAt": "2023-08-25T17:40:52.453Z" } } ], - "nextLink": "kkpnmehaubvkfnuzaypwycbgr" + "nextLink": "bvbshxnaxznetoylfjjbyf" } } } diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Skus_List_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Skus_List_MaximumSet_Gen.json index b04febc89d23..d1ac3bb57e0e 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Skus_List_MaximumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Skus_List_MaximumSet_Gen.json @@ -1,10 +1,10 @@ { - "title": "Skus_List_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "List all the available Skus in the region and information related to them", "operationId": "Skus_List", "parameters": { "subscriptionId": "subscriptionid", "api-version": "2024-05-01", - "$filter": "twwceymshjxhmzyvgww" + "$filter": "obwwdrkq" }, "responses": { "200": { @@ -13,27 +13,27 @@ { "name": "Premium_LRS", "tier": "Premium", - "resourceType": "qdkvccmffzxkwalsnsrtfxsuxwzogg", + "resourceType": "tlqickysdtjahoanstgancifxfu", "locations": [ - "hdzfsztvrmfhrqr" + "ceszpxwqyifrxobqykplm" ], "locationInfo": [ { - "location": "klfwnyxxlgthi", + "location": "ngycrsoihxdfctigejlf", "zones": [ - "szjimumzhjysuqcqg" + "1" ] } ], "capabilities": [ { - "name": "bokdo", - "value": "y" + "name": "qkht", + "value": "eoayvlyzyjjziecxymlpk" } ] } ], - "nextLink": "vzzaecvtz" + "nextLink": "venbbrnqqxaqemezvv" } } } diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Skus_List_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Skus_List_MinimumSet_Gen.json index b2cc60121174..29fddfdbb193 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Skus_List_MinimumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Skus_List_MinimumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "Skus_List_MaximumSet_Gen - generated by [MinimumSet] rule", + "title": "List all the available Skus in the region and information related to them", "operationId": "Skus_List", "parameters": { "subscriptionId": "subscriptionid", diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Create_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Create_MaximumSet_Gen.json index f7b19ffc8e93..b4d466f8145c 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Create_MaximumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Create_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "VolumeGroups_Create_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "VolumeGroups_Create", "operationId": "VolumeGroups_Create", "parameters": { "subscriptionId": "subscriptionid", @@ -10,7 +10,7 @@ "identity": { "type": "None", "userAssignedIdentities": { - "key6160": {} + "key1006": {} } }, "properties": { @@ -18,18 +18,18 @@ "encryption": "EncryptionAtRestWithPlatformKey", "encryptionProperties": { "keyVaultProperties": { - "keyName": "oaamyfynvyzxlpdyadfiptxgex", - "keyVersion": "cwjwblxnmnhbbrdbxoopcsdghur", + "keyName": "lunpapamzeimppgobraxjt", + "keyVersion": "oemygbnfmqhijmonkqfqmy", "keyVaultUri": "https://microsoft.com/a" }, "identity": { - "userAssignedIdentity": "xu" + "userAssignedIdentity": "gfhkfbozahmmwluqndfgxunssafa" } }, "networkAcls": { "virtualNetworkRules": [ { - "id": "dcywtkhbwqoaayzvj", + "id": "bkhwaiqvvaguymsmnzzbzz", "action": "Allow" } ] @@ -43,13 +43,13 @@ "200": { "body": { "identity": { - "principalId": "waiuktshnm", - "tenantId": "rjltknjpqnd", + "principalId": "uqclmeopt", + "tenantId": "qvhlvbvgodtycsfjhamstlrusktly", "type": "None", "userAssignedIdentities": { - "key6160": { - "principalId": "evse", - "clientId": "biabkgbordaxlmbgfgmkyvh" + "key1006": { + "principalId": "pcbbifvgblsrhzmpdt", + "clientId": "hsfmzocbkqpxspqwamdqjknd" } } }, @@ -59,21 +59,21 @@ "encryption": "EncryptionAtRestWithPlatformKey", "encryptionProperties": { "keyVaultProperties": { - "keyName": "oaamyfynvyzxlpdyadfiptxgex", - "keyVersion": "cwjwblxnmnhbbrdbxoopcsdghur", + "keyName": "lunpapamzeimppgobraxjt", + "keyVersion": "oemygbnfmqhijmonkqfqmy", "keyVaultUri": "https://microsoft.com/a", - "currentVersionedKeyIdentifier": "qaqgnsrfjua", - "lastKeyRotationTimestamp": "2024-05-13T06:23:47.282Z", - "currentVersionedKeyExpirationTimestamp": "2024-05-13T06:23:47.282Z" + "currentVersionedKeyIdentifier": "giyyriknaomjipru", + "lastKeyRotationTimestamp": "2024-07-09T08:26:49.141Z", + "currentVersionedKeyExpirationTimestamp": "2024-07-09T08:26:49.141Z" }, "identity": { - "userAssignedIdentity": "xu" + "userAssignedIdentity": "gfhkfbozahmmwluqndfgxunssafa" } }, "networkAcls": { "virtualNetworkRules": [ { - "id": "dcywtkhbwqoaayzvj", + "id": "bkhwaiqvvaguymsmnzzbzz", "action": "Allow" } ] @@ -83,42 +83,42 @@ "properties": { "provisioningState": "Invalid", "privateEndpoint": { - "id": "pwvla" + "id": "kdvywmjnrvqksyvxgosjorlzjk" }, "privateLinkServiceConnectionState": { "status": "Pending", - "description": "iyhfjnligaieovq", - "actionsRequired": "jnyswa" + "description": "hqsksvdlhacbmawvhlhhfmcyv", + "actionsRequired": "xvnopczgivazrjlzirhtww" }, "groupIds": [ - "szjqerjjtbcxjxsaqlfcexperaoc" + "ftdxwynrey" ] }, - "id": "kjmlgsuyzzimq", - "name": "uolibxojvjdp", - "type": "tlajrvzuisxmtgsswn", + "id": "utnp", + "name": "duzwhl", + "type": "mzwnrqbkzgk", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "iskcypymrroqhmdwccwqzdclpyutpb", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2024-07-09T08:26:45.352Z", + "lastModifiedBy": "ujpptnmvqtzudoiaihbgrvnagxh", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" + "lastModifiedAt": "2024-07-09T08:26:45.352Z" } } ], "enforceDataIntegrityCheckForIscsi": true }, - "id": "wawodajygzedvsz", - "name": "jacnlsnxssywuk", - "type": "kbvsfyul", + "id": "cgwmakehxvhv", + "name": "qymuqyvdlpshrna", + "type": "wwkffcgidqktzuzo", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "iskcypymrroqhmdwccwqzdclpyutpb", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2024-07-09T08:26:45.352Z", + "lastModifiedBy": "ujpptnmvqtzudoiaihbgrvnagxh", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" + "lastModifiedAt": "2024-07-09T08:26:45.352Z" } } }, @@ -128,13 +128,13 @@ }, "body": { "identity": { - "principalId": "waiuktshnm", - "tenantId": "rjltknjpqnd", + "principalId": "uqclmeopt", + "tenantId": "qvhlvbvgodtycsfjhamstlrusktly", "type": "None", "userAssignedIdentities": { - "key6160": { - "principalId": "evse", - "clientId": "biabkgbordaxlmbgfgmkyvh" + "key1006": { + "principalId": "pcbbifvgblsrhzmpdt", + "clientId": "hsfmzocbkqpxspqwamdqjknd" } } }, @@ -144,21 +144,21 @@ "encryption": "EncryptionAtRestWithPlatformKey", "encryptionProperties": { "keyVaultProperties": { - "keyName": "oaamyfynvyzxlpdyadfiptxgex", - "keyVersion": "cwjwblxnmnhbbrdbxoopcsdghur", + "keyName": "lunpapamzeimppgobraxjt", + "keyVersion": "oemygbnfmqhijmonkqfqmy", "keyVaultUri": "https://microsoft.com/a", - "currentVersionedKeyIdentifier": "qaqgnsrfjua", - "lastKeyRotationTimestamp": "2024-05-13T06:23:47.282Z", - "currentVersionedKeyExpirationTimestamp": "2024-05-13T06:23:47.282Z" + "currentVersionedKeyIdentifier": "giyyriknaomjipru", + "lastKeyRotationTimestamp": "2024-07-09T08:26:49.141Z", + "currentVersionedKeyExpirationTimestamp": "2024-07-09T08:26:49.141Z" }, "identity": { - "userAssignedIdentity": "xu" + "userAssignedIdentity": "gfhkfbozahmmwluqndfgxunssafa" } }, "networkAcls": { "virtualNetworkRules": [ { - "id": "dcywtkhbwqoaayzvj", + "id": "bkhwaiqvvaguymsmnzzbzz", "action": "Allow" } ] @@ -168,42 +168,42 @@ "properties": { "provisioningState": "Invalid", "privateEndpoint": { - "id": "pwvla" + "id": "kdvywmjnrvqksyvxgosjorlzjk" }, "privateLinkServiceConnectionState": { "status": "Pending", - "description": "iyhfjnligaieovq", - "actionsRequired": "jnyswa" + "description": "hqsksvdlhacbmawvhlhhfmcyv", + "actionsRequired": "xvnopczgivazrjlzirhtww" }, "groupIds": [ - "szjqerjjtbcxjxsaqlfcexperaoc" + "ftdxwynrey" ] }, - "id": "kjmlgsuyzzimq", - "name": "uolibxojvjdp", - "type": "tlajrvzuisxmtgsswn", + "id": "utnp", + "name": "duzwhl", + "type": "mzwnrqbkzgk", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "iskcypymrroqhmdwccwqzdclpyutpb", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2024-07-09T08:26:45.352Z", + "lastModifiedBy": "ujpptnmvqtzudoiaihbgrvnagxh", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" + "lastModifiedAt": "2024-07-09T08:26:45.352Z" } } ], "enforceDataIntegrityCheckForIscsi": true }, - "id": "wawodajygzedvsz", - "name": "jacnlsnxssywuk", - "type": "kbvsfyul", + "id": "cgwmakehxvhv", + "name": "qymuqyvdlpshrna", + "type": "wwkffcgidqktzuzo", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "iskcypymrroqhmdwccwqzdclpyutpb", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2024-07-09T08:26:45.352Z", + "lastModifiedBy": "ujpptnmvqtzudoiaihbgrvnagxh", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" + "lastModifiedAt": "2024-07-09T08:26:45.352Z" } } } diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Create_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Create_MinimumSet_Gen.json index 5454bc57d85c..618f92aec326 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Create_MinimumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Create_MinimumSet_Gen.json @@ -11,140 +11,13 @@ }, "responses": { "200": { - "body": { - "identity": { - "principalId": "ihsiwrwdofymkhquaxcrtfmmrsygw", - "tenantId": "gtkzkjsy", - "type": "None", - "userAssignedIdentities": { - "key7482": { - "principalId": "vfdzizicxcfcqecgsmshz", - "clientId": "jaczsquolgxwpznljbmdupn" - } - } - }, - "properties": { - "provisioningState": "Succeeded", - "protocolType": "Iscsi", - "encryption": "EncryptionAtRestWithPlatformKey", - "encryptionProperties": { - "keyVaultProperties": { - "keyName": "sftaiernmrzypnrkpakrrawxcbsqzc", - "keyVersion": "c", - "keyVaultUri": "https://microsoft.com/axmblwp", - "currentVersionedKeyIdentifier": "rnpxhtzkquzyoepwbwktbwb", - "lastKeyRotationTimestamp": "2023-08-23T12:16:11.388Z", - "currentVersionedKeyExpirationTimestamp": "2023-08-23T12:16:11.388Z" - }, - "identity": { - "userAssignedIdentity": "im" - } - }, - "networkAcls": { - "virtualNetworkRules": [ - { - "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}", - "action": "Allow" - } - ] - }, - "privateEndpointConnections": [ - { - "properties": { - "provisioningState": "Invalid", - "privateEndpoint": { - "id": "ehxmltubeltzmgcqxocakaansat" - }, - "privateLinkServiceConnectionState": { - "status": "Pending", - "description": "nahklgxicbqjbbvcdrkljqdhprruys", - "actionsRequired": "sairafcqpvucoy" - }, - "groupIds": [ - "bolviufgqnyid" - ] - }, - "id": "opcjchensdf", - "name": "gewxykc", - "type": "ailymcedgvxbqklmqtlty", - "systemData": { - "createdBy": "kakcyehdrphqkilgkhpbdtvpupak", - "createdByType": "User", - "createdAt": "2023-08-23T12:16:10.057Z", - "lastModifiedBy": "bcclmbseed", - "lastModifiedByType": "User", - "lastModifiedAt": "2023-08-23T12:16:10.057Z" - } - } - ] - }, - "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}", - "name": "cr", - "type": "Microsoft.ElasticSan/elasticSans/volumeGroups", - "systemData": { - "createdBy": "kakcyehdrphqkilgkhpbdtvpupak", - "createdByType": "User", - "createdAt": "2023-08-23T12:16:10.057Z", - "lastModifiedBy": "bcclmbseed", - "lastModifiedByType": "User", - "lastModifiedAt": "2023-08-23T12:16:10.057Z" - } - } + "body": {} }, "201": { "headers": { "location": "https://contoso.com/operationstatus" }, - "body": { - "identity": { - "principalId": "ihsiwrwdofymkhquaxcrtfmmrsygw", - "tenantId": "gtkzkjsy", - "type": "None", - "userAssignedIdentities": { - "key7482": { - "principalId": "vfdzizicxcfcqecgsmshz", - "clientId": "jaczsquolgxwpznljbmdupn" - } - } - }, - "properties": { - "provisioningState": "Succeeded", - "protocolType": "Iscsi", - "encryption": "EncryptionAtRestWithPlatformKey", - "encryptionProperties": { - "keyVaultProperties": { - "keyName": "sftaiernmrzypnrkpakrrawxcbsqzc", - "keyVersion": "c", - "keyVaultUri": "https://microsoft.com/axmblwp", - "currentVersionedKeyIdentifier": "rnpxhtzkquzyoepwbwktbwb", - "lastKeyRotationTimestamp": "2023-08-23T12:16:11.388Z", - "currentVersionedKeyExpirationTimestamp": "2023-08-23T12:16:11.388Z" - }, - "identity": { - "userAssignedIdentity": "im" - } - }, - "networkAcls": { - "virtualNetworkRules": [ - { - "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}", - "action": "Allow" - } - ] - } - }, - "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}", - "name": "cr", - "type": "Microsoft.ElasticSan/elasticSans/volumeGroups", - "systemData": { - "createdBy": "kakcyehdrphqkilgkhpbdtvpupak", - "createdByType": "User", - "createdAt": "2023-08-23T12:16:10.057Z", - "lastModifiedBy": "bcclmbseed", - "lastModifiedByType": "User", - "lastModifiedAt": "2023-08-23T12:16:10.057Z" - } - } + "body": {} } } } diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Delete_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Delete_MaximumSet_Gen.json index ac9b3fe4c91f..f176d21ae1a9 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Delete_MaximumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Delete_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "VolumeGroups_Delete_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "VolumeGroups_Delete", "operationId": "VolumeGroups_Delete", "parameters": { "subscriptionId": "subscriptionid", diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Get_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Get_MaximumSet_Gen.json index bd3699566906..31ae9d03d483 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Get_MaximumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Get_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "VolumeGroups_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "VolumeGroups_Get", "operationId": "VolumeGroups_Get", "parameters": { "subscriptionId": "subscriptionid", @@ -12,13 +12,13 @@ "200": { "body": { "identity": { - "principalId": "waiuktshnm", - "tenantId": "rjltknjpqnd", + "principalId": "uqclmeopt", + "tenantId": "qvhlvbvgodtycsfjhamstlrusktly", "type": "None", "userAssignedIdentities": { - "key6160": { - "principalId": "evse", - "clientId": "biabkgbordaxlmbgfgmkyvh" + "key1006": { + "principalId": "pcbbifvgblsrhzmpdt", + "clientId": "hsfmzocbkqpxspqwamdqjknd" } } }, @@ -28,21 +28,21 @@ "encryption": "EncryptionAtRestWithPlatformKey", "encryptionProperties": { "keyVaultProperties": { - "keyName": "oaamyfynvyzxlpdyadfiptxgex", - "keyVersion": "cwjwblxnmnhbbrdbxoopcsdghur", + "keyName": "lunpapamzeimppgobraxjt", + "keyVersion": "oemygbnfmqhijmonkqfqmy", "keyVaultUri": "https://microsoft.com/a", - "currentVersionedKeyIdentifier": "qaqgnsrfjua", - "lastKeyRotationTimestamp": "2024-05-13T06:23:47.282Z", - "currentVersionedKeyExpirationTimestamp": "2024-05-13T06:23:47.282Z" + "currentVersionedKeyIdentifier": "giyyriknaomjipru", + "lastKeyRotationTimestamp": "2024-07-09T08:26:49.141Z", + "currentVersionedKeyExpirationTimestamp": "2024-07-09T08:26:49.141Z" }, "identity": { - "userAssignedIdentity": "xu" + "userAssignedIdentity": "gfhkfbozahmmwluqndfgxunssafa" } }, "networkAcls": { "virtualNetworkRules": [ { - "id": "dcywtkhbwqoaayzvj", + "id": "bkhwaiqvvaguymsmnzzbzz", "action": "Allow" } ] @@ -52,42 +52,42 @@ "properties": { "provisioningState": "Invalid", "privateEndpoint": { - "id": "pwvla" + "id": "kdvywmjnrvqksyvxgosjorlzjk" }, "privateLinkServiceConnectionState": { "status": "Pending", - "description": "iyhfjnligaieovq", - "actionsRequired": "jnyswa" + "description": "hqsksvdlhacbmawvhlhhfmcyv", + "actionsRequired": "xvnopczgivazrjlzirhtww" }, "groupIds": [ - "szjqerjjtbcxjxsaqlfcexperaoc" + "ftdxwynrey" ] }, - "id": "kjmlgsuyzzimq", - "name": "uolibxojvjdp", - "type": "tlajrvzuisxmtgsswn", + "id": "utnp", + "name": "duzwhl", + "type": "mzwnrqbkzgk", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "iskcypymrroqhmdwccwqzdclpyutpb", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2024-07-09T08:26:45.352Z", + "lastModifiedBy": "ujpptnmvqtzudoiaihbgrvnagxh", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" + "lastModifiedAt": "2024-07-09T08:26:45.352Z" } } ], "enforceDataIntegrityCheckForIscsi": true }, - "id": "wawodajygzedvsz", - "name": "jacnlsnxssywuk", - "type": "kbvsfyul", + "id": "cgwmakehxvhv", + "name": "qymuqyvdlpshrna", + "type": "wwkffcgidqktzuzo", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "iskcypymrroqhmdwccwqzdclpyutpb", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2024-07-09T08:26:45.352Z", + "lastModifiedBy": "ujpptnmvqtzudoiaihbgrvnagxh", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" + "lastModifiedAt": "2024-07-09T08:26:45.352Z" } } } diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_ListByElasticSan_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_ListByElasticSan_MaximumSet_Gen.json index 25e26bfebb22..1a9eb5c2a221 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_ListByElasticSan_MaximumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_ListByElasticSan_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "VolumeGroups_ListByElasticSan_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "VolumeGroups_ListByElasticSan", "operationId": "VolumeGroups_ListByElasticSan", "parameters": { "subscriptionId": "subscriptionid", @@ -13,13 +13,13 @@ "value": [ { "identity": { - "principalId": "waiuktshnm", - "tenantId": "rjltknjpqnd", + "principalId": "uqclmeopt", + "tenantId": "qvhlvbvgodtycsfjhamstlrusktly", "type": "None", "userAssignedIdentities": { - "key6160": { - "principalId": "evse", - "clientId": "biabkgbordaxlmbgfgmkyvh" + "key1006": { + "principalId": "pcbbifvgblsrhzmpdt", + "clientId": "hsfmzocbkqpxspqwamdqjknd" } } }, @@ -29,21 +29,21 @@ "encryption": "EncryptionAtRestWithPlatformKey", "encryptionProperties": { "keyVaultProperties": { - "keyName": "oaamyfynvyzxlpdyadfiptxgex", - "keyVersion": "cwjwblxnmnhbbrdbxoopcsdghur", + "keyName": "lunpapamzeimppgobraxjt", + "keyVersion": "oemygbnfmqhijmonkqfqmy", "keyVaultUri": "https://microsoft.com/a", - "currentVersionedKeyIdentifier": "qaqgnsrfjua", - "lastKeyRotationTimestamp": "2024-05-13T06:23:47.282Z", - "currentVersionedKeyExpirationTimestamp": "2024-05-13T06:23:47.282Z" + "currentVersionedKeyIdentifier": "giyyriknaomjipru", + "lastKeyRotationTimestamp": "2024-07-09T08:26:49.141Z", + "currentVersionedKeyExpirationTimestamp": "2024-07-09T08:26:49.141Z" }, "identity": { - "userAssignedIdentity": "xu" + "userAssignedIdentity": "gfhkfbozahmmwluqndfgxunssafa" } }, "networkAcls": { "virtualNetworkRules": [ { - "id": "dcywtkhbwqoaayzvj", + "id": "bkhwaiqvvaguymsmnzzbzz", "action": "Allow" } ] @@ -53,46 +53,46 @@ "properties": { "provisioningState": "Invalid", "privateEndpoint": { - "id": "pwvla" + "id": "kdvywmjnrvqksyvxgosjorlzjk" }, "privateLinkServiceConnectionState": { "status": "Pending", - "description": "iyhfjnligaieovq", - "actionsRequired": "jnyswa" + "description": "hqsksvdlhacbmawvhlhhfmcyv", + "actionsRequired": "xvnopczgivazrjlzirhtww" }, "groupIds": [ - "szjqerjjtbcxjxsaqlfcexperaoc" + "ftdxwynrey" ] }, - "id": "kjmlgsuyzzimq", - "name": "uolibxojvjdp", - "type": "tlajrvzuisxmtgsswn", + "id": "utnp", + "name": "duzwhl", + "type": "mzwnrqbkzgk", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "iskcypymrroqhmdwccwqzdclpyutpb", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2024-07-09T08:26:45.352Z", + "lastModifiedBy": "ujpptnmvqtzudoiaihbgrvnagxh", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" + "lastModifiedAt": "2024-07-09T08:26:45.352Z" } } ], "enforceDataIntegrityCheckForIscsi": true }, - "id": "wawodajygzedvsz", - "name": "jacnlsnxssywuk", - "type": "kbvsfyul", + "id": "cgwmakehxvhv", + "name": "qymuqyvdlpshrna", + "type": "wwkffcgidqktzuzo", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "iskcypymrroqhmdwccwqzdclpyutpb", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2024-07-09T08:26:45.352Z", + "lastModifiedBy": "ujpptnmvqtzudoiaihbgrvnagxh", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" + "lastModifiedAt": "2024-07-09T08:26:45.352Z" } } ], - "nextLink": "daaeyyyw" + "nextLink": "xhokenxyibcglczppcoqlnvwblwx" } } } diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Update_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Update_MaximumSet_Gen.json index 330b763d33e7..f7d590986a51 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Update_MaximumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeGroups_Update_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "VolumeGroups_Update_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "VolumeGroups_Update", "operationId": "VolumeGroups_Update", "parameters": { "subscriptionId": "subscriptionid", @@ -10,7 +10,7 @@ "identity": { "type": "None", "userAssignedIdentities": { - "key6160": {} + "key1006": {} } }, "properties": { @@ -18,18 +18,18 @@ "encryption": "EncryptionAtRestWithPlatformKey", "encryptionProperties": { "keyVaultProperties": { - "keyName": "oaamyfynvyzxlpdyadfiptxgex", - "keyVersion": "cwjwblxnmnhbbrdbxoopcsdghur", + "keyName": "lunpapamzeimppgobraxjt", + "keyVersion": "oemygbnfmqhijmonkqfqmy", "keyVaultUri": "https://microsoft.com/a" }, "identity": { - "userAssignedIdentity": "xu" + "userAssignedIdentity": "gfhkfbozahmmwluqndfgxunssafa" } }, "networkAcls": { "virtualNetworkRules": [ { - "id": "dcywtkhbwqoaayzvj", + "id": "bkhwaiqvvaguymsmnzzbzz", "action": "Allow" } ] @@ -43,13 +43,13 @@ "200": { "body": { "identity": { - "principalId": "waiuktshnm", - "tenantId": "rjltknjpqnd", + "principalId": "uqclmeopt", + "tenantId": "qvhlvbvgodtycsfjhamstlrusktly", "type": "None", "userAssignedIdentities": { - "key6160": { - "principalId": "evse", - "clientId": "biabkgbordaxlmbgfgmkyvh" + "key1006": { + "principalId": "pcbbifvgblsrhzmpdt", + "clientId": "hsfmzocbkqpxspqwamdqjknd" } } }, @@ -59,21 +59,21 @@ "encryption": "EncryptionAtRestWithPlatformKey", "encryptionProperties": { "keyVaultProperties": { - "keyName": "oaamyfynvyzxlpdyadfiptxgex", - "keyVersion": "cwjwblxnmnhbbrdbxoopcsdghur", + "keyName": "lunpapamzeimppgobraxjt", + "keyVersion": "oemygbnfmqhijmonkqfqmy", "keyVaultUri": "https://microsoft.com/a", - "currentVersionedKeyIdentifier": "qaqgnsrfjua", - "lastKeyRotationTimestamp": "2024-05-13T06:23:47.282Z", - "currentVersionedKeyExpirationTimestamp": "2024-05-13T06:23:47.282Z" + "currentVersionedKeyIdentifier": "giyyriknaomjipru", + "lastKeyRotationTimestamp": "2024-07-09T08:26:49.141Z", + "currentVersionedKeyExpirationTimestamp": "2024-07-09T08:26:49.141Z" }, "identity": { - "userAssignedIdentity": "xu" + "userAssignedIdentity": "gfhkfbozahmmwluqndfgxunssafa" } }, "networkAcls": { "virtualNetworkRules": [ { - "id": "dcywtkhbwqoaayzvj", + "id": "bkhwaiqvvaguymsmnzzbzz", "action": "Allow" } ] @@ -83,42 +83,42 @@ "properties": { "provisioningState": "Invalid", "privateEndpoint": { - "id": "pwvla" + "id": "kdvywmjnrvqksyvxgosjorlzjk" }, "privateLinkServiceConnectionState": { "status": "Pending", - "description": "iyhfjnligaieovq", - "actionsRequired": "jnyswa" + "description": "hqsksvdlhacbmawvhlhhfmcyv", + "actionsRequired": "xvnopczgivazrjlzirhtww" }, "groupIds": [ - "szjqerjjtbcxjxsaqlfcexperaoc" + "ftdxwynrey" ] }, - "id": "kjmlgsuyzzimq", - "name": "uolibxojvjdp", - "type": "tlajrvzuisxmtgsswn", + "id": "utnp", + "name": "duzwhl", + "type": "mzwnrqbkzgk", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "iskcypymrroqhmdwccwqzdclpyutpb", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2024-07-09T08:26:45.352Z", + "lastModifiedBy": "ujpptnmvqtzudoiaihbgrvnagxh", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" + "lastModifiedAt": "2024-07-09T08:26:45.352Z" } } ], "enforceDataIntegrityCheckForIscsi": true }, - "id": "wawodajygzedvsz", - "name": "jacnlsnxssywuk", - "type": "kbvsfyul", + "id": "cgwmakehxvhv", + "name": "qymuqyvdlpshrna", + "type": "wwkffcgidqktzuzo", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "iskcypymrroqhmdwccwqzdclpyutpb", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2024-07-09T08:26:45.352Z", + "lastModifiedBy": "ujpptnmvqtzudoiaihbgrvnagxh", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" + "lastModifiedAt": "2024-07-09T08:26:45.352Z" } } }, diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Create_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Create_MaximumSet_Gen.json index a84039665d2e..b556eae88362 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Create_MaximumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Create_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "VolumeSnapshots_Create_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "VolumeSnapshots_Create", "operationId": "VolumeSnapshots_Create", "parameters": { "subscriptionId": "subscriptionid", @@ -10,7 +10,7 @@ "parameters": { "properties": { "creationData": { - "sourceId": "o" + "sourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}" } } }, @@ -21,22 +21,22 @@ "body": { "properties": { "creationData": { - "sourceId": "o" + "sourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}" }, - "provisioningState": "Invalid", - "sourceVolumeSizeGiB": 18, - "volumeName": "whboeudd" + "provisioningState": "Succeeded", + "sourceVolumeSizeGiB": 28, + "volumeName": "volumename" }, - "id": "tzrkidbbzldzqehoztnddmzkpam", - "name": "oughhb", - "type": "nmkshfnfxxsduacbp", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/snapshots/{snapshotName}", + "name": "qukfugetqthsufp", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/snapshots", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "f", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2023-09-06T06:58:45.864Z", + "lastModifiedBy": "wifrlzeszzcckvdzdwxhvservlvarp", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" + "lastModifiedAt": "2023-09-06T06:58:45.864Z" } } }, @@ -47,22 +47,22 @@ "body": { "properties": { "creationData": { - "sourceId": "o" + "sourceId": "vfirlleqvpepxnptyyrz" }, "provisioningState": "Invalid", - "sourceVolumeSizeGiB": 18, - "volumeName": "whboeudd" + "sourceVolumeSizeGiB": 28, + "volumeName": "o" }, - "id": "tzrkidbbzldzqehoztnddmzkpam", - "name": "oughhb", - "type": "nmkshfnfxxsduacbp", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/snapshots/{snapshotName}", + "name": "qukfugetqthsufp", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/snapshots", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "f", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2023-09-06T06:58:45.864Z", + "lastModifiedBy": "wifrlzeszzcckvdzdwxhvservlvarp", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" + "lastModifiedAt": "2023-09-06T06:58:45.864Z" } } } diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Delete_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Delete_MaximumSet_Gen.json index 1b9d3424af58..10b83e5ae84e 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Delete_MaximumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Delete_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "VolumeSnapshots_Delete_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "VolumeSnapshots_Delete", "operationId": "VolumeSnapshots_Delete", "parameters": { "subscriptionId": "subscriptionid", diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Get_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Get_MaximumSet_Gen.json index f0e49b65e11d..6431f0f58151 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Get_MaximumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_Get_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "VolumeSnapshots_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "VolumeSnapshots_Get", "operationId": "VolumeSnapshots_Get", "parameters": { "subscriptionId": "subscriptionid", @@ -14,22 +14,22 @@ "body": { "properties": { "creationData": { - "sourceId": "o" + "sourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}" }, - "provisioningState": "Invalid", - "sourceVolumeSizeGiB": 18, - "volumeName": "whboeudd" + "provisioningState": "Succeeded", + "sourceVolumeSizeGiB": 28, + "volumeName": "volumename" }, - "id": "tzrkidbbzldzqehoztnddmzkpam", - "name": "oughhb", - "type": "nmkshfnfxxsduacbp", + "id": "bbqqgzxagggqgkdgjqq", + "name": "qukfugetqthsufp", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/snapshots", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "f", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2023-09-06T06:58:45.864Z", + "lastModifiedBy": "wifrlzeszzcckvdzdwxhvservlvarp", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" + "lastModifiedAt": "2023-09-06T06:58:45.864Z" } } } diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_ListByVolumeGroup_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_ListByVolumeGroup_MaximumSet_Gen.json index 829a2cb36e4d..dd4bcdeb540e 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_ListByVolumeGroup_MaximumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/VolumeSnapshots_ListByVolumeGroup_MaximumSet_Gen.json @@ -1,12 +1,12 @@ { - "title": "VolumeSnapshots_ListByVolumeGroup_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "VolumeSnapshots_ListByVolumeGroup", "operationId": "VolumeSnapshots_ListByVolumeGroup", "parameters": { "subscriptionId": "subscriptionid", "resourceGroupName": "resourcegroupname", "elasticSanName": "elasticsanname", "volumeGroupName": "volumegroupname", - "$filter": "znhowhiiiika", + "$filter": "volumeName eq ", "api-version": "2024-05-01" }, "responses": { @@ -16,26 +16,26 @@ { "properties": { "creationData": { - "sourceId": "o" + "sourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}" }, - "provisioningState": "Invalid", - "sourceVolumeSizeGiB": 18, - "volumeName": "whboeudd" + "provisioningState": "Succeeded", + "sourceVolumeSizeGiB": 28, + "volumeName": "volumename" }, - "id": "tzrkidbbzldzqehoztnddmzkpam", - "name": "oughhb", - "type": "nmkshfnfxxsduacbp", + "id": "bbqqgzxagggqgkdgjqq", + "name": "qukfugetqthsufp", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/snapshots", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "f", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2023-09-06T06:58:45.864Z", + "lastModifiedBy": "wifrlzeszzcckvdzdwxhvservlvarp", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" + "lastModifiedAt": "2023-09-06T06:58:45.864Z" } } ], - "nextLink": "eiz" + "nextLink": "dhkjkw" } } } diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Create_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Create_MaximumSet_Gen.json index 9fca4f0344b5..0258d9d0318e 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Create_MaximumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Create_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "Volumes_Create_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "Volumes_Create", "operationId": "Volumes_Create", "parameters": { "subscriptionId": "subscriptionid", @@ -11,11 +11,11 @@ "properties": { "creationData": { "createSource": "None", - "sourceId": "fkackofx" + "sourceId": "ARM Id of Resource" }, - "sizeGiB": 10, + "sizeGiB": 9, "managedBy": { - "resourceId": "fyodcxvtqlspavsxygxc" + "resourceId": "mtkeip" } } }, @@ -25,34 +25,34 @@ "200": { "body": { "properties": { - "volumeId": "zknqnsqrk", + "volumeId": "umwjlxntntjejiyrywrytkzbfbluhk", "creationData": { "createSource": "None", - "sourceId": "fkackofx" + "sourceId": "ARM Id of Resource" }, - "sizeGiB": 10, + "sizeGiB": 9, "storageTarget": { - "targetIqn": "uwcmcmnijctbcjbkjfnzsa", - "targetPortalHostname": "htmqxwuqdpdfabhtpqrccvuqe", - "targetPortalPort": 9, - "provisioningState": "Invalid", + "targetIqn": "izdwogzjedsfug", + "targetPortalHostname": "wyfbjobugmad", + "targetPortalPort": 21, + "provisioningState": "Succeeded", "status": "Invalid" }, "managedBy": { - "resourceId": "fyodcxvtqlspavsxygxc" + "resourceId": "mtkeip" }, "provisioningState": "Invalid" }, - "id": "jdx", - "name": "erxwbvxsi", - "type": "atcxo", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}", + "name": "o", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/volumes", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "kakcyehdrphqkilgkhpbdtvpupak", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2023-08-23T12:16:10.057Z", + "lastModifiedBy": "bcclmbseed", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" + "lastModifiedAt": "2023-08-23T12:16:10.057Z" } } }, @@ -62,34 +62,34 @@ }, "body": { "properties": { - "volumeId": "zknqnsqrk", + "volumeId": "umwjlxntntjejiyrywrytkzbfbluhk", "creationData": { "createSource": "None", - "sourceId": "fkackofx" + "sourceId": "ARM Id of Resource" }, - "sizeGiB": 10, + "sizeGiB": 9, "storageTarget": { - "targetIqn": "uwcmcmnijctbcjbkjfnzsa", - "targetPortalHostname": "htmqxwuqdpdfabhtpqrccvuqe", - "targetPortalPort": 9, - "provisioningState": "Invalid", + "targetIqn": "izdwogzjedsfug", + "targetPortalHostname": "wyfbjobugmad", + "targetPortalPort": 21, + "provisioningState": "Succeeded", "status": "Invalid" }, "managedBy": { - "resourceId": "fyodcxvtqlspavsxygxc" + "resourceId": "mtkeip" }, "provisioningState": "Invalid" }, - "id": "jdx", - "name": "erxwbvxsi", - "type": "atcxo", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}", + "name": "o", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/volumes", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "kakcyehdrphqkilgkhpbdtvpupak", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2023-08-23T12:16:10.057Z", + "lastModifiedBy": "bcclmbseed", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" + "lastModifiedAt": "2023-08-23T12:16:10.057Z" } } } diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Delete_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Delete_MaximumSet_Gen.json index 063d3ba462a7..c2a119167cc0 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Delete_MaximumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Delete_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "Volumes_Delete_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "Volumes_Delete", "operationId": "Volumes_Delete", "parameters": { "subscriptionId": "subscriptionid", diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Get_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Get_MaximumSet_Gen.json index a53c25a8827a..8fb0bb404424 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Get_MaximumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Get_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "Volumes_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "Volumes_Get", "operationId": "Volumes_Get", "parameters": { "subscriptionId": "subscriptionid", @@ -13,34 +13,34 @@ "200": { "body": { "properties": { - "volumeId": "zknqnsqrk", + "volumeId": "umwjlxntntjejiyrywrytkzbfbluhk", "creationData": { "createSource": "None", - "sourceId": "fkackofx" + "sourceId": "ARM Id of Resource" }, - "sizeGiB": 10, + "sizeGiB": 9, "storageTarget": { - "targetIqn": "uwcmcmnijctbcjbkjfnzsa", - "targetPortalHostname": "htmqxwuqdpdfabhtpqrccvuqe", - "targetPortalPort": 9, - "provisioningState": "Invalid", + "targetIqn": "izdwogzjedsfug", + "targetPortalHostname": "wyfbjobugmad", + "targetPortalPort": 21, + "provisioningState": "Succeeded", "status": "Invalid" }, "managedBy": { - "resourceId": "fyodcxvtqlspavsxygxc" + "resourceId": "mtkeip" }, "provisioningState": "Invalid" }, - "id": "jdx", - "name": "erxwbvxsi", - "type": "atcxo", + "id": "swkcmwglncgtsnejzvldnbpsifxez", + "name": "o", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/volumes", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "kakcyehdrphqkilgkhpbdtvpupak", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2023-08-23T12:16:10.057Z", + "lastModifiedBy": "bcclmbseed", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" + "lastModifiedAt": "2023-08-23T12:16:10.057Z" } } } diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_ListByVolumeGroup_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_ListByVolumeGroup_MaximumSet_Gen.json index 9218a72fcf6a..01b7dd37acaa 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_ListByVolumeGroup_MaximumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_ListByVolumeGroup_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "Volumes_ListByVolumeGroup_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "Volumes_ListByVolumeGroup", "operationId": "Volumes_ListByVolumeGroup", "parameters": { "subscriptionId": "subscriptionid", @@ -14,38 +14,38 @@ "value": [ { "properties": { - "volumeId": "zknqnsqrk", + "volumeId": "umwjlxntntjejiyrywrytkzbfbluhk", "creationData": { "createSource": "None", - "sourceId": "fkackofx" + "sourceId": "ARM Id of Resource" }, - "sizeGiB": 10, + "sizeGiB": 9, "storageTarget": { - "targetIqn": "uwcmcmnijctbcjbkjfnzsa", - "targetPortalHostname": "htmqxwuqdpdfabhtpqrccvuqe", - "targetPortalPort": 9, - "provisioningState": "Invalid", + "targetIqn": "izdwogzjedsfug", + "targetPortalHostname": "wyfbjobugmad", + "targetPortalPort": 21, + "provisioningState": "Succeeded", "status": "Invalid" }, "managedBy": { - "resourceId": "fyodcxvtqlspavsxygxc" + "resourceId": "mtkeip" }, "provisioningState": "Invalid" }, - "id": "jdx", - "name": "erxwbvxsi", - "type": "atcxo", + "id": "swkcmwglncgtsnejzvldnbpsifxez", + "name": "o", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/volumes", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "kakcyehdrphqkilgkhpbdtvpupak", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2023-08-23T12:16:10.057Z", + "lastModifiedBy": "bcclmbseed", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" + "lastModifiedAt": "2023-08-23T12:16:10.057Z" } } ], - "nextLink": "wjkvqvvzdqoxzs" + "nextLink": "gguhcswqbqzoxqirej" } } } diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Update_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Update_MaximumSet_Gen.json index dbd24c57d9f6..268ca370f3fa 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Update_MaximumSet_Gen.json +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/examples/Volumes_Update_MaximumSet_Gen.json @@ -1,5 +1,5 @@ { - "title": "Volumes_Update_MaximumSet_Gen - generated by [MaximumSet] rule", + "title": "Volumes_Update", "operationId": "Volumes_Update", "parameters": { "subscriptionId": "subscriptionid", @@ -9,10 +9,7 @@ "volumeName": "volumename", "parameters": { "properties": { - "sizeGiB": 30, - "managedBy": { - "resourceId": "fyodcxvtqlspavsxygxc" - } + "sizeGiB": 11 } }, "api-version": "2024-05-01" @@ -21,34 +18,34 @@ "200": { "body": { "properties": { - "volumeId": "zknqnsqrk", + "volumeId": "umwjlxntntjejiyrywrytkzbfbluhk", "creationData": { "createSource": "None", - "sourceId": "fkackofx" + "sourceId": "ARM Id of Resource" }, - "sizeGiB": 10, + "sizeGiB": 9, "storageTarget": { - "targetIqn": "uwcmcmnijctbcjbkjfnzsa", - "targetPortalHostname": "htmqxwuqdpdfabhtpqrccvuqe", - "targetPortalPort": 9, - "provisioningState": "Invalid", + "targetIqn": "izdwogzjedsfug", + "targetPortalHostname": "wyfbjobugmad", + "targetPortalPort": 21, + "provisioningState": "Succeeded", "status": "Invalid" }, "managedBy": { - "resourceId": "fyodcxvtqlspavsxygxc" + "resourceId": "mtkeip" }, "provisioningState": "Invalid" }, - "id": "jdx", - "name": "erxwbvxsi", - "type": "atcxo", + "id": "swkcmwglncgtsnejzvldnbpsifxez", + "name": "o", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/volumes", "systemData": { - "createdBy": "cuwjnszrvrxht", + "createdBy": "kakcyehdrphqkilgkhpbdtvpupak", "createdByType": "User", - "createdAt": "2024-05-13T06:23:45.838Z", - "lastModifiedBy": "snlm", + "createdAt": "2023-08-23T12:16:10.057Z", + "lastModifiedBy": "bcclmbseed", "lastModifiedByType": "User", - "lastModifiedAt": "2024-05-13T06:23:45.838Z" + "lastModifiedAt": "2023-08-23T12:16:10.057Z" } } }, diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Cache/RedisCache.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Cache/RedisCache.tsp index d797c05a7602..1c03f354b6a9 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Cache/RedisCache.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Cache/RedisCache.tsp @@ -1,7 +1,10 @@ +import "@typespec/versioning"; +using TypeSpec.Versioning; /** Describes the schema of the Redis Cache events published to Azure Event Grid. This corresponds to the Data property of an EventGridEvent. */ namespace Microsoft.EventGrid.SystemEvents { alias RedisBaseEventData = { /** The time at which the event occurred. */ + @madeRequired(ServiceApiVersions.v2024_01_01) timestamp: utcDateTime; /** The name of this event. */ diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/AzureCommunicationServices.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/AzureCommunicationServices.tsp index 69b9b1966ffb..ba76f9403764 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/AzureCommunicationServices.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/AzureCommunicationServices.tsp @@ -1,3 +1,5 @@ +import "@typespec/versioning"; +using TypeSpec.Versioning; /** Describes the schema of the Azure Communication Services events published to Azure Event Grid. This corresponds to the Data property of an EventGridEvent. */ namespace Microsoft.EventGrid.SystemEvents; @@ -51,6 +53,7 @@ model AcsChatMessageEditedEventData extends AcsChatMessageEventBaseProperties { ...AcsChatMessageBaseEventData; /** The time at which the message was edited */ + @madeRequired(ServiceApiVersions.v2024_01_01) editTime: utcDateTime; } @@ -61,6 +64,7 @@ model AcsChatMessageEditedInThreadEventData ...AcsChatMessageBaseEventData; /** The time at which the message was edited */ + @madeRequired(ServiceApiVersions.v2024_01_01) editTime: utcDateTime; } @@ -68,6 +72,7 @@ model AcsChatMessageEditedInThreadEventData #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Maintain compatibility with existing models." model AcsChatMessageDeletedEventData extends AcsChatMessageEventBaseProperties { /** The time at which the message was deleted */ + @madeRequired(ServiceApiVersions.v2024_01_01) deleteTime: utcDateTime; } @@ -76,6 +81,7 @@ model AcsChatMessageDeletedEventData extends AcsChatMessageEventBaseProperties { model AcsChatMessageDeletedInThreadEventData extends AcsChatMessageEventInThreadBaseProperties { /** The time at which the message was deleted */ + @madeRequired(ServiceApiVersions.v2024_01_01) deleteTime: utcDateTime; } @@ -115,6 +121,7 @@ model AcsChatThreadPropertiesUpdatedPerUserEventData editedByCommunicationIdentifier: CommunicationIdentifierModel; /** The time at which the properties of the thread were updated */ + @madeRequired(ServiceApiVersions.v2024_01_01) editTime: utcDateTime; /** The thread metadata */ @@ -144,6 +151,7 @@ model AcsChatParticipantAddedToThreadWithUserEventData model AcsChatParticipantRemovedFromThreadWithUserEventData extends AcsChatThreadEventBaseProperties { /** The time at which the user was removed to the thread */ + @madeRequired(ServiceApiVersions.v2024_01_01) time: utcDateTime; /** The communication identifier of the user who removed the user */ @@ -168,6 +176,7 @@ model AcsChatParticipantAddedToThreadEventData model AcsChatParticipantRemovedFromThreadEventData extends AcsChatEventInThreadBaseProperties { /** The time at which the user was removed to the thread */ + @madeRequired(ServiceApiVersions.v2024_01_01) time: utcDateTime; /** The communication identifier of the user who removed the user */ @@ -193,6 +202,7 @@ model AcsSmsDeliveryReportReceivedEventData extends AcsSmsEventBaseProperties { deliveryAttempts: AcsSmsDeliveryAttemptProperties[]; /** The time at which the SMS delivery report was received */ + @madeRequired(ServiceApiVersions.v2024_01_01) receivedTimestamp: utcDateTime; /** Customer Content */ @@ -206,6 +216,7 @@ model AcsSmsReceivedEventData extends AcsSmsEventBaseProperties { message?: string; /** The time at which the SMS was received */ + @madeRequired(ServiceApiVersions.v2024_01_01) receivedTimestamp: utcDateTime; } @@ -216,18 +227,22 @@ model AcsRecordingFileStatusUpdatedEventData { recordingStorageInfo: AcsRecordingStorageInfoProperties; /** The time at which the recording started */ + @madeRequired(ServiceApiVersions.v2024_01_01) recordingStartTime: utcDateTime; /** The recording duration in milliseconds */ recordingDurationMs?: int64; /** The recording content type- AudioVideo, or Audio */ + @madeRequired(ServiceApiVersions.v2024_01_01) recordingContentType: recordingContentType; /** The recording channel type - Mixed, Unmixed */ + @madeRequired(ServiceApiVersions.v2024_01_01) recordingChannelType: recordingChannelType; /** The recording format type - Mp4, Mp3, Wav */ + @madeRequired(ServiceApiVersions.v2024_01_01) recordingFormatType: recordingFormatType; /** The reason for ending recording session */ @@ -246,13 +261,15 @@ model AcsEmailDeliveryReportReceivedEventData { messageId?: string; /** The status of the email. Any value other than Delivered is considered failed. */ + @madeRequired(ServiceApiVersions.v2024_01_01) status: AcsEmailDeliveryReportStatus; /** Detailed information about the status if any */ deliveryStatusDetails: AcsEmailDeliveryReportStatusDetails; /** The time at which the email delivery report received timestamp */ - deliveryAttemptTimeStamp: utcDateTime; + @madeRequired(ServiceApiVersions.v2024_01_01) + deliveryAttemptTimestamp: utcDateTime; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.EmailEngagementTrackingReportReceived event. */ @@ -267,7 +284,8 @@ model AcsEmailEngagementTrackingReportReceivedEventData { messageId?: string; /** The time at which the user interacted with the email */ - userActionTimeStamp: utcDateTime; + @madeRequired(ServiceApiVersions.v2024_01_01) + userActionTimestamp: utcDateTime; /** The context of the type of engagement user had with email */ engagementContext?: string; @@ -276,6 +294,7 @@ model AcsEmailEngagementTrackingReportReceivedEventData { userAgent?: string; /** The type of engagement user have with email */ + @madeRequired(ServiceApiVersions.v2024_01_01) engagementType: AcsUserEngagement; } @@ -369,6 +388,7 @@ model AcsRouterJobQueuedEventData extends AcsRouterJobEventData { #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Maintain compatibility with existing models." model AcsRouterJobReceivedEventData extends AcsRouterJobEventData { /** Router Job Received Job Status */ + @madeRequired(ServiceApiVersions.v2024_01_01) jobStatus: AcsRouterJobStatus; /** Router Job Classification Policy Id */ @@ -381,6 +401,7 @@ model AcsRouterJobReceivedEventData extends AcsRouterJobEventData { requestedWorkerSelectors: AcsRouterWorkerSelector[]; /** Router Job Received Scheduled Time in UTC */ + @madeRequired(ServiceApiVersions.v2024_01_01) scheduledOn: utcDateTime; /** Unavailable For Matching for Router Job Received */ @@ -442,6 +463,7 @@ model AcsRouterJobSchedulingFailedEventData extends AcsRouterJobEventData { /** Router Job Scheduling Failed Scheduled Time in UTC */ // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + @madeRequired(ServiceApiVersions.v2024_01_01) scheduledOn: utcDateTime; /** Router Job Scheduling Failed Reason */ @@ -472,6 +494,7 @@ model AcsRouterJobWaitingForActivationEventData extends AcsRouterJobEventData { /** Router Job Waiting For Activation Scheduled Time in UTC */ // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + @madeRequired(ServiceApiVersions.v2024_01_01) scheduledOn: utcDateTime; /** Router Job Waiting For Activation Unavailable For Matching */ @@ -564,10 +587,12 @@ model AcsRouterWorkerOfferIssuedEventData extends AcsRouterWorkerEventData { /** Router Worker Offer Issued Time in UTC */ // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + @madeRequired(ServiceApiVersions.v2024_01_01) offeredOn: utcDateTime; /** Router Worker Offer Issued Expiration Time in UTC */ // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + @madeRequired(ServiceApiVersions.v2024_01_01) expiresOn: utcDateTime; /** Router Worker Offer Issued Worker Tags */ @@ -692,6 +717,7 @@ model AcsRouterWorkerSelector { key?: string; /** Router Job Worker Selector Label Operator */ + @madeRequired(ServiceApiVersions.v2024_01_01) labelOperator: AcsRouterLabelOperator; /** Router Job Worker Selector Value */ @@ -702,9 +728,11 @@ model AcsRouterWorkerSelector { ttlSeconds: float64; /** Router Job Worker Selector State */ + @madeRequired(ServiceApiVersions.v2024_01_01) state: AcsRouterWorkerSelectorState; /** Router Job Worker Selector Expiration Time */ + @madeRequired(ServiceApiVersions.v2024_01_01) expirationTime: utcDateTime; } @@ -736,6 +764,7 @@ alias AcsChatThreadDeletedBaseEventData = { deletedByCommunicationIdentifier: CommunicationIdentifierModel; /** The deletion time of the thread */ + @madeRequired(ServiceApiVersions.v2024_01_01) deleteTime: utcDateTime; }; @@ -744,6 +773,7 @@ alias AcsChatThreadPropertiesBaseEventData = { editedByCommunicationIdentifier: CommunicationIdentifierModel; /** The time at which the properties of the thread were updated */ + @madeRequired(ServiceApiVersions.v2024_01_01) editTime: utcDateTime; /** The updated thread properties */ @@ -756,6 +786,7 @@ alias AcsChatThreadPropertiesBaseEventData = { alias AcsChatParticipantBaseEventData = { /** The time at which the user was added to the thread */ + @madeRequired(ServiceApiVersions.v2024_01_01) time: utcDateTime; /** The communication identifier of the user who added the user */ @@ -868,6 +899,7 @@ model AcsEmailDeliveryReportStatusDetails { #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Maintain compatibility with existing models." model AcsChatThreadEventBaseProperties extends AcsChatEventBaseProperties { /** The original creation time of the thread */ + @madeRequired(ServiceApiVersions.v2024_01_01) createTime: utcDateTime; /** The version of the thread */ @@ -879,6 +911,7 @@ model AcsChatThreadEventBaseProperties extends AcsChatEventBaseProperties { model AcsChatThreadEventInThreadBaseProperties extends AcsChatEventInThreadBaseProperties { /** The original creation time of the thread */ + @madeRequired(ServiceApiVersions.v2024_01_01) createTime: utcDateTime; /** The version of the thread */ @@ -898,6 +931,7 @@ model AcsChatMessageEventBaseProperties extends AcsChatEventBaseProperties { senderDisplayName?: string; /** The original compose time of the message */ + @madeRequired(ServiceApiVersions.v2024_01_01) composeTime: utcDateTime; /** The type of the message */ @@ -921,6 +955,7 @@ model AcsChatMessageEventInThreadBaseProperties senderDisplayName?: string; /** The original compose time of the message */ + @madeRequired(ServiceApiVersions.v2024_01_01) composeTime: utcDateTime; /** The type of the message */ @@ -974,6 +1009,7 @@ model AcsSmsEventBaseProperties { /** Schema for details of a delivery attempt */ model AcsSmsDeliveryAttemptProperties { /** TimeStamp when delivery was attempted */ + @madeRequired(ServiceApiVersions.v2024_01_01) timestamp: utcDateTime; /** Number of segments that were successfully delivered */ @@ -1033,6 +1069,7 @@ union AcsUserEngagement { /** Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model must be interpreted as a union: Apart from rawId, at most one further property may be set. */ model CommunicationIdentifierModel { /** The identifier kind. Only required in responses. */ + @madeRequired(ServiceApiVersions.v2024_01_01) kind: CommunicationIdentifierModelKind; /** Raw Id of the identifier. Optional in requests, required in responses. */ @@ -1074,6 +1111,7 @@ model MicrosoftTeamsAppIdentifierModel { appId: string; /** The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. */ + @madeRequired(ServiceApiVersions.v2024_01_01) cloud: CommunicationCloudEnvironmentModel; } @@ -1086,6 +1124,7 @@ model MicrosoftTeamsUserIdentifierModel { isAnonymous?: boolean; /** The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. */ + @madeRequired(ServiceApiVersions.v2024_01_01) cloud: CommunicationCloudEnvironmentModel; } @@ -1132,9 +1171,11 @@ model AcsMessageDeliveryStatusUpdatedEventData extends AcsMessageEventData { messageId?: string; /** The updated message status */ + @madeRequired(ServiceApiVersions.v2024_01_01) status: AcsMessageDeliveryStatus; /** The updated message channel type */ + @madeRequired(ServiceApiVersions.v2024_01_01) channelType: AcsMessageChannelKind; } @@ -1196,6 +1237,7 @@ model AcsMessageButtonContent { /** Message Interactive Content */ model AcsMessageInteractiveContent { /** The Message interactive reply type */ + @madeRequired(ServiceApiVersions.v2024_01_01) type: AcsInteractiveReplyKind; /** The Message Sent when a customer clicks a button */ @@ -1235,6 +1277,7 @@ model AcsMessageEventData { to?: string; /** The time message was received */ + @madeRequired(ServiceApiVersions.v2024_01_01) receivedTimeStamp: utcDateTime; /** The channel event error */ diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ContainerRegistry/ContainerRegistry.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ContainerRegistry/ContainerRegistry.tsp index 726089a7278c..5f71f3c4d0fb 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ContainerRegistry/ContainerRegistry.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ContainerRegistry/ContainerRegistry.tsp @@ -1,3 +1,5 @@ +import "@typespec/versioning"; +using TypeSpec.Versioning; /** Describes the schema of the Azure Container Registry events published to Azure Event Grid. This corresponds to the Data property of an EventGridEvent. */ namespace Microsoft.EventGrid.SystemEvents; @@ -26,6 +28,7 @@ alias ContainerRegistryBaseEventData = { id?: string; /** The time at which the event occurred. */ + @madeRequired(ServiceApiVersions.v2024_01_01) timestamp: utcDateTime; /** The action that encompasses the provided event. */ diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.DataBox/DataBox.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.DataBox/DataBox.tsp index 05d7129a7c9c..649bf0c72dcc 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.DataBox/DataBox.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.DataBox/DataBox.tsp @@ -1,3 +1,5 @@ +import "@typespec/versioning"; +using TypeSpec.Versioning; /** EG DataBox Data Model */ namespace Microsoft.EventGrid.SystemEvents { /** Schema of the Data property of an EventGridEvent for a Microsoft.DataBox.CopyStarted event. */ @@ -20,9 +22,11 @@ namespace Microsoft.EventGrid.SystemEvents { serialNumber?: string; /** Name of the current Stage */ + @madeRequired(ServiceApiVersions.v2024_01_01) stageName: DataBoxStageName; /** The time at which the stage happened. */ + @madeRequired(ServiceApiVersions.v2024_01_01) stageTime: utcDateTime; }; diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.EventGrid/EventGrid.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.EventGrid/EventGrid.tsp index f3c1877aa959..64142194e7c4 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.EventGrid/EventGrid.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.EventGrid/EventGrid.tsp @@ -1,3 +1,5 @@ +import "@typespec/versioning"; +using TypeSpec.Versioning; /** Describes the schema of the Azure EventGrid events published to Azure Event Grid. This corresponds to the Data property of an EventGridEvent. */ namespace Microsoft.EventGrid.SystemEvents; @@ -89,10 +91,12 @@ model SubscriptionDeletedEventData { model EventGridMQTTClientCreatedOrUpdatedEventData extends EventGridMQTTClientEventData { /** Configured state of the client. The value could be Enabled or Disabled */ + @madeRequired(ServiceApiVersions.v2024_01_01) state: EventGridMQTTClientState; /** Time the client resource is created based on the provider's UTC time. */ // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + @madeRequired(ServiceApiVersions.v2024_01_01) createdOn: utcDateTime; /** @@ -100,6 +104,7 @@ Time the client resource is last updated based on the provider's UTC time. If the client resource was never updated, this value is identical to the value of the 'createdOn' property. */ + @madeRequired(ServiceApiVersions.v2024_01_01) updatedOn: utcDateTime; /** The key-value attributes that are assigned to the client resource. */ @@ -170,5 +175,6 @@ than the previous event. Reason for the disconnection of the MQTT client's session. The value could be one of the values in the disconnection reasons table. */ + @madeRequired(ServiceApiVersions.v2024_01_01) disconnectionReason: EventGridMQTTClientDisconnectionReason; } diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.EventHub/EventHub.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.EventHub/EventHub.tsp index 1f903d9d64ad..38cf0a1e404a 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.EventHub/EventHub.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.EventHub/EventHub.tsp @@ -1,3 +1,5 @@ +import "@typespec/versioning"; +using TypeSpec.Versioning; /** Describes the schema of the Azure EventHub events published to Azure Event Grid. This corresponds to the Data property of an EventGridEvent. */ namespace Microsoft.EventGrid.SystemEvents; @@ -25,8 +27,10 @@ model EventHubCaptureFileCreatedEventData { lastSequenceNumber?: int32; /** The first time from the queue. */ + @madeRequired(ServiceApiVersions.v2024_01_01) firstEnqueueTime: utcDateTime; /** The last time from the queue. */ + @madeRequired(ServiceApiVersions.v2024_01_01) lastEnqueueTime: utcDateTime; } diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.HealthcareApis/HealthcareApis.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.HealthcareApis/HealthcareApis.tsp index 9256d60c1ed6..0e1dce392dbe 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.HealthcareApis/HealthcareApis.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.HealthcareApis/HealthcareApis.tsp @@ -1,9 +1,14 @@ +import "@typespec/versioning"; + +using TypeSpec.Versioning; + /** Describes the schema of the Azure HealthcareApis events published to Azure Event Grid. This corresponds to the Data property of an EventGridEvent. */ namespace Microsoft.EventGrid.SystemEvents { // model HealthcareFhirResourceType is string {} /** Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.FhirResourceCreated event. */ model HealthcareFhirResourceCreatedEventData { /** Type of HL7 FHIR resource. */ + @madeRequired(ServiceApiVersions.v2024_01_01) resourceType: HealthcareFhirResourceType; /** Domain name of FHIR account for this resource. */ @@ -19,6 +24,7 @@ namespace Microsoft.EventGrid.SystemEvents { /** Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.FhirResourceUpdated event. */ model HealthcareFhirResourceUpdatedEventData { /** Type of HL7 FHIR resource. */ + @madeRequired(ServiceApiVersions.v2024_01_01) resourceType: HealthcareFhirResourceType; /** Domain name of FHIR account for this resource. */ @@ -34,6 +40,7 @@ namespace Microsoft.EventGrid.SystemEvents { /** Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.FhirResourceDeleted event. */ model HealthcareFhirResourceDeletedEventData { /** Type of HL7 FHIR resource. */ + @madeRequired(ServiceApiVersions.v2024_01_01) resourceType: HealthcareFhirResourceType; /** Domain name of FHIR account for this resource. */ diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.MachineLearningServices/MachineLearningServices.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.MachineLearningServices/MachineLearningServices.tsp index 7287fceca6e6..41b17e6b9ded 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.MachineLearningServices/MachineLearningServices.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.MachineLearningServices/MachineLearningServices.tsp @@ -1,3 +1,5 @@ +import "@typespec/versioning"; +using TypeSpec.Versioning; /** Describes the schema of the Azure Machine Learning Services events published to Azure Event Grid. This corresponds to the Data property of an EventGridEvent. */ namespace Microsoft.EventGrid.SystemEvents; @@ -82,9 +84,11 @@ model MachineLearningServicesDatasetDriftDetectedEventData { driftCoefficient?: float64; /** The start time of the target dataset time series that resulted in drift detection. */ + @madeRequired(ServiceApiVersions.v2024_01_01) startTime: utcDateTime; /** The end time of the target dataset time series that resulted in drift detection. */ + @madeRequired(ServiceApiVersions.v2024_01_01) endTime: utcDateTime; } diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Media/MediaServices.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Media/MediaServices.tsp index b7662f5bb55c..3dd583abda9b 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Media/MediaServices.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Media/MediaServices.tsp @@ -1,3 +1,7 @@ +import "@typespec/versioning"; + +using TypeSpec.Versioning; + /** Describes the schema of the Azure Media Services events published to Azure Event Grid. This corresponds to the Data property of an EventGridEvent. */ namespace Microsoft.EventGrid.SystemEvents { /** State of a Media Job. */ @@ -101,9 +105,11 @@ namespace Microsoft.EventGrid.SystemEvents { */ model MediaJobStateChangeEventData { /** The previous state of the Job. */ + @madeRequired(ServiceApiVersions.v2024_01_01) previousState: MediaJobState; /** The new state of the Job. */ + @madeRequired(ServiceApiVersions.v2024_01_01) state: MediaJobState; /** Gets the Job correlation data. */ @@ -113,15 +119,18 @@ namespace Microsoft.EventGrid.SystemEvents { /** Details of JobOutput errors. */ model MediaJobError { /** Error code describing the error. */ + @madeRequired(ServiceApiVersions.v2024_01_01) code: MediaJobErrorCode; /** A human-readable language-dependent representation of the error. */ message?: string; /** Helps with categorization of errors. */ + @madeRequired(ServiceApiVersions.v2024_01_01) category: MediaJobErrorCategory; /** Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. */ + @madeRequired(ServiceApiVersions.v2024_01_01) retry: MediaJobRetry; /** An array of details about specific errors that led to this reported error. */ @@ -155,6 +164,7 @@ namespace Microsoft.EventGrid.SystemEvents { progress: int64; /** Gets the Job output state. */ + @madeRequired(ServiceApiVersions.v2024_01_01) state: MediaJobState; } @@ -189,6 +199,7 @@ namespace Microsoft.EventGrid.SystemEvents { */ model MediaJobOutputStateChangeEventData { /** The previous state of the Job. */ + @madeRequired(ServiceApiVersions.v2024_01_01) previousState: MediaJobState; /** Gets the output. */ diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.PolicyInsights/PolicyInsights.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.PolicyInsights/PolicyInsights.tsp index 4f1aeb38de12..ba9e9e526b03 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.PolicyInsights/PolicyInsights.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.PolicyInsights/PolicyInsights.tsp @@ -1,3 +1,5 @@ +import "@typespec/versioning"; +using TypeSpec.Versioning; /** Describes the schema of the Azure Policy events published to Azure Event Grid. This corresponds to the Data property of an EventGridEvent. */ namespace Microsoft.EventGrid.SystemEvents { /** Schema of the Data property of an EventGridEvent for a Microsoft.PolicyInsights.PolicyStateCreated event. */ @@ -17,6 +19,7 @@ namespace Microsoft.EventGrid.SystemEvents { alias PolicyInsightsBaseEventData = { /** The time that the resource was scanned by Azure Policy in the Universal ISO 8601 DateTime format yyyy-MM-ddTHH:mm:ss.fffffffZ. */ + @madeRequired(ServiceApiVersions.v2024_01_01) timestamp: utcDateTime; /** The resource ID of the policy assignment. */ diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ResourceNotifications/ResourceNotifications.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ResourceNotifications/ResourceNotifications.tsp index d43977b7fa8c..d92988211988 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ResourceNotifications/ResourceNotifications.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.ResourceNotifications/ResourceNotifications.tsp @@ -1,3 +1,5 @@ +import "@typespec/versioning"; +using TypeSpec.Versioning; /** Describes the schema of the Health Resources events published to Azure Event Grid. This corresponds to the Data property of an EventGridEvent. @@ -54,6 +56,7 @@ model ResourceNotificationsResourceUpdatedDetails { model ResourceNotificationsOperationalDetails { /** Date and Time when resource was updated */ // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + @madeRequired(ServiceApiVersions.v2024_01_01) resourceEventTime: utcDateTime; } diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.SignalRService/SignalRService.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.SignalRService/SignalRService.tsp index 7eec1b99c30e..332188465cc4 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.SignalRService/SignalRService.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.SignalRService/SignalRService.tsp @@ -1,3 +1,5 @@ +import "@typespec/versioning"; +using TypeSpec.Versioning; /** Describes the schema of the Azure SignalR Service events published to Azure Event Grid. This corresponds to the Data property of an EventGridEvent. */ #suppress "@azure-tools/typespec-azure-core/casing-style" "Modeling after service swagger." namespace Microsoft.EventGrid.SystemEvents { @@ -18,6 +20,7 @@ namespace Microsoft.EventGrid.SystemEvents { alias SignalRServiceBaseEventdata = { /** The time at which the event occurred. */ + @madeRequired(ServiceApiVersions.v2024_01_01) timestamp: utcDateTime; /** The hub of connected client connection. */ diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Storage/Storage.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Storage/Storage.tsp index 88f423a12136..43c5e972dda3 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Storage/Storage.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Storage/Storage.tsp @@ -1,3 +1,5 @@ +import "@typespec/versioning"; +using TypeSpec.Versioning; /** Describes the schema of the Azure Storage events published to Azure Event Grid. This corresponds to the Data property of an EventGridEvent. */ namespace Microsoft.EventGrid.SystemEvents { /** Schema of the Data property of an EventGridEvent for a Microsoft.Storage.BlobCreated event. */ @@ -241,6 +243,7 @@ namespace Microsoft.EventGrid.SystemEvents { /** Schema of the Data property of an EventGridEvent for an Microsoft.Storage.BlobInventoryPolicyCompleted event. */ model StorageBlobInventoryPolicyCompletedEventData { /** The time at which inventory policy was scheduled. */ + @madeRequired(ServiceApiVersions.v2024_01_01) scheduleDateTime: utcDateTime; /** The account name for which inventory policy is registered. */ @@ -265,9 +268,11 @@ namespace Microsoft.EventGrid.SystemEvents { /** Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskCompleted event. */ model StorageTaskCompletedEventData { /** The status for a storage task. */ + @madeRequired(ServiceApiVersions.v2024_01_01) status: StorageTaskCompletedStatus; /** The time at which a storage task was completed. */ + @madeRequired(ServiceApiVersions.v2024_01_01) completedDateTime: utcDateTime; /** The execution id for a storage task. */ @@ -283,6 +288,7 @@ namespace Microsoft.EventGrid.SystemEvents { /** Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskQueued event. */ model StorageTaskQueuedEventData { /** The time at which a storage task was queued. */ + @madeRequired(ServiceApiVersions.v2024_01_01) queuedDateTime: utcDateTime; /** The execution id for a storage task. */ @@ -293,6 +299,7 @@ namespace Microsoft.EventGrid.SystemEvents { model StorageTaskAssignmentQueuedEventData { /** The time at which a storage task was queued. */ // @encode("ISO8601") + @madeRequired(ServiceApiVersions.v2024_01_01) queuedDateTime: utcDateTime; /** The execution id for a storage task. */ @@ -302,10 +309,12 @@ namespace Microsoft.EventGrid.SystemEvents { /** Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskAssignmentCompleted event. */ model StorageTaskAssignmentCompletedEventData { /** The status for a storage task. */ + @madeRequired(ServiceApiVersions.v2024_01_01) status: StorageTaskAssignmentCompletedStatus; /** The time at which a storage task was completed. */ // @encode("ISO8601") + @madeRequired(ServiceApiVersions.v2024_01_01) completedDateTime: utcDateTime; /** The execution id for a storage task. */ diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Web/Web.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Web/Web.tsp index 762cc4d65ce0..12907ed807c7 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Web/Web.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Web/Web.tsp @@ -1,9 +1,14 @@ +import "@typespec/versioning"; + +using TypeSpec.Versioning; + /** Describes the schema of the Azure App Service events published to Azure Event Grid. This corresponds to the Data property of an EventGridEvent. */ namespace Microsoft.EventGrid.SystemEvents { // /** sku of app service plan. */ /** Detail of action on the app. */ model AppEventTypeDetail { /** Type of action of the operation. */ + @madeRequired(ServiceApiVersions.v2024_01_01) action: AppAction; } @@ -142,12 +147,15 @@ namespace Microsoft.EventGrid.SystemEvents { /** Detail of action on the app service plan. */ model AppServicePlanEventTypeDetail { /** Kind of environment where app service plan is. */ + @madeRequired(ServiceApiVersions.v2024_01_01) stampKind: StampKind; /** Type of action on the app service plan. */ + @madeRequired(ServiceApiVersions.v2024_01_01) action: AppServicePlanAction; /** Asynchronous operation status of the operation on the app service plan. */ + @madeRequired(ServiceApiVersions.v2024_01_01) status: AsyncStatus; } diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/HealthResources_AvailabilityStatusChanged.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/HealthResources_AvailabilityStatusChanged.json new file mode 100644 index 000000000000..93799aea17b8 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/HealthResources_AvailabilityStatusChanged.json @@ -0,0 +1,28 @@ +{ + "id": "1fb6fa94-d965-4306-abeq-4810f0774e97", + "source": "/subscriptions/{subscription-id}", + "subject": "/subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Compute/virtualMachines/{vm-name}", + "data": { + "resourceInfo": { + "id": "/subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Compute/virtualMachines/{vm-name}/providers/Microsoft.ResourceHealth/availabilityStatuses/{event-id}", + "name": "{event-id}", + "type": "Microsoft.ResourceHealth/availabilityStatuses", + "properties": { + "targetResourceId": "/subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Compute/virtualMachines/{vm-name}", + "targetResourceType": "Microsoft.Compute/virtualMachines", + "occurredTime": "2023-07-24T19:20:37.9245071Z", + "previousAvailabilityState": "Unavailable", + "availabilityState": "Available" + } + }, + "operationalInfo": { + "resourceEventTime": "2023-07-24T19:20:37.9245071Z" + }, + "apiVersion": "2023-12-01" + }, + "type": "Microsoft.ResourceNotifications.HealthResources.AvailabilityStatusChanged", + "specversion": "1.0", + "time": "2023-07-24T19:20:37.9245071Z", + "operationId": "AvailabilityStatusChangedEventName", + "title": "AvailabilityStatusChanged" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/HealthResources_ResourceAnnotated.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/HealthResources_ResourceAnnotated.json new file mode 100644 index 000000000000..491bfd7597d4 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/HealthResources_ResourceAnnotated.json @@ -0,0 +1,31 @@ +{ + "id": "8945cf9b-e220-496e-ab4f-f3a239318995", + "source": "/subscriptions/{subscription-id}", + "subject": "/subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Compute/virtualMachines/{vm-name}", + "data": { + "resourceInfo": { + "id": "/subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Compute/virtualMachines/{vm-name}/providers/Microsoft.ResourceHealth/resourceAnnotations/{event-id}", + "name": "{event-id}", + "type": "Microsoft.ResourceHealth/resourceAnnotations", + "properties": { + "targetResourceId": "/subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Compute/virtualMachines/{vm-name}", + "targetResourceType": "Microsoft.Compute/virtualMachines", + "occurredTime": "2023-07-24T19:20:37.9245071Z", + "annotationName": "VirtualMachineDeallocationInitiated", + "reason": "Stopping and deallocating", + "summary": "This virtual machine is stopped and deallocated as requested by an authorized user or process.", + "context": "Customer Initiated", + "category": "Not Applicable" + } + }, + "operationalInfo": { + "resourceEventTime": "2023-07-24T19:20:37.9245071Z" + }, + "apiVersion": "2022-08-01" + }, + "type": "Microsoft.ResourceNotifications.HealthResources.ResourceAnnotated", + "specversion": "1.0", + "time": "2023-07-24T19:20:37.9245071Z", + "operationId": "ResourceAnnotatedEventName", + "title": "ResourceAnnotated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/MediaLiveEventChannelArchiveHeartbeatEvent.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/MediaLiveEventChannelArchiveHeartbeatEvent.json new file mode 100644 index 000000000000..27df681b3584 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/MediaLiveEventChannelArchiveHeartbeatEvent.json @@ -0,0 +1,14 @@ +{ + "source": "/subscriptions//resourceGroups//providers/Microsoft.Media/mediaservices/", + "subject": "liveEvent/mle1", + "type": "Microsoft.Media.LiveEventChannelArchiveHeartbeat", + "time": "2021-05-14T23:50:00.3240000", + "id": "7f450938-491f-41e1-b06f-c6cd3965d786", + "data": { + "channelLatencyMs": "10", + "latencyResultCode": "S_OK" + }, + "specversion": "1.0", + "operationId": "LiveEventChannelArchiveHeartbeatEventName", + "title": "LiveEventChannelArchiveHeartbeat" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/MediaLiveEventIngestHeartbeatEvent.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/MediaLiveEventIngestHeartbeatEvent.json new file mode 100644 index 000000000000..fe68e1a956e3 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/MediaLiveEventIngestHeartbeatEvent.json @@ -0,0 +1,28 @@ +{ + "source": "/subscriptions//resourceGroups//providers/Microsoft.Media/mediaservices/", + "subject": "liveEvent/mle1", + "type": "Microsoft.Media.LiveEventIngestHeartbeat", + "time": "2021-05-14T23:50:00.3240000", + "id": "7f450938-491f-41e1-b06f-c6cd3965d786", + "data": { + "trackType": "video", + "trackName": "video", + "bitrate": 2500000, + "incomingBitrate": 2462597, + "lastTimestamp": "106999", + "timescale": "1000", + "overlapCount": 0, + "discontinuityCount": 0, + "nonincreasingCount": 0, + "unexpectedBitrate": false, + "state": "Running", + "healthy": true, + "lastFragmentArrivalTime": "2021-05-14T23:50:00", + "ingestDriftValue": "0", + "transcriptionState": "On", + "transcriptionLanguage": "en-us" + }, + "specversion": "1.0", + "operationId": "LiveEventIngestHeartbeatEventName", + "title": "LiveEventIngestHeartbeat" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/Resources_CreatedOrUpdated.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/Resources_CreatedOrUpdated.json new file mode 100644 index 000000000000..4ba368f76566 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/Resources_CreatedOrUpdated.json @@ -0,0 +1,74 @@ +{ + "id": "4eef929a-a65c-47dd-93e2-46b8c17c6c17", + "source": "/subscriptions/{subscription-id}", + "subject": "/subscriptions/{subscription-id} /resourceGroups/{rg-name}/providers/Microsoft.Storage/storageAccounts/{storageAccount-name}", + "data": { + "resourceInfo": { + "tags": {}, + "id": "/subscriptions/{subcription-id} /resourceGroups/{rg-name}/providers/Microsoft.Storage/storageAccounts/{storageAccount-name}", + "name": "StorageAccount-name", + "type": "Microsoft.Storage/storageAccounts", + "location": "eastus", + "properties": { + "privateEndpointConnections": [], + "minimumTlsVersion": "TLS1_2", + "allowBlobPublicAccess": 1, + "allowSharedKeyAccess": 1, + "networkAcls": { + "bypass": "AzureServices", + "virtualNetworkRules": [], + "ipRules": [], + "defaultAction": "Allow" + }, + "supportsHttpsTrafficOnly": 1, + "encryption": { + "requireInfrastructureEncryption": 0, + "services": { + "file": { + "keyType": "Account", + "enabled": 1, + "lastEnabledTime": "2023-07-28T20:12:50.6380308Z" + }, + "blob": { + "keyType": "Account", + "enabled": 1, + "lastEnabledTime": "2023-07-28T20:12:50.6380308Z" + } + }, + "keySource": "Microsoft.Storage" + }, + "accessTier": "Hot", + "provisioningState": "Succeeded", + "creationTime": "2023-07-28T20:12:50.4661564Z", + "primaryEndpoints": { + "dfs": "https://{storageAccount-name}.dfs.core.windows.net/", + "web": "https://{storageAccount-name}.z13.web.core.windows.net/", + "blob": "https://{storageAccount-name}.blob.core.windows.net/", + "queue": "https://{storageAccount-name}.queue.core.windows.net/", + "table": "https://{storageAccount-name}.table.core.windows.net/", + "file": "https://{storageAccount-name}.file.core.windows.net/" + }, + "primaryLocation": "eastus", + "statusOfPrimary": "available", + "secondaryLocation": "westus", + "statusOfSecondary": "available", + "secondaryEndpoints": { + "dfs": "https://{storageAccount-name} -secondary.dfs.core.windows.net/", + "web": "https://{storageAccount-name}-secondary.z13.web.core.windows.net/", + "blob": "https://{storageAccount-name}-secondary.blob.core.windows.net/", + "queue": "https://{storageAccount-name}-secondary.queue.core.windows.net/", + "table": "https://{storageAccount-name}-secondary.table.core.windows.net/" + } + } + }, + "operationalInfo": { + "resourceEventTime": "2023-07-28T20:13:10.8418063Z" + }, + "apiVersion": "2019-06-01" + }, + "type": "Microsoft.ResourceNotifications.Resources.CreatedOrUpdated", + "specversion": "1.0", + "time": "2023-07-28T20:13:10.8418063Z", + "operationId": "CreatedOrUpdatedEventName", + "title": "CreatedOrUpdated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/Resources_Deleted.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/Resources_Deleted.json new file mode 100644 index 000000000000..5ffd29bde249 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/Resources_Deleted.json @@ -0,0 +1,20 @@ +{ + "id": "d4611260-d179-4f86-b196-3a9d4128be2d", + "source": "/subscriptions/{subscription-id}", + "subject": "/subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Storage/storageAccounts/{storageAccount-name}", + "data": { + "resourceInfo": { + "id": "/subscriptions/{subscription-id}/resourceGroups/{rg-name}/providers/Microsoft.Storage/storageAccounts/{storageAccount-name}", + "name": "storageAccount-name", + "type": "Microsoft.Storage/storageAccounts" + }, + "operationalInfo": { + "resourceEventTime": "2023-07-28T20:11:36.6347858Z" + } + }, + "type": "Microsoft.ResourceNotifications.Resources.Deleted", + "specversion": "1.0", + "time": "2023-07-28T20:11:36.6347858Z", + "operationId": "DeletedEventName", + "title": "Deleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/active_messages_available_periodic_notifications.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/active_messages_available_periodic_notifications.json new file mode 100644 index 000000000000..25820ab479e7 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/active_messages_available_periodic_notifications.json @@ -0,0 +1,18 @@ +{ + "source": "/subscriptions/{subscription-id}/resourcegroups/DemoGroup/providers/Microsoft.ServiceBus/namespaces/{namespace}", + "subject": "topics/{topic}/subscriptions/{subscription}", + "type": "Microsoft.ServiceBus.ActiveMessagesAvailablePeriodicNotifications", + "time": "2018-02-14T05:12:53.4133526Z", + "id": "dede87b0-3656-419c-acaf-70c95ddc60f5", + "data": { + "namespaceName": "{namespace}", + "requestUri": "https://{namespace}.servicebus.windows.net/{topic}/subscriptions/{subscription}/$deadletterqueue/messages/head", + "entityType": "subscriber", + "queueName": null, + "topicName": "{topic}", + "subscriptionName": "{subscription}" + }, + "specversion": "1.0", + "operationId": "ActiveMessagesAvailablePeriodicNotificationsEventName", + "title": "ActiveMessagesAvailablePeriodicNotifications" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/active_messages_available_with_no_listeners.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/active_messages_available_with_no_listeners.json new file mode 100644 index 000000000000..afbd8fed4074 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/active_messages_available_with_no_listeners.json @@ -0,0 +1,18 @@ +{ + "source": "/subscriptions/faa080af-c1d8-40ad-9cce-e1a450ca5b57/resourcegroups/v-tong-MonthlyTrleaseTestPass/providers/Microsoft.ServiceBus/namespaces/othercloudtest", + "subject": "queues/gaoqueue", + "type": "Microsoft.ServiceBus.ActiveMessagesAvailableWithNoListeners", + "time": "2021-09-09T05:43:01.8429206Z", + "id": "3ce929ea-fab7-428a-8270-0452970fa710", + "data": { + "namespaceName": "othercloudtest", + "requestUri": "https://othercloudtest.servicebus.windows.net/gaoqueue/messages/head", + "entityType": "queue", + "queueName": "gaoqueue", + "topicName": null, + "subscriptionName": null + }, + "specversion": "1.0", + "operationId": "ActiveMessagesAvailableWithNoListenersEventName", + "title": "ActiveMessagesAvailableWithNoListeners" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/apiCreated.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/apiCreated.json new file mode 100644 index 000000000000..b18026ef1ecc --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/apiCreated.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}", + "subject": "/apis/myapi", + "type": "Microsoft.ApiManagement.APICreated", + "time": "2021-07-12T23:13:44.9048323Z", + "id": "95015754-aa51-4eb6-98d9-9ee322b82ad7", + "data": { + "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/apis/myapi" + }, + "specversion": "1.0", + "operationId": "APICreatedEventName", + "title": "APICreated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/apiDeleted.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/apiDeleted.json new file mode 100644 index 000000000000..a83f317cafab --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/apiDeleted.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}", + "subject": "/apis/myapi;Rev=1", + "type": "Microsoft.ApiManagement.APIDeleted", + "time": "2021-07-12T23:13:44.9048323Z", + "id": "95015754-aa51-4eb6-98d9-9ee322b82ad7", + "data": { + "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/apis/myapi;Rev=1" + }, + "specversion": "1.0", + "operationId": "APIDeletedEventName", + "title": "APIDeleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/apiReleaseCreated.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/apiReleaseCreated.json new file mode 100644 index 000000000000..7bc9e9c121e2 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/apiReleaseCreated.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}", + "subject": "/apis/{apiId}/releases/{releaseId}", + "type": "Microsoft.ApiManagement.APIReleaseCreated", + "time": "2021-07-12T23:13:44.9048323Z", + "id": "95015754-aa51-4eb6-98d9-9ee322b82ad7", + "data": { + "resourceUri": "/subscriptions/subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/apis/{apiId}/releases/{releaseId}" + }, + "specversion": "1.0", + "operationId": "APIReleaseCreatedEventName", + "title": "APIReleaseCreated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/apiReleaseDeleted.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/apiReleaseDeleted.json new file mode 100644 index 000000000000..809b213397e9 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/apiReleaseDeleted.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}", + "subject": "/apis/{apiId}/releases/{releaseId}", + "type": "Microsoft.ApiManagement.APIReleaseDeleted", + "time": "2021-07-12T23:13:44.9048323Z", + "id": "95015754-aa51-4eb6-98d9-9ee322b82ad7", + "data": { + "resourceUri": "/subscriptions/subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/apis/{apiId}/releases/{releaseId}" + }, + "specversion": "1.0", + "operationId": "APIReleaseDeletedEventName", + "title": "APIReleaseDeleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/apiReleaseUpdated.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/apiReleaseUpdated.json new file mode 100644 index 000000000000..84b3512bba39 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/apiReleaseUpdated.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}", + "subject": "/apis/{apiId}/releases/{releaseId}", + "type": "Microsoft.ApiManagement.APIReleaseUpdated", + "time": "2021-07-12T23:13:44.9048323Z", + "id": "95015754-aa51-4eb6-98d9-9ee322b82ad7", + "data": { + "resourceUri": "/subscriptions/subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/apis/{apiId}/releases/{releaseId}" + }, + "specversion": "1.0", + "operationId": "APIReleaseUpdatedEventName", + "title": "APIReleaseUpdated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/apiUpdated.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/apiUpdated.json new file mode 100644 index 000000000000..14f42cdcf690 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/apiUpdated.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}", + "subject": "/apis/myapi;Rev=1", + "type": "Microsoft.ApiManagement.APIUpdated", + "time": "2021-07-12T23:13:44.9048323Z", + "id": "95015754-aa51-4eb6-98d9-9ee322b82ad7", + "data": { + "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/apis/myapi;Rev=1" + }, + "specversion": "1.0", + "operationId": "APIUpdatedEventName", + "title": "APIUpdated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/app_service_plan_updated.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/app_service_plan_updated.json new file mode 100644 index 000000000000..85df248a02a5 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/app_service_plan_updated.json @@ -0,0 +1,30 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.Web/serverfarms/{serverfarm-name}", + "subject": "/Microsoft.Web/serverfarms/{plan-name}", + "type": "Microsoft.Web.AppServicePlanUpdated", + "time": "2020-01-28T18:22:23.5516004Z", + "id": "56501672-9150-40e1-893a-18420c7fdbf7", + "data": { + "serverFarmEventTypeDetail": { + "stampKind": "Public", + "action": "Updated", + "status": "Started" + }, + "serverFarmId": "0", + "sku": { + "name": "P1v2", + "tier": "PremiumV2", + "size": "P1v2", + "family": "Pv2", + "capacity": 1 + }, + "clientRequestId": "8f880321-a991-45c7-b743-6ff63fe4c004", + "correlationRequestId": "1995c3be-ba7f-4ccf-94af-516df637ec8a", + "requestId": "b973a8e6-6949-4783-b44c-ac778be831bb", + "address": "/websystems/WebSites/serverfarms/subscriptions/{subscription-id}/webspaces/{webspace-id}/serverfarms/{plan-name}/async", + "verb": "PUT" + }, + "specversion": "1.0", + "operationId": "AppServicePlanUpdatedEventName", + "title": "AppServicePlanUpdated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/app_updated_changed_app_settings.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/app_updated_changed_app_settings.json new file mode 100644 index 000000000000..c4de138b0d5a --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/app_updated_changed_app_settings.json @@ -0,0 +1,21 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.Web/sites/{site-name}", + "subject": "/Microsoft.Web/sites/{site-name}", + "type": "Microsoft.Web.AppUpdated", + "time": "2020-01-28T18:22:30.2760952Z", + "id": "b74ea56b-2a3f-4de5-a5d7-38e60c81cf23", + "data": { + "appEventTypeDetail": { + "action": "Stopped" + }, + "name": "{site-name}", + "clientRequestId": "64a5e0aa-7cee-4ff1-9093-b9197b820014", + "correlationRequestId": "25bb36a5-8f6c-4f04-b615-e9a0ee045756", + "requestId": "f2e8eb3f-b190-42de-b99e-6acefe587374", + "address": "/websystems/WebSites/web/subscriptions/{subscription-id}/webspaces/{webspace}/sites/{site-name}/stop", + "verb": "POST" + }, + "specversion": "1.0", + "operationId": "AppUpdatedEventName", + "title": "AppUpdated Changed App Settings" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/app_updated_restarted.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/app_updated_restarted.json new file mode 100644 index 000000000000..2ffb6a7c1579 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/app_updated_restarted.json @@ -0,0 +1,21 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.Web/sites/{site-name}", + "subject": "/Microsoft.Web/sites/{site-name}", + "type": "Microsoft.Web.AppUpdated", + "time": "2020-01-28T18:22:30.2760952Z", + "id": "b74ea56b-2a3f-4de5-a5d7-38e60c81cf23", + "data": { + "appEventTypeDetail": { + "action": "Stopped" + }, + "name": "{site-name}", + "clientRequestId": "64a5e0aa-7cee-4ff1-9093-b9197b820014", + "correlationRequestId": "25bb36a5-8f6c-4f04-b615-e9a0ee045756", + "requestId": "f2e8eb3f-b190-42de-b99e-6acefe587374", + "address": "/websystems/WebSites/web/subscriptions/{subscription-id}/webspaces/{webspace}/sites/{site-name}/stop", + "verb": "POST" + }, + "specversion": "1.0", + "operationId": "AppUpdatedEventName", + "title": "AppUpdated Restarted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/app_updated_stopped.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/app_updated_stopped.json new file mode 100644 index 000000000000..1418759eb75f --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/app_updated_stopped.json @@ -0,0 +1,21 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.Web/sites/{site-name}", + "subject": "/Microsoft.Web/sites/{site-name}", + "type": "Microsoft.Web.AppUpdated", + "time": "2020-01-28T18:22:30.2760952Z", + "id": "b74ea56b-2a3f-4de5-a5d7-38e60c81cf23", + "data": { + "appEventTypeDetail": { + "action": "Stopped" + }, + "name": "{site-name}", + "clientRequestId": "64a5e0aa-7cee-4ff1-9093-b9197b820014", + "correlationRequestId": "25bb36a5-8f6c-4f04-b615-e9a0ee045756", + "requestId": "f2e8eb3f-b190-42de-b99e-6acefe587374", + "address": "/websystems/WebSites/web/subscriptions/{subscription-id}/webspaces/{webspace}/sites/{site-name}/stop", + "verb": "POST" + }, + "specversion": "1.0", + "operationId": "AppUpdatedEventName", + "title": "AppUpdated Stopped" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/backup_operation_completed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/backup_operation_completed.json new file mode 100644 index 000000000000..cececab71686 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/backup_operation_completed.json @@ -0,0 +1,21 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.Web/sites/{site-name}", + "subject": "/Microsoft.Web/sites/{site-name}", + "type": "Microsoft.Web.BackupOperationCompleted", + "time": "2020-01-28T18:26:51.7194887Z", + "id": "7c5d6de5-eb70-4de2-b788-c52a544e68b8", + "data": { + "appEventTypeDetail": { + "action": "Started" + }, + "name": "{site-name}", + "clientRequestId": "None", + "correlationRequestId": "None", + "requestId": "292f499d-04ee-4066-994d-c2df57b99198", + "address": "None", + "verb": "None" + }, + "specversion": "1.0", + "operationId": "BackupOperationCompletedEventName", + "title": "BackupOperationCompleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/backup_operation_failed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/backup_operation_failed.json new file mode 100644 index 000000000000..066b7f80aa0a --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/backup_operation_failed.json @@ -0,0 +1,21 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.Web/sites/{site-name}", + "subject": "/Microsoft.Web/sites/{site-name}", + "type": "Microsoft.Web.BackupOperationFailed", + "time": "2020-01-28T18:26:51.7194887Z", + "id": "7c5d6de5-eb70-4de2-b788-c52a544e68b8", + "data": { + "appEventTypeDetail": { + "action": "Started" + }, + "name": "{site-name}", + "clientRequestId": "None", + "correlationRequestId": "None", + "requestId": "292f499d-04ee-4066-994d-c2df57b99198", + "address": "None", + "verb": "None" + }, + "specversion": "1.0", + "operationId": "BackupOperationFailedEventName", + "title": "BackupOperationFailed" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/backup_operation_started.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/backup_operation_started.json new file mode 100644 index 000000000000..d8cf500757b3 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/backup_operation_started.json @@ -0,0 +1,21 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.Web/sites/{site-name}", + "subject": "/Microsoft.Web/sites/{site-name}", + "type": "Microsoft.Web.BackupOperationStarted", + "time": "2020-01-28T18:26:51.7194887Z", + "id": "7c5d6de5-eb70-4de2-b788-c52a544e68b8", + "data": { + "appEventTypeDetail": { + "action": "Started" + }, + "name": "{site-name}", + "clientRequestId": "None", + "correlationRequestId": "None", + "requestId": "292f499d-04ee-4066-994d-c2df57b99198", + "address": "None", + "verb": "None" + }, + "specversion": "1.0", + "operationId": "BackupOperationStartedEventName", + "title": "BackupOperationStarted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/blob_created.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/blob_created.json new file mode 100644 index 000000000000..f31c5f8a4122 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/blob_created.json @@ -0,0 +1,24 @@ +{ + "source": "/subscriptions/faa080af-c1d8-40ad-9cce-e1a450ca5b57/resourceGroups/jolov/providers/Microsoft.Storage/storageAccounts/jolovstorage", + "subject": "/blobServices/default/containers/gaocontainer/blobs/Template1.xlsx", + "type": "Microsoft.Storage.BlobCreated", + "time": "2021-08-16T02:51:26.4248221Z", + "id": "beb21a5e-401e-002b-3749-928517060431", + "data": { + "api": "PutBlob", + "clientRequestId": "89bc72c2-5dfe-4d9f-9706-43612c1bd01b", + "requestId": "beb21a5e-401e-002b-3749-928517000000", + "eTag": "0x8D96060BDA19D9D", + "contentType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", + "contentLength": 17555, + "blobType": "BlockBlob", + "url": "https://jolovstorage.blob.core.windows.net/gaocontainer/Template1.xlsx", + "sequencer": "0000000000000000000000000000B00D0000000005b058d3", + "storageDiagnostics": { + "batchId": "23f68872-a006-0065-0049-9240f2000000" + } + }, + "specversion": "1.0", + "operationId": "BlobCreatedEventName", + "title": "BlobCreated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/blob_deleted.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/blob_deleted.json new file mode 100644 index 000000000000..2d09010d3709 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/blob_deleted.json @@ -0,0 +1,23 @@ +{ + "source": "/subscriptions/faa080af-c1d8-40ad-9cce-e1a450ca5b57/resourceGroups/jolov/providers/Microsoft.Storage/storageAccounts/jolovstorage", + "subject": "/blobServices/default/containers/gaocontainer/blobs/Template1.xlsx", + "type": "Microsoft.Storage.BlobDeleted", + "time": "2021-08-16T02:58:18.5038290Z", + "id": "3626e710-c01e-005c-794a-92005606d96d", + "data": { + "api": "DeleteBlob", + "requestId": "3626e710-c01e-005c-794a-920056000000", + "eTag": "0x8D96061B33FE1D2", + "contentType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", + "contentLength": 17555, + "blobType": "BlockBlob", + "url": "https://jolovstorage.blob.core.windows.net/gaocontainer/Template1.xlsx", + "sequencer": "0000000000000000000000000000B00D0000000005b29696", + "storageDiagnostics": { + "batchId": "24045172-a006-0065-004a-9240f2000000" + } + }, + "specversion": "1.0", + "operationId": "BlobDeletedEventName", + "title": "BlobDeleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/blob_inventory_policy_completed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/blob_inventory_policy_completed.json new file mode 100644 index 000000000000..afa2e7830213 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/blob_inventory_policy_completed.json @@ -0,0 +1,19 @@ +{ + "source": "/subscriptions/faa080af-c1d8-40ad-9cce-e1a450ca5b57/resourceGroups/jolov/providers/Microsoft.Storage/storageAccounts/jolovstorage", + "subject": "BlobDataManagement/BlobInventory", + "type": "Microsoft.Storage.BlobInventoryPolicyCompleted", + "time": "2021-08-20T22:26:04.0000000Z", + "id": "5d055648-1126-4053-bc6f-f86b8d14790f", + "data": { + "scheduleDateTime": "2021-08-20T22:04:55Z", + "accountName": "jolovstorage", + "ruleName": "gao8.20", + "policyRunStatus": "Succeeded", + "policyRunStatusMessage": "Inventory run succeeded, refer manifest file for inventory details.", + "policyRunId": "83e7c94c-6973-4fbc-acdc-88277e448bf5", + "manifestBlobUrl": "https://jolovstorage.blob.core.windows.net/gaoaugcontainer/2021/08/20/22-04-55/gao8.20/gao8.20-manifest.json" + }, + "specversion": "1.0", + "operationId": "BlobInventoryPolicyCompletedEventName", + "title": "BlobInventoryPolicyCompleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/blob_renamed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/blob_renamed.json new file mode 100644 index 000000000000..eb323b34bce5 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/blob_renamed.json @@ -0,0 +1,22 @@ +{ + "source": "/subscriptions/faa080af-c1d8-40ad-9cce-e1a450ca5b57/resourceGroups/jolov/providers/Microsoft.Storage/storageAccounts/jolovdfs", + "subject": "/blobServices/default/containers/gaocontainer/blobs/newname", + "type": "Microsoft.Storage.BlobRenamed", + "time": "2021-08-19T01:37:38.9324784Z", + "id": "707665f1-a01f-0037-799a-9490a106020e", + "data": { + "api": "RenameFile", + "requestId": "707665f1-a01f-0037-799a-9490a1000000", + "destinationBlobUrl": "https://jolovdfs.blob.core.windows.net/gaocontainer/newname", + "sourceBlobUrl": "https://jolovdfs.blob.core.windows.net/gaocontainer/metrics.txt", + "destinationUrl": "https://jolovdfs.dfs.core.windows.net/gaocontainer/newname", + "sourceUrl": "https://jolovdfs.dfs.core.windows.net/gaocontainer/metrics.txt", + "sequencer": "0000000000000000000000000000010200000000000364db", + "storageDiagnostics": { + "batchId": "69bbaf93-267f-4752-9267-b575e61e0d5d" + } + }, + "specversion": "1.0", + "operationId": "BlobRenamedEventName", + "title": "BlobRenamed" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/blob_tier_changed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/blob_tier_changed.json new file mode 100644 index 000000000000..b47e37c1bfea --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/blob_tier_changed.json @@ -0,0 +1,23 @@ +{ + "source": "/subscriptions/faa080af-c1d8-40ad-9cce-e1a450ca5b57/resourceGroups/jolov/providers/Microsoft.Storage/storageAccounts/jolovstorage", + "subject": "/blobServices/default/containers/gaocontainer/blobs/Template1.xlsx", + "type": "Microsoft.Storage.BlobTierChanged", + "time": "2021-08-16T03:13:40.5681296Z", + "id": "5ed67fc9-401e-0009-354c-92eb2106efc7", + "data": { + "api": "SetBlobTier", + "requestId": "5ed67fc9-401e-0009-354c-92eb21000000", + "eTag": "0x8D9606211320D17", + "contentType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", + "contentLength": 17555, + "blobType": "BlockBlob", + "url": "https://jolovstorage.blob.core.windows.net/gaocontainer/Template1.xlsx", + "sequencer": "0000000000000000000000000000B00D0000000005b7c63a", + "storageDiagnostics": { + "batchId": "24231d1f-a006-0065-004c-9240f2000000" + } + }, + "specversion": "1.0", + "operationId": "BlobTierChangedEventName", + "title": "BlobTierChanged" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/capture_file_created.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/capture_file_created.json new file mode 100644 index 000000000000..cf34596b1244 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/capture_file_created.json @@ -0,0 +1,21 @@ +{ + "source": "/subscriptions/{guid}/resourcegroups/rgDataMigrationSample/providers/Microsoft.EventHub/namespaces/tfdatamigratens", + "subject": "eventhubs/hubdatamigration", + "type": "Microsoft.EventHub.CaptureFileCreated", + "time": "2017-08-31T19:12:46.0498024Z", + "id": "14e87d03-6fbf-4bb2-9a21-92bd1281f247", + "data": { + "fileUrl": "https://tf0831datamigrate.blob.core.windows.net/windturbinecapture/tfdatamigratens/hubdatamigration/1/2017/08/31/19/11/45.avro", + "fileType": "AzureBlockBlob", + "partitionId": "1", + "sizeInBytes": 249168, + "eventCount": 1500, + "firstSequenceNumber": 2400, + "lastSequenceNumber": 3899, + "firstEnqueueTime": "2017-08-31T19:12:14.674Z", + "lastEnqueueTime": "2017-08-31T19:12:44.309Z" + }, + "specversion": "1.0", + "operationId": "CaptureFileCreatedEventName", + "title": "CaptureFileCreated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chart_deleted.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chart_deleted.json new file mode 100644 index 000000000000..8d469b96edaf --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chart_deleted.json @@ -0,0 +1,28 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.ContainerRegistry/registries/{name}", + "subject": "mychart:1.0.0", + "type": "Microsoft.ContainerRegistry.ChartDeleted", + "time": "2019-03-12T22:42:08.7034064Z", + "id": "39136b3a-1a7e-416f-a09e-5c85d5402fca", + "data": { + "id": "ea3a9c28-5b17-40f6-a500-3f02b682927", + "timestamp": "2019-03-12T15:42:08.3783775-07:00", + "action": "chart_delete", + "location": "westus", + "target": { + "mediaType": "application/vnd.acr.helm.chart", + "size": 25265, + "digest": "sha256:7f060075264b5ba7c14c23672698152ae6a3ebac1c47916e4efe19cd624d5fab", + "repository": "repo", + "tag": "mychart-1.0.0.tgz", + "name": "mychart", + "version": "1.0.0" + }, + "connectedRegistry": { + "name": "edge1" + } + }, + "specversion": "1.0", + "operationId": "ChartDeletedEventName", + "title": "ChartDeleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chart_pushed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chart_pushed.json new file mode 100644 index 000000000000..1aed13dbb33f --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chart_pushed.json @@ -0,0 +1,28 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.ContainerRegistry/registries/{name}", + "subject": "mychart:1.0.0", + "type": "Microsoft.ContainerRegistry.ChartPushed", + "time": "2019-03-12T22:16:31.5164086Z", + "id": "ea3a9c28-5b17-40f6-a500-3f02b6829277", + "data": { + "id": "ea3a9c28-5b17-40f6-a500-3f02b682927", + "timestamp": "2019-03-12T15:16:31.0087496-07:00", + "action": "chart_push", + "location": "westus", + "target": { + "mediaType": "application/vnd.acr.helm.chart", + "size": 25265, + "digest": "sha256:7f060075264b5ba7c14c23672698152ae6a3ebac1c47916e4efe19cd624d5fab", + "repository": "repo", + "tag": "mychart-1.0.0.tgz", + "name": "mychart", + "version": "1.0.0" + }, + "connectedRegistry": { + "name": "edge1" + } + }, + "specversion": "1.0", + "operationId": "ChartPushedEventName", + "title": "ChartPushed" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_message_deleted.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_message_deleted.json new file mode 100644 index 000000000000..af12a893574b --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_message_deleted.json @@ -0,0 +1,34 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "thread/{thread-id}/sender/{rawId}/recipient/{rawId}", + "type": "Microsoft.Communication.ChatMessageDeleted", + "time": "2021-02-19T00:43:10.9982947Z", + "id": "23cfcc13-33f2-4ae1-8d23-b5015b05302b", + "data": { + "deleteTime": "2021-02-19T00:43:10.14Z", + "messageId": "1613695388152", + "senderId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-578d-7d07-83fe-084822000f6e", + "senderCommunicationIdentifier": { + "rawId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-578d-7d07-83fe-084822000f6e", + "communicationUser": { + "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-578d-7d07-83fe-084822000f6e" + } + }, + "senderDisplayName": "Bob(Admin)", + "composeTime": "2021-02-19T00:43:08.152Z", + "type": "Text", + "version": 1613695390361, + "recipientId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-578d-7d60-83fe-084822000f6f", + "recipientCommunicationIdentifier": { + "rawId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-578d-7d60-83fe-084822000f6f", + "communicationUser": { + "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-578d-7d60-83fe-084822000f6f" + } + }, + "transactionId": "fFs4InlBn0O/0WyhfQZVSQ.1.1.2.1.1867776045.1.4", + "threadId": "19:48899258eec941e7a281e03edc8f4964@thread.v2" + }, + "specversion": "1.0", + "operationId": "ChatMessageDeletedEventName", + "title": "ChatMessageDeleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_message_deleted_in_thread.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_message_deleted_in_thread.json new file mode 100644 index 000000000000..a18d69128cca --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_message_deleted_in_thread.json @@ -0,0 +1,26 @@ +{ + "source": "/subscriptions/{subscription-id}/resourcegroups/{group-name}/providers/microsoft.communication/communicationservices/{communication-services-resource-name}", + "subject": "thread/{thread-id}/sender/{rawId}", + "type": "Microsoft.Communication.ChatMessageDeletedInThread", + "time": "2021-02-20T01:00:14.8518034Z", + "id": "17d9c39d-0c58-4ed8-947d-c55959f57f75", + "data": { + "deleteTime": "2021-02-19T16:59:10.464-08:00", + "messageId": "1613782685440", + "type": "Text", + "version": "1613782814333", + "senderDisplayName": "Scott", + "senderCommunicationIdentifier": { + "rawId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38a0-88f7-084822002453", + "communicationUser": { + "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38a0-88f7-084822002453" + } + }, + "composeTime": "2021-02-19T16:58:05.44-08:00", + "threadId": "19:e07c8ddc5bab4c059ea9f11d29b544b6@thread.v2", + "transactionId": "HqU6PeK5AkCRSpW8eAbL0A.1.1.2.1.987824181.1" + }, + "specversion": "1.0", + "operationId": "ChatMessageDeletedInThreadEventName", + "title": "ChatMessageDeletedInThread" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_message_edited.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_message_edited.json new file mode 100644 index 000000000000..8d18c57c3bcc --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_message_edited.json @@ -0,0 +1,39 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "thread/{thread-id}/sender/{rawId}/recipient/{rawId}", + "type": "Microsoft.Communication.ChatMessageEdited", + "time": "2021-02-19T00:28:21.7456718Z", + "id": "93fc1037-b645-4eb0-a0f2-d7bb3ba6e060", + "data": { + "editTime": "2021-02-19T00:28:20.784Z", + "messageBody": "Let's Chat about new communication services.", + "messageId": "1613694357917", + "metadata": { + "key": "value", + "description": "A map of data associated with the message" + }, + "senderId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-578d-7caf-07fd-084822001724", + "senderCommunicationIdentifier": { + "rawId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-578d-7caf-07fd-084822001724", + "communicationUser": { + "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-578d-7caf-07fd-084822001724" + } + }, + "senderDisplayName": "Bob(Admin)", + "composeTime": "2021-02-19T00:25:57.917Z", + "type": "Text", + "version": 1613694500784, + "recipientId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-578d-7d60-83fe-084822000f6f", + "recipientCommunicationIdentifier": { + "rawId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-578d-7d60-83fe-084822000f6f", + "communicationUser": { + "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-578d-7d60-83fe-084822000f6f" + } + }, + "transactionId": "1mL4XZH2gEecu/alk9tOtw.2.1.2.1.1833042153.1.7", + "threadId": "19:6e5d6ca1d75044a49a36a7965ec4a906@thread.v2" + }, + "specversion": "1.0", + "operationId": "ChatMessageEditedEventName", + "title": "ChatMessageEdited" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_message_edited_in_thread.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_message_edited_in_thread.json new file mode 100644 index 000000000000..650a5a61046d --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_message_edited_in_thread.json @@ -0,0 +1,31 @@ +{ + "source": "/subscriptions/{subscription-id}/resourcegroups/{group-name}/providers/microsoft.communication/communicationservices/{communication-services-resource-name}", + "subject": "thread/{thread-id}/sender/{rawId}", + "type": "Microsoft.Communication.ChatMessageEditedInThread", + "time": "2021-02-20T00:59:10.7600061Z", + "id": "7b8dc01e-2659-41fa-bc8c-88a967714510", + "data": { + "editTime": "2021-02-19T16:59:10.464-08:00", + "messageBody": "8effb181-1eb2-4a58-9d03-ed48a461b19b", + "messageId": "1613782685964", + "metadata": { + "key": "value", + "description": "A map of data associated with the message" + }, + "type": "Text", + "version": "1613782750464", + "senderDisplayName": "Scott", + "senderCommunicationIdentifier": { + "rawId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38a0-88f7-084822002453", + "communicationUser": { + "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38a0-88f7-084822002453" + } + }, + "composeTime": "2021-02-19T16:58:05.964-08:00", + "threadId": "19:e07c8ddc5bab4c059ea9f11d29b544b6@thread.v2", + "transactionId": "H8Gpj3NkIU6bXlWw8WPvhQ.2.1.2.1.985333801.1" + }, + "specversion": "1.0", + "operationId": "ChatMessageEditedInThreadEventName", + "title": "ChatMessageEditedInThread" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_message_received.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_message_received.json new file mode 100644 index 000000000000..39c7115e884b --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_message_received.json @@ -0,0 +1,38 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "thread/{thread-id}/sender/{rawId}/recipient/{rawId}", + "type": "Microsoft.Communication.ChatMessageReceived", + "time": "2021-02-19T00:25:59.9436666Z", + "id": "02272459-badb-4e2e-b538-4cb8a2f71da6", + "data": { + "messageBody": "Welcome to Azure Communication Services", + "messageId": "1613694358927", + "metadata": { + "key": "value", + "description": "A map of data associated with the message" + }, + "senderId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-578d-7caf-07fd-084822001724", + "senderCommunicationIdentifier": { + "rawId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-578d-7caf-07fd-084822001724", + "communicationUser": { + "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-578d-7caf-07fd-084822001724" + } + }, + "senderDisplayName": "Jhon", + "composeTime": "2021-02-19T00:25:58.927Z", + "type": "Text", + "version": 1613694358927, + "recipientId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-578d-7d05-83fe-084822000f6d", + "recipientCommunicationIdentifier": { + "rawId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-578d-7d05-83fe-084822000f6d", + "communicationUser": { + "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-578d-7d05-83fe-084822000f6d" + } + }, + "transactionId": "oh+LGB2dUUadMcTAdRWQxQ.1.1.1.1.1827536918.1.7", + "threadId": "19:6e5d6ca1d75044a49a36a7965ec4a906@thread.v2" + }, + "specversion": "1.0", + "operationId": "ChatMessageReceivedEventName", + "title": "ChatMessageReceived" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_message_received_in_thread.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_message_received_in_thread.json new file mode 100644 index 000000000000..b92d6d6f1423 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_message_received_in_thread.json @@ -0,0 +1,30 @@ +{ + "source": "/subscriptions/{subscription-id}/resourcegroups/{group-name}/providers/microsoft.communication/communicationservices/{communication-services-resource-name}", + "subject": "thread/{thread-id}/sender/8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cdb-4916-07fd-084822002624", + "type": "Microsoft.Communication.ChatMessageReceivedInThread", + "time": "2021-02-20T01:07:10.5704596Z", + "id": "4f614f97-c451-4b82-a8c9-1e30c3bfcda1", + "data": { + "messageBody": "Talk about new Thread Events in commuication services", + "messageId": "1613783230064", + "metadata": { + "key": "value", + "description": "A map of data associated with the message" + }, + "type": "Text", + "version": "1613783230064", + "senderDisplayName": "Bob", + "senderCommunicationIdentifier": { + "rawId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cdb-4916-07fd-084822002624", + "communicationUser": { + "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cdb-4916-07fd-084822002624" + } + }, + "composeTime": "2021-02-19T17:07:10.064-08:00", + "threadId": "19:5b3809e80e4a439d92c3316e273f4a2b@thread.v2", + "transactionId": "foMkntkKS0O/MhMlIE5Aag.1.1.1.1.1004077250.1" + }, + "specversion": "1.0", + "operationId": "ChatMessageReceivedInThreadEventName", + "title": "ChatMessageReceivedInThread" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_participant_added_to_thread_with_user.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_participant_added_to_thread_with_user.json new file mode 100644 index 000000000000..73bd86b07dfe --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_participant_added_to_thread_with_user.json @@ -0,0 +1,41 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "thread/{thread-id}/participantAdded/{rawId}/recipient/{rawId}", + "type": "Microsoft.Communication.ChatParticipantAddedToThreadWithUser", + "time": "2021-02-25T06:37:31.4880091Z", + "id": "049a5a7f-6cd7-43c1-b352-df9e9e6146d1", + "data": { + "time": "2021-02-25T06:37:29.9232485Z", + "addedByCommunicationIdentifier": { + "rawId": "8:acs:0a420b29-555c-4f6b-841e-de8059893bb9_00000008-77c9-8767-1655-373a0d00885d", + "communicationUser": { + "id": "8:acs:0a420b29-555c-4f6b-841e-de8059893bb9_00000008-77c9-8767-1655-373a0d00885d" + } + }, + "participantAdded": { + "displayName": "John Smith", + "participantCommunicationIdentifier": { + "rawId": "8:acs:0a420b29-555c-4f6b-841e-de8059893bb9_00000008-77c9-8785-1655-373a0d00885f", + "communicationUser": { + "id": "8:acs:0a420b29-555c-4f6b-841e-de8059893bb9_00000008-77c9-8785-1655-373a0d00885f" + } + }, + "metadata": { + "key": "value" + } + }, + "recipientCommunicationIdentifier": { + "rawId": "8:acs:0a420b29-555c-4f6b-841e-de8059893bb9_00000008-77c9-8781-1655-373a0d00885e", + "communicationUser": { + "id": "8:acs:0a420b29-555c-4f6b-841e-de8059893bb9_00000008-77c9-8781-1655-373a0d00885e" + } + }, + "createTime": "2021-02-25T06:37:17.371Z", + "version": 1614235049907, + "transactionId": "q7rr9by6m0CiGiQxKdSO1w.1.1.1.1.1473446055.1.6", + "threadId": "19:f1400e1c542f4086a606b52ad20cd0bd@thread.v2" + }, + "specversion": "1.0", + "operationId": "ChatParticipantAddedToThreadWithUserEventName", + "title": "ChatParticipantAddedToThreadWithUser" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_participant_removed_from_thread_with_user.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_participant_removed_from_thread_with_user.json new file mode 100644 index 000000000000..2677715e6c02 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_participant_removed_from_thread_with_user.json @@ -0,0 +1,41 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "thread/{thread-id}/participantRemoved/{rawId}/recipient/{rawId}", + "type": "Microsoft.Communication.ChatParticipantRemovedFromThreadWithUser", + "time": "2021-02-25T06:40:24.2244945Z", + "id": "e8a4df24-799d-4c53-94fd-1e05703a4549", + "data": { + "time": "2021-02-25T06:40:20.3564556Z", + "removedByCommunicationIdentifier": { + "rawId": "8:acs:0a420b29-555c-4f6b-841e-de8059893bb9_00000008-77c9-8767-1655-373a0d00885d", + "communicationUser": { + "id": "8:acs:0a420b29-555c-4f6b-841e-de8059893bb9_00000008-77c9-8767-1655-373a0d00885d" + } + }, + "participantRemoved": { + "displayName": "Bob", + "participantCommunicationIdentifier": { + "rawId": "8:acs:0a420b29-555c-4f6b-841e-de8059893bb9_00000008-77c9-8785-1655-373a0d00885f", + "communicationUser": { + "id": "8:acs:0a420b29-555c-4f6b-841e-de8059893bb9_00000008-77c9-8785-1655-373a0d00885f" + } + }, + "metadata": { + "key": "value" + } + }, + "recipientCommunicationIdentifier": { + "rawId": "8:acs:0a420b29-555c-4f6b-841e-de8059893bb9_00000008-77c9-8781-1655-373a0d00885e", + "communicationUser": { + "id": "8:acs:0a420b29-555c-4f6b-841e-de8059893bb9_00000008-77c9-8781-1655-373a0d00885e" + } + }, + "createTime": "2021-02-25T06:37:17.371Z", + "version": 1614235220325, + "transactionId": "usv74GQ5zU+JmWv/bQ+qfg.1.1.1.1.1480065078.1.5", + "threadId": "19:f1400e1c542f4086a606b52ad20cd0bd@thread.v2" + }, + "specversion": "1.0", + "operationId": "ChatParticipantRemovedFromThreadWithUserEventName", + "title": "ChatParticipantRemovedFromThreadWithUser" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_thread_created.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_thread_created.json new file mode 100644 index 000000000000..826c09701504 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_thread_created.json @@ -0,0 +1,79 @@ +{ + "source": "/subscriptions/{subscription-id}/resourcegroups/{group-name}/providers/microsoft.communication/communicationservices/{communication-services-resource-name}", + "subject": "thread/{thread-id}/createdBy/{rawId}", + "type": "Microsoft.Communication.ChatThreadCreated", + "time": "2021-02-20T00:31:54.5369967Z", + "id": "a607ac52-0974-4d3c-bfd8-6f708a26f509", + "data": { + "createdByCommunicationIdentifier": { + "rawId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38a0-88f7-084822002453", + "communicationUser": { + "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38a0-88f7-084822002453" + } + }, + "properties": { + "topic": "Talk about new Thread Events in commuication services" + }, + "participants": [ + { + "displayName": "Bob", + "participantCommunicationIdentifier": { + "rawId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38a0-88f7-084822002453", + "communicationUser": { + "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38a0-88f7-084822002453" + } + }, + "metadata": { + "key": "value" + } + }, + { + "displayName": "Scott", + "participantCommunicationIdentifier": { + "rawId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38e6-07fd-084822002467", + "communicationUser": { + "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38e6-07fd-084822002467" + } + }, + "metadata": { + "key": "value", + "description": "A map of data associated with the participant" + } + }, + { + "displayName": "Shawn", + "participantCommunicationIdentifier": { + "rawId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38f6-83fe-084822002337", + "communicationUser": { + "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38f6-83fe-084822002337" + } + }, + "metadata": { + "key": "value" + } + }, + { + "displayName": "Anthony", + "participantCommunicationIdentifier": { + "rawId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38e3-e1fe-084822002c35", + "communicationUser": { + "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38e3-e1fe-084822002c35" + } + }, + "metadata": { + "key": "value" + } + } + ], + "metadata": { + "key": "value" + }, + "createTime": "2021-02-19T16:31:54.365-08:00", + "version": 1613781114365, + "threadId": "19:e07c8ddc5bab4c059ea9f11d29b544b6@thread.v2", + "transactionId": "gK6+kgANy0O1wchlVKVTJg.1.1.1.1.921436178.1" + }, + "specversion": "1.0", + "operationId": "ChatThreadCreatedEventName", + "title": "ChatThreadCreated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_thread_created_withUser.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_thread_created_withUser.json new file mode 100644 index 000000000000..d82045ca4b28 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_thread_created_withUser.json @@ -0,0 +1,72 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "thread/{thread-id}/createdBy/rawId/recipient/rawId", + "type": "Microsoft.Communication.ChatThreadCreatedWithUser", + "time": "2021-02-18T23:47:34.7437103Z", + "id": "eba02b2d-37bf-420e-8656-3a42ef74c435", + "data": { + "createdBy": "8:acs:3d703c91-9657-4b3f-b19c-ef9d53f99710_00000008-576c-286d-e1fe-0848220013b9", + "createdByCommunicationIdentifier": { + "rawId": "8:acs:3d703c91-9657-4b3f-b19c-ef9d53f99710_00000008-576c-286d-e1fe-0848220013b9", + "communicationUser": { + "id": "8:acs:3d703c91-9657-4b3f-b19c-ef9d53f99710_00000008-576c-286d-e1fe-0848220013b9" + } + }, + "properties": { + "topic": "Chat about new commuication services" + }, + "members": [ + { + "displayName": "Bob", + "memberId": "8:acs:3d703c91-9657-4b3f-b19c-ef9d53f99710_00000008-576c-286d-e1fe-0848220013b9" + }, + { + "displayName": "John", + "memberId": "8:acs:3d703c91-9657-4b3f-b19c-ef9d53f99710_00000008-576c-289b-07fd-0848220015ea" + } + ], + "participants": [ + { + "displayName": "Bob", + "participantCommunicationIdentifier": { + "rawId": "8:acs:3d703c91-9657-4b3f-b19c-ef9d53f99710_00000008-576c-286d-e1fe-0848220013b9", + "communicationUser": { + "id": "8:acs:3d703c91-9657-4b3f-b19c-ef9d53f99710_00000008-576c-286d-e1fe-0848220013b9" + } + }, + "metadata": { + "key": "value" + } + }, + { + "displayName": "John", + "participantCommunicationIdentifier": { + "rawId": "8:acs:3d703c91-9657-4b3f-b19c-ef9d53f99710_00000008-576c-289b-07fd-0848220015ea", + "communicationUser": { + "id": "8:acs:3d703c91-9657-4b3f-b19c-ef9d53f99710_00000008-576c-289b-07fd-0848220015ea" + } + }, + "metadata": { + "key": "value" + } + } + ], + "metadata": { + "key": "value" + }, + "createTime": "2021-02-18T23:47:26.91Z", + "version": 1613692046910, + "recipientId": "8:acs:3d703c91-9657-4b3f-b19c-ef9d53f99710_00000008-576c-286e-84f5-08482200181c", + "recipientCommunicationIdentifier": { + "rawId": "8:acs:3d703c91-9657-4b3f-b19c-ef9d53f99710_00000008-576c-286e-84f5-08482200181c", + "communicationUser": { + "id": "8:acs:3d703c91-9657-4b3f-b19c-ef9d53f99710_00000008-576c-286e-84f5-08482200181c" + } + }, + "transactionId": "zbZt+9h/N0em+XCW2QvyIA.1.1.1.1.1737228330.0.1737490483.1.6", + "threadId": "19:1d594fb1eeb14566903cbc5decb5bf5b@thread.v2" + }, + "specversion": "1.0", + "operationId": "ChatThreadCreatedWithUserEventName", + "title": "ChatThreadCreatedWithUser" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_thread_deleted.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_thread_deleted.json new file mode 100644 index 000000000000..0abed374bd4c --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_thread_deleted.json @@ -0,0 +1,23 @@ +{ + "source": "/subscriptions/{subscription-id}/resourcegroups/{group-name}/providers/microsoft.communication/communicationservices/{communication-services-resource-name}", + "subject": "thread/{thread-id}/deletedBy/{rawId}", + "type": "Microsoft.Communication.ChatThreadDeleted", + "time": "2021-02-20T00:00:42.5428002Z", + "id": "1dbd5237-4823-4fed-980c-8d27c17cf5b0", + "data": { + "deletedByCommunicationIdentifier": { + "rawId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5c9e-a300-07fd-084822002266", + "communicationUser": { + "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5c9e-a300-07fd-084822002266" + } + }, + "deleteTime": "2021-02-19T16:00:42.109802-08:00", + "createTime": "2021-02-19T16:00:39.947-08:00", + "version": 1613779241389, + "threadId": "19:c9e9f3060b884e448671391882066ac3@thread.v2", + "transactionId": "KibptDpcLEeEFnlR7cI3QA.1.1.2.1.848298005.1" + }, + "specversion": "1.0", + "operationId": "ChatThreadDeletedEventName", + "title": "ChatThreadDeleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_thread_participant_added.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_thread_participant_added.json new file mode 100644 index 000000000000..40572e2922d7 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_thread_participant_added.json @@ -0,0 +1,35 @@ +{ + "source": "/subscriptions/{subscription-id}/resourcegroups/{group-name}/providers/microsoft.communication/communicationservices/{communication-services-resource-name}", + "subject": "thread/{thread-id}/participantadded/{rawId}", + "type": "Microsoft.Communication.ChatThreadParticipantAdded", + "time": "2021-02-20T00:54:43.9866454Z", + "id": "3024eb5d-1d71-49d1-878c-7dc3165433d9", + "data": { + "time": "2021-02-19T16:54:42.8622646-08:00", + "addedByCommunicationIdentifier": { + "rawId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38a0-88f7-084822002453", + "communicationUser": { + "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38a0-88f7-084822002453" + } + }, + "participantAdded": { + "displayName": "Bob", + "participantCommunicationIdentifier": { + "rawId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38f3-88f7-084822002454", + "communicationUser": { + "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38f3-88f7-084822002454" + } + }, + "metadata": { + "key": "value" + } + }, + "createTime": "2021-02-19T16:31:54.365-08:00", + "version": 1613782482822, + "threadId": "19:e07c8ddc5bab4c059ea9f11d29b544b6@thread.v2", + "transactionId": "9q6cO7i4FkaZ+5RRVzshVw.1.1.1.1.974913783.1" + }, + "specversion": "1.0", + "operationId": "ChatThreadParticipantAddedEventName", + "title": "ChatThreadParticipantAdded" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_thread_participant_removed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_thread_participant_removed.json new file mode 100644 index 000000000000..00c5fa061821 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_thread_participant_removed.json @@ -0,0 +1,35 @@ +{ + "source": "/subscriptions/{subscription-id}/resourcegroups/{group-name}/providers/microsoft.communication/communicationservices/{communication-services-resource-name}", + "subject": "thread/{thread-id}/participantremoved/{rawId}", + "type": "Microsoft.Communication.ChatThreadParticipantRemoved", + "time": "2021-02-20T00:56:18.8567210Z", + "id": "6ed810fd-8776-4b13-81c2-1a0c4f791a07", + "data": { + "time": "2021-02-19T16:56:18.1118825-08:00", + "removedByCommunicationIdentifier": { + "rawId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38a0-88f7-084822002453", + "communicationUser": { + "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38a0-88f7-084822002453" + } + }, + "participantRemoved": { + "displayName": "Shawn", + "participantCommunicationIdentifier": { + "rawId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38e6-07fd-084822002467", + "communicationUser": { + "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5cbb-38e6-07fd-084822002467" + } + }, + "metadata": { + "key": "value" + } + }, + "createTime": "2021-02-19T16:31:54.365-08:00", + "version": 1613782578096, + "threadId": "19:e07c8ddc5bab4c059ea9f11d29b544b6@thread.v2", + "transactionId": "zGCq8IGRr0aEF6COuy7wSA.1.1.1.1.978649284.1" + }, + "specversion": "1.0", + "operationId": "ChatThreadParticipantRemovedEventName", + "title": "ChatThreadParticipantRemoved" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_thread_properties_updated.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_thread_properties_updated.json new file mode 100644 index 000000000000..3e0cd3f5481c --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_thread_properties_updated.json @@ -0,0 +1,26 @@ +{ + "source": "/subscriptions/{subscription-id}/resourcegroups/{group-name}/providers/microsoft.communication/communicationservices/{communication-services-resource-name}", + "subject": "thread/{thread-id}/editedBy/{rawId}", + "type": "Microsoft.Communication.ChatThreadPropertiesUpdated", + "time": "2021-02-20T00:04:07.8410277Z", + "id": "cf867580-9caf-45be-b49f-ab1cbfcaa59f", + "data": { + "editedByCommunicationIdentifier": { + "rawId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5c9e-9e35-07fd-084822002264", + "communicationUser": { + "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-5c9e-9e35-07fd-084822002264" + } + }, + "editTime": "2021-02-19T16:04:07.7152073-08:00", + "properties": { + "topic": "Talk about new Thread Events in commuication services" + }, + "createTime": "2021-02-19T16:00:40.126-08:00", + "version": 1613779447695, + "threadId": "19:9e8eefe67b3c470a8187b4c2b00240bc@thread.v2", + "transactionId": "GBE9MB2a40KEWzexIg0D3A.1.1.1.1.856359041.1" + }, + "specversion": "1.0", + "operationId": "ChatThreadPropertiesUpdatedEventName", + "title": "ChatThreadPropertiesUpdated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_thread_properties_updated_per_user.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_thread_properties_updated_per_user.json new file mode 100644 index 000000000000..7da296d593ce --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_thread_properties_updated_per_user.json @@ -0,0 +1,37 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "thread/{thread-id}/editedBy/{rawId}/recipient/{rawId}", + "type": "Microsoft.Communication.ChatThreadPropertiesUpdatedPerUser", + "time": "2021-02-19T00:28:29.5597260Z", + "id": "d57342ff-264e-4a5e-9c54-ef05b7d50082", + "data": { + "editedBy": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-578d-7d07-83fe-084822000f6e", + "editedByCommunicationIdentifier": { + "rawId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-578d-7d07-83fe-084822000f6e", + "communicationUser": { + "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-578d-7d07-83fe-084822000f6e" + } + }, + "editTime": "2021-02-19T00:28:28.7390282Z", + "properties": { + "topic": "Communication in Azure" + }, + "metadata": { + "key": "value" + }, + "createTime": "2021-02-19T00:28:25.864Z", + "version": 1613694508719, + "recipientId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-578d-7caf-07fd-084822001724", + "recipientCommunicationIdentifier": { + "rawId": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-578d-7caf-07fd-084822001724", + "communicationUser": { + "id": "8:acs:109f0644-b956-4cd9-87b1-71024f6e2f44_00000008-578d-7caf-07fd-084822001724" + } + }, + "transactionId": "WLXPrnJ/I0+LTj2cwMrNMQ.1.1.1.1.1833369763.1.4", + "threadId": "19:2cc3504c41244d7483208a4f58a1f188@thread.v2" + }, + "specversion": "1.0", + "operationId": "ChatThreadPropertiesUpdatedPerUserEventName", + "title": "ChatThreadPropertiesUpdatedPerUser" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_thread_with_user_deleted.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_thread_with_user_deleted.json new file mode 100644 index 000000000000..4c3f085b3cbc --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/chat_thread_with_user_deleted.json @@ -0,0 +1,31 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "thread/{thread-id}/deletedBy/{rawId}/recipient/{rawId}", + "type": "Microsoft.Communication.ChatThreadWithUserDeleted", + "time": "2021-02-18T23:57:52.1597234Z", + "id": "f5d6750c-c6d7-4da8-bb05-6f3fca6c7295", + "data": { + "deletedBy": "8:acs:3d703c91-9657-4b3f-b19c-ef9d53f99710_00000008-5772-6473-83fe-084822000e21", + "deletedByCommunicationIdentifier": { + "rawId": "8:acs:3d703c91-9657-4b3f-b19c-ef9d53f99710_00000008-5772-6473-83fe-084822000e21", + "communicationUser": { + "id": "8:acs:3d703c91-9657-4b3f-b19c-ef9d53f99710_00000008-5772-6473-83fe-084822000e21" + } + }, + "deleteTime": "2021-02-18T23:57:51.5987591Z", + "createTime": "2021-02-18T23:54:15.683Z", + "version": 1613692578672, + "recipientId": "8:acs:3d703c91-9657-4b3f-b19c-ef9d53f99710_00000008-5772-647b-e1fe-084822001416", + "recipientCommunicationIdentifier": { + "rawId": "8:acs:3d703c91-9657-4b3f-b19c-ef9d53f99710_00000008-5772-647b-e1fe-084822001416", + "communicationUser": { + "id": "8:acs:3d703c91-9657-4b3f-b19c-ef9d53f99710_00000008-5772-647b-e1fe-084822001416" + } + }, + "transactionId": "mrliWVUndEmLwkZbeS5KoA.1.1.2.1.1761607918.1.6", + "threadId": "19:5870b8f021d74fd786bf5aeb095da291@thread.v2" + }, + "specversion": "1.0", + "operationId": "ChatThreadWithUserDeletedEventName", + "title": "ChatThreadWithUserDeleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/client_connection_connected.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/client_connection_connected.json new file mode 100644 index 000000000000..076064ca5649 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/client_connection_connected.json @@ -0,0 +1,16 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/signalr-rg/providers/Microsoft.SignalRService/SignalR/signalr-resource", + "subject": "/hub/chat", + "type": "Microsoft.SignalRService.ClientConnectionConnected", + "time": "2019-06-10T18:41:00.9584103Z", + "id": "831e1650-001e-001b-66ab-eeb76e069631", + "data": { + "timestamp": "2019-06-10T18:41:00.9584103Z", + "hubName": "chat", + "connectionId": "crH0uxVSvP61p5wkFY1x1A", + "userId": "user-eymwyo23" + }, + "specversion": "1.0", + "operationId": "ClientConnectionConnectedEventName", + "title": "ClientConnectionConnected" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/client_connection_disconnected.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/client_connection_disconnected.json new file mode 100644 index 000000000000..d9f457f792e2 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/client_connection_disconnected.json @@ -0,0 +1,17 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/signalr-rg/providers/Microsoft.SignalRService/SignalR/signalr-resource", + "subject": "/hub/chat", + "type": "Microsoft.SignalRService.ClientConnectionDisconnected", + "time": "2019-06-10T18:41:00.9584103Z", + "id": "831e1650-001e-001b-66ab-eeb76e069631", + "data": { + "timestamp": "2019-06-10T18:41:00.9584103Z", + "hubName": "chat", + "connectionId": "crH0uxVSvP61p5wkFY1x1A", + "userId": "user-eymwyo23", + "errorMessage": "Internal server error." + }, + "specversion": "1.0", + "operationId": "ClientConnectionDisconnectedEventName", + "title": "ClientConnectionDisconnected" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/client_created_or_updated.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/client_created_or_updated.json new file mode 100644 index 000000000000..2b4272ce14d7 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/client_created_or_updated.json @@ -0,0 +1,21 @@ +{ + "specversion": "1.0", + "id": "383d1562-c95f-4095-936c-688e72c6b2bb", + "time": "2023-07-29T01:14:35.8928724Z", + "type": "Microsoft.EventGrid.MQTTClientCreatedOrUpdated", + "source": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg/providers/Microsoft.EventGrid/namespaces/myns", + "subject": "clients/client1", + "data": { + "createdOn": "2023-07-29T01:14:34.2048108Z", + "updatedOn": "2023-07-29T01:14:34.2048108Z", + "namespaceName": "myns", + "clientName": "client1", + "clientAuthenticationName": "client1", + "state": "Enabled", + "attributes": { + "attribute1": "value1" + } + }, + "operationId": "MQTTClientCreatedOrUpdatedEventName", + "title": "MQTTClientCreatedOrUpdated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/client_deleted.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/client_deleted.json new file mode 100644 index 000000000000..c89b48800f36 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/client_deleted.json @@ -0,0 +1,15 @@ +{ + "specversion": "1.0", + "id": "2a93aaf9-66c2-4f8e-9ba3-8d899c10bf17", + "time": "2023-07-29T01:30:52.5620566Z", + "type": "Microsoft.EventGrid.MQTTClientDeleted", + "source": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg/providers/Microsoft.EventGrid/namespaces/myns", + "subject": "clients/client1", + "data": { + "namespaceName": "myns", + "clientName": "client1", + "clientAuthenticationName": "client1" + }, + "operationId": "MQTTClientDeletedEventName", + "title": "MQTTClientDeleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/clientsession_connected.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/clientsession_connected.json new file mode 100644 index 000000000000..316395e92359 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/clientsession_connected.json @@ -0,0 +1,16 @@ +{ + "specversion": "1.0", + "id": "5249c38a-a048-46dd-8f60-df34fcdab06c", + "time": "2023-07-29T01:23:49.6454046Z", + "type": "Microsoft.EventGrid.MQTTClientSessionConnected", + "source": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg/providers/Microsoft.EventGrid/namespaces/myns", + "subject": "clients/client1/sessions/session1", + "data": { + "namespaceName": "myns", + "clientAuthenticationName": "client1", + "clientSessionName": "session1", + "sequenceNumber": 1 + }, + "operationId": "MQTTClientSessionConnectedEventName", + "title": "MQTTClientSessionConnected" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/clientsession_disconnected.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/clientsession_disconnected.json new file mode 100644 index 000000000000..6218ca1e913b --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/clientsession_disconnected.json @@ -0,0 +1,17 @@ +{ + "specversion": "1.0", + "id": "e30e5174-787d-4e19-8812-580148bfcf7b", + "time": "2023-07-29T01:27:40.2446871Z", + "type": "Microsoft.EventGrid.MQTTClientSessionDisconnected", + "source": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg/providers/Microsoft.EventGrid/namespaces/myns", + "subject": "clients/client1/sessions/session1", + "data": { + "namespaceName": "myns", + "clientAuthenticationName": "client1", + "clientSessionName": "session1", + "sequenceNumber": 1, + "disconnectionReason": "ClientInitiatedDisconnect" + }, + "operationId": "MQTTClientSessionDisconnectedEventName", + "title": "MQTTClientSessionDisconnected" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/cluster_support_ended.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/cluster_support_ended.json new file mode 100644 index 000000000000..dffc18810467 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/cluster_support_ended.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ContainerService/managedClusters/{cluster}", + "subject": "{cluster}", + "type": "Microsoft.ContainerService.ClusterSupportEnded", + "time": "2023-03-29T18:00:00.0000000Z", + "id": "1234567890abcdef1234567890abcdef12345678", + "data": { + "kubernetesVersion": "1.23.15" + }, + "specversion": "1.0", + "operationId": "ClusterSupportEndedEventName", + "title": "ClusterSupportEnded" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/cluster_support_ending.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/cluster_support_ending.json new file mode 100644 index 000000000000..951f651513ba --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/cluster_support_ending.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ContainerService/managedClusters/{cluster}", + "subject": "{cluster}", + "type": "Microsoft.ContainerService.ClusterSupportEnding", + "time": "2023-03-29T18:00:00.0000000Z", + "id": "1234567890abcdef1234567890abcdef12345678", + "data": { + "kubernetesVersion": "1.24.10" + }, + "specversion": "1.0", + "operationId": "ClusterSupportEndingEventName", + "title": "ClusterSupportEnding" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/cluster_updated.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/cluster_updated.json new file mode 100644 index 000000000000..f882398b74e2 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/cluster_updated.json @@ -0,0 +1,22 @@ +{ + "source": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.AVS/privateClouds/{sddc_name}", + "subject": "/clusters/{cluster_name}", + "type": "Microsoft.AVS.ClusterUpdated", + "time": "2023-12-09T16:50:19.9995668-05:00", + "id": "9b87886d-21a5-4af5-8e3e-10c4b8dac73b", + "data": { + "addedHostNames": [ + "esx17-r04.p01.431cc…" + ], + "removedHostNames": [ + "esx15-r01.p01.431cc…" + ], + "inMaintenanceHostNames": [ + "esx01-r03.p01.431cc…" + ], + "operationId": "c8c0b304-2db3-402b-8a6b-06065e0e1755" + }, + "specVersion": "1.0", + "operationId": "ClusterUpdatedEventName", + "title": "ClusterUpdated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/copy_completed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/copy_completed.json new file mode 100644 index 000000000000..98275184f557 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/copy_completed.json @@ -0,0 +1,15 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.DataBox/jobs/{your-resource}", + "subject": "/jobs/{your-resource}", + "type": "Microsoft.DataBox.CopyCompleted", + "time": "2022-10-16T02:51:26.4248221Z", + "id": "759c892a-a628-4e48-a116-2e1d54c555ce", + "data": { + "serialNumber": "SampleSerialNumber", + "stageName": "CopyCompleted", + "stageTime": "2022-10-12T19:38:08.0218897Z" + }, + "specVersion": "1.0", + "operationId": "CopyCompletedEventName", + "title": "CopyCompleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/copy_started.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/copy_started.json new file mode 100644 index 000000000000..b801ddeb4498 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/copy_started.json @@ -0,0 +1,15 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.DataBox/jobs/{your-resource}", + "subject": "/jobs/{your-resource}", + "type": "Microsoft.DataBox.CopyStarted", + "time": "2022-10-16T02:51:26.4248221Z", + "id": "049ec3f6-5b7d-4052-858e-6f4ce6a46570", + "data": { + "serialNumber": "SampleSerialNumber", + "stageName": "CopyStarted", + "stageTime": "2022-10-12T19:38:08.0218897Z" + }, + "specVersion": "1.0", + "operationId": "CopyStartedEventName", + "title": "CopyStarted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/dataset_drift_detected.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/dataset_drift_detected.json new file mode 100644 index 000000000000..33ad61a57bc9 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/dataset_drift_detected.json @@ -0,0 +1,20 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.MachineLearningServices/workspaces/{workspace-name}", + "subject": "datadrifts/{}/runs/{}", + "type": "Microsoft.MachineLearningServices.DatasetDriftDetected", + "time": "2017-06-26T18:41:00.9584103Z", + "id": "831e1650-001e-001b-66ab-eeb76e069631", + "data": { + "DataDriftId": "01d29aa4-e6a4-470a-9ef3-66660d21f8ef", + "DataDriftName": "myDriftMonitor", + "RunId": "01d29aa4-e6a4-470a-9ef3-66660d21f8ef_1571590300380", + "BaseDatasetId": "3c56d136-0f64-4657-a0e8-5162089a88a3", + "TargetDatasetId": "d7e74d2e-c972-4266-b5fb-6c9c182d2a74", + "DriftCoefficient": 0.8350349068479208, + "StartTime": "2019-07-03T17:00:00-07:00", + "EndTime": "2019-07-04T17:00:00-07:00" + }, + "specversion": "1.0", + "operationId": "DatasetDriftDetectedEventName", + "title": "DatasetDriftDetected" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/deadletter_messages_available_periodic_notification.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/deadletter_messages_available_periodic_notification.json new file mode 100644 index 000000000000..36d8ffa69db4 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/deadletter_messages_available_periodic_notification.json @@ -0,0 +1,18 @@ +{ + "source": "/subscriptions/{subscription-id}/resourcegroups/DemoGroup/providers/Microsoft.ServiceBus/namespaces/{namespace}", + "subject": "queues/{queue}", + "type": "Microsoft.ServiceBus.DeadletterMessagesAvailablePeriodicNotifications", + "time": "2018-02-14T05:12:53.4133526Z", + "id": "dede87b0-3656-419c-acaf-70c95ddc60f5", + "data": { + "namespaceName": "{namespace}", + "requestUri": "https://{namespace}.servicebus.windows.net/{queue}/$deadletterqueue/messages/head", + "entityType": "subscriber", + "queueName": "{queue}", + "topicName": null, + "subscriptionName": null + }, + "specversion": "1.0", + "operationId": "DeadletterMessagesAvailablePeriodicNotificationsEventName", + "title": "DeadletterMessagesAvailablePeriodicNotifications" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/deadletter_messages_available_with_no_listeners.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/deadletter_messages_available_with_no_listeners.json new file mode 100644 index 000000000000..987421be786b --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/deadletter_messages_available_with_no_listeners.json @@ -0,0 +1,18 @@ +{ + "source": "/subscriptions/{subscription-id}/resourcegroups/{your-rg}/providers/Microsoft.ServiceBus/namespaces/{your-service-bus-namespace}", + "subject": "topics/{your-service-bus-topic}/subscriptions/{your-service-bus-subscription}", + "type": "Microsoft.ServiceBus.DeadletterMessagesAvailableWithNoListeners", + "time": "2018-02-14T05:12:53.4133526Z", + "id": "dede87b0-3656-419c-acaf-70c95ddc60f5", + "data": { + "namespaceName": "YOUR SERVICE BUS NAMESPACE WILL SHOW HERE", + "requestUri": "https://{your-service-bus-namespace}.servicebus.windows.net/{your-topic}/subscriptions/{your-service-bus-subscription}/$deadletterqueue/messages/head", + "entityType": "subscriber", + "queueName": "QUEUE NAME IF QUEUE", + "topicName": "TOPIC NAME IF TOPIC", + "subscriptionName": "SUBSCRIPTION NAME" + }, + "specversion": "1.0", + "operationId": "DeadletterMessagesAvailableWithNoListenersEventName", + "title": "DeadletterMessagesAvailableWithNoListeners" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/device_connected.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/device_connected.json new file mode 100644 index 000000000000..f43cb336e8df --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/device_connected.json @@ -0,0 +1,18 @@ +{ + "source": "/SUBSCRIPTIONS/{subscription-id}/RESOURCEGROUPS{resource-group}/PROVIDERS/MICROSOFT.DEVICES/IOTHUBS/{hub—name}", + "subject": "devices/LogicAppTestDevice", + "type": "Microsoft.Devices.DeviceConnected", + "time": "2018-06-02T19:17:44.4383997Z", + "id": "f6bbf8f4-d365-520d-a878-17bf7238abd8", + "data": { + "deviceConnectionStateEventInfo": { + "sequenceNumber": "000000000000000001D4132452F67CE200000002000000000000000000000001" + }, + "hubName": "egtesthub1", + "deviceId": "LogicAppTestDevice", + "moduleId": "DeviceModuleID" + }, + "specversion": "1.0", + "operationId": "DeviceConnectedEventName", + "title": "DeviceConnected" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/device_created.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/device_created.json new file mode 100644 index 000000000000..dcf8df794805 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/device_created.json @@ -0,0 +1,44 @@ +{ + "source": "/SUBSCRIPTIONS/{subscription-ID}/RESOURCEGROUPS/{resource-group}/PROVIDERS/MICROSOFT.DEVICES/IOTHUBS/{hub-name}", + "subject": "devices/LogicAppTestDevice", + "type": "Microsoft.Devices.DeviceCreated", + "time": "2018-01-02T19:17:44.4383997Z", + "id": "56afc886-767b-d359-d59e-0da7877166b2", + "data": { + "twin": { + "deviceId": "LogicAppTestDevice", + "etag": "AAAAAAAAAAE=", + "deviceEtag": "null", + "status": "enabled", + "statusUpdateTime": "0001-01-01T00:00:00", + "connectionState": "Disconnected", + "lastActivityTime": "0001-01-01T00:00:00", + "cloudToDeviceMessageCount": 0, + "authenticationType": "sas", + "x509Thumbprint": { + "primaryThumbprint": null, + "secondaryThumbprint": null + }, + "version": 2, + "properties": { + "desired": { + "$metadata": { + "$lastUpdated": "2018-01-02T19:17:44.4383997Z" + }, + "$version": 1 + }, + "reported": { + "$metadata": { + "$lastUpdated": "2018-01-02T19:17:44.4383997Z" + }, + "$version": 1 + } + } + }, + "hubName": "egtesthub1", + "deviceId": "LogicAppTestDevice" + }, + "specversion": "1.0", + "operationId": "DeviceCreatedEventName", + "title": "DeviceCreated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/device_telemetry.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/device_telemetry.json new file mode 100644 index 000000000000..d406fff9c2f5 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/device_telemetry.json @@ -0,0 +1,30 @@ +{ + "source": "/SUBSCRIPTIONS/{subscription-ID}/RESOURCEGROUPS/{resource-group}/PROVIDERS/MICROSOFT.DEVICES/IOTHUBS/{hub-name}", + "subject": "devices/LogicAppTestDevice", + "type": "Microsoft.Devices.DeviceTelemetry", + "time": "2019-01-07T20:58:30.4800000Z", + "id": "9af86784-8d40-fe2g-8b2a-bab65e106785", + "data": { + "body": { + "Weather": { + "Temperature": 900 + }, + "Location": "USA" + }, + "properties": { + "Status": "Active" + }, + "systemProperties": { + "iothub-content-type": "application/json", + "iothub-content-encoding": "utf-8", + "iothub-connection-device-id": "d1", + "iothub-connection-auth-method": "{\"scope\":\"device\",\"type\":\"sas\",\"issuer\":\"iothub\",\"acceptingIpFilterRule\":null}", + "iothub-connection-auth-generation-id": "123455432199234570", + "iothub-enqueuedtime": "2019-01-07T20:58:30.48Z", + "iothub-message-source": "Telemetry" + } + }, + "specversion": "1.0", + "operationId": "DeviceTelemetryEventName", + "title": "DeviceTelemetry" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/dicom_image_created.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/dicom_image_created.json new file mode 100644 index 000000000000..41ce40083bc6 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/dicom_image_created.json @@ -0,0 +1,18 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}", + "subject": "{dicom-account}.dicom.azurehealthcareapis.com/v1/partitions/Microsoft.Default/studies/1.2.3.4.3/series/1.2.3.4.3.9423673/instances/1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442", + "type": "Microsoft.HealthcareApis.DicomImageCreated", + "time": "2022-09-15T01:14:04.5613214Z", + "id": "d621839d-958b-4142-a638-bb966b4f7dfd", + "data": { + "partitionName": "Microsoft.Default", + "imageStudyInstanceUid": "1.2.3.4.3", + "imageSeriesInstanceUid": "1.2.3.4.3.9423673", + "imageSopInstanceUid": "1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442", + "serviceHostName": "{dicom-account}.dicom.azurehealthcareapis.com", + "sequenceNumber": 1 + }, + "specversion": "1.0", + "operationId": "DicomImageCreatedEventName", + "title": "DicomImageCreated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/dicom_image_deleted.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/dicom_image_deleted.json new file mode 100644 index 000000000000..aae916c2f6a1 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/dicom_image_deleted.json @@ -0,0 +1,18 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}", + "subject": "{dicom-account}.dicom.azurehealthcareapis.com/v1/partitions/Microsoft.Default/studies/1.2.3.4.3/series/1.2.3.4.3.9423673/instances/1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442", + "type": "Microsoft.HealthcareApis.DicomImageDeleted", + "time": "2022-09-15T01:14:04.5613214Z", + "id": "eac1c1a0-ffa8-4b28-97cc-1d8b9a0a6021", + "data": { + "partitionName": "Microsoft.Default", + "imageStudyInstanceUid": "1.2.3.4.3", + "imageSeriesInstanceUid": "1.2.3.4.3.9423673", + "imageSopInstanceUid": "1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442", + "serviceHostName": "{dicom-account}.dicom.azurehealthcareapis.com", + "sequenceNumber": 2 + }, + "specversion": "1.0", + "operationId": "DicomImageDeletedEventName", + "title": "DicomImageDeleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/dicom_image_updated.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/dicom_image_updated.json new file mode 100644 index 000000000000..930c742cdd5a --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/dicom_image_updated.json @@ -0,0 +1,18 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}", + "subject": "{dicom-account}.dicom.azurehealthcareapis.com/v1/partitions/Microsoft.Default/studies/1.2.3.4.3/series/1.2.3.4.3.9423673/instances/1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442", + "type": "Microsoft.HealthcareApis.DicomImageUpdated", + "time": "2022-09-15T01:14:04.5613214Z", + "id": "7e8aca04-e815-4387-82a8-9fcf15a3114b", + "data": { + "partitionName": "Microsoft.Default", + "imageStudyInstanceUid": "1.2.3.4.3", + "imageSeriesInstanceUid": "1.2.3.4.3.9423673", + "imageSopInstanceUid": "1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442", + "serviceHostName": "{dicom-account}.dicom.azurehealthcareapis.com", + "sequenceNumber": 1 + }, + "specversion": "1.0", + "operationId": "DicomImageUpdatedEventName", + "title": "DicomImageUpdated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/directory_created.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/directory_created.json new file mode 100644 index 000000000000..13490d6b14ff --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/directory_created.json @@ -0,0 +1,33 @@ +{ + "source": "/subscriptions/faa080af-c1d8-40ad-9cce-e1a450ca5b57/resourceGroups/jolov/providers/Microsoft.Storage/storageAccounts/jolovdfs", + "subject": "/blobServices/default/containers/gaocontainer/blobs/gaodir", + "type": "Microsoft.Storage.DirectoryCreated", + "time": "2021-08-16T05:36:06.1613834Z", + "id": "d706a817-d01f-0002-3e60-92fcb5068c19", + "data": { + "api": "CreateDirectory", + "requestId": "d706a817-d01f-0002-3e60-92fcb5000000", + "eTag": "0x8D96077BE69372E", + "directoryProperties": [ + { + "acl": [ + { + "access": "u::rwx,g::rx,o::", + "permission": "0750", + "owner": "$superuser", + "group": "$superuser" + } + ] + } + ], + "blobUrl": "https://jolovdfs.blob.core.windows.net/gaocontainer/gaodir", + "url": "https://jolovdfs.dfs.core.windows.net/gaocontainer/gaodir", + "sequencer": "00000000000000000000000000000102000000000001e192", + "storageDiagnostics": { + "batchId": "e4b5c5d5-b727-4429-b35f-babb83eb15f1" + } + }, + "specversion": "1.0", + "operationId": "DirectoryCreatedEventName", + "title": "DirectoryCreated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/directory_deleted.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/directory_deleted.json new file mode 100644 index 000000000000..773dc9815252 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/directory_deleted.json @@ -0,0 +1,21 @@ +{ + "source": "/subscriptions/faa080af-c1d8-40ad-9cce-e1a450ca5b57/resourceGroups/jolov/providers/Microsoft.Storage/storageAccounts/jolovdfs", + "subject": "/blobServices/default/containers/gaocontainer/blobs/gaodir", + "type": "Microsoft.Storage.DirectoryDeleted", + "time": "2021-08-16T05:36:57.4835481Z", + "id": "45a3a9fa-001f-0001-1b60-921dd1069801", + "data": { + "api": "DeleteDirectory", + "requestId": "45a3a9fa-001f-0001-1b60-921dd1000000", + "blobUrl": "https://jolovdfs.blob.core.windows.net/gaocontainer/gaodir", + "url": "https://jolovdfs.dfs.core.windows.net/gaocontainer/gaodir", + "recursive": "false", + "sequencer": "00000000000000000000000000000102000000000001e1a4", + "storageDiagnostics": { + "batchId": "c41d46e2-dfa5-4dd1-832a-9a63bed28ebc" + } + }, + "specversion": "1.0", + "operationId": "DirectoryDeletedEventName", + "title": "DirectoryDeleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/directory_renamed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/directory_renamed.json new file mode 100644 index 000000000000..bb6cdab85b2a --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/directory_renamed.json @@ -0,0 +1,22 @@ +{ + "source": "/subscriptions/faa080af-c1d8-40ad-9cce-e1a450ca5b57/resourceGroups/jolov/providers/Microsoft.Storage/storageAccounts/jolovdfs", + "subject": "/blobServices/default/containers/gaocontainer/blobs/gaonewdir", + "type": "Microsoft.Storage.DirectoryRenamed", + "time": "2021-08-16T05:38:05.1425527Z", + "id": "45a3aa46-001f-0001-2d60-921dd1062e11", + "data": { + "api": "RenameDirectory", + "requestId": "45a3aa46-001f-0001-2d60-921dd1000000", + "destinationBlobUrl": "https://jolovdfs.blob.core.windows.net/gaocontainer/gaonewdir", + "sourceBlobUrl": "https://jolovdfs.blob.core.windows.net/gaocontainer/gaoname", + "destinationUrl": "https://jolovdfs.dfs.core.windows.net/gaocontainer/gaonewdir", + "sourceUrl": "https://jolovdfs.dfs.core.windows.net/gaocontainer/gaoname", + "sequencer": "00000000000000000000000000000102000000000001e1c6", + "storageDiagnostics": { + "batchId": "5f991456-5dcf-4b1b-9d49-562ee2b0757f" + } + }, + "specversion": "1.0", + "operationId": "DirectoryRenamedEventName", + "title": "DirectoryRenamed" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/email_delivery_report_received.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/email_delivery_report_received.json new file mode 100644 index 000000000000..51dddcbc6d56 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/email_delivery_report_received.json @@ -0,0 +1,17 @@ +{ + "id": "5f04f77c-2a6a-43bd-9b74-576a64c01f9e", + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "sender/test2@contoso.org/message/950850f5-bcdf-4315-b77a-6447cf56fac9", + "data": { + "sender": "test2@contoso.org", + "recipient": "test1@contoso.com", + "messageId": "950850f5-bcdf-4315-b77a-6447cf56fac9", + "status": "delivered", + "deliveryAttemptTimestamp": "2023-02-09T19:46:12.2480265+00:00" + }, + "type": "Microsoft.Communication.EmailDeliveryReportReceived", + "time": "2023-02-09T19:46:12.2478002Z", + "specversion": "1.0", + "operationId": "EmailDeliveryReportReceivedEventName", + "title": "EmailDeliveryReportReceived" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/email_engagement_tracking_report_received.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/email_engagement_tracking_report_received.json new file mode 100644 index 000000000000..f45a02148908 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/email_engagement_tracking_report_received.json @@ -0,0 +1,18 @@ +{ + "id": "b69d6528-f09f-4ba7-93f9-dab8baf98d0e", + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "sender/test2@contoso.org/message/fe26a737-6941-410c-b126-7eacbe4035d1", + "data": { + "sender": "test2@contoso.org", + "messageId": "fe26a737-6941-410c-b126-7eacbe4035d1", + "userActionTimestamp": "2023-02-09T20:07:22.745555+00:00", + "engagementContext": "www.example.com", + "userAgent": "Desktop", + "engagementType": "click" + }, + "type": "Microsoft.Communication.EmailEngagementTrackingReportReceived", + "time": "2023-02-09T20:07:22.7453611Z", + "specversion": "1.0", + "operationId": "EmailEngagementTrackingReportReceivedEventName", + "title": "EmailEngagementTrackingReportReceived" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/export_rdb_completed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/export_rdb_completed.json new file mode 100644 index 000000000000..0a9a8071c3ed --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/export_rdb_completed.json @@ -0,0 +1,15 @@ +{ + "source": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.Cache/Redis/{cache_name}", + "subject": "ExportRDBCompleted", + "type": "Microsoft.Cache.ExportRDBCompleted", + "time": "2020-12-09T13:50:19.9995668-08:00", + "id": "9b87886d-21a5-4af5-8e3e-10c4b8dac73b", + "data": { + "name": "ExportRDBCompleted", + "timestamp": "2020-12-09T13:50:19.9995668-08:00", + "status": "Succeeded" + }, + "specversion": "1.0", + "operationId": "ExportRDBCompletedEventName", + "title": "ExportRDBCompleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/fhir_resource_created.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/fhir_resource_created.json new file mode 100644 index 000000000000..a1510809bc92 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/fhir_resource_created.json @@ -0,0 +1,16 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}", + "subject": "{fhir-account}.fhir.azurehealthcareapis.com/Patient/e0a1f743-1a70-451f-830e-e96477163902", + "type": "Microsoft.HealthcareApis.FhirResourceCreated", + "time": "2021-09-08T01:14:04.5613214Z", + "id": "e4c7f556-d72c-e7f7-1069-1e82ac76ab41", + "data": { + "resourceType": "Patient", + "resourceFhirAccount": "{fhir-account}.fhir.azurehealthcareapis.com", + "resourceFhirId": "e0a1f743-1a70-451f-830e-e96477163902", + "resourceVersionId": 1 + }, + "specversion": "1.0", + "operationId": "FhirResourceCreatedEventName", + "title": "FhirResourceCreated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/fhir_resource_deleted.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/fhir_resource_deleted.json new file mode 100644 index 000000000000..9fbe50d21eee --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/fhir_resource_deleted.json @@ -0,0 +1,16 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}", + "subject": "{fhir-account}.fhir.azurehealthcareapis.com/Patient/e0a1f743-1a70-451f-830e-e96477163902", + "type": "Microsoft.HealthcareApis.FhirResourceDeleted", + "time": "2021-09-08T01:31:58.5175837Z", + "id": "ef289b93-3159-b833-3a44-dc6b86ed1a8a", + "data": { + "resourceType": "Patient", + "resourceFhirAccount": "{fhir-account}.fhir.azurehealthcareapis.com", + "resourceFhirId": "e0a1f743-1a70-451f-830e-e96477163902", + "resourceVersionId": 3 + }, + "specversion": "1.0", + "operationId": "FhirResourceDeletedEventName", + "title": "FhirResourceDeleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/fhir_resource_updated.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/fhir_resource_updated.json new file mode 100644 index 000000000000..29b409b82e27 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/fhir_resource_updated.json @@ -0,0 +1,16 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}", + "subject": "{fhir-account}.fhir.azurehealthcareapis.com/Patient/e0a1f743-1a70-451f-830e-e96477163902", + "type": "Microsoft.HealthcareApis.FhirResourceUpdated", + "time": "2021-09-08T01:29:12.0618739Z", + "id": "634bd421-8467-f23c-b8cb-f6a31e41c32a", + "data": { + "resourceType": "Patient", + "resourceFhirAccount": "{fhir-account}.fhir.azurehealthcareapis.com", + "resourceFhirId": "e0a1f743-1a70-451f-830e-e96477163902", + "resourceVersionId": 2 + }, + "specversion": "1.0", + "operationId": "FhirResourceUpdatedEventName", + "title": "FhirResourceUpdated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayApiAdded.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayApiAdded.json new file mode 100644 index 000000000000..5cb4419dc19d --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayApiAdded.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}", + "subject": "/gateways/{gateway-name}/apis/example-api", + "type": "Microsoft.ApiManagement.GatewayAPIAdded", + "time": "2021-07-02T00:47:47.8536532Z", + "id": "92c502f2-a966-42a7-a428-d3b319844544", + "data": { + "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/gateways/{gateway-name}/apis/example-api" + }, + "specVersion": "1.0", + "operationId": "GatewayAPIAddedEventName", + "title": "GatewayAPIAdded" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayApiRemoved.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayApiRemoved.json new file mode 100644 index 000000000000..f8680f8d2569 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayApiRemoved.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}", + "subject": "/gateways/{gateway-name}/apis/example-api", + "type": "Microsoft.ApiManagement.GatewayAPIRemoved", + "time": "2021-07-02T00:47:47.8536532Z", + "id": "92c502f2-a966-42a7-a428-d3b319844544", + "data": { + "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/gateways/{gateway-name}/apis/example-api" + }, + "specVersion": "1.0", + "operationId": "GatewayAPIRemovedEventName", + "title": "GatewayAPIRemoved" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayCertificateAuthorityCreated.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayCertificateAuthorityCreated.json new file mode 100644 index 000000000000..79c80577a672 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayCertificateAuthorityCreated.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}", + "subject": "/gateways/{gateway-name}/certificateAuthorities/example-ca", + "type": "Microsoft.ApiManagement.GatewayCertificateAuthorityCreated", + "time": "2021-07-02T00:47:47.8536532Z", + "id": "92c502f2-a966-42a7-a428-d3b319844544", + "data": { + "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/gateways/{gateway-name}/certificateAuthorities/example-ca" + }, + "specVersion": "1.0", + "operationId": "GatewayCertificateAuthorityCreatedEventName", + "title": "GatewayCertificateAuthorityCreated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayCertificateAuthorityDeleted.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayCertificateAuthorityDeleted.json new file mode 100644 index 000000000000..51e0f8b76620 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayCertificateAuthorityDeleted.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}", + "subject": "/gateways/{gateway-name}/certificateAuthorities/example-ca", + "type": "Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted", + "time": "2021-07-02T00:47:47.8536532Z", + "id": "92c502f2-a966-42a7-a428-d3b319844544", + "data": { + "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/gateways/{gateway-name}/certificateAuthorities/example-ca" + }, + "specVersion": "1.0", + "operationId": "GatewayCertificateAuthorityDeletedEventName", + "title": "GatewayCertificateAuthorityDeleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayCertificateAuthorityUpdated.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayCertificateAuthorityUpdated.json new file mode 100644 index 000000000000..8e8f17e5c36a --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayCertificateAuthorityUpdated.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}", + "subject": "/gateways/{gateway-name}/certificateAuthorities/example-ca", + "type": "Microsoft.ApiManagement.GatewayCertificateAuthorityUpdated", + "time": "2021-07-02T00:47:47.8536532Z", + "id": "92c502f2-a966-42a7-a428-d3b319844544", + "data": { + "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/gateways/{gateway-name}/certificateAuthorities/example-ca" + }, + "specVersion": "1.0", + "operationId": "GatewayCertificateAuthorityUpdatedEventName", + "title": "GatewayCertificateAuthorityUpdated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayCreated.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayCreated.json new file mode 100644 index 000000000000..5d5a7d9665b1 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayCreated.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}", + "subject": "/gateways/{gateway-name}", + "type": "Microsoft.ApiManagement.GatewayCreated", + "time": "2021-07-02T00:47:47.8536532Z", + "id": "92c502f2-a966-42a7-a428-d3b319844544", + "data": { + "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/gateways/{gateway-name}" + }, + "specVersion": "1.0", + "operationId": "GatewayCreatedEventName", + "title": "GatewayCreated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayDeleted.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayDeleted.json new file mode 100644 index 000000000000..3571b41d4b5e --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayDeleted.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}", + "subject": "/gateways/{gateway-name}", + "type": "Microsoft.ApiManagement.GatewayDeleted", + "time": "2021-07-02T00:47:47.8536532Z", + "id": "92c502f2-a966-42a7-a428-d3b319844544", + "data": { + "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/gateways/{gateway-name}" + }, + "specVersion": "1.0", + "operationId": "GatewayDeletedEventName", + "title": "GatewayDeleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayHostnameConfigurationCreated.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayHostnameConfigurationCreated.json new file mode 100644 index 000000000000..6402ccd04430 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayHostnameConfigurationCreated.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}", + "subject": "/gateways/{gateway-name}/hostnameConfigurations/example-hostname", + "type": "Microsoft.ApiManagement.GatewayHostnameConfigurationCreated", + "time": "2021-07-02T00:47:47.8536532Z", + "id": "92c502f2-a966-42a7-a428-d3b319844544", + "data": { + "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/gateways/{gateway-name}/hostnameConfigurations/example-hostname" + }, + "specVersion": "1.0", + "operationId": "GatewayHostnameConfigurationCreatedEventName", + "title": "GatewayHostnameConfigurationCreated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayHostnameConfigurationDeleted.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayHostnameConfigurationDeleted.json new file mode 100644 index 000000000000..4ab4a6e31091 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayHostnameConfigurationDeleted.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}", + "subject": "/gateways/{gateway-name}/hostnameConfigurations/example-hostname", + "type": "Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted", + "time": "2021-07-02T00:47:47.8536532Z", + "id": "92c502f2-a966-42a7-a428-d3b319844544", + "data": { + "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/gateways/{gateway-name}/hostnameConfigurations/example-hostname" + }, + "specVersion": "1.0", + "operationId": "GatewayHostnameConfigurationDeletedEventName", + "title": "GatewayHostnameConfigurationDeleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayHostnameConfigurationUpdated.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayHostnameConfigurationUpdated.json new file mode 100644 index 000000000000..3280423d11f5 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayHostnameConfigurationUpdated.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}", + "subject": "/gateways/{gateway-name}/hostnameConfigurations/example-hostname", + "type": "Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated", + "time": "2021-07-02T00:47:47.8536532Z", + "id": "92c502f2-a966-42a7-a428-d3b319844544", + "data": { + "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/gateways/{gateway-name}/hostnameConfigurations/example-hostname" + }, + "specVersion": "1.0", + "operationId": "GatewayHostnameConfigurationUpdatedEventName", + "title": "GatewayHostnameConfigurationUpdated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayUpdated.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayUpdated.json new file mode 100644 index 000000000000..417deb41bbbe --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/gatewayUpdated.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}", + "subject": "/gateways/{gateway-name}", + "type": "Microsoft.ApiManagement.GatewayUpdated", + "time": "2021-07-02T00:47:47.8536532Z", + "id": "92c502f2-a966-42a7-a428-d3b319844544", + "data": { + "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/gateways/{gateway-name}" + }, + "specVersion": "1.0", + "operationId": "GatewayUpdatedEventName", + "title": "GatewayUpdated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/geofence_entered.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/geofence_entered.json new file mode 100644 index 000000000000..0b9b6c545b11 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/geofence_entered.json @@ -0,0 +1,24 @@ +{ + "source": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Maps/accounts/{accountName}", + "subject": "/spatial/geofence/udid/{udid}/id/{eventId}", + "type": "Microsoft.Maps.GeofenceEntered", + "time": "2018-11-08T00:54:17.6408601Z", + "id": "7f8446e2-1ac7-4234-8425-303726ea3981", + "data": { + "geometries": [ + { + "deviceId": "device_1", + "udId": "1a13b444-4acf-32ab-ce4e-9ca4af20b169", + "geometryId": "2", + "distance": -999.0, + "nearestLat": 47.618786, + "nearestLon": -122.132151 + } + ], + "expiredGeofenceGeometryId": [], + "invalidPeriodGeofenceGeometryId": [] + }, + "specversion": "1.0", + "operationId": "GeofenceEnteredEventName", + "title": "GeofenceEntered" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/geofence_result.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/geofence_result.json new file mode 100644 index 000000000000..ec9d47e66e3e --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/geofence_result.json @@ -0,0 +1,32 @@ +{ + "source": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Maps/accounts/{accountName}", + "subject": "/spatial/geofence/udid/{udid}/id/{eventId}", + "type": "Microsoft.Maps.GeofenceResult", + "time": "2018-11-08T00:52:08.0954283Z", + "id": "451675de-a67d-4929-876c-5c2bf0b2c000", + "data": { + "geometries": [ + { + "deviceId": "device_1", + "udId": "1a13b444-4acf-32ab-ce4e-9ca4af20b169", + "geometryId": "1", + "distance": 999.0, + "nearestLat": 47.609833, + "nearestLon": -122.148274 + }, + { + "deviceId": "device_1", + "udId": "1a13b444-4acf-32ab-ce4e-9ca4af20b169", + "geometryId": "2", + "distance": 999.0, + "nearestLat": 47.621954, + "nearestLon": -122.131841 + } + ], + "expiredGeofenceGeometryId": [], + "invalidPeriodGeofenceGeometryId": [] + }, + "specversion": "1.0", + "operationId": "GeofenceResultEventName", + "title": "GeofenceResult" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/image_deleted.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/image_deleted.json new file mode 100644 index 000000000000..0402aca558e8 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/image_deleted.json @@ -0,0 +1,30 @@ +{ + "source": "/subscriptions/faa080af-c1d8-40ad-9cce-e1a450ca5b57/resourceGroups/jolov/providers/Microsoft.ContainerRegistry/registries/jolovcr", + "subject": "samples/nginx", + "type": "Microsoft.ContainerRegistry.ImageDeleted", + "time": "2021-09-08T06:49:40.5342401Z", + "id": "6fdef14c-2594-41e8-9156-c0376eb0a190", + "data": { + "id": "6fdef14c-2594-41e8-9156-c0376eb0a190", + "timestamp": "2021-09-08T06:49:40.1850248Z", + "action": "delete", + "location": "westus", + "target": { + "mediaType": "application/vnd.docker.distribution.manifest.v2+json", + "digest": "sha256:57a94fc99816c6aa225678b738ac40d85422e75dbb96115f1bb9b6ed77176166", + "repository": "samples/nginx" + }, + "request": { + "id": "62a60cbd-1bfc-4742-b013-ed7098922ca6", + "host": "jolovcr.azurecr.io", + "method": "DELETE", + "useragent": "python-requests/2.22.0" + }, + "connectedRegistry": { + "name": "edge1" + } + }, + "specversion": "1.0", + "operationId": "ImageDeletedEventName", + "title": "ImageDeleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/image_pushed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/image_pushed.json new file mode 100644 index 000000000000..9a6cf78d1b6a --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/image_pushed.json @@ -0,0 +1,33 @@ +{ + "source": "/subscriptions/faa080af-c1d8-40ad-9cce-e1a450ca5b57/resourceGroups/jolov/providers/Microsoft.ContainerRegistry/registries/jolovcr", + "subject": "samples/nginx:latest", + "type": "Microsoft.ContainerRegistry.ImagePushed", + "time": "2021-09-08T06:37:45.6609948Z", + "id": "c25fdb80-ebbd-4dd0-a29c-a7349e6388f6", + "data": { + "id": "c25fdb80-ebbd-4dd0-a29c-a7349e6388f6", + "timestamp": "2021-09-08T06:37:45.4681009Z", + "action": "push", + "location": "westus", + "target": { + "mediaType": "application/vnd.docker.distribution.manifest.v2+json", + "size": 1153, + "digest": "sha256:57a94fc99816c6aa225678b738ac40d85422e75dbb96115f1bb9b6ed77176166", + "length": 1153, + "repository": "samples/nginx", + "tag": "latest" + }, + "request": { + "id": "9f8fa9d4-5b86-4066-b805-e406f321c7d6", + "host": "jolovcr.azurecr.io", + "method": "PUT", + "useragent": "docker/20.10.7 go/go1.13.15 git-commit/b0f5bc3 kernel/5.10.16.3-microsoft-standard-WSL2 os/linux arch/amd64 UpstreamClient(Docker-Client/20.10.7 \\(windows\\))" + }, + "connectedRegistry": { + "name": "edge1" + } + }, + "specversion": "1.0", + "operationId": "ImagePushedEventName", + "title": "ImagePushed" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/import_rdb_completed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/import_rdb_completed.json new file mode 100644 index 000000000000..e28f13db55cb --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/import_rdb_completed.json @@ -0,0 +1,15 @@ +{ + "source": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.Cache/Redis/{cache_name}", + "subject": "ImportRDBCompleted", + "type": "Microsoft.Cache.ImportRDBCompleted", + "time": "2020-12-09T13:50:19.9995668-08:00", + "id": "9b87886d-21a5-4af5-8e3e-10c4b8dac73b", + "data": { + "name": "ImportRDBCompleted", + "timestamp": "2020-12-09T13:50:19.9995668-08:00", + "status": "Succeeded" + }, + "specversion": "1.0", + "operationId": "ImportRDBCompletedEventName", + "title": "ImportRDBCompleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/incoming_call.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/incoming_call.json new file mode 100644 index 000000000000..69f72411a38d --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/incoming_call.json @@ -0,0 +1,40 @@ +{ + "id": "e80026e7-e298-46ba-bc42-dab0eda92581", + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "/caller/{caller-id}/recipient/{recipient-id}", + "data": { + "to": { + "kind": "communicationUser", + "rawId": "{recipient-id}", + "communicationUser": { + "id": "{recipient-id}" + } + }, + "from": { + "kind": "communicationUser", + "rawId": "{caller-id}", + "communicationUser": { + "id": "{caller-id}" + } + }, + "serverCallId": "{server-call-id}", + "callerDisplayName": "VOIP Caller", + "customContext": { + "sipHeaders": { + "userToUser": "616d617a6f6e5f6368696;encoding=hex", + "X-MS-Custom-myheader1": "35567842", + "X-MS-Custom-myheader2": "customsipheadervalue" + }, + "voipHeaders": { + "customHeader": "customValue" + } + }, + "incomingCallContext": "{incoming-call-contextValue}", + "correlationId": "correlationId" + }, + "type": "Microsoft.Communication.IncomingCall", + "specversion": "1.0", + "time": "2023-04-04T17:18:42.5542219Z", + "operationId": "IncomingCallEventName", + "title": "IncomingCall" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/keyvalue_deleted.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/keyvalue_deleted.json new file mode 100644 index 000000000000..b2316852bb7c --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/keyvalue_deleted.json @@ -0,0 +1,16 @@ +{ + "source": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/microsoft.appconfiguration/configurationstores/contoso", + "subject": "https://contoso.azconfig.io/kv/Foo?label=FizzBuzz", + "type": "Microsoft.AppConfiguration.KeyValueDeleted", + "time": "2019-05-31T20:05:03.0000000Z", + "id": "84e17ea4-66db-4b54-8050-df8f7763f87b", + "data": { + "key": "Foo", + "label": "FizzBuzz", + "etag": "FnUExLaj2moIi4tJX9AXn9sakm0", + "syncToken": "zAJw6V16=Njo1IzUxNjQ2NzM=;sn=5164673" + }, + "specversion": "1.0", + "operationId": "KeyValueDeletedEventName", + "title": "KeyValueDeleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/keyvalue_modified.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/keyvalue_modified.json new file mode 100644 index 000000000000..a71f576b04f2 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/keyvalue_modified.json @@ -0,0 +1,16 @@ +{ + "source": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/microsoft.appconfiguration/configurationstores/contoso", + "subject": "https://contoso.azconfig.io/kv/Foo?label=FizzBuzz", + "type": "Microsoft.AppConfiguration.KeyValueModified", + "time": "2019-05-31T20:05:03.0000000Z", + "id": "84e17ea4-66db-4b54-8050-df8f7763f87b", + "data": { + "key": "Foo", + "label": "FizzBuzz", + "etag": "FnUExLaj2moIi4tJX9AXn9sakm0", + "syncToken": "zAJw6V16=Njo1IzUxNjQ2NzM=;sn=5164673" + }, + "specversion": "1.0", + "operationId": "KeyValueModifiedEventName", + "title": "KeyValueModified" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/model_deployed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/model_deployed.json new file mode 100644 index 000000000000..b79d8910fffb --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/model_deployed.json @@ -0,0 +1,22 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.MachineLearningServices/workspaces/{workspace-name}", + "subject": "endpoints/my-sklearn-service", + "type": "Microsoft.MachineLearningServices.ModelDeployed", + "time": "2017-06-26T18:41:00.9584103Z", + "id": "831e1650-001e-001b-66ab-eeb76e069631", + "data": { + "ServiceName": "my-sklearn-service", + "ServiceComputeType": "ACI", + "ModelIds": "sklearn_regression_model:1,sklearn_regression_model:2", + "ServiceTags": { + "area": "diabetes", + "type": "regression" + }, + "ServiceProperties": { + "type": "test" + } + }, + "specversion": "1.0", + "operationId": "ModelDeployedEventName", + "title": "ModelDeployed" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/model_registered.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/model_registered.json new file mode 100644 index 000000000000..b5304d632c95 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/model_registered.json @@ -0,0 +1,21 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.MachineLearningServices/workspaces/{workspace-name}", + "subject": "models/sklearn_regression_model:20", + "type": "Microsoft.MachineLearningServices.ModelRegistered", + "time": "2017-06-26T18:41:00.9584103Z", + "id": "831e1650-001e-001b-66ab-eeb76e069631", + "data": { + "ModelName": "sklearn_regression_model", + "ModelVersion": 20, + "ModelTags": { + "area": "diabetes", + "type": "regression" + }, + "ModelProperties": { + "type": "test" + } + }, + "specversion": "1.0", + "operationId": "ModelRegisteredEventName", + "title": "ModelRegistered" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/new_kubernetes_version_available.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/new_kubernetes_version_available.json new file mode 100644 index 000000000000..e6ad56a9c30d --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/new_kubernetes_version_available.json @@ -0,0 +1,16 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ContainerService/managedClusters/{cluster}", + "subject": "{cluster}", + "type": "Microsoft.ContainerService.NewKubernetesVersionAvailable", + "time": "2021-07-01T04:52:57.0000000Z", + "id": "1234567890abcdef1234567890abcdef12345678", + "data": { + "latestSupportedKubernetesVersion": "1.20.7", + "latestStableKubernetesVersion": "1.19.11", + "lowestMinorKubernetesVersion": "1.18.19", + "latestPreviewKubernetesVersion": "1.21.1" + }, + "specversion": "1.0", + "operationId": "NewKubernetesVersionAvailableEventName", + "title": "NewKubernetesVersionAvailable" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/node_pool_rolling_failed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/node_pool_rolling_failed.json new file mode 100644 index 000000000000..ac6019f4d081 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/node_pool_rolling_failed.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ContainerService/managedClusters/{cluster}", + "subject": "{cluster}", + "type": "Microsoft.ContainerService.NodePoolRollingFailed", + "time": "2023-03-29T18:00:00.0000000Z", + "id": "1234567890abcdef1234567890abcdef12345678", + "data": { + "nodePoolName": "nodepool1" + }, + "specversion": "1.0", + "operationId": "NodePoolRollingFailedEventName", + "title": "NodePoolRollingFailed" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/node_pool_rolling_started.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/node_pool_rolling_started.json new file mode 100644 index 000000000000..d431d547baf0 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/node_pool_rolling_started.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ContainerService/managedClusters/{cluster}", + "subject": "{cluster}", + "type": "Microsoft.ContainerService.NodePoolRollingStarted", + "time": "2023-03-29T18:00:00.0000000Z", + "id": "1234567890abcdef1234567890abcdef12345678", + "data": { + "nodePoolName": "nodepool1" + }, + "specversion": "1.0", + "operationId": "NodePoolRollingStartedEventName", + "title": "NodePoolRollingStarted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/node_pool_rolling_succeeded.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/node_pool_rolling_succeeded.json new file mode 100644 index 000000000000..c996b132e7f7 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/node_pool_rolling_succeeded.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ContainerService/managedClusters/{cluster}", + "subject": "{cluster}", + "type": "Microsoft.ContainerService.NodePoolRollingSucceeded", + "time": "2023-03-29T18:00:00.0000000Z", + "id": "1234567890abcdef1234567890abcdef12345678", + "data": { + "nodePoolName": "nodepool1" + }, + "specversion": "1.0", + "operationId": "NodePoolRollingSucceededEventName", + "title": "NodePoolRollingSucceeded" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/order_completed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/order_completed.json new file mode 100644 index 000000000000..1d1ae403a15c --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/order_completed.json @@ -0,0 +1,15 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.DataBox/jobs/{your-resource}", + "subject": "/jobs/{your-resource}", + "type": "Microsoft.DataBox.OrderCompleted", + "time": "2022-10-16T02:51:26.4248221Z", + "id": "5eb07c79-39a8-439c-bb4b-bde1f6267c37", + "data": { + "serialNumber": "SampleSerialNumber", + "stageName": "OrderCompleted", + "stageTime": "2022-10-12T19:38:08.0218897Z" + }, + "specVersion": "1.0", + "operationId": "OrderCompletedEventName", + "title": "OrderCompleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/patching_completed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/patching_completed.json new file mode 100644 index 000000000000..1c5adbcd4023 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/patching_completed.json @@ -0,0 +1,15 @@ +{ + "source": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.Cache/Redis/{cache_name}", + "subject": "PatchingCompleted", + "type": "Microsoft.Cache.PatchingCompleted", + "time": "2020-12-09T13:50:19.9995668-08:00", + "id": "9b87886d-21a5-4af5-8e3e-10c4b8dac73b", + "data": { + "name": "PatchingCompleted", + "timestamp": "2020-12-09T13:50:19.9995668-08:00", + "status": "Succeeded" + }, + "specversion": "1.0", + "operationId": "PatchingCompletedEventName", + "title": "PatchingCompleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/policy_state_changed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/policy_state_changed.json new file mode 100644 index 000000000000..2a0d19b5c64e --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/policy_state_changed.json @@ -0,0 +1,19 @@ +{ + "source": "/subscriptions/{subscription-id}", + "subject": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/{provider-namespace}/{resource-type}/{resource-name}", + "type": "Microsoft.PolicyInsights.PolicyStateChanged", + "time": "2021-03-27T18:37:42.5241536Z", + "id": "5829794FCB5075FCF585476619577B5A5A30E52C84842CBD4E2AD73996714C4C", + "data": { + "timestamp": "2021-03-27T18:37:42.4496956Z", + "policyAssignmentId": "{policy-assignment-scope}/providers/microsoft.authorization/policyassignments/{policy-assignment-name}", + "policyDefinitionId": "{policy-definition-scope}/providers/microsoft.authorization/policydefinitions/{policy-definition-name}", + "policyDefinitionReferenceId": "", + "complianceState": "NonCompliant", + "subscriptionId": "{subscription-id}", + "complianceReasonCode": "" + }, + "specversion": "1.0", + "operationId": "PolicyStateChangedEventName", + "title": "PolicyStateChanged" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/policy_state_created.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/policy_state_created.json new file mode 100644 index 000000000000..eb01cd2e5e9a --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/policy_state_created.json @@ -0,0 +1,19 @@ +{ + "source": "/subscriptions/{subscription-id}", + "subject": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/{provider-namespace}/{resource-type}/{resource-name}", + "type": "Microsoft.PolicyInsights.PolicyStateCreated", + "time": "2021-03-27T18:37:42.5241536Z", + "id": "5829794FCB5075FCF585476619577B5A5A30E52C84842CBD4E2AD73996714C4C", + "data": { + "timestamp": "2021-03-27T18:37:42.4496956Z", + "policyAssignmentId": "{policy-assignment-scope}/providers/microsoft.authorization/policyassignments/{policy-assignment-name}", + "policyDefinitionId": "{policy-definition-scope}/providers/microsoft.authorization/policydefinitions/{policy-definition-name}", + "policyDefinitionReferenceId": "", + "complianceState": "NonCompliant", + "subscriptionId": "{subscription-id}", + "complianceReasonCode": "" + }, + "specversion": "1.0", + "operationId": "PolicyStateCreatedEventName", + "title": "PolicyStateCreated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/privatecloud_updating.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/privatecloud_updating.json new file mode 100644 index 000000000000..3ce4d1955d73 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/privatecloud_updating.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.AVS/privateClouds/{sddc_name}", + "subject": "", + "type": "Microsoft.AVS.PrivateCloudUpdating", + "time": "2023-12-09T16:50:19.9995668-05:00", + "id": "9b87886d-21a5-4af5-8e3e-10c4b8dac73b", + "data": { + "operationId": "6dcd7db8-0679-40d9-bb8a-6f2a684395e2" + }, + "specVersion": "1.0", + "operationId": "PrivateCloudUpdatingEventName", + "title": "PrivateCloudUpdating" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/productCreated.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/productCreated.json new file mode 100644 index 000000000000..661741d0f8d7 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/productCreated.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}", + "subject": "/products/myproduct", + "type": "Microsoft.ApiManagement.ProductCreated", + "time": "2021-07-02T00:47:47.8536532Z", + "id": "92c502f2-a966-42a7-a428-d3b319844544", + "data": { + "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/products/myproduct" + }, + "specversion": "1.0", + "operationId": "ProductCreatedEventName", + "title": "ProductCreated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/productDeleted.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/productDeleted.json new file mode 100644 index 000000000000..b7effe511a06 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/productDeleted.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}", + "subject": "/products/myproduct", + "type": "Microsoft.ApiManagement.ProductDeleted", + "time": "2021-07-02T00:47:47.8536532Z", + "id": "92c502f2-a966-42a7-a428-d3b319844544", + "data": { + "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/products/myproduct" + }, + "specversion": "1.0", + "operationId": "ProductDeletedEventName", + "title": "ProductDeleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/productUpdated.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/productUpdated.json new file mode 100644 index 000000000000..fc2e409923fa --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/productUpdated.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}", + "subject": "/products/myproduct", + "type": "Microsoft.ApiManagement.ProductUpdated", + "time": "2021-07-02T00:47:47.8536532Z", + "id": "92c502f2-a966-42a7-a428-d3b319844544", + "data": { + "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/products/myproduct" + }, + "specversion": "1.0", + "operationId": "ProductUpdatedEventName", + "title": "ProductUpdated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/recording_file_status_updated.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/recording_file_status_updated.json new file mode 100644 index 000000000000..a37721664ed0 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/recording_file_status_updated.json @@ -0,0 +1,30 @@ +{ + "source": "/subscriptions/{subscription-id}/resourcegroups/}{group-name}/providers/microsoft.communication/communicationservices/{communication-services-resource-name}", + "subject": "/recording/call/{call-id}/recordingId/{recording-id}", + "type": "Microsoft.Communication.RecordingFileStatusUpdated", + "time": "2021-07-27T15:20:34.2199328Z", + "id": "7283825e-f8f1-4c61-a9ea-752c56890500", + "data": { + "recordingStorageInfo": { + "recordingChunks": [ + { + "documentId": "0-eus-d12-801b3f3fc462fe8a01e6810cbff729b8", + "index": 0, + "endReason": "SessionEnded", + "contentLocation": "https://storage.asm.skype.com/v1/objects/0-eus-d12-801b3f3fc462fe8a01e6810cbff729b8/content/video", + "metadataLocation": "https://storage.asm.skype.com/v1/objects/0-eus-d12-801b3f3fc462fe8a01e6810cbff729b8/content/acsmetadata", + "deleteLocation": "https://storage.asm.skype.com/v1/objects/0-eus-d12-801b3f3fc462fe8a01e6810cbff729b8/content/deletedata" + } + ] + }, + "recordingStartTime": "2021-07-27T15:20:23.6089755Z", + "recordingDurationMs": 6620, + "sessionEndReason": "CallEnded", + "recordingContentType": "Audio", + "recordingChannelType": "Mixed", + "recordingFormatType": "Mp3" + }, + "specversion": "1.0", + "operationId": "RecordingFileStatusUpdatedEventName", + "title": "RecordingFileStatusUpdated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/resource_action_cancel.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/resource_action_cancel.json new file mode 100644 index 000000000000..b5d7471041c2 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/resource_action_cancel.json @@ -0,0 +1,53 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}", + "subject": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.EventHub/namespaces/{namespace}/AuthorizationRules/RootManageSharedAccessKey", + "type": "Microsoft.Resources.ResourceActionCancel", + "time": "2018-10-08T22:46:22.6022559Z", + "id": "{ID}", + "data": { + "authorization": { + "scope": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.EventHub/namespaces/{namespace}/AuthorizationRules/RootManageSharedAccessKey", + "action": "Microsoft.EventHub/namespaces/AuthorizationRules/listKeys/action", + "evidence": { + "role": "Contributor", + "roleAssignmentScope": "/subscriptions/{subscription-id}", + "roleAssignmentId": "{ID}", + "roleDefinitionId": "{ID}", + "principalId": "{ID}", + "principalType": "ServicePrincipal" + } + }, + "claims": { + "aud": "{audience-claim}", + "iss": "{issuer-claim}", + "iat": "{issued-at-claim}", + "nbf": "{not-before-claim}", + "exp": "{expiration-claim}", + "aio": "{token}", + "appid": "{ID}", + "appidacr": "2", + "http://schemas.microsoft.com/identity/claims/identityprovider": "{URL}", + "http://schemas.microsoft.com/identity/claims/objectidentifier": "{ID}", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier": "{ID}", + "http://schemas.microsoft.com/identity/claims/tenantid": "{ID}", + "uti": "{ID}", + "ver": "1.0" + }, + "correlationId": "{ID}", + "httpRequest": { + "clientRequestId": "{ID}", + "clientIpAddress": "{IP-address}", + "method": "POST", + "url": "https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.EventHub/namespaces/{namespace}/AuthorizationRules/RootManageSharedAccessKey/listKeys?api-version=2017-04-01" + }, + "resourceProvider": "Microsoft.EventHub", + "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.EventHub/namespaces/{namespace}/AuthorizationRules/RootManageSharedAccessKey", + "operationName": "Microsoft.EventHub/namespaces/AuthorizationRules/listKeys/action", + "status": "Succeeded", + "subscriptionId": "{subscription-id}", + "tenantId": "{tenant-id}" + }, + "specversion": "1.0", + "operationId": "ResourceActionCancelEventName", + "title": "ResourceActionCancel" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/resource_action_failure.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/resource_action_failure.json new file mode 100644 index 000000000000..b95a170941f2 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/resource_action_failure.json @@ -0,0 +1,53 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}", + "subject": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.EventHub/namespaces/{namespace}/AuthorizationRules/RootManageSharedAccessKey", + "type": "Microsoft.Resources.ResourceActionFailure", + "time": "2018-10-08T22:46:22.6022559Z", + "id": "{ID}", + "data": { + "authorization": { + "scope": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.EventHub/namespaces/{namespace}/AuthorizationRules/RootManageSharedAccessKey", + "action": "Microsoft.EventHub/namespaces/AuthorizationRules/listKeys/action", + "evidence": { + "role": "Contributor", + "roleAssignmentScope": "/subscriptions/{subscription-id}", + "roleAssignmentId": "{ID}", + "roleDefinitionId": "{ID}", + "principalId": "{ID}", + "principalType": "ServicePrincipal" + } + }, + "claims": { + "aud": "{audience-claim}", + "iss": "{issuer-claim}", + "iat": "{issued-at-claim}", + "nbf": "{not-before-claim}", + "exp": "{expiration-claim}", + "aio": "{token}", + "appid": "{ID}", + "appidacr": "2", + "http://schemas.microsoft.com/identity/claims/identityprovider": "{URL}", + "http://schemas.microsoft.com/identity/claims/objectidentifier": "{ID}", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier": "{ID}", + "http://schemas.microsoft.com/identity/claims/tenantid": "{ID}", + "uti": "{ID}", + "ver": "1.0" + }, + "correlationId": "{ID}", + "httpRequest": { + "clientRequestId": "{ID}", + "clientIpAddress": "{IP-address}", + "method": "POST", + "url": "https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.EventHub/namespaces/{namespace}/AuthorizationRules/RootManageSharedAccessKey/listKeys?api-version=2017-04-01" + }, + "resourceProvider": "Microsoft.EventHub", + "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.EventHub/namespaces/{namespace}/AuthorizationRules/RootManageSharedAccessKey", + "operationName": "Microsoft.EventHub/namespaces/AuthorizationRules/listKeys/action", + "status": "Succeeded", + "subscriptionId": "{subscription-id}", + "tenantId": "{tenant-id}" + }, + "specversion": "1.0", + "operationId": "ResourceActionFailureEventName", + "title": "ResourceActionFailure" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/resource_action_success.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/resource_action_success.json new file mode 100644 index 000000000000..ac29d4e24ecc --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/resource_action_success.json @@ -0,0 +1,53 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}", + "subject": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.EventHub/namespaces/{namespace}/AuthorizationRules/RootManageSharedAccessKey", + "type": "Microsoft.Resources.ResourceActionSuccess", + "time": "2018-10-08T22:46:22.6022559Z", + "id": "{ID}", + "data": { + "authorization": { + "scope": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.EventHub/namespaces/{namespace}/AuthorizationRules/RootManageSharedAccessKey", + "action": "Microsoft.EventHub/namespaces/AuthorizationRules/listKeys/action", + "evidence": { + "role": "Contributor", + "roleAssignmentScope": "/subscriptions/{subscription-id}", + "roleAssignmentId": "{ID}", + "roleDefinitionId": "{ID}", + "principalId": "{ID}", + "principalType": "ServicePrincipal" + } + }, + "claims": { + "aud": "{audience-claim}", + "iss": "{issuer-claim}", + "iat": "{issued-at-claim}", + "nbf": "{not-before-claim}", + "exp": "{expiration-claim}", + "aio": "{token}", + "appid": "{ID}", + "appidacr": "2", + "http://schemas.microsoft.com/identity/claims/identityprovider": "{URL}", + "http://schemas.microsoft.com/identity/claims/objectidentifier": "{ID}", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier": "{ID}", + "http://schemas.microsoft.com/identity/claims/tenantid": "{ID}", + "uti": "{ID}", + "ver": "1.0" + }, + "correlationId": "{ID}", + "httpRequest": { + "clientRequestId": "{ID}", + "clientIpAddress": "{IP-address}", + "method": "POST", + "url": "https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.EventHub/namespaces/{namespace}/AuthorizationRules/RootManageSharedAccessKey/listKeys?api-version=2017-04-01" + }, + "resourceProvider": "Microsoft.EventHub", + "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.EventHub/namespaces/{namespace}/AuthorizationRules/RootManageSharedAccessKey", + "operationName": "Microsoft.EventHub/namespaces/AuthorizationRules/listKeys/action", + "status": "Succeeded", + "subscriptionId": "{subscription-id}", + "tenantId": "{tenant-id}" + }, + "specversion": "1.0", + "operationId": "ResourceActionSuccessEventName", + "title": "ResourceActionSuccess" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/resource_delete_cancel.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/resource_delete_cancel.json new file mode 100644 index 000000000000..beddce02b92a --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/resource_delete_cancel.json @@ -0,0 +1,62 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}", + "subject": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.Storage/storageAccounts/{storage-name}", + "type": "Microsoft.Resources.ResourceDeleteCancel", + "time": "2018-07-19T19:24:12.7638810Z", + "id": "19a69642-1aad-4a96-a5ab-8d05494513ce", + "data": { + "authorization": { + "scope": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.Storage/storageAccounts/{storage-name}", + "action": "Microsoft.Storage/storageAccounts/delete", + "evidence": { + "role": "Subscription Admin" + } + }, + "claims": { + "aud": "{audience-claim}", + "iss": "{issuer-claim}", + "iat": "{issued-at-claim}", + "nbf": "{not-before-claim}", + "exp": "{expiration-claim}", + "_claim_names": "{\"groups\":\"src1\"}", + "_claim_sources": "{\"src1\":{\"endpoint\":\"{URI}\"}}", + "http://schemas.microsoft.com/claims/authnclassreference": "1", + "aio": "{token}", + "http://schemas.microsoft.com/claims/authnmethodsreferences": "rsa,mfa", + "appid": "{ID}", + "appidacr": "2", + "http://schemas.microsoft.com/2012/01/devicecontext/claims/identifier": "{ID}", + "e_exp": "262800", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname": "{last-name}", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname": "{first-name}", + "ipaddr": "{IP-address}", + "name": "{full-name}", + "http://schemas.microsoft.com/identity/claims/objectidentifier": "{ID}", + "onprem_sid": "{ID}", + "puid": "{ID}", + "http://schemas.microsoft.com/identity/claims/scope": "user_impersonation", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier": "{ID}", + "http://schemas.microsoft.com/identity/claims/tenantid": "{ID}", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name": "{user-name}", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn": "{user-name}", + "uti": "{ID}", + "ver": "1.0" + }, + "correlationId": "{ID}", + "httpRequest": { + "clientRequestId": "{ID}", + "clientIpAddress": "{IP-address}", + "method": "DELETE", + "url": "https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.Storage/storageAccounts/{storage-name}?api-version=2018-02-01" + }, + "resourceProvider": "Microsoft.Storage", + "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.Storage/storageAccounts/{storage-name}", + "operationName": "Microsoft.Storage/storageAccounts/delete", + "status": "Succeeded", + "subscriptionId": "{subscription-id}", + "tenantId": "{tenant-id}" + }, + "specversion": "1.0", + "operationId": "ResourceDeleteCancelEventName", + "title": "ResourceDeleteCancel" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/resource_delete_failure.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/resource_delete_failure.json new file mode 100644 index 000000000000..c5aeb788f2ef --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/resource_delete_failure.json @@ -0,0 +1,62 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}", + "subject": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.Storage/storageAccounts/{storage-name}", + "type": "Microsoft.Resources.ResourceDeleteFailure", + "time": "2018-07-19T19:24:12.7638810Z", + "id": "19a69642-1aad-4a96-a5ab-8d05494513ce", + "data": { + "authorization": { + "scope": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.Storage/storageAccounts/{storage-name}", + "action": "Microsoft.Storage/storageAccounts/delete", + "evidence": { + "role": "Subscription Admin" + } + }, + "claims": { + "aud": "{audience-claim}", + "iss": "{issuer-claim}", + "iat": "{issued-at-claim}", + "nbf": "{not-before-claim}", + "exp": "{expiration-claim}", + "_claim_names": "{\"groups\":\"src1\"}", + "_claim_sources": "{\"src1\":{\"endpoint\":\"{URI}\"}}", + "http://schemas.microsoft.com/claims/authnclassreference": "1", + "aio": "{token}", + "http://schemas.microsoft.com/claims/authnmethodsreferences": "rsa,mfa", + "appid": "{ID}", + "appidacr": "2", + "http://schemas.microsoft.com/2012/01/devicecontext/claims/identifier": "{ID}", + "e_exp": "262800", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname": "{last-name}", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname": "{first-name}", + "ipaddr": "{IP-address}", + "name": "{full-name}", + "http://schemas.microsoft.com/identity/claims/objectidentifier": "{ID}", + "onprem_sid": "{ID}", + "puid": "{ID}", + "http://schemas.microsoft.com/identity/claims/scope": "user_impersonation", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier": "{ID}", + "http://schemas.microsoft.com/identity/claims/tenantid": "{ID}", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name": "{user-name}", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn": "{user-name}", + "uti": "{ID}", + "ver": "1.0" + }, + "correlationId": "{ID}", + "httpRequest": { + "clientRequestId": "{ID}", + "clientIpAddress": "{IP-address}", + "method": "DELETE", + "url": "https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.Storage/storageAccounts/{storage-name}?api-version=2018-02-01" + }, + "resourceProvider": "Microsoft.Storage", + "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.Storage/storageAccounts/{storage-name}", + "operationName": "Microsoft.Storage/storageAccounts/delete", + "status": "Succeeded", + "subscriptionId": "{subscription-id}", + "tenantId": "{tenant-id}" + }, + "specversion": "1.0", + "operationId": "ResourceDeleteFailureEventName", + "title": "ResourceDeleteFailure" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/resource_delete_success.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/resource_delete_success.json new file mode 100644 index 000000000000..8c04aaee1f61 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/resource_delete_success.json @@ -0,0 +1,62 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}", + "subject": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.Storage/storageAccounts/{storage-name}", + "type": "Microsoft.Resources.ResourceDeleteSuccess", + "time": "2018-07-19T19:24:12.7638810Z", + "id": "19a69642-1aad-4a96-a5ab-8d05494513ce", + "data": { + "authorization": { + "scope": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.Storage/storageAccounts/{storage-name}", + "action": "Microsoft.Storage/storageAccounts/delete", + "evidence": { + "role": "Subscription Admin" + } + }, + "claims": { + "aud": "{audience-claim}", + "iss": "{issuer-claim}", + "iat": "{issued-at-claim}", + "nbf": "{not-before-claim}", + "exp": "{expiration-claim}", + "_claim_names": "{\"groups\":\"src1\"}", + "_claim_sources": "{\"src1\":{\"endpoint\":\"{URI}\"}}", + "http://schemas.microsoft.com/claims/authnclassreference": "1", + "aio": "{token}", + "http://schemas.microsoft.com/claims/authnmethodsreferences": "rsa,mfa", + "appid": "{ID}", + "appidacr": "2", + "http://schemas.microsoft.com/2012/01/devicecontext/claims/identifier": "{ID}", + "e_exp": "262800", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname": "{last-name}", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname": "{first-name}", + "ipaddr": "{IP-address}", + "name": "{full-name}", + "http://schemas.microsoft.com/identity/claims/objectidentifier": "{ID}", + "onprem_sid": "{ID}", + "puid": "{ID}", + "http://schemas.microsoft.com/identity/claims/scope": "user_impersonation", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier": "{ID}", + "http://schemas.microsoft.com/identity/claims/tenantid": "{ID}", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name": "{user-name}", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn": "{user-name}", + "uti": "{ID}", + "ver": "1.0" + }, + "correlationId": "{ID}", + "httpRequest": { + "clientRequestId": "{ID}", + "clientIpAddress": "{IP-address}", + "method": "DELETE", + "url": "https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.Storage/storageAccounts/{storage-name}?api-version=2018-02-01" + }, + "resourceProvider": "Microsoft.Storage", + "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.Storage/storageAccounts/{storage-name}", + "operationName": "Microsoft.Storage/storageAccounts/delete", + "status": "Succeeded", + "subscriptionId": "{subscription-id}", + "tenantId": "{tenant-id}" + }, + "specversion": "1.0", + "operationId": "ResourceDeleteSuccessEventName", + "title": "ResourceDeleteSuccess" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/resource_write_cancel.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/resource_write_cancel.json new file mode 100644 index 000000000000..c12b1f3a7d98 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/resource_write_cancel.json @@ -0,0 +1,56 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}", + "subject": "/subscriptions/{subscription-id}/resourcegroups/{resource-group}/providers/Microsoft.Storage/storageAccounts/{storage-name}", + "type": "Microsoft.Resources.ResourceWriteCancel", + "time": "2018-07-19T18:38:04.6117357Z", + "id": "4db48cba-50a2-455a-93b4-de41a3b5b7f6", + "data": { + "authorization": { + "scope": "/subscriptions/{subscription-id}/resourcegroups/{resource-group}/providers/Microsoft.Storage/storageAccounts/{storage-name}", + "action": "Microsoft.Storage/storageAccounts/write", + "evidence": { + "role": "Subscription Admin" + } + }, + "claims": { + "aud": "{audience-claim}", + "iss": "{issuer-claim}", + "iat": "{issued-at-claim}", + "nbf": "{not-before-claim}", + "exp": "{expiration-claim}", + "_claim_names": "{\"groups\":\"src1\"}", + "_claim_sources": "{\"src1\":{\"endpoint\":\"{URI}\"}}", + "http://schemas.microsoft.com/claims/authnclassreference": "1", + "aio": "{token}", + "http://schemas.microsoft.com/claims/authnmethodsreferences": "rsa,mfa", + "appid": "{ID}", + "appidacr": "2", + "http://schemas.microsoft.com/2012/01/devicecontext/claims/identifier": "{ID}", + "e_exp": "{expiration}", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname": "{last-name}", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname": "{first-name}", + "ipaddr": "{IP-address}", + "name": "{full-name}", + "http://schemas.microsoft.com/identity/claims/objectidentifier": "{ID}", + "onprem_sid": "{ID}", + "puid": "{ID}", + "http://schemas.microsoft.com/identity/claims/scope": "user_impersonation", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier": "{ID}", + "http://schemas.microsoft.com/identity/claims/tenantid": "{ID}", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name": "{user-name}", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn": "{user-name}", + "uti": "{ID}", + "ver": "1.0" + }, + "correlationId": "{ID}", + "resourceProvider": "Microsoft.Storage", + "resourceUri": "/subscriptions/{subscription-id}/resourcegroups/{resource-group}/providers/Microsoft.Storage/storageAccounts/{storage-name}", + "operationName": "Microsoft.Storage/storageAccounts/write", + "status": "Succeeded", + "subscriptionId": "{subscription-id}", + "tenantId": "{tenant-id}" + }, + "specversion": "1.0", + "operationId": "ResourceWriteCancelEventName", + "title": "ResourceWriteCancel" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/resource_write_failure.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/resource_write_failure.json new file mode 100644 index 000000000000..66b05899e504 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/resource_write_failure.json @@ -0,0 +1,56 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}", + "subject": "/subscriptions/{subscription-id}/resourcegroups/{resource-group}/providers/Microsoft.Storage/storageAccounts/{storage-name}", + "type": "Microsoft.Resources.ResourceWriteFailure", + "time": "2018-07-19T18:38:04.6117357Z", + "id": "4db48cba-50a2-455a-93b4-de41a3b5b7f6", + "data": { + "authorization": { + "scope": "/subscriptions/{subscription-id}/resourcegroups/{resource-group}/providers/Microsoft.Storage/storageAccounts/{storage-name}", + "action": "Microsoft.Storage/storageAccounts/write", + "evidence": { + "role": "Subscription Admin" + } + }, + "claims": { + "aud": "{audience-claim}", + "iss": "{issuer-claim}", + "iat": "{issued-at-claim}", + "nbf": "{not-before-claim}", + "exp": "{expiration-claim}", + "_claim_names": "{\"groups\":\"src1\"}", + "_claim_sources": "{\"src1\":{\"endpoint\":\"{URI}\"}}", + "http://schemas.microsoft.com/claims/authnclassreference": "1", + "aio": "{token}", + "http://schemas.microsoft.com/claims/authnmethodsreferences": "rsa,mfa", + "appid": "{ID}", + "appidacr": "2", + "http://schemas.microsoft.com/2012/01/devicecontext/claims/identifier": "{ID}", + "e_exp": "{expiration}", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname": "{last-name}", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname": "{first-name}", + "ipaddr": "{IP-address}", + "name": "{full-name}", + "http://schemas.microsoft.com/identity/claims/objectidentifier": "{ID}", + "onprem_sid": "{ID}", + "puid": "{ID}", + "http://schemas.microsoft.com/identity/claims/scope": "user_impersonation", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier": "{ID}", + "http://schemas.microsoft.com/identity/claims/tenantid": "{ID}", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name": "{user-name}", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn": "{user-name}", + "uti": "{ID}", + "ver": "1.0" + }, + "correlationId": "{ID}", + "resourceProvider": "Microsoft.Storage", + "resourceUri": "/subscriptions/{subscription-id}/resourcegroups/{resource-group}/providers/Microsoft.Storage/storageAccounts/{storage-name}", + "operationName": "Microsoft.Storage/storageAccounts/write", + "status": "Succeeded", + "subscriptionId": "{subscription-id}", + "tenantId": "{tenant-id}" + }, + "specversion": "1.0", + "operationId": "ResourceWriteFailureEventName", + "title": "ResourceWriteFailure" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/resource_write_success.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/resource_write_success.json new file mode 100644 index 000000000000..5ecbe61f96b9 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/resource_write_success.json @@ -0,0 +1,56 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}", + "subject": "/subscriptions/{subscription-id}/resourcegroups/{resource-group}/providers/Microsoft.Storage/storageAccounts/{storage-name}", + "type": "Microsoft.Resources.ResourceWriteSuccess", + "time": "2018-07-19T18:38:04.6117357Z", + "id": "4db48cba-50a2-455a-93b4-de41a3b5b7f6", + "data": { + "authorization": { + "scope": "/subscriptions/{subscription-id}/resourcegroups/{resource-group}/providers/Microsoft.Storage/storageAccounts/{storage-name}", + "action": "Microsoft.Storage/storageAccounts/write", + "evidence": { + "role": "Subscription Admin" + } + }, + "claims": { + "aud": "{audience-claim}", + "iss": "{issuer-claim}", + "iat": "{issued-at-claim}", + "nbf": "{not-before-claim}", + "exp": "{expiration-claim}", + "_claim_names": "{\"groups\":\"src1\"}", + "_claim_sources": "{\"src1\":{\"endpoint\":\"{URI}\"}}", + "http://schemas.microsoft.com/claims/authnclassreference": "1", + "aio": "{token}", + "http://schemas.microsoft.com/claims/authnmethodsreferences": "rsa,mfa", + "appid": "{ID}", + "appidacr": "2", + "http://schemas.microsoft.com/2012/01/devicecontext/claims/identifier": "{ID}", + "e_exp": "{expiration}", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname": "{last-name}", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname": "{first-name}", + "ipaddr": "{IP-address}", + "name": "{full-name}", + "http://schemas.microsoft.com/identity/claims/objectidentifier": "{ID}", + "onprem_sid": "{ID}", + "puid": "{ID}", + "http://schemas.microsoft.com/identity/claims/scope": "user_impersonation", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier": "{ID}", + "http://schemas.microsoft.com/identity/claims/tenantid": "{ID}", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name": "{user-name}", + "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn": "{user-name}", + "uti": "{ID}", + "ver": "1.0" + }, + "correlationId": "{ID}", + "resourceProvider": "Microsoft.Storage", + "resourceUri": "/subscriptions/{subscription-id}/resourcegroups/{resource-group}/providers/Microsoft.Storage/storageAccounts/{storage-name}", + "operationName": "Microsoft.Storage/storageAccounts/write", + "status": "Succeeded", + "subscriptionId": "{subscription-id}", + "tenantId": "{tenant-id}" + }, + "specversion": "1.0", + "operationId": "ResourceWriteSuccessEventName", + "title": "ResourceWriteSuccess" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/restore_operation_completed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/restore_operation_completed.json new file mode 100644 index 000000000000..980acdf79875 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/restore_operation_completed.json @@ -0,0 +1,21 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.Web/sites/{site-name}", + "subject": "/Microsoft.Web/sites/{site-name}", + "type": "Microsoft.Web.RestoreOperationCompleted", + "time": "2020-01-28T18:26:51.7194887Z", + "id": "7c5d6de5-eb70-4de2-b788-c52a544e68b8", + "data": { + "appEventTypeDetail": { + "action": "Started" + }, + "name": "{site-name}", + "clientRequestId": "None", + "correlationRequestId": "None", + "requestId": "292f499d-04ee-4066-994d-c2df57b99198", + "address": "None", + "verb": "POST" + }, + "specversion": "1.0", + "operationId": "RestoreOperationCompletedEventName", + "title": "RestoreOperationCompleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/restore_operation_failed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/restore_operation_failed.json new file mode 100644 index 000000000000..e01074905f50 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/restore_operation_failed.json @@ -0,0 +1,21 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.Web/sites/{site-name}", + "subject": "/Microsoft.Web/sites/{site-name}", + "type": "Microsoft.Web.RestoreOperationFailed", + "time": "2020-01-28T18:26:51.7194887Z", + "id": "7c5d6de5-eb70-4de2-b788-c52a544e68b8", + "data": { + "appEventTypeDetail": { + "action": "Started" + }, + "name": "{site-name}", + "clientRequestId": "None", + "correlationRequestId": "None", + "requestId": "292f499d-04ee-4066-994d-c2df57b99198", + "address": "None", + "verb": "POST" + }, + "specversion": "1.0", + "operationId": "RestoreOperationFailedEventName", + "title": "RestoreOperationFailed" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/restore_operation_started.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/restore_operation_started.json new file mode 100644 index 000000000000..429ad94c741b --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/restore_operation_started.json @@ -0,0 +1,21 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.Web/sites/{site-name}", + "subject": "/Microsoft.Web/sites/{site-name}", + "type": "Microsoft.Web.RestoreOperationStarted", + "time": "2020-01-28T18:26:51.7194887Z", + "id": "7c5d6de5-eb70-4de2-b788-c52a544e68b8", + "data": { + "appEventTypeDetail": { + "action": "Started" + }, + "name": "{site-name}", + "clientRequestId": "None", + "correlationRequestId": "None", + "requestId": "292f499d-04ee-4066-994d-c2df57b99198", + "address": "None", + "verb": "POST" + }, + "specversion": "1.0", + "operationId": "RestoreOperationStartedEventName", + "title": "RestoreOperationStarted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_cancelled.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_cancelled.json new file mode 100644 index 000000000000..93b14c8b3207 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_cancelled.json @@ -0,0 +1,28 @@ +{ + "id": "b6d8687a-5a1a-42ae-b8b5-ff7ec338c872", + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "job/{job-id}/channel/{channel-id}/disposition/{disposition-code}", + "data": { + "note": "Cancelled due to ", + "dispositionCode": "100", + "jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712", + "channelReference": "test-abc", + "channelId": "FooVoiceChannelId", + "labels": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + }, + "tags": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + }, + "queueId": "" + }, + "type": "Microsoft.Communication.RouterJobCancelled", + "specVersion": "1.0", + "time": "2022-02-17T00:55:25.1736293Z", + "operationId": "RouterJobCancelledEventName", + "title": "RouterJobCancelled" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_classification_failed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_classification_failed.json new file mode 100644 index 000000000000..86ad7627c4cf --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_classification_failed.json @@ -0,0 +1,35 @@ +{ + "id": "b6d8687a-5a1a-42ae-b8b5-ff7ec338c872", + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "job/{job-id}/channel/{channel-id}/classificationpolicy/{classificationpolicy-id}", + "data": { + "errors": [ + { + "code": null, + "message": "Classification failed due to ", + "target": null, + "innererror": null, + "details": null + } + ], + "jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712", + "channelReference": "test-abc", + "channelId": "FooVoiceChannelId", + "classificationPolicyId": "test-policy", + "labels": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + }, + "tags": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + } + }, + "type": "Microsoft.Communication.RouterJobClassificationFailed", + "specVersion": "1.0", + "time": "2022-02-17T00:55:25.1736293Z", + "operationId": "RouterJobClassificationFailedEventName", + "title": "RouterJobClassificationFailed" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_classified.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_classified.json new file mode 100644 index 000000000000..d4cb0076a8ea --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_classified.json @@ -0,0 +1,45 @@ +{ + "id": "b6d8687a-5a1a-42ae-b8b5-ff7ec338c872", + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "job/{job-id}/channel/{channel-id}/queue/{queue-id}", + "data": { + "queueDetails": { + "id": "625fec06-ab81-4e60-b780-f364ed96ade1", + "name": "Queue 1", + "labels": { + "Language": "en", + "Product": "Office", + "Geo": "NA" + } + }, + "jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712", + "channelReference": "test-abc", + "channelId": "FooVoiceChannelId", + "classificationPolicyId": "test-policy", + "queueId": "625fec06-ab81-4e60-b780-f364ed96ade1", + "priority": 5, + "labels": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + }, + "tags": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + }, + "attachedWorkerSelectors": [ + { + "key": "string", + "labelOperator": "equal", + "value": 5, + "ttlSeconds": "36" + } + ] + }, + "type": "Microsoft.Communication.RouterJobClassified", + "specVersion": "1.0", + "time": "2022-02-17T00:55:25.1736293Z", + "operationId": "RouterJobClassifiedEventName", + "title": "RouterJobClassified" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_closed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_closed.json new file mode 100644 index 000000000000..13d2847c8420 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_closed.json @@ -0,0 +1,29 @@ +{ + "id": "b6d8687a-5a1a-42ae-b8b5-ff7ec338c872", + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "job/{job-id}/channel/{channel-id}/assignment/{assignment-id}", + "data": { + "jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712", + "channelReference": "test-abc", + "channelId": "FooVoiceChannelId", + "queueId": "", + "dispositionCode": "", + "workerId": "", + "assignmentId": "", + "labels": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + }, + "tags": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + } + }, + "type": "Microsoft.Communication.RouterJobClosed", + "specVersion": "1.0", + "time": "2022-02-17T00:55:25.1736293Z", + "operationId": "RouterJobClosedEventName", + "title": "RouterJobClosed" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_completed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_completed.json new file mode 100644 index 000000000000..486dfcd80ab8 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_completed.json @@ -0,0 +1,28 @@ +{ + "id": "b6d8687a-5a1a-42ae-b8b5-ff7ec338c872", + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "job/{job-id}/channel/{channel-id}/assignment/{assignment-id}", + "data": { + "jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712", + "channelReference": "test-abc", + "channelId": "FooVoiceChannelId", + "queueId": "queue-id", + "assignmentId": "6f1df17b-570b-4ae5-9cf5-fe6ff64cc712", + "labels": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + }, + "tags": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + }, + "workerId": "" + }, + "type": "Microsoft.Communication.RouterJobCompleted", + "specVersion": "1.0", + "time": "2022-02-17T00:55:25.1736293Z", + "operationId": "RouterJobCompletedEventName", + "title": "RouterJobCompleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_deleted.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_deleted.json new file mode 100644 index 000000000000..ac06929c5d2c --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_deleted.json @@ -0,0 +1,26 @@ +{ + "id": "acdf8fa5-8ab4-4a65-874a-c1d2a4a97f2e", + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "job/{job-id}/channel/{channel-id}", + "data": { + "jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712", + "channelReference": "test-abc", + "channelId": "FooVoiceChannelId", + "labels": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + }, + "tags": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + }, + "queueId": "" + }, + "type": "Microsoft.Communication.RouterJobDeleted", + "specVersion": "1.0", + "time": "2022-02-17T00:55:25.1736293Z", + "operationId": "RouterJobDeletedEventName", + "title": "RouterJobDeleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_exception_triggered.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_exception_triggered.json new file mode 100644 index 000000000000..01ae25094c59 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_exception_triggered.json @@ -0,0 +1,27 @@ +{ + "id": "1027db4a-17fe-4a7f-ae67-276c3120a29f", + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "job/{job-id}/channel/{channel-id}/exceptionrule/{rulekey}", + "data": { + "ruleKey": "r100", + "exceptionRuleId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712", + "jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712", + "channelReference": "test-abc", + "channelId": "FooVoiceChannelId", + "labels": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + }, + "tags": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + } + }, + "type": "Microsoft.Communication.RouterJobExceptionTriggered", + "specVersion": "1.0", + "time": "2022-02-17T00:55:25.1736293Z", + "operationId": "RouterJobExceptionTriggeredEventName", + "title": "RouterJobExceptionTriggered" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_queued.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_queued.json new file mode 100644 index 000000000000..80737e723e13 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_queued.json @@ -0,0 +1,43 @@ +{ + "id": "b6d8687a-5a1a-42ae-b8b5-ff7ec338c872", + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "job/{job-id}/channel/{channel-id}/queue/{queue-id}", + "data": { + "jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712", + "channelReference": "test-abc", + "channelId": "FooVoiceChannelId", + "queueId": "625fec06-ab81-4e60-b780-f364ed96ade1", + "priority": 1, + "labels": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + }, + "tags": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + }, + "requestedWorkerSelectors": [ + { + "key": "string", + "labelOperator": "equal", + "value": 5, + "ttl": "40" + } + ], + "attachedWorkerSelectors": [ + { + "key": "string", + "labelOperator": "equal", + "value": 5, + "ttlSeconds": "39" + } + ] + }, + "type": "Microsoft.Communication.RouterJobQueued", + "specVersion": "1.0", + "time": "2022-02-17T00:55:25.1736293Z", + "operationId": "RouterJobQueuedEventName", + "title": "RouterJobQueued" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_received.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_received.json new file mode 100644 index 000000000000..08f10751508f --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_received.json @@ -0,0 +1,39 @@ +{ + "id": "acdf8fa5-8ab4-4a65-874a-c1d2a4a97f2e", + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "job/{job-id}/channel/{channel-id}", + "data": { + "jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712", + "channelReference": "test-abc", + "jobStatus": "PendingClassification", + "channelId": "FooVoiceChannelId", + "classificationPolicyId": "test-policy", + "queueId": "queue-id", + "priority": 0, + "labels": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + }, + "tags": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + }, + "requestedWorkerSelectors": [ + { + "key": "string", + "labelOperator": "equal", + "value": 5, + "ttlSeconds": "36" + } + ], + "scheduledOn": "3/28/2007 7:13:50 PM +00:00", + "unavailableForMatching": false + }, + "type": "Microsoft.Communication.RouterJobReceived", + "specVersion": "1.0", + "time": "2022-02-17T00:55:25.1736293Z", + "operationId": "RouterJobReceivedEventName", + "title": "RouterJobReceived" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_scheduling_failed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_scheduling_failed.json new file mode 100644 index 000000000000..c44c5b556053 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_scheduling_failed.json @@ -0,0 +1,45 @@ +{ + "id": "acdf8fa5-8ab4-4a65-874a-c1d2a4a97f2e", + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "job/{job-id}/channel/{channel-id}", + "data": { + "jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712", + "channelId": "FooVoiceChannelId", + "channelReference": "test-abc", + "queueId": "queue-id", + "priority": 1, + "labels": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + }, + "tags": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + }, + "requestedWorkerSelectors": [ + { + "key": "string", + "labelOperator": "equal", + "value": 5, + "ttlSeconds": "36" + } + ], + "attachedWorkerSelectors": [ + { + "key": "string", + "labelOperator": "equal", + "value": 5, + "ttlSeconds": "30" + } + ], + "scheduledOn": "2022-02-17T00:55:25.1736293Z", + "failureReason": "Expired Job" + }, + "type": "Microsoft.Communication.RouterJobSchedulingFailed", + "specVersion": "1.0", + "time": "2022-02-17T00:55:25.1736293Z", + "operationId": "RouterJobSchedulingFailedEventName", + "title": "RouterJobSchedulingFailed" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_unassigned.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_unassigned.json new file mode 100644 index 000000000000..4b383aed40fb --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_unassigned.json @@ -0,0 +1,28 @@ +{ + "id": "acdf8fa5-8ab4-4a65-874a-c1d2a4a97f2e", + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "job/{job-id}/channel/{channel-id}/assignment/{assignment-id}", + "data": { + "jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712", + "assignmentId": "", + "workerId": "", + "channelId": "FooVoiceChannelId", + "channelReference": "test-abc", + "queueId": "queue-id", + "labels": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + }, + "tags": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + } + }, + "type": "Microsoft.Communication.RouterJobUnassigned", + "specVersion": "1.0", + "time": "2022-02-17T00:55:25.1736293Z", + "operationId": "RouterJobUnassignedEventName", + "title": "RouterJobUnassigned" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_waiting_for_activation.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_waiting_for_activation.json new file mode 100644 index 000000000000..f86ae7a78d93 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_waiting_for_activation.json @@ -0,0 +1,45 @@ +{ + "id": "acdf8fa5-8ab4-4a65-874a-c1d2a4a97f2e", + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "job/{job-id}/channel/{channel-id}", + "data": { + "jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712", + "channelId": "FooVoiceChannelId", + "channelReference": "test-abc", + "queueId": "queue-id", + "priority": 1, + "labels": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + }, + "tags": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + }, + "requestedWorkerSelectors": [ + { + "key": "string", + "labelOperator": "equal", + "value": 5, + "ttlSeconds": "45" + } + ], + "attachedWorkerSelectors": [ + { + "key": "string", + "labelOperator": "equal", + "value": 5, + "ttlSeconds": "32" + } + ], + "scheduledOn": "2022-02-17T00:55:25.1736293Z", + "unavailableForMatching": false + }, + "type": "Microsoft.Communication.RouterJobWaitingForActivation", + "specVersion": "1.0", + "time": "2022-02-17T00:55:25.1736293Z", + "operationId": "RouterJobWaitingForActivationEventName", + "title": "RouterJobWaitingForActivation" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_worker_selectors_expired.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_worker_selectors_expired.json new file mode 100644 index 000000000000..fe032e4a9ffd --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_job_worker_selectors_expired.json @@ -0,0 +1,42 @@ +{ + "id": "b6d8687a-5a1a-42ae-b8b5-ff7ec338c872", + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "job/{job-id}/channel/{channel-id}/queue/{queue-id}", + "data": { + "jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712", + "channelReference": "test-abc", + "channelId": "FooVoiceChannelId", + "queueId": "625fec06-ab81-4e60-b780-f364ed96ade1", + "labels": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + }, + "tags": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + }, + "expiredRequestedWorkerSelectors": [ + { + "key": "string", + "labelOperator": "equal", + "value": 5, + "ttlSeconds": "30" + } + ], + "attachedWorkerSelectorsExpired": [ + { + "key": "string", + "labelOperator": "equal", + "value": 5, + "ttlSeconds": "35" + } + ] + }, + "type": "Microsoft.Communication.RouterJobWorkerSelectorsExpired", + "specVersion": "1.0", + "time": "2022-02-17T00:55:25.1736293Z", + "operationId": "RouterJobWorkerSelectorsExpiredEventName", + "title": "RouterJobWorkerSelectorsExpired" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_worker_deleted.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_worker_deleted.json new file mode 100644 index 000000000000..3f7dfce2c605 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_worker_deleted.json @@ -0,0 +1,13 @@ +{ + "id": "1027db4a-17fe-4a7f-ae67-276c3120a29f", + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "worker/{worker-id}", + "data": { + "workerId": "worker3" + }, + "type": "Microsoft.Communication.RouterWorkerDeleted", + "specVersion": "1.0", + "time": "2022-02-17T00:55:25.1736293Z", + "operationId": "RouterWorkerDeletedEventName", + "title": "RouterWorkerDeleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_worker_deregistered.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_worker_deregistered.json new file mode 100644 index 000000000000..44afa02c64c3 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_worker_deregistered.json @@ -0,0 +1,13 @@ +{ + "id": "1027db4a-17fe-4a7f-ae67-276c3120a29f", + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "worker/{worker-id}", + "data": { + "workerId": "worker3" + }, + "type": "Microsoft.Communication.RouterWorkerDeregistered", + "specVersion": "1.0", + "time": "2022-02-17T00:55:25.1736293Z", + "operationId": "RouterWorkerDeregisteredEventName", + "title": "RouterWorkerDeregistered" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_worker_offer_accepted.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_worker_offer_accepted.json new file mode 100644 index 000000000000..9cbb60effa64 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_worker_offer_accepted.json @@ -0,0 +1,30 @@ +{ + "id": "1027db4a-17fe-4a7f-ae67-276c3120a29f", + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "worker/{worker-id}/job/{job-id}", + "data": { + "workerId": "w100", + "jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712", + "jobPriority": 5, + "jobLabels": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + }, + "jobTags": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + }, + "channelReference": "test-abc", + "channelId": "FooVoiceChannelId", + "queueId": "625fec06-ab81-4e60-b780-f364ed96ade1", + "offerId": "565fec06-ab81-4e60-b780-f364ed96ade1", + "assignmentId": "765fec06-ab81-4e60-b780-f364ed96ade1" + }, + "type": "Microsoft.Communication.RouterWorkerOfferAccepted", + "specVersion": "1.0", + "time": "2022-02-17T00:55:25.1736293Z", + "operationId": "RouterWorkerOfferAcceptedEventName", + "title": "RouterWorkerOfferAccepted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_worker_offer_declined.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_worker_offer_declined.json new file mode 100644 index 000000000000..6a9d6b48c30f --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_worker_offer_declined.json @@ -0,0 +1,18 @@ +{ + "id": "1027db4a-17fe-4a7f-ae67-276c3120a29f", + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "worker/{worker-id}/job/{job-id}", + "data": { + "workerId": "w100", + "jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712", + "channelReference": "test-abc", + "channelId": "FooVoiceChannelId", + "queueId": "625fec06-ab81-4e60-b780-f364ed96ade1", + "offerId": "565fec06-ab81-4e60-b780-f364ed96ade1" + }, + "type": "Microsoft.Communication.RouterWorkerOfferDeclined", + "specVersion": "1.0", + "time": "2022-02-17T00:55:25.1736293Z", + "operationId": "RouterWorkerOfferDeclinedEventName", + "title": "RouterWorkerOfferDeclined" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_worker_offer_expired.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_worker_offer_expired.json new file mode 100644 index 000000000000..28cecc2790bb --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_worker_offer_expired.json @@ -0,0 +1,18 @@ +{ + "id": "1027db4a-17fe-4a7f-ae67-276c3120a29f", + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "worker/{worker-id}/job/{job-id}", + "data": { + "offerId": "565fec06-ab81-4e60-b780-f364ed96ade1", + "workerId": "w100", + "jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712", + "channelReference": "test-abc", + "channelId": "FooVoiceChannelId", + "queueId": "625fec06-ab81-4e60-b780-f364ed96ade1" + }, + "type": "Microsoft.Communication.RouterWorkerOfferExpired", + "specVersion": "1.0", + "time": "2022-02-17T00:55:25.1736293Z", + "operationId": "RouterWorkerOfferExpiredEventName", + "title": "RouterWorkerOfferExpired" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_worker_offer_issued.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_worker_offer_issued.json new file mode 100644 index 000000000000..3cbc680d408e --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_worker_offer_issued.json @@ -0,0 +1,31 @@ +{ + "id": "1027db4a-17fe-4a7f-ae67-276c3120a29f", + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "worker/{worker-id}/job/{job-id}", + "data": { + "workerId": "w100", + "jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712", + "channelReference": "test-abc", + "channelId": "FooVoiceChannelId", + "queueId": "625fec06-ab81-4e60-b780-f364ed96ade1", + "offerId": "525fec06-ab81-4e60-b780-f364ed96ade1", + "offeredOn": "2021-06-23T02:43:30.3847144Z", + "expiresOn": "2021-06-23T02:44:30.3847674Z", + "jobPriority": 5, + "jobLabels": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + }, + "jobTags": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + } + }, + "type": "Microsoft.Communication.RouterWorkerOfferIssued", + "specVersion": "1.0", + "time": "2022-02-17T00:55:25.1736293Z", + "operationId": "RouterWorkerOfferIssuedEventName", + "title": "RouterWorkerOfferIssued" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_worker_offer_revoked.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_worker_offer_revoked.json new file mode 100644 index 000000000000..de165805c103 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_worker_offer_revoked.json @@ -0,0 +1,18 @@ +{ + "id": "1027db4a-17fe-4a7f-ae67-276c3120a29f", + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "worker/{worker-id}/job/{job-id}", + "data": { + "offerId": "565fec06-ab81-4e60-b780-f364ed96ade1", + "workerId": "w100", + "jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712", + "channelReference": "test-abc", + "channelId": "FooVoiceChannelId", + "queueId": "625fec06-ab81-4e60-b780-f364ed96ade1" + }, + "type": "Microsoft.Communication.RouterWorkerOfferRevoked", + "specVersion": "1.0", + "time": "2022-02-17T00:55:25.1736293Z", + "operationId": "RouterWorkerOfferRevokedEventName", + "title": "RouterWorkerOfferRevoked" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_worker_registered.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_worker_registered.json new file mode 100644 index 000000000000..34dddf8c2d26 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/router_worker_registered.json @@ -0,0 +1,41 @@ +{ + "id": "1027db4a-17fe-4a7f-ae67-276c3120a29f", + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "worker/{worker-id}", + "data": { + "workerId": "worker3", + "totalCapacity": 100, + "queueAssignments": [ + { + "id": "MyQueueId2", + "name": "Queue 3", + "labels": { + "Language": "en", + "Product": "Office", + "Geo": "NA" + } + } + ], + "labels": { + "x": "111", + "y": "111" + }, + "channelConfigurations": [ + { + "channelId": "FooVoiceChannelId", + "capacityCostPerJob": 10 + } + ], + "tags": { + "Locale": "en-us", + "Segment": "Enterprise", + "Token": "FooToken" + }, + "maxNumberOfJobs": 5 + }, + "type": "Microsoft.Communication.RouterWorkerRegistered", + "specVersion": "1.0", + "time": "2022-02-17T00:55:25.1736293Z", + "operationId": "RouterWorkerRegisteredEventName", + "title": "RouterWorkerRegistered" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/run_completed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/run_completed.json new file mode 100644 index 000000000000..9afb74b2e829 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/run_completed.json @@ -0,0 +1,32 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.MachineLearningServices/workspaces/{workspace-name}", + "subject": "experiments/0fa9dfaa-cba3-4fa7-b590-23e48548f5c1/runs/AutoML_ad912b2d-6467-4f32-a616-dbe4af6dd8fc_5", + "type": "Microsoft.MachineLearningServices.RunCompleted", + "time": "2017-06-26T18:41:00.9584103Z", + "id": "831e1650-001e-001b-66ab-eeb76e069631", + "data": { + "experimentId": "0fa9dfaa-cba3-4fa7-b590-23e48548f5c1", + "experimentName": "automl-local-regression", + "runId": "AutoML_ad912b2d-6467-4f32-a616-dbe4af6dd8fc_5", + "runType": null, + "runTags": {}, + "runProperties": { + "runTemplate": "automl_child", + "pipeline_id": "5adc0a4fe02504a586f09a4fcbb241f9a4012062", + "pipeline_spec": "{\"objects\": [{\"class_name\": \"StandardScaler\", \"module\": \"sklearn.preprocessing\", \"param_args\": [], \"param_kwargs\": {\"with_mean\": true, \"with_std\": false}, \"prepared_kwargs\": {}, \"spec_class\": \"preproc\"}, {\"class_name\": \"LassoLars\", \"module\": \"sklearn.linear_model\", \"param_args\": [], \"param_kwargs\": {\"alpha\": 0.001, \"normalize\": true}, \"prepared_kwargs\": {}, \"spec_class\": \"sklearn\"}], \"pipeline_id\": \"5adc0a4fe02504a586f09a4fcbb241f9a4012062\"}", + "training_percent": "100", + "predicted_cost": "0.062226144097381045", + "iteration": "5", + "run_template": "automl_child", + "run_preprocessor": "StandardScalerWrapper", + "run_algorithm": "LassoLars", + "conda_env_data_location": "aml://artifact/ExperimentRun/dcid.AutoML_ad912b2d-6467-4f32-a616-dbe4af6dd8fc_5/outputs/conda_env_v_1_0_0.yml", + "model_name": "AutoMLad912b2d65", + "scoring_data_location": "aml://artifact/ExperimentRun/dcid.AutoML_ad912b2d-6467-4f32-a616-dbe4af6dd8fc_5/outputs/scoring_file_v_1_0_0.py", + "model_data_location": "aml://artifact/ExperimentRun/dcid.AutoML_ad912b2d-6467-4f32-a616-dbe4af6dd8fc_5/outputs/model.pkl" + } + }, + "specversion": "1.0", + "operationId": "RunCompletedEventName", + "title": "RunCompleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/run_status_changed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/run_status_changed.json new file mode 100644 index 000000000000..41124b425b1d --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/run_status_changed.json @@ -0,0 +1,33 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.MachineLearningServices/workspaces/{workspace-name}", + "subject": "experiments/0fa9dfaa-cba3-4fa7-b590-23e48548f5c1/runs/AutoML_ad912b2d-6467-4f32-a616-dbe4af6dd8fc_5", + "type": "Microsoft.MachineLearningServices.RunStatusChanged", + "time": "2017-06-26T18:41:00.9584103Z", + "id": "831e1650-001e-001b-66ab-eeb76e069631", + "data": { + "experimentId": "0fa9dfaa-cba3-4fa7-b590-23e48548f5c1", + "experimentName": "automl-local-regression", + "runId": "AutoML_ad912b2d-6467-4f32-a616-dbe4af6dd8fc_5", + "runType": null, + "runTags": {}, + "runProperties": { + "runTemplate": "automl_child", + "pipeline_id": "5adc0a4fe02504a586f09a4fcbb241f9a4012062", + "pipeline_spec": "{\"objects\": [{\"class_name\": \"StandardScaler\", \"module\": \"sklearn.preprocessing\", \"param_args\": [], \"param_kwargs\": {\"with_mean\": true, \"with_std\": false}, \"prepared_kwargs\": {}, \"spec_class\": \"preproc\"}, {\"class_name\": \"LassoLars\", \"module\": \"sklearn.linear_model\", \"param_args\": [], \"param_kwargs\": {\"alpha\": 0.001, \"normalize\": true}, \"prepared_kwargs\": {}, \"spec_class\": \"sklearn\"}], \"pipeline_id\": \"5adc0a4fe02504a586f09a4fcbb241f9a4012062\"}", + "training_percent": "100", + "predicted_cost": "0.062226144097381045", + "iteration": "5", + "run_template": "automl_child", + "run_preprocessor": "StandardScalerWrapper", + "run_algorithm": "LassoLars", + "conda_env_data_location": "aml://artifact/ExperimentRun/dcid.AutoML_ad912b2d-6467-4f32-a616-dbe4af6dd8fc_5/outputs/conda_env_v_1_0_0.yml", + "model_name": "AutoMLad912b2d65", + "scoring_data_location": "aml://artifact/ExperimentRun/dcid.AutoML_ad912b2d-6467-4f32-a616-dbe4af6dd8fc_5/outputs/scoring_file_v_1_0_0.py", + "model_data_location": "aml://artifact/ExperimentRun/dcid.AutoML_ad912b2d-6467-4f32-a616-dbe4af6dd8fc_5/outputs/model.pkl" + }, + "runStatus": "failed" + }, + "specversion": "1.0", + "operationId": "RunStatusChangedEventName", + "title": "RunStatusChanged" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/scaling_completed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/scaling_completed.json new file mode 100644 index 000000000000..c007866eaa7d --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/scaling_completed.json @@ -0,0 +1,15 @@ +{ + "source": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.Cache/Redis/{cache_name}", + "subject": "ScalingCompleted", + "type": "Microsoft.Cache.ScalingCompleted", + "time": "2020-12-09T13:50:19.9995668-08:00", + "id": "9b87886d-21a5-4af5-8e3e-10c4b8dac73b", + "data": { + "name": "ScalingCompleted", + "timestamp": "2020-12-09T13:50:19.9995668-08:00", + "status": "Succeeded" + }, + "specversion": "1.0", + "operationId": "ScalingCompletedEventName", + "title": "ScalingCompleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/script_execution_failed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/script_execution_failed.json new file mode 100644 index 000000000000..21b716b08bc5 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/script_execution_failed.json @@ -0,0 +1,16 @@ +{ + "source": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.AVS/privateClouds/{sddc_name}", + "subject": "/scriptExecutions/{execution_name}", + "type": "Microsoft.AVS.ScriptExecutionFailed", + "time": "2023-12-09T16:50:19.9995668-05:00", + "id": "9b87886d-21a5-4af5-8e3e-10c4b8dac73b", + "data": { + "operationId": "fe1cb595-71c8-47d7-b505-60d39a44d53d", + "failureMessage": "05/04/2023 03:15:40 Get-SpbmStoragePolicy SpbmStoragePolicy with name ' RAID-5 FTT-1' was not found using the specified filter(s).", + "cmdletId": "Microsoft.AVS.Management@5.3.70/Set-LocationStoragePolicy", + "output": [] + }, + "specVersion": "1.0", + "operationId": "ScriptExecutionFailedEventName", + "title": "ScriptExecutionFailed" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/secret_new_version_created.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/secret_new_version_created.json new file mode 100644 index 000000000000..6c5e1db34ea8 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/secret_new_version_created.json @@ -0,0 +1,19 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/sample-rg/providers/Microsoft.KeyVault/vaults/sample-kv", + "subject": "newsecret", + "type": "Microsoft.KeyVault.SecretNewVersionCreated", + "time": "2019-07-25T01:08:33.1036736Z", + "id": "00eccf70-95a7-4e7c-8299-2eb17ee9ad64", + "data": { + "Id": "https://sample-kv.vault.azure.net/secrets/newsecret/ee059b2bb5bc48398a53b168c6cdcb10", + "VaultName": "sample-kv", + "ObjectType": "Secret", + "ObjectName": "newsecret", + "Version": "ee059b2bb5bc48398a53b168c6cdcb10", + "NBF": "1559081980", + "EXP": "1559082102" + }, + "specversion": "1.0", + "operationId": "SecretNewVersionCreatedEventName", + "title": "SecretNewVersionCreated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/slot_swap_completed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/slot_swap_completed.json new file mode 100644 index 000000000000..395c39773a09 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/slot_swap_completed.json @@ -0,0 +1,21 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.Web/sites/{site-name}", + "subject": "/Microsoft.Web/sites/{site-name}", + "type": "Microsoft.Web.SlotSwapCompleted", + "time": "2020-01-28T18:26:51.7194887Z", + "id": "7c5d6de5-eb70-4de2-b788-c52a544e68b8", + "data": { + "appEventTypeDetail": null, + "name": "{site-name}", + "clientRequestId": "922f4841-20d9-4dd6-8c5b-23f0d85e5592", + "correlationRequestId": "9ac46505-2b8a-4e06-834c-05ffbe2e8c3a", + "requestId": "765117aa-eaf8-4bd2-a644-1dbf69c7b0fd", + "address": "/websystems/WebSites/web/subscriptions/{subscription-id}/webspaces/{webspace}/sites/{site-name}/slots?Command=SWAP&targetSlot=production", + "verb": "POST", + "sourceSlot": "staging", + "targetSlot": "production" + }, + "specversion": "1.0", + "operationId": "SlotSwapCompletedEventName", + "title": "SlotSwapCompleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/slot_swap_failed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/slot_swap_failed.json new file mode 100644 index 000000000000..4e76796eac0a --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/slot_swap_failed.json @@ -0,0 +1,21 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.Web/sites/{site-name}", + "subject": "/Microsoft.Web/sites/{site-name}", + "type": "Microsoft.Web.SlotSwapFailed", + "time": "2020-01-28T18:26:51.7194887Z", + "id": "7c5d6de5-eb70-4de2-b788-c52a544e68b8", + "data": { + "appEventTypeDetail": null, + "name": "{site-name}", + "clientRequestId": "922f4841-20d9-4dd6-8c5b-23f0d85e5592", + "correlationRequestId": "9ac46505-2b8a-4e06-834c-05ffbe2e8c3a", + "requestId": "765117aa-eaf8-4bd2-a644-1dbf69c7b0fd", + "address": "/websystems/WebSites/web/subscriptions/{subscription-id}/webspaces/{webspace}/sites/{site-name}/slots?Command=SWAP&targetSlot=production", + "verb": "POST", + "sourceSlot": "staging", + "targetSlot": "production" + }, + "specversion": "1.0", + "operationId": "SlotSwapFailedEventName", + "title": "SlotSwapFailed" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/slot_swap_started.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/slot_swap_started.json new file mode 100644 index 000000000000..1c386ba0d793 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/slot_swap_started.json @@ -0,0 +1,21 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.Web/sites/{site-name}", + "subject": "/Microsoft.Web/sites/{site-name}", + "type": "Microsoft.Web.SlotSwapStarted", + "time": "2020-01-28T18:26:51.7194887Z", + "id": "7c5d6de5-eb70-4de2-b788-c52a544e68b8", + "data": { + "appEventTypeDetail": null, + "name": "{site-name}", + "clientRequestId": "922f4841-20d9-4dd6-8c5b-23f0d85e5592", + "correlationRequestId": "9ac46505-2b8a-4e06-834c-05ffbe2e8c3a", + "requestId": "765117aa-eaf8-4bd2-a644-1dbf69c7b0fd", + "address": "/websystems/WebSites/web/subscriptions/{subscription-id}/webspaces/{webspace}/sites/{site-name}/slots?Command=SWAP&targetSlot=production", + "verb": "POST", + "sourceSlot": "staging", + "targetSlot": "production" + }, + "specversion": "1.0", + "operationId": "SlotSwapStartedEventName", + "title": "SlotSwapStarted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/slot_swap_with_preview_cancelled.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/slot_swap_with_preview_cancelled.json new file mode 100644 index 000000000000..761b40621e3e --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/slot_swap_with_preview_cancelled.json @@ -0,0 +1,21 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.Web/sites/{site-name}", + "subject": "/Microsoft.Web/sites/{site-name}", + "type": "Microsoft.Web.SlotSwapWithPreviewCancelled", + "time": "2020-01-28T18:26:51.7194887Z", + "id": "7c5d6de5-eb70-4de2-b788-c52a544e68b8", + "data": { + "appEventTypeDetail": null, + "name": "{site-name}", + "clientRequestId": "922f4841-20d9-4dd6-8c5b-23f0d85e5592", + "correlationRequestId": "9ac46505-2b8a-4e06-834c-05ffbe2e8c3a", + "requestId": "765117aa-eaf8-4bd2-a644-1dbf69c7b0fd", + "address": "/websystems/WebSites/web/subscriptions/{subscription-id}/webspaces/{webspace}/sites/{site-name}/slots?Command=SWAP&targetSlot=production", + "verb": "POST", + "sourceSlot": "staging", + "targetSlot": "production" + }, + "specversion": "1.0", + "operationId": "SlotSwapWithPreviewCancelledEventName", + "title": "SlotSwapWithPreviewCancelled" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/slot_swap_with_preview_started.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/slot_swap_with_preview_started.json new file mode 100644 index 000000000000..9927ec90d80a --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/slot_swap_with_preview_started.json @@ -0,0 +1,21 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.Web/sites/{site-name}", + "subject": "/Microsoft.Web/sites/{site-name}", + "type": "Microsoft.Web.SlotSwapWithPreviewStarted", + "time": "2020-01-28T18:26:51.7194887Z", + "id": "7c5d6de5-eb70-4de2-b788-c52a544e68b8", + "data": { + "appEventTypeDetail": null, + "name": "{site-name}", + "clientRequestId": "922f4841-20d9-4dd6-8c5b-23f0d85e5592", + "correlationRequestId": "9ac46505-2b8a-4e06-834c-05ffbe2e8c3a", + "requestId": "765117aa-eaf8-4bd2-a644-1dbf69c7b0fd", + "address": "/websystems/WebSites/web/subscriptions/{subscription-id}/webspaces/{webspace}/sites/{site-name}/slots?Command=SWAP&targetSlot=production", + "verb": "POST", + "sourceSlot": "staging", + "targetSlot": "production" + }, + "specversion": "1.0", + "operationId": "SlotSwapWithPreviewStartedEventName", + "title": "SlotSwapWithPreviewStarted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/sms_delivery_report_received.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/sms_delivery_report_received.json new file mode 100644 index 000000000000..c02ecd2a836a --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/sms_delivery_report_received.json @@ -0,0 +1,25 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/microsoft.communication/communicationservices/{communication-services-resource-name}", + "subject": "/phonenumber/15555555555", + "type": "Microsoft.Communication.SMSDeliveryReportReceived", + "time": "2020-09-18T00:22:20.0000000Z", + "id": "Outgoing_202009180022138813a09b-0cbf-4304-9b03-1546683bb910", + "data": { + "MessageId": "Outgoing_202009180022138813a09b-0cbf-4304-9b03-1546683bb910", + "From": "15555555555", + "To": "+15555555555", + "DeliveryStatus": "Delivered", + "DeliveryStatusDetails": "No error.", + "ReceivedTimestamp": "2020-09-18T00:22:20.2855749Z", + "DeliveryAttempts": [ + { + "Timestamp": "2020-09-18T00:22:14.9315918Z", + "SegmentsSucceeded": 1, + "SegmentsFailed": 0 + } + ] + }, + "specversion": "1.0", + "operationId": "SMSDeliveryReportReceivedEventName", + "title": "SMSDeliveryReportReceived" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/sms_received.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/sms_received.json new file mode 100644 index 000000000000..0c5a91ed9140 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/sms_received.json @@ -0,0 +1,17 @@ +{ + "source": "/subscriptions/50ad1522-5c2c-4d9a-a6c8-67c11ecb75b8/resourcegroups/acse2e/providers/microsoft.communication/communicationservices/{communication-services-resource-name}", + "subject": "/phonenumber/15555555555", + "type": "Microsoft.Communication.SMSReceived", + "time": "2020-09-18T00:27:47.0000000Z", + "id": "Incoming_20200918002745d29ebbea-3341-4466-9690-0a03af35228e", + "data": { + "MessageId": "Incoming_20200918002745d29ebbea-3341-4466-9690-0a03af35228e", + "From": "15555555555", + "To": "15555555555", + "Message": "Great to connect with ACS events", + "ReceivedTimestamp": "2020-09-18T00:27:45.32Z" + }, + "specversion": "1.0", + "operationId": "SMSReceivedEventName", + "title": "SMSReceived" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/snapshot_created.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/snapshot_created.json new file mode 100644 index 000000000000..2250fb4ec54f --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/snapshot_created.json @@ -0,0 +1,15 @@ +{ + "source": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/microsoft.appconfiguration/configurationstores/contoso", + "subject": "https://contoso.azconfig.io/kvsnapshots/Foo", + "type": "Microsoft.AppConfiguration.SnapshotCreated", + "time": "2023-09-02T20:05:03.0000000Z", + "id": "84e17ea4-66db-4b54-8050-df8f7763f87b", + "data": { + "name": "Foo", + "etag": "FnUExLaj2moIi4tJX9AXn9sakm0", + "syncToken": "zAJw6V16=Njo1IzUxNjQ2NzM=;sn=5164673" + }, + "specversion": "1.0", + "operationId": "SnapshotCreatedEventName", + "title": "SnapshotCreated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/snapshot_modified.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/snapshot_modified.json new file mode 100644 index 000000000000..698ba7dfd592 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/snapshot_modified.json @@ -0,0 +1,15 @@ +{ + "source": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/microsoft.appconfiguration/configurationstores/contoso", + "subject": "https://contoso.azconfig.io/snapshots/Foo", + "type": "Microsoft.AppConfiguration.SnapshotModified", + "time": "2023-09-03T20:05:03.0000000Z", + "id": "84e17ea4-66db-4b54-8050-df8f7763f87b", + "data": { + "name": "Foo", + "etag": "FnUExLaj2moIi4tJX9AXn9sakm0", + "syncToken": "zAJw6V16=Njo1IzUxNjQ2NzM=;sn=5164673" + }, + "specversion": "1.0", + "operationId": "SnapshotModifiedEventName", + "title": "SnapshotModified" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/storage_task_assignment_completed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/storage_task_assignment_completed.json new file mode 100644 index 000000000000..9b1b08148018 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/storage_task_assignment_completed.json @@ -0,0 +1,17 @@ +{ + "source": "/subscriptions/c86a9c18-8373-41fa-92d4-1d7bdc16977b/resourceGroups/shubhajTestRG/providers/Microsoft.Storage/storageAccounts/canaryfns", + "subject": "DataManagement/StorageActions/StorageTaskAssignments", + "type": "Microsoft.Storage.StorageTaskAssignmentCompleted", + "time": "2023-11-27T23:09:21Z", + "id": "dd17c35c-e68a-437d be15-5417820310d2", + "data": { + "status": "Succeeded", + "completedDateTime": "2023-11-27T23:09:21Z", + "taskExecutionId": "testtest2-2023-11-27T21:16:43.4491131Z", + "taskName": "dizbbcanary2", + "summaryReportBlobUrl": "https://canaryfns.blob.core.windows.net/reports/dizbbcanary2/testtest2/2023-11-27T21:17:53/SummaryReport.json" + }, + "specversion": "1.0", + "operationId": "StorageTaskAssignmentCompletedEventName", + "title": "StorageTaskAssignmentCompleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/storage_task_assignment_queued.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/storage_task_assignment_queued.json new file mode 100644 index 000000000000..ff15df34b81c --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/storage_task_assignment_queued.json @@ -0,0 +1,14 @@ +{ + "source": "/subscriptions/c86a9c18-8373-41fa-92d4-1d7bdc16977b/resourceGroups/shubhajTestRG/providers/Microsoft.Storage/storageAccounts/canaryfns", + "subject": "DataManagement/StorageActions/StorageTaskAssignments", + "type": "Microsoft.Storage.StorageTaskAssignmentQueued", + "time": "2023-11-27T21:17:53Z", + "id": "59ff3f6f-696c-4cd2-a206-8012fc1a73f2", + "data": { + "queuedDateTime": "2023-11-27T21:17:53Z", + "taskExecutionId": "testtest2-2023-11-27T21:16:43.4491131Z" + }, + "specversion": "1.0", + "operationId": "StorageTaskAssignmentQueuedEventName", + "title": "StorageTaskAssignmentQueued" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/storage_task_completed.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/storage_task_completed.json new file mode 100644 index 000000000000..e38ef4e3057c --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/storage_task_completed.json @@ -0,0 +1,17 @@ +{ + "source": "/subscriptions/c86a9c18-8373-41fa-92d4-1d7bdc16977b/resourceGroups/shulin-rg/providers/Microsoft.Storage/storageAccounts/shulinstcanest2", + "subject": "DataManagement/StorageTasks", + "type": "Microsoft.Storage.StorageTaskCompleted", + "time": "2023-03-23T16:52:58Z", + "id": "b34b3b93-a64d-41ea-aba4-d55f2d29190b", + "data": { + "status": "Succeeded", + "completedDateTime": "2023-03-23T16:52:58Z", + "taskExecutionId": "deletetest-2023-03-23T16:42:33.8658256Z_2023-03-23T16:42:58.8983000Z", + "taskName": "delete123", + "summaryReportBlobUrl": "https://shulinstcanest2.blob.core.windows.net/report/delete123_deletetest_2023-03-23T16:43:50/SummaryReport.json" + }, + "specversion": "1.0", + "operationId": "StorageTaskCompletedEventName", + "title": "StorageTaskCompleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/storage_task_queued.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/storage_task_queued.json new file mode 100644 index 000000000000..443462c3c0f4 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/storage_task_queued.json @@ -0,0 +1,14 @@ +{ + "source": "/subscriptions/c86a9c18-8373-41fa-92d4-1d7bdc16977b/resourceGroups/shulin-rg/providers/Microsoft.Storage/storageAccounts/shulinstcanest2", + "subject": "DataManagement/StorageTasks", + "type": "Microsoft.Storage.StorageTaskQueued", + "time": "2023-03-23T16:43:50Z", + "id": "7fddaf06-24e8-4d57-9b66-5b7ab920a626", + "data": { + "queuedDateTime": "2023-03-23T16:43:50Z", + "taskExecutionId": "deletetest-2023-03-23T16:42:33.8658256Z_2023-03-23T16:42:58.8983000Z" + }, + "specversion": "1.0", + "operationId": "StorageTaskQueuedEventName", + "title": "StorageTaskQueued" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/subscriptionCreated.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/subscriptionCreated.json new file mode 100644 index 000000000000..99f810685320 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/subscriptionCreated.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}", + "subject": "/subscriptions/{subscriptionId}", + "type": "Microsoft.ApiManagement.SubscriptionCreated", + "time": "2021-07-02T00:47:47.8536532Z", + "id": "831e1650-001e-001b-66ab-eeb76e069631", + "data": { + "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/subscriptions/{subscriptionId}" + }, + "specversion": "1.0", + "operationId": "SubscriptionCreatedEventName", + "title": "SubscriptionCreated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/subscriptionDeleted.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/subscriptionDeleted.json new file mode 100644 index 000000000000..5ae2c599d7c6 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/subscriptionDeleted.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}", + "subject": "/subscriptions/{subscriptionId}", + "type": "Microsoft.ApiManagement.SubscriptionDeleted", + "time": "2021-07-02T00:47:47.8536532Z", + "id": "831e1650-001e-001b-66ab-eeb76e069631", + "data": { + "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/subscriptions/{subscriptionId}" + }, + "specversion": "1.0", + "operationId": "SubscriptionDeletedEventName", + "title": "SubscriptionDeleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/subscriptionUpdated.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/subscriptionUpdated.json new file mode 100644 index 000000000000..d46f3884cbd4 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/subscriptionUpdated.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}", + "subject": "/subscriptions/{subscriptionId}", + "type": "Microsoft.ApiManagement.SubscriptionUpdated", + "time": "2021-07-02T00:47:47.8536532Z", + "id": "831e1650-001e-001b-66ab-eeb76e069631", + "data": { + "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/subscriptions/{subscriptionId}" + }, + "specversion": "1.0", + "operationId": "SubscriptionUpdatedEventName", + "title": "SubscriptionUpdated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/userCreated.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/userCreated.json new file mode 100644 index 000000000000..18bbb719f7ef --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/userCreated.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}", + "subject": "/users/apimuser-contoso-com", + "type": "Microsoft.ApiManagement.UserCreated", + "time": "2021-07-02T00:47:47.8237532Z", + "id": "92c502f2-a966-42a7-a428-d3b319844544", + "data": { + "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/users/apimuser-contoso-com" + }, + "specversion": "1.0", + "operationId": "UserCreatedEventName", + "title": "UserCreated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/userDeleted.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/userDeleted.json new file mode 100644 index 000000000000..09da565dd7c1 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/userDeleted.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}", + "subject": "/users/apimuser-contoso-com", + "type": "Microsoft.ApiManagement.UserDeleted", + "time": "2021-07-02T00:47:47.8536532Z", + "id": "92c502f2-a966-42a7-a428-d3b319844544", + "data": { + "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/users/apimuser-contoso-com" + }, + "specversion": "1.0", + "operationId": "UserDeletedEventName", + "title": "UserDeleted" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/userUpdated.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/userUpdated.json new file mode 100644 index 000000000000..1f13dfec5950 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/userUpdated.json @@ -0,0 +1,13 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}", + "subject": "/users/apimuser-contoso-com", + "type": "Microsoft.ApiManagement.UserUpdated", + "time": "2021-07-02T00:47:48.8269769Z", + "id": "92c502f2-a966-42a7-a428-d3b319844544", + "data": { + "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/users/apimuser-contoso-com" + }, + "specversion": "1.0", + "operationId": "UserUpdatedEventName", + "title": "UserUpdated" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/user_disconnected.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/user_disconnected.json new file mode 100644 index 000000000000..add7b982111d --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2018-01-01/user_disconnected.json @@ -0,0 +1,18 @@ +{ + "source": "/subscriptions/3364013b-4c5c-4dc3-953a-072f091c89a7/resourcegroups/testresources/providers/microsoft.communication/communicationservices/vikramacstestresource", + "subject": "user/8:acs:5354158b-17b7-489c-9380-95d8821ff76b_0000000c-6c47-7dfd-6d70-224822000cfb", + "type": "Microsoft.Communication.UserDisconnected", + "time": "2021-09-09T21:13:45.0000000Z", + "id": "93fa5460-7d6c-4fb7-bbb7-2d56159e98d9", + "data": { + "userCommunicationIdentifier": { + "rawId": "8:acs:5354158b-17b7-489c-9380-95d8821ff76b_0000000c-6c47-7dfd-6d70-224822000cfb", + "communicationUser": { + "id": "8:acs:5354158b-17b7-489c-9380-95d8821ff76b_0000000c-6c47-7dfd-6d70-224822000cfb" + } + } + }, + "specversion": "1.0", + "operationId": "UserDisconnectedEventName", + "title": "UserDisconnected" +} diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2024-01-01/email_delivery_report_received.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2024-01-01/email_delivery_report_received.json index bf96f5e6b66f..51dddcbc6d56 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2024-01-01/email_delivery_report_received.json +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2024-01-01/email_delivery_report_received.json @@ -7,7 +7,7 @@ "recipient": "test1@contoso.com", "messageId": "950850f5-bcdf-4315-b77a-6447cf56fac9", "status": "delivered", - "deliveryAttemptTimeStamp": "2023-02-09T19:46:12.2480265+00:00" + "deliveryAttemptTimestamp": "2023-02-09T19:46:12.2480265+00:00" }, "type": "Microsoft.Communication.EmailDeliveryReportReceived", "time": "2023-02-09T19:46:12.2478002Z", diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2024-01-01/email_engagement_tracking_report_received.json b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2024-01-01/email_engagement_tracking_report_received.json index 85f10a93a965..f45a02148908 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2024-01-01/email_engagement_tracking_report_received.json +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/examples/2024-01-01/email_engagement_tracking_report_received.json @@ -5,7 +5,7 @@ "data": { "sender": "test2@contoso.org", "messageId": "fe26a737-6941-410c-b126-7eacbe4035d1", - "userActionTimeStamp": "2023-02-09T20:07:22.745555+00:00", + "userActionTimestamp": "2023-02-09T20:07:22.745555+00:00", "engagementContext": "www.example.com", "userAgent": "Desktop", "engagementType": "click" diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/main.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/main.tsp index 89ed7f761fd4..19d9b9408809 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/main.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/main.tsp @@ -36,6 +36,7 @@ namespace Microsoft.EventGrid.SystemEvents { using TypeSpec.Versioning; enum ServiceApiVersions { + v2018_01_01: "2018-01-01", v2024_01_01: "2024-01-01", } } diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverride.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverride.tsp index 1b2b2247d318..afce376662a8 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverride.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverride.tsp @@ -25,14 +25,6 @@ using Azure.ClientGenerator.Core; ); @@clientName(AcsRouterWorkerSelector.value, "labelValue", "autorest"); -@@clientName(AcsEmailDeliveryReportReceivedEventData.deliveryAttemptTimeStamp, - "deliveryAttemptTimestamp", - "autorest" -); -@@clientName(AcsEmailEngagementTrackingReportReceivedEventData.userActionTimeStamp, - "userActionTimestamp", - "autorest" -); @@clientName(AcsEmailEngagementTrackingReportReceivedEventData.engagementType, "engagement", "autorest" diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideCsharp.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideCsharp.tsp index 60933e665420..abea6683fbfb 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideCsharp.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideCsharp.tsp @@ -23,14 +23,6 @@ using Microsoft.EventGrid.SystemEvents; "csharp" ); -@@clientName(AcsEmailDeliveryReportReceivedEventData.deliveryAttemptTimeStamp, - "deliveryAttemptTimestamp", - "csharp" -); -@@clientName(AcsEmailEngagementTrackingReportReceivedEventData.userActionTimeStamp, - "userActionTimestamp", - "csharp" -); @@clientName(AcsEmailEngagementTrackingReportReceivedEventData.engagementType, "engagement", "csharp" @@ -201,6 +193,48 @@ using Microsoft.EventGrid.SystemEvents; "csharp" ); +@@clientName(EventGridMQTTClientCreatedOrUpdatedEventData, + "EventGridMqttClientCreatedOrUpdatedEventData", + "csharp" +); + +@@clientName(EventGridMQTTClientDeletedEventData, + "EventGridMqttClientDeletedEventData", + "csharp" +); + +@@clientName(EventGridMQTTClientSessionConnectedEventData, + "EventGridMqttClientSessionConnectedEventData", + "csharp" +); + +@@clientName(EventGridMQTTClientSessionDisconnectedEventData, + "EventGridMqttClientSessionDisconnectedEventData", + "csharp" +); + +@@clientName(EventGridMQTTClientEventData, + "EventGridMqttClientEventData", + "csharp" +); + +@@clientName(EventGridMQTTClientState, "EventGridMqttClientState", "csharp"); + +@@clientName(EventGridMQTTClientDisconnectionReason, + "EventGridMqttClientDisconnectionReason", + "csharp" +); + +@@clientName(RedisImportRDBCompletedEventData, + "RedisImportRdbCompletedEventData", + "csharp" +); + +@@clientName(RedisExportRDBCompletedEventData, + "RedisExportRdbCompletedEventData", + "csharp" +); + @@clientName(AcsRouterWorkerSelector.state, "SelectorState", "csharp"); @@clientName(AcsRouterWorkerSelector.ttlSeconds, "TimeToLive", "csharp"); @@clientName(AcsRouterWorkerSelector.value, "labelValue", "csharp"); diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideGo.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideGo.tsp index 3f1332b43f72..67d69823970f 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideGo.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideGo.tsp @@ -333,10 +333,6 @@ using Microsoft.EventGrid.SystemEvents; "ACSEmailDeliveryReportReceivedEventData", "go" ); -@@clientName(AcsEmailDeliveryReportReceivedEventData.deliveryAttemptTimeStamp, - "DeliveryAttemptTimestamp", - "go" -); @@clientName(AcsEmailDeliveryReportStatus, "ACSEmailDeliveryReportStatus", @@ -355,10 +351,6 @@ using Microsoft.EventGrid.SystemEvents; "Engagement", "go" ); -@@clientName(AcsEmailEngagementTrackingReportReceivedEventData.userActionTimeStamp, - "UserActionTimestamp", - "go" -); @@clientName(AcsIncomingCallCustomContext, "ACSIncomingCallCustomContext", diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideJs.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideJs.tsp index aae89181bef8..b729151e8e59 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideJs.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideJs.tsp @@ -45,10 +45,7 @@ using Microsoft.EventGrid.SystemEvents; "toCommunicationIdentifier", "javascript" ); -@@clientName(AcsEmailEngagementTrackingReportReceivedEventData.userActionTimeStamp, - "userActionTimestamp", - "javascript" -); + @@clientName(AcsEmailEngagementTrackingReportReceivedEventData.engagementType, "engagement", "javascript" @@ -65,10 +62,7 @@ using Microsoft.EventGrid.SystemEvents; "summaryReportBlobUri", "javascript" ); -@@clientName(AcsEmailDeliveryReportReceivedEventData.deliveryAttemptTimeStamp, - "deliveryAttemptTimestamp", - "javascript" -); + @@clientName(ResourceNotificationsResourceUpdatedEventData.resourceInfo, "resourceDetails", "javascript" diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml index b70a5107b6fc..2cecc3941806 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml @@ -13,7 +13,7 @@ options: emitter-output-dir: "{project-root}/.." examples-directory: examples omit-unreachable-types: false - output-file: "{azure-resource-provider-folder}/Microsoft.EventGrid/{version-status}/{version}/SystemEvents.json" + output-file: "{azure-resource-provider-folder}/Microsoft.EventGrid/{version-status}/{version}/GeneratedSystemEvents.json" azure-resource-provider-folder: "data-plane" emit-lro-options: "none" "@azure-tools/typespec-python": @@ -29,3 +29,4 @@ options: model-namespace: false namespace: Azure.Messaging.EventGrid.SystemEvents flavor: azure + api-version: "2018-01-01" diff --git a/specification/eventgrid/Azure.Messaging.EventGrid/tspconfig.yaml b/specification/eventgrid/Azure.Messaging.EventGrid/tspconfig.yaml index 8689784d3655..a75923badadb 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid/tspconfig.yaml +++ b/specification/eventgrid/Azure.Messaging.EventGrid/tspconfig.yaml @@ -35,10 +35,10 @@ options: namespace: "com.azure.messaging.eventgrid.namespaces" package-dir: azure-messaging-eventgrid-namespaces partial-update: true - namer: true generate-samples: false generate-tests: false enable-sync-stack: true + service-version-exclude-preview: true customization-class: customization/src/main/java/EventGridCustomization.java dev-options: loglevel: info diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json index 8cbf69a50d02..4228c52100eb 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json @@ -1480,11 +1480,10 @@ "description": "Detailed information about the status if any", "$ref": "#/definitions/AcsEmailDeliveryReportStatusDetails" }, - "deliveryAttemptTimeStamp": { + "deliveryAttemptTimestamp": { "description": "The time at which the email delivery report received timestamp", "format": "date-time", - "type": "string", - "x-ms-client-name": "deliveryAttemptTimestamp" + "type": "string" } } }, @@ -1504,11 +1503,10 @@ "description": "The Id of the email that has been sent", "type": "string" }, - "userActionTimeStamp": { + "userActionTimestamp": { "description": "The time at which the user interacted with the email", "format": "date-time", - "type": "string", - "x-ms-client-name": "userActionTimestamp" + "type": "string" }, "engagementContext": { "description": "The context of the type of engagement user had with email", diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/email_delivery_report_received.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/email_delivery_report_received.json index cefae0de0469..73732b719478 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/email_delivery_report_received.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/email_delivery_report_received.json @@ -7,7 +7,7 @@ "recipient": "test1@contoso.com", "messageId": "950850f5-bcdf-4315-b77a-6447cf56fac9", "status": "delivered", - "deliveryAttemptTimeStamp": "2023-02-09T19:46:12.2480265+00:00" + "deliveryAttemptTimestamp": "2023-02-09T19:46:12.2480265+00:00" }, "type": "Microsoft.Communication.EmailDeliveryReportReceived", "time": "2023-02-09T19:46:12.2478002Z", diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/email_engagement_tracking_report_received.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/email_engagement_tracking_report_received.json index a3f80e9ec99f..aeff3ea6ff26 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/email_engagement_tracking_report_received.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/email_engagement_tracking_report_received.json @@ -5,7 +5,7 @@ "data": { "sender": "test2@contoso.org", "messageId": "fe26a737-6941-410c-b126-7eacbe4035d1", - "userActionTimeStamp": "2023-02-09T20:07:22.745555+00:00", + "userActionTimestamp": "2023-02-09T20:07:22.745555+00:00", "engagementContext": "www.example.com", "userAgent": "Desktop", "engagementType": "click" diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/email_delivery_report_received.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/email_delivery_report_received.json index cd033a72e70a..47d4fc8b7d68 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/email_delivery_report_received.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/email_delivery_report_received.json @@ -7,7 +7,7 @@ "recipient": "test1@contoso.com", "messageId": "950850f5-bcdf-4315-b77a-6447cf56fac9", "status": "delivered", - "deliveryAttemptTimeStamp": "2023-02-09T19:46:12.2480265+00:00", + "deliveryAttemptTimestamp": "2023-02-09T19:46:12.2480265+00:00", "deliveryStatusDetails": { "statusMessage": "DestinationMailboxFull" } diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/email_engagement_tracking_report_received.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/email_engagement_tracking_report_received.json index 7b543b7e3444..65bc2f04746e 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/email_engagement_tracking_report_received.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/email_engagement_tracking_report_received.json @@ -5,7 +5,7 @@ "data": { "sender": "test2@contoso.org", "messageId": "fe26a737-6941-410c-b126-7eacbe4035d1", - "userActionTimeStamp": "2023-02-09T20:07:22.745555+00:00", + "userActionTimestamp": "2023-02-09T20:07:22.745555+00:00", "engagementContext": "www.example.com", "userAgent": "Desktop", "engagementType": "click" 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 new file mode 100644 index 000000000000..ad15d675970b --- /dev/null +++ b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/GeneratedSystemEvents.json @@ -0,0 +1,9246 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure.Messaging.SystemEvents", + "version": "2018-01-01", + "description": "Azure Messaging EventGrid SystemEvents", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "tags": [], + "paths": {}, + "definitions": { + "AcsChatEventBaseProperties": { + "type": "object", + "description": "Schema of common properties of all chat events", + "properties": { + "recipientCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the target user" + }, + "transactionId": { + "type": "string", + "description": "The transaction id will be used as co-relation vector" + }, + "threadId": { + "type": "string", + "description": "The chat thread id" + } + }, + "required": [ + "recipientCommunicationIdentifier" + ] + }, + "AcsChatEventInThreadBaseProperties": { + "type": "object", + "description": "Schema of common properties of all thread-level chat events", + "properties": { + "transactionId": { + "type": "string", + "description": "The transaction id will be used as co-relation vector" + }, + "threadId": { + "type": "string", + "description": "The chat thread id" + } + } + }, + "AcsChatMessageDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageDeleted event.", + "properties": { + "deleteTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the message was deleted" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AcsChatMessageEventBaseProperties" + } + ] + }, + "AcsChatMessageDeletedInThreadEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageDeletedInThread event.", + "properties": { + "deleteTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the message was deleted" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AcsChatMessageEventInThreadBaseProperties" + } + ] + }, + "AcsChatMessageEditedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageEdited event.", + "properties": { + "messageBody": { + "type": "string", + "description": "The body of the chat message" + }, + "metadata": { + "type": "object", + "description": "The chat message metadata", + "additionalProperties": { + "type": "string" + } + }, + "editTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the message was edited" + } + }, + "required": [ + "metadata" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatMessageEventBaseProperties" + } + ] + }, + "AcsChatMessageEditedInThreadEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageEditedInThread event.", + "properties": { + "messageBody": { + "type": "string", + "description": "The body of the chat message" + }, + "metadata": { + "type": "object", + "description": "The chat message metadata", + "additionalProperties": { + "type": "string" + } + }, + "editTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the message was edited" + } + }, + "required": [ + "metadata" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatMessageEventInThreadBaseProperties" + } + ] + }, + "AcsChatMessageEventBaseProperties": { + "type": "object", + "description": "Schema of common properties of all chat message events", + "properties": { + "messageId": { + "type": "string", + "description": "The chat message id" + }, + "senderCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the sender" + }, + "senderDisplayName": { + "type": "string", + "description": "The display name of the sender" + }, + "composeTime": { + "type": "string", + "format": "date-time", + "description": "The original compose time of the message" + }, + "type": { + "type": "string", + "description": "The type of the message" + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the message" + } + }, + "required": [ + "senderCommunicationIdentifier" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatEventBaseProperties" + } + ] + }, + "AcsChatMessageEventInThreadBaseProperties": { + "type": "object", + "description": "Schema of common properties of all thread-level chat message events", + "properties": { + "messageId": { + "type": "string", + "description": "The chat message id" + }, + "senderCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the sender" + }, + "senderDisplayName": { + "type": "string", + "description": "The display name of the sender" + }, + "composeTime": { + "type": "string", + "format": "date-time", + "description": "The original compose time of the message" + }, + "type": { + "type": "string", + "description": "The type of the message" + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the message" + } + }, + "required": [ + "senderCommunicationIdentifier" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatEventInThreadBaseProperties" + } + ] + }, + "AcsChatMessageReceivedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageReceived event.", + "properties": { + "messageBody": { + "type": "string", + "description": "The body of the chat message" + }, + "metadata": { + "type": "object", + "description": "The chat message metadata", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "metadata" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatMessageEventBaseProperties" + } + ] + }, + "AcsChatMessageReceivedInThreadEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageReceivedInThread event.", + "properties": { + "messageBody": { + "type": "string", + "description": "The body of the chat message" + }, + "metadata": { + "type": "object", + "description": "The chat message metadata", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "metadata" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatMessageEventInThreadBaseProperties" + } + ] + }, + "AcsChatParticipantAddedToThreadEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadParticipantAdded event.", + "properties": { + "time": { + "type": "string", + "format": "date-time", + "description": "The time at which the user was added to the thread" + }, + "addedByCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the user who added the user" + }, + "participantAdded": { + "$ref": "#/definitions/AcsChatThreadParticipantProperties", + "description": "The details of the user who was added" + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the thread" + } + }, + "required": [ + "addedByCommunicationIdentifier", + "participantAdded" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatEventInThreadBaseProperties" + } + ] + }, + "AcsChatParticipantAddedToThreadWithUserEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatParticipantAddedToThreadWithUser event.", + "properties": { + "time": { + "type": "string", + "format": "date-time", + "description": "The time at which the user was added to the thread" + }, + "addedByCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the user who added the user" + }, + "participantAdded": { + "$ref": "#/definitions/AcsChatThreadParticipantProperties", + "description": "The details of the user who was added" + } + }, + "required": [ + "addedByCommunicationIdentifier", + "participantAdded" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatThreadEventBaseProperties" + } + ] + }, + "AcsChatParticipantRemovedFromThreadEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadParticipantRemoved event.", + "properties": { + "time": { + "type": "string", + "format": "date-time", + "description": "The time at which the user was removed to the thread" + }, + "removedByCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the user who removed the user" + }, + "participantRemoved": { + "$ref": "#/definitions/AcsChatThreadParticipantProperties", + "description": "The details of the user who was removed" + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the thread" + } + }, + "required": [ + "removedByCommunicationIdentifier", + "participantRemoved" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatEventInThreadBaseProperties" + } + ] + }, + "AcsChatParticipantRemovedFromThreadWithUserEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatParticipantRemovedFromThreadWithUser event.", + "properties": { + "time": { + "type": "string", + "format": "date-time", + "description": "The time at which the user was removed to the thread" + }, + "removedByCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the user who removed the user" + }, + "participantRemoved": { + "$ref": "#/definitions/AcsChatThreadParticipantProperties", + "description": "The details of the user who was removed" + } + }, + "required": [ + "removedByCommunicationIdentifier", + "participantRemoved" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatThreadEventBaseProperties" + } + ] + }, + "AcsChatThreadCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadCreated event.", + "properties": { + "createdByCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the user who created the thread" + }, + "properties": { + "type": "object", + "description": "The thread properties", + "additionalProperties": {} + }, + "metadata": { + "type": "object", + "description": "The thread metadata", + "additionalProperties": { + "type": "string" + } + }, + "participants": { + "type": "array", + "description": "The list of properties of participants who are part of the thread", + "items": { + "$ref": "#/definitions/AcsChatThreadParticipantProperties" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "createdByCommunicationIdentifier", + "properties", + "metadata", + "participants" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatThreadEventInThreadBaseProperties" + } + ] + }, + "AcsChatThreadCreatedWithUserEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadCreatedWithUser event.", + "properties": { + "createdByCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the user who created the thread" + }, + "properties": { + "type": "object", + "description": "The thread properties", + "additionalProperties": {} + }, + "metadata": { + "type": "object", + "description": "The thread metadata", + "additionalProperties": { + "type": "string" + } + }, + "participants": { + "type": "array", + "description": "The list of properties of participants who are part of the thread", + "items": { + "$ref": "#/definitions/AcsChatThreadParticipantProperties" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "createdByCommunicationIdentifier", + "properties", + "metadata", + "participants" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatThreadEventBaseProperties" + } + ] + }, + "AcsChatThreadDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadDeleted event.", + "properties": { + "deletedByCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the user who deleted the thread" + }, + "deleteTime": { + "type": "string", + "format": "date-time", + "description": "The deletion time of the thread" + } + }, + "required": [ + "deletedByCommunicationIdentifier" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatThreadEventInThreadBaseProperties" + } + ] + }, + "AcsChatThreadEventBaseProperties": { + "type": "object", + "description": "Schema of common properties of all chat thread events", + "properties": { + "createTime": { + "type": "string", + "format": "date-time", + "description": "The original creation time of the thread" + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the thread" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AcsChatEventBaseProperties" + } + ] + }, + "AcsChatThreadEventInThreadBaseProperties": { + "type": "object", + "description": "Schema of common properties of all chat thread events", + "properties": { + "createTime": { + "type": "string", + "format": "date-time", + "description": "The original creation time of the thread" + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the thread" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AcsChatEventInThreadBaseProperties" + } + ] + }, + "AcsChatThreadParticipantProperties": { + "type": "object", + "description": "Schema of the chat thread participant", + "properties": { + "displayName": { + "type": "string", + "description": "The name of the user" + }, + "participantCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the user" + }, + "metadata": { + "type": "object", + "description": "The metadata of the user", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "participantCommunicationIdentifier", + "metadata" + ] + }, + "AcsChatThreadPropertiesUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadPropertiesUpdated event.", + "properties": { + "editedByCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the user who updated the thread properties" + }, + "editTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the properties of the thread were updated" + }, + "properties": { + "type": "object", + "description": "The updated thread properties", + "additionalProperties": {} + }, + "metadata": { + "type": "object", + "description": "The thread metadata", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "editedByCommunicationIdentifier", + "properties", + "metadata" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatThreadEventInThreadBaseProperties" + } + ] + }, + "AcsChatThreadPropertiesUpdatedPerUserEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadPropertiesUpdatedPerUser event.", + "properties": { + "editedByCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the user who updated the thread properties" + }, + "editTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the properties of the thread were updated" + }, + "metadata": { + "type": "object", + "description": "The thread metadata", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "type": "object", + "description": "The updated thread properties", + "additionalProperties": {} + } + }, + "required": [ + "editedByCommunicationIdentifier", + "metadata", + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatThreadEventBaseProperties" + } + ] + }, + "AcsChatThreadWithUserDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadWithUserDeleted event.", + "properties": { + "deletedByCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the user who deleted the thread" + }, + "deleteTime": { + "type": "string", + "format": "date-time", + "description": "The deletion time of the thread" + } + }, + "required": [ + "deletedByCommunicationIdentifier" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatThreadEventBaseProperties" + } + ] + }, + "AcsEmailDeliveryReportReceivedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.EmailDeliveryReportReceived event.", + "properties": { + "sender": { + "type": "string", + "description": "The Sender Email Address" + }, + "recipient": { + "type": "string", + "description": "The recipient Email Address" + }, + "messageId": { + "type": "string", + "description": "The Id of the email been sent" + }, + "status": { + "$ref": "#/definitions/AcsEmailDeliveryReportStatus", + "description": "The status of the email. Any value other than Delivered is considered failed." + }, + "deliveryStatusDetails": { + "$ref": "#/definitions/AcsEmailDeliveryReportStatusDetails", + "description": "Detailed information about the status if any" + }, + "deliveryAttemptTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time at which the email delivery report received timestamp" + } + }, + "required": [ + "deliveryStatusDetails" + ] + }, + "AcsEmailDeliveryReportStatus": { + "type": "string", + "description": "The status of the email. Any value other than Delivered is considered failed.", + "enum": [ + "Bounced", + "Delivered", + "Failed", + "FilteredSpam", + "Quarantined", + "Suppressed" + ], + "x-ms-enum": { + "name": "AcsEmailDeliveryReportStatus", + "modelAsString": true, + "values": [ + { + "name": "Bounced", + "value": "Bounced", + "description": "Hard bounce detected while sending the email" + }, + { + "name": "Delivered", + "value": "Delivered", + "description": "The email was delivered" + }, + { + "name": "Failed", + "value": "Failed", + "description": "The email failed to be delivered" + }, + { + "name": "FilteredSpam", + "value": "FilteredSpam", + "description": "The message was identified as spam and was rejected or blocked (not quarantined)." + }, + { + "name": "Quarantined", + "value": "Quarantined", + "description": "The message was quarantined (as spam, bulk mail, or phishing). For more information, see Quarantined email messages in EOP (EXCHANGE ONLINE PROTECTION)." + }, + { + "name": "Suppressed", + "value": "Suppressed", + "description": "The email was suppressed" + } + ] + } + }, + "AcsEmailDeliveryReportStatusDetails": { + "type": "object", + "description": "Detailed information about the status if any", + "properties": { + "statusMessage": { + "type": "string", + "description": "Detailed status message" + } + } + }, + "AcsEmailEngagementTrackingReportReceivedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.EmailEngagementTrackingReportReceived event.", + "properties": { + "sender": { + "type": "string", + "description": "The Sender Email Address" + }, + "recipient": { + "type": "string", + "description": "The Recipient Email Address" + }, + "messageId": { + "type": "string", + "description": "The Id of the email that has been sent" + }, + "userActionTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time at which the user interacted with the email" + }, + "engagementContext": { + "type": "string", + "description": "The context of the type of engagement user had with email" + }, + "userAgent": { + "type": "string", + "description": "The user agent interacting with the email" + }, + "engagementType": { + "$ref": "#/definitions/AcsUserEngagement", + "description": "The type of engagement user have with email", + "x-ms-client-name": "engagement" + } + } + }, + "AcsIncomingCallCustomContext": { + "type": "object", + "description": "Custom Context of Incoming Call", + "properties": { + "sipHeaders": { + "type": "object", + "description": "Sip Headers for incoming call", + "additionalProperties": { + "type": "string" + } + }, + "voipHeaders": { + "type": "object", + "description": "Voip Headers for incoming call", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "sipHeaders", + "voipHeaders" + ] + }, + "AcsIncomingCallEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.IncomingCall event", + "properties": { + "to": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the target user.", + "x-ms-client-name": "toCommunicationIdentifier" + }, + "from": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the user who initiated the call.", + "x-ms-client-name": "fromCommunicationIdentifier" + }, + "serverCallId": { + "type": "string", + "description": "The Id of the server call" + }, + "callerDisplayName": { + "type": "string", + "description": "Display name of caller." + }, + "customContext": { + "$ref": "#/definitions/AcsIncomingCallCustomContext", + "description": "Custom Context of Incoming Call" + }, + "incomingCallContext": { + "type": "string", + "description": "Signed incoming call context." + }, + "correlationId": { + "type": "string", + "description": "CorrelationId (CallId)." + } + }, + "required": [ + "to", + "from", + "customContext" + ] + }, + "AcsInteractiveReplyKind": { + "type": "string", + "description": "Interactive reply kind", + "enum": [ + "buttonReply", + "listReply", + "unknown" + ], + "x-ms-enum": { + "name": "AcsInteractiveReplyKind", + "modelAsString": true, + "values": [ + { + "name": "buttonReply", + "value": "buttonReply", + "description": "Messaged interactive reply type is ButtonReply" + }, + { + "name": "listReply", + "value": "listReply", + "description": "Messaged interactive reply type is ListReply" + }, + { + "name": "unknown", + "value": "unknown", + "description": "Messaged interactive reply type is Unknown" + } + ] + } + }, + "AcsMessageButtonContent": { + "type": "object", + "description": "Message Button Content", + "properties": { + "text": { + "type": "string", + "description": "The Text of the button" + }, + "payload": { + "type": "string", + "description": "The Payload of the button which was clicked by the user, setup by the business" + } + } + }, + "AcsMessageChannelEventError": { + "type": "object", + "description": "Message Channel Event Error", + "properties": { + "channelCode": { + "type": "string", + "description": "The channel error code" + }, + "channelMessage": { + "type": "string", + "description": "The channel error message" + } + } + }, + "AcsMessageChannelKind": { + "type": "string", + "description": "Message channel kind", + "enum": [ + "whatsapp" + ], + "x-ms-enum": { + "name": "AcsMessageChannelKind", + "modelAsString": true, + "values": [ + { + "name": "whatsapp", + "value": "whatsapp", + "description": "Updated message channel type is WhatsApp" + } + ] + } + }, + "AcsMessageContext": { + "type": "object", + "description": "Message Context", + "properties": { + "from": { + "type": "string", + "description": "The WhatsApp ID for the customer who replied to an inbound message." + }, + "id": { + "type": "string", + "description": "The message ID for the sent message for an inbound reply", + "x-ms-client-name": "messageId" + } + } + }, + "AcsMessageDeliveryStatus": { + "type": "string", + "description": "Message delivery status", + "enum": [ + "read", + "delivered", + "failed", + "sent", + "warning", + "unknown" + ], + "x-ms-enum": { + "name": "AcsMessageDeliveryStatus", + "modelAsString": true, + "values": [ + { + "name": "read", + "value": "read", + "description": "Read" + }, + { + "name": "delivered", + "value": "delivered", + "description": "Delivered" + }, + { + "name": "failed", + "value": "failed", + "description": "Failed" + }, + { + "name": "sent", + "value": "sent", + "description": "Sent" + }, + { + "name": "warning", + "value": "warning", + "description": "Warning" + }, + { + "name": "unknown", + "value": "unknown", + "description": "Unknown" + } + ] + } + }, + "AcsMessageDeliveryStatusUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated event.", + "properties": { + "messageId": { + "type": "string", + "description": "The message id" + }, + "status": { + "$ref": "#/definitions/AcsMessageDeliveryStatus", + "description": "The updated message status" + }, + "channelType": { + "$ref": "#/definitions/AcsMessageChannelKind", + "description": "The updated message channel type", + "x-ms-client-name": "channelKind" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AcsMessageEventData" + } + ] + }, + "AcsMessageEventData": { + "type": "object", + "description": "Schema of common properties of all chat thread events", + "properties": { + "from": { + "type": "string", + "description": "The message sender" + }, + "to": { + "type": "string", + "description": "The message recipient" + }, + "receivedTimeStamp": { + "type": "string", + "format": "date-time", + "description": "The time message was received" + }, + "error": { + "$ref": "#/definitions/AcsMessageChannelEventError", + "description": "The channel event error" + } + }, + "required": [ + "error" + ] + }, + "AcsMessageInteractiveButtonReplyContent": { + "type": "object", + "description": "Message Interactive button reply content for a user to business message", + "properties": { + "id": { + "type": "string", + "description": "The ID of the button", + "x-ms-client-name": "buttonId" + }, + "title": { + "type": "string", + "description": "The title of the button" + } + } + }, + "AcsMessageInteractiveContent": { + "type": "object", + "description": "Message Interactive Content", + "properties": { + "type": { + "$ref": "#/definitions/AcsInteractiveReplyKind", + "description": "The Message interactive reply type", + "x-ms-client-name": "replyKind" + }, + "buttonReply": { + "$ref": "#/definitions/AcsMessageInteractiveButtonReplyContent", + "description": "The Message Sent when a customer clicks a button" + }, + "listReply": { + "$ref": "#/definitions/AcsMessageInteractiveListReplyContent", + "description": "The Message Sent when a customer selects an item from a list" + } + }, + "required": [ + "buttonReply", + "listReply" + ] + }, + "AcsMessageInteractiveListReplyContent": { + "type": "object", + "description": "Message Interactive list reply content for a user to business message", + "properties": { + "id": { + "type": "string", + "description": "The ID of the selected list item", + "x-ms-client-name": "listItemId" + }, + "title": { + "type": "string", + "description": "The title of the selected list item" + }, + "description": { + "type": "string", + "description": "The description of the selected row" + } + } + }, + "AcsMessageMediaContent": { + "type": "object", + "description": "Message Media Content", + "properties": { + "mimeType": { + "type": "string", + "description": "The MIME type of the file this media represents" + }, + "id": { + "type": "string", + "description": "The media identifier", + "x-ms-client-name": "mediaId" + }, + "fileName": { + "type": "string", + "description": "The filename of the underlying media file as specified when uploaded" + }, + "caption": { + "type": "string", + "description": "The caption for the media object, if supported and provided" + } + } + }, + "AcsMessageReceivedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.AdvancedMessageReceived event.", + "properties": { + "content": { + "type": "string", + "description": "The message content" + }, + "channelType": { + "$ref": "#/definitions/AcsMessageChannelKind", + "description": "The message channel type", + "x-ms-client-name": "channelKind" + }, + "media": { + "$ref": "#/definitions/AcsMessageMediaContent", + "description": "The received message media content", + "x-ms-client-name": "mediaContent" + }, + "context": { + "$ref": "#/definitions/AcsMessageContext", + "description": "The received message context" + }, + "button": { + "$ref": "#/definitions/AcsMessageButtonContent", + "description": "The received message button content" + }, + "interactive": { + "$ref": "#/definitions/AcsMessageInteractiveContent", + "description": "The received message interactive content", + "x-ms-client-name": "interactiveContent" + } + }, + "required": [ + "channelType", + "media", + "context", + "button", + "interactive" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsMessageEventData" + } + ] + }, + "AcsRecordingChunkInfoProperties": { + "type": "object", + "description": "Schema for all properties of Recording Chunk Information.", + "properties": { + "documentId": { + "type": "string", + "description": "The documentId of the recording chunk" + }, + "index": { + "type": "integer", + "format": "int64", + "description": "The index of the recording chunk" + }, + "endReason": { + "type": "string", + "description": "The reason for ending the recording chunk" + }, + "metadataLocation": { + "type": "string", + "description": "The location of the metadata for this chunk" + }, + "contentLocation": { + "type": "string", + "description": "The location of the content for this chunk" + }, + "deleteLocation": { + "type": "string", + "description": "The location to delete all chunk storage" + } + } + }, + "AcsRecordingFileStatusUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RecordingFileStatusUpdated event.", + "properties": { + "recordingStorageInfo": { + "$ref": "#/definitions/AcsRecordingStorageInfoProperties", + "description": "The details of recording storage information" + }, + "recordingStartTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the recording started" + }, + "recordingDurationMs": { + "type": "integer", + "format": "int64", + "description": "The recording duration in milliseconds" + }, + "recordingContentType": { + "$ref": "#/definitions/recordingContentType", + "description": "The recording content type- AudioVideo, or Audio" + }, + "recordingChannelType": { + "$ref": "#/definitions/recordingChannelType", + "description": "The recording channel type - Mixed, Unmixed" + }, + "recordingFormatType": { + "$ref": "#/definitions/recordingFormatType", + "description": "The recording format type - Mp4, Mp3, Wav" + }, + "sessionEndReason": { + "type": "string", + "description": "The reason for ending recording session" + } + }, + "required": [ + "recordingStorageInfo" + ] + }, + "AcsRecordingStorageInfoProperties": { + "type": "object", + "description": "Schema for all properties of Recording Storage Information.", + "properties": { + "recordingChunks": { + "type": "array", + "description": "List of details of recording chunks information", + "items": { + "$ref": "#/definitions/AcsRecordingChunkInfoProperties" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "recordingChunks" + ] + }, + "AcsRouterChannelConfiguration": { + "type": "object", + "description": "Router Channel Configuration", + "properties": { + "channelId": { + "type": "string", + "description": "Channel ID for Router Job" + }, + "capacityCostPerJob": { + "type": "integer", + "format": "int32", + "description": "Capacity Cost Per Job for Router Job" + }, + "maxNumberOfJobs": { + "type": "integer", + "format": "int32", + "description": "Max Number of Jobs for Router Job" + } + } + }, + "AcsRouterCommunicationError": { + "type": "object", + "description": "Router Communication Error", + "properties": { + "code": { + "type": "string", + "description": "Router Communication Error Code" + }, + "message": { + "type": "string", + "description": "Router Communication Error Message" + }, + "target": { + "type": "string", + "description": "Router Communication Error Target" + }, + "innererror": { + "$ref": "#/definitions/AcsRouterCommunicationError", + "description": "Router Communication Inner Error" + }, + "details": { + "type": "array", + "description": "List of Router Communication Errors", + "items": { + "$ref": "#/definitions/AcsRouterCommunicationError" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "innererror", + "details" + ] + }, + "AcsRouterEventData": { + "type": "object", + "description": "Schema of common properties of all Router events", + "properties": { + "jobId": { + "type": "string", + "description": "Router Event Job ID" + }, + "channelReference": { + "type": "string", + "description": "Router Event Channel Reference" + }, + "channelId": { + "type": "string", + "description": "Router Event Channel ID" + } + } + }, + "AcsRouterJobCancelledEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobCancelled event", + "properties": { + "note": { + "type": "string", + "description": "Router Job Note" + }, + "dispositionCode": { + "type": "string", + "description": "Router Job Disposition Code" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ] + }, + "AcsRouterJobClassificationFailedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobClassificationFailed event", + "properties": { + "classificationPolicyId": { + "type": "string", + "description": "Router Job Classification Policy Id" + }, + "errors": { + "type": "array", + "description": "Router Job Classification Failed Errors", + "items": { + "$ref": "#/definitions/AcsRouterCommunicationError" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "errors" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ] + }, + "AcsRouterJobClassifiedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobClassified event", + "properties": { + "queueDetails": { + "$ref": "#/definitions/AcsRouterQueueDetails", + "description": "Router Job Queue Info" + }, + "classificationPolicyId": { + "type": "string", + "description": "Router Job Classification Policy Id" + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "Router Job Priority" + }, + "attachedWorkerSelectors": { + "type": "array", + "description": "Router Job Attached Worker Selector", + "items": { + "$ref": "#/definitions/AcsRouterWorkerSelector" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "queueDetails", + "attachedWorkerSelectors" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ] + }, + "AcsRouterJobClosedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobClosed event", + "properties": { + "assignmentId": { + "type": "string", + "description": "Router Job Closed Assignment Id" + }, + "workerId": { + "type": "string", + "description": "Router Job Closed Worker Id" + }, + "dispositionCode": { + "type": "string", + "description": "Router Job Closed Disposition Code" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ] + }, + "AcsRouterJobCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobCompleted event", + "properties": { + "assignmentId": { + "type": "string", + "description": "Router Job Completed Assignment Id" + }, + "workerId": { + "type": "string", + "description": "Router Job Completed Worker Id" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ] + }, + "AcsRouterJobDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobDeleted event", + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ] + }, + "AcsRouterJobEventData": { + "type": "object", + "description": "Schema of common properties of all Router Job events", + "properties": { + "queueId": { + "type": "string", + "description": "Router Job events Queue Id" + }, + "labels": { + "type": "object", + "description": "Router Job events Labels", + "additionalProperties": { + "type": "string" + } + }, + "tags": { + "type": "object", + "description": "Router Jobs events Tags", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "labels", + "tags" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsRouterEventData" + } + ] + }, + "AcsRouterJobExceptionTriggeredEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobExceptionTriggered event", + "properties": { + "ruleKey": { + "type": "string", + "description": "Router Job Exception Triggered Rule Key" + }, + "exceptionRuleId": { + "type": "string", + "description": "Router Job Exception Triggered Rule Id" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ] + }, + "AcsRouterJobQueuedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobQueued event", + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "description": "Router Job Priority" + }, + "attachedWorkerSelectors": { + "type": "array", + "description": "Router Job Queued Attached Worker Selector", + "items": { + "$ref": "#/definitions/AcsRouterWorkerSelector" + }, + "x-ms-identifiers": [] + }, + "requestedWorkerSelectors": { + "type": "array", + "description": "Router Job Queued Requested Worker Selector", + "items": { + "$ref": "#/definitions/AcsRouterWorkerSelector" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "attachedWorkerSelectors", + "requestedWorkerSelectors" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ] + }, + "AcsRouterJobReceivedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobReceived event", + "properties": { + "jobStatus": { + "$ref": "#/definitions/AcsRouterJobStatus", + "description": "Router Job Received Job Status" + }, + "classificationPolicyId": { + "type": "string", + "description": "Router Job Classification Policy Id" + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "Router Job Priority" + }, + "requestedWorkerSelectors": { + "type": "array", + "description": "Router Job Received Requested Worker Selectors", + "items": { + "$ref": "#/definitions/AcsRouterWorkerSelector" + }, + "x-ms-identifiers": [] + }, + "scheduledOn": { + "type": "string", + "format": "date-time", + "description": "Router Job Received Scheduled Time in UTC" + }, + "unavailableForMatching": { + "type": "boolean", + "description": "Unavailable For Matching for Router Job Received" + } + }, + "required": [ + "requestedWorkerSelectors", + "unavailableForMatching" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ] + }, + "AcsRouterJobSchedulingFailedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobSchedulingFailed event", + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "description": "Router Job Priority" + }, + "expiredAttachedWorkerSelectors": { + "type": "array", + "description": "Router Job Scheduling Failed Attached Worker Selector Expired", + "items": { + "$ref": "#/definitions/AcsRouterWorkerSelector" + }, + "x-ms-identifiers": [] + }, + "expiredRequestedWorkerSelectors": { + "type": "array", + "description": "Router Job Scheduling Failed Requested Worker Selector Expired", + "items": { + "$ref": "#/definitions/AcsRouterWorkerSelector" + }, + "x-ms-identifiers": [] + }, + "scheduledOn": { + "type": "string", + "format": "date-time", + "description": "Router Job Scheduling Failed Scheduled Time in UTC" + }, + "failureReason": { + "type": "string", + "description": "Router Job Scheduling Failed Reason" + } + }, + "required": [ + "expiredAttachedWorkerSelectors", + "expiredRequestedWorkerSelectors" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ] + }, + "AcsRouterJobStatus": { + "type": "string", + "description": "Acs Router Job Status", + "enum": [ + "PendingClassification", + "Queued", + "Assigned", + "Completed", + "Closed", + "Cancelled", + "ClassificationFailed", + "Created", + "PendingSchedule", + "Scheduled", + "ScheduleFailed", + "WaitingForActivation" + ], + "x-ms-enum": { + "name": "AcsRouterJobStatus", + "modelAsString": true, + "values": [ + { + "name": "PendingClassification", + "value": "PendingClassification", + "description": "Router Job Status Pending Classification" + }, + { + "name": "Queued", + "value": "Queued", + "description": "Router Job Status Queued" + }, + { + "name": "Assigned", + "value": "Assigned", + "description": "Router Job Status Assigned" + }, + { + "name": "Completed", + "value": "Completed", + "description": "Router Job Status Completed" + }, + { + "name": "Closed", + "value": "Closed", + "description": "Router Job Status Closed" + }, + { + "name": "Cancelled", + "value": "Cancelled", + "description": "Router Job Status Cancelled" + }, + { + "name": "ClassificationFailed", + "value": "ClassificationFailed", + "description": "Router Job Status Classification Failed" + }, + { + "name": "Created", + "value": "Created", + "description": "Router Job Status Created" + }, + { + "name": "PendingSchedule", + "value": "PendingSchedule", + "description": "Router Job Status Pending Schedule" + }, + { + "name": "Scheduled", + "value": "Scheduled", + "description": "Router Job Status Scheduled" + }, + { + "name": "ScheduleFailed", + "value": "ScheduleFailed", + "description": "Router Job Status Schedule Failed" + }, + { + "name": "WaitingForActivation", + "value": "WaitingForActivation", + "description": "Router Job Status Waiting For Activation" + } + ] + } + }, + "AcsRouterJobUnassignedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobUnassigned event", + "properties": { + "assignmentId": { + "type": "string", + "description": "Router Job Unassigned Assignment Id" + }, + "workerId": { + "type": "string", + "description": "Router Job Unassigned Worker Id" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ] + }, + "AcsRouterJobWaitingForActivationEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobWaitingForActivation event", + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "description": "Router Job Waiting For Activation Priority" + }, + "expiredAttachedWorkerSelectors": { + "type": "array", + "description": "Router Job Waiting For Activation Worker Selector Expired", + "items": { + "$ref": "#/definitions/AcsRouterWorkerSelector" + }, + "x-ms-identifiers": [] + }, + "expiredRequestedWorkerSelectors": { + "type": "array", + "description": "Router Job Waiting For Activation Requested Worker Selector Expired", + "items": { + "$ref": "#/definitions/AcsRouterWorkerSelector" + }, + "x-ms-identifiers": [] + }, + "scheduledOn": { + "type": "string", + "format": "date-time", + "description": "Router Job Waiting For Activation Scheduled Time in UTC" + }, + "unavailableForMatching": { + "type": "boolean", + "description": "Router Job Waiting For Activation Unavailable For Matching" + } + }, + "required": [ + "expiredAttachedWorkerSelectors", + "expiredRequestedWorkerSelectors", + "unavailableForMatching" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ] + }, + "AcsRouterJobWorkerSelectorsExpiredEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobWorkerSelectorsExpired event", + "properties": { + "expiredRequestedWorkerSelectors": { + "type": "array", + "description": "Router Job Worker Selectors Expired Requested Worker Selectors", + "items": { + "$ref": "#/definitions/AcsRouterWorkerSelector" + }, + "x-ms-identifiers": [] + }, + "expiredAttachedWorkerSelectors": { + "type": "array", + "description": "Router Job Worker Selectors Expired Attached Worker Selectors", + "items": { + "$ref": "#/definitions/AcsRouterWorkerSelector" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "expiredRequestedWorkerSelectors", + "expiredAttachedWorkerSelectors" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ] + }, + "AcsRouterLabelOperator": { + "type": "string", + "description": "Router Job Worker Selector Label Operator", + "enum": [ + "Equal", + "NotEqual", + "Greater", + "Less", + "GreaterThanOrEqual", + "LessThanOrEqual" + ], + "x-ms-enum": { + "name": "AcsRouterLabelOperator", + "modelAsString": true, + "values": [ + { + "name": "Equal", + "value": "Equal", + "description": "Router Label Operator Equal" + }, + { + "name": "NotEqual", + "value": "NotEqual", + "description": "Router Label Operator Not Equal" + }, + { + "name": "Greater", + "value": "Greater", + "description": "Router Label Operator Greater" + }, + { + "name": "Less", + "value": "Less", + "description": "Router Label Operator Less" + }, + { + "name": "GreaterThanOrEqual", + "value": "GreaterThanOrEqual", + "description": "Router Label Operator Greater than or equal" + }, + { + "name": "LessThanOrEqual", + "value": "LessThanOrEqual", + "description": "Router Label Operator Less than or equal" + } + ] + } + }, + "AcsRouterQueueDetails": { + "type": "object", + "description": "Router Queue Details", + "properties": { + "id": { + "type": "string", + "description": "Router Queue Id" + }, + "name": { + "type": "string", + "description": "Router Queue Name" + }, + "labels": { + "type": "object", + "description": "Router Queue Labels", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "labels" + ] + }, + "AcsRouterUpdatedWorkerProperty": { + "type": "string", + "description": "Worker properties that can be updated", + "enum": [ + "AvailableForOffers", + "TotalCapacity", + "QueueAssignments", + "Labels", + "Tags", + "ChannelConfigurations" + ], + "x-ms-enum": { + "name": "AcsRouterUpdatedWorkerProperty", + "modelAsString": true, + "values": [ + { + "name": "AvailableForOffers", + "value": "AvailableForOffers", + "description": "AvailableForOffers" + }, + { + "name": "TotalCapacity", + "value": "TotalCapacity", + "description": "TotalCapacity" + }, + { + "name": "QueueAssignments", + "value": "QueueAssignments", + "description": "QueueAssignments" + }, + { + "name": "Labels", + "value": "Labels", + "description": "Labels" + }, + { + "name": "Tags", + "value": "Tags", + "description": "Tags" + }, + { + "name": "ChannelConfigurations", + "value": "ChannelConfigurations", + "description": "ChannelConfigurations" + } + ] + } + }, + "AcsRouterWorkerDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerDeleted event", + "allOf": [ + { + "$ref": "#/definitions/AcsRouterWorkerEventData" + } + ] + }, + "AcsRouterWorkerDeregisteredEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerDeregistered event", + "properties": { + "workerId": { + "type": "string", + "description": "Router Worker Deregistered Worker Id" + } + } + }, + "AcsRouterWorkerEventData": { + "type": "object", + "description": "Schema of common properties of all Router Worker events", + "properties": { + "workerId": { + "type": "string", + "description": "Router Worker events Worker Id" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AcsRouterEventData" + } + ] + }, + "AcsRouterWorkerOfferAcceptedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferAccepted event", + "properties": { + "queueId": { + "type": "string", + "description": "Router Worker Offer Accepted Queue Id" + }, + "offerId": { + "type": "string", + "description": "Router Worker Offer Accepted Offer Id" + }, + "assignmentId": { + "type": "string", + "description": "Router Worker Offer Accepted Assignment Id" + }, + "jobPriority": { + "type": "integer", + "format": "int32", + "description": "Router Worker Offer Accepted Job Priority" + }, + "workerLabels": { + "type": "object", + "description": "Router Worker Offer Accepted Worker Labels", + "additionalProperties": { + "type": "string" + } + }, + "workerTags": { + "type": "object", + "description": "Router Worker Offer Accepted Worker Tags", + "additionalProperties": { + "type": "string" + } + }, + "jobLabels": { + "type": "object", + "description": "Router Worker Offer Accepted Job Labels", + "additionalProperties": { + "type": "string" + } + }, + "jobTags": { + "type": "object", + "description": "Router Worker Offer Accepted Job Tags", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "workerLabels", + "workerTags", + "jobLabels", + "jobTags" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsRouterWorkerEventData" + } + ] + }, + "AcsRouterWorkerOfferDeclinedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferDeclined event", + "properties": { + "queueId": { + "type": "string", + "description": "Router Worker Offer Declined Queue Id" + }, + "offerId": { + "type": "string", + "description": "Router Worker Offer Declined Offer Id" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AcsRouterWorkerEventData" + } + ] + }, + "AcsRouterWorkerOfferExpiredEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferExpired event", + "properties": { + "queueId": { + "type": "string", + "description": "Router Worker Offer Expired Queue Id" + }, + "offerId": { + "type": "string", + "description": "Router Worker Offer Expired Offer Id" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AcsRouterWorkerEventData" + } + ] + }, + "AcsRouterWorkerOfferIssuedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferIssued event", + "properties": { + "queueId": { + "type": "string", + "description": "Router Worker Offer Issued Queue Id" + }, + "offerId": { + "type": "string", + "description": "Router Worker Offer Issued Offer Id" + }, + "jobPriority": { + "type": "integer", + "format": "int32", + "description": "Router Worker Offer Issued Job Priority" + }, + "workerLabels": { + "type": "object", + "description": "Router Worker Offer Issued Worker Labels", + "additionalProperties": { + "type": "string" + } + }, + "offeredOn": { + "type": "string", + "format": "date-time", + "description": "Router Worker Offer Issued Time in UTC" + }, + "expiresOn": { + "type": "string", + "format": "date-time", + "description": "Router Worker Offer Issued Expiration Time in UTC" + }, + "workerTags": { + "type": "object", + "description": "Router Worker Offer Issued Worker Tags", + "additionalProperties": { + "type": "string" + } + }, + "jobLabels": { + "type": "object", + "description": "Router Worker Offer Issued Job Labels", + "additionalProperties": { + "type": "string" + } + }, + "jobTags": { + "type": "object", + "description": "Router Worker Offer Issued Job Tags", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "workerLabels", + "workerTags", + "jobLabels", + "jobTags" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsRouterWorkerEventData" + } + ] + }, + "AcsRouterWorkerOfferRevokedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferRevoked event", + "properties": { + "queueId": { + "type": "string", + "description": "Router Worker Offer Revoked Queue Id" + }, + "offerId": { + "type": "string", + "description": "Router Worker Offer Revoked Offer Id" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AcsRouterWorkerEventData" + } + ] + }, + "AcsRouterWorkerRegisteredEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerRegistered event", + "properties": { + "workerId": { + "type": "string", + "description": "Router Worker Registered Worker Id" + }, + "queueAssignments": { + "type": "array", + "description": "Router Worker Registered Queue Info", + "items": { + "$ref": "#/definitions/AcsRouterQueueDetails" + } + }, + "channelConfigurations": { + "type": "array", + "description": "Router Worker Registered Channel Configuration", + "items": { + "$ref": "#/definitions/AcsRouterChannelConfiguration" + }, + "x-ms-identifiers": [] + }, + "totalCapacity": { + "type": "integer", + "format": "int32", + "description": "Router Worker Register Total Capacity" + }, + "labels": { + "type": "object", + "description": "Router Worker Registered Labels", + "additionalProperties": { + "type": "string" + } + }, + "tags": { + "type": "object", + "description": "Router Worker Registered Tags", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "queueAssignments", + "channelConfigurations", + "labels", + "tags" + ] + }, + "AcsRouterWorkerSelector": { + "type": "object", + "description": "Router Job Worker Selector", + "properties": { + "key": { + "type": "string", + "description": "Router Job Worker Selector Key" + }, + "labelOperator": { + "$ref": "#/definitions/AcsRouterLabelOperator", + "description": "Router Job Worker Selector Label Operator" + }, + "value": { + "description": "Router Job Worker Selector Value", + "x-ms-client-name": "labelValue" + }, + "ttlSeconds": { + "type": "number", + "format": "double", + "description": "Router Job Worker Selector Time to Live in Seconds" + }, + "state": { + "$ref": "#/definitions/AcsRouterWorkerSelectorState", + "description": "Router Job Worker Selector State" + }, + "expirationTime": { + "type": "string", + "format": "date-time", + "description": "Router Job Worker Selector Expiration Time" + } + }, + "required": [ + "value", + "ttlSeconds" + ] + }, + "AcsRouterWorkerSelectorState": { + "type": "string", + "description": "Router Worker Selector State", + "enum": [ + "active", + "expired" + ], + "x-ms-enum": { + "name": "AcsRouterWorkerSelectorState", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "active", + "description": "Router Worker Selector State Active" + }, + { + "name": "Expired", + "value": "expired", + "description": "Router Worker Selector State Expired" + } + ] + } + }, + "AcsRouterWorkerUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerUpdated event.", + "properties": { + "workerId": { + "type": "string", + "description": "Router Worker Updated Worker Id" + }, + "queueAssignments": { + "type": "array", + "description": "Router Worker Updated Queue Info", + "items": { + "$ref": "#/definitions/AcsRouterQueueDetails" + } + }, + "channelConfigurations": { + "type": "array", + "description": "Router Worker Updated Channel Configuration", + "items": { + "$ref": "#/definitions/AcsRouterChannelConfiguration" + }, + "x-ms-identifiers": [] + }, + "totalCapacity": { + "type": "integer", + "format": "int32", + "description": "Router Worker Updated Total Capacity" + }, + "labels": { + "type": "object", + "description": "Router Worker Updated Labels", + "additionalProperties": { + "type": "string" + } + }, + "tags": { + "type": "object", + "description": "Router Worker Updated Tags", + "additionalProperties": { + "type": "string" + } + }, + "updatedWorkerProperties": { + "type": "array", + "description": "Router Worker Properties Updated", + "items": { + "$ref": "#/definitions/AcsRouterUpdatedWorkerProperty" + } + } + }, + "required": [ + "queueAssignments", + "channelConfigurations", + "labels", + "tags", + "updatedWorkerProperties" + ] + }, + "AcsSmsDeliveryAttemptProperties": { + "type": "object", + "description": "Schema for details of a delivery attempt", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "description": "TimeStamp when delivery was attempted" + }, + "segmentsSucceeded": { + "type": "integer", + "format": "int32", + "description": "Number of segments that were successfully delivered" + }, + "segmentsFailed": { + "type": "integer", + "format": "int32", + "description": "Number of segments whose delivery failed" + } + } + }, + "AcsSmsDeliveryReportReceivedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.SMSDeliveryReportReceived event.", + "properties": { + "deliveryStatus": { + "type": "string", + "description": "Status of Delivery" + }, + "deliveryStatusDetails": { + "type": "string", + "description": "Details about Delivery Status" + }, + "deliveryAttempts": { + "type": "array", + "description": "List of details of delivery attempts made", + "items": { + "$ref": "#/definitions/AcsSmsDeliveryAttemptProperties" + }, + "x-ms-identifiers": [] + }, + "receivedTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time at which the SMS delivery report was received" + }, + "tag": { + "type": "string", + "description": "Customer Content" + } + }, + "required": [ + "deliveryAttempts" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsSmsEventBaseProperties" + } + ] + }, + "AcsSmsEventBaseProperties": { + "type": "object", + "description": "Schema of common properties of all SMS events", + "properties": { + "messageId": { + "type": "string", + "description": "The identity of the SMS message" + }, + "from": { + "type": "string", + "description": "The identity of SMS message sender" + }, + "to": { + "type": "string", + "description": "The identity of SMS message receiver" + } + } + }, + "AcsSmsReceivedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.SMSReceived event.", + "properties": { + "message": { + "type": "string", + "description": "The SMS content" + }, + "receivedTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time at which the SMS was received" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AcsSmsEventBaseProperties" + } + ] + }, + "AcsUserDisconnectedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.UserDisconnected event.", + "properties": { + "userCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the user who was disconnected" + } + }, + "required": [ + "userCommunicationIdentifier" + ] + }, + "AcsUserEngagement": { + "type": "string", + "description": "The type of engagement user have with email.", + "enum": [ + "view", + "click" + ], + "x-ms-enum": { + "name": "AcsUserEngagement", + "modelAsString": true, + "values": [ + { + "name": "view", + "value": "view", + "description": "View" + }, + { + "name": "click", + "value": "click", + "description": "Click" + } + ] + } + }, + "ApiCenterApiDefinitionAddedEventData": { + "type": "object", + "description": "Schema of the data property of an EventGridEvent for a Microsoft.ApiCenter.ApiDefinitionAdded event.", + "properties": { + "title": { + "type": "string", + "description": "API definition title." + }, + "description": { + "type": "string", + "description": "API definition description." + }, + "specification": { + "$ref": "#/definitions/ApiCenterApiSpecification", + "description": "API definition specification." + } + }, + "required": [ + "specification" + ] + }, + "ApiCenterApiDefinitionUpdatedEventData": { + "type": "object", + "description": "Schema of the data property of an EventGridEvent for a Microsoft.ApiCenter.ApiDefinitionUpdated event.", + "properties": { + "title": { + "type": "string", + "description": "API definition title." + }, + "description": { + "type": "string", + "description": "API definition description." + }, + "specification": { + "$ref": "#/definitions/ApiCenterApiSpecification", + "description": "API definition specification." + } + }, + "required": [ + "specification" + ] + }, + "ApiCenterApiSpecification": { + "type": "object", + "description": "API specification details.", + "properties": { + "name": { + "type": "string", + "description": "Specification name." + }, + "version": { + "type": "string", + "description": "Specification version." + } + } + }, + "ApiManagementApiCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APICreated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" + } + } + }, + "ApiManagementApiDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIDeleted event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" + } + } + }, + "ApiManagementApiReleaseCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIReleaseCreated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" + } + } + }, + "ApiManagementApiReleaseDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIReleaseDeleted event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" + } + } + }, + "ApiManagementApiReleaseUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIReleaseUpdated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" + } + } + }, + "ApiManagementApiUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIUpdated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" + } + } + }, + "ApiManagementGatewayApiAddedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayAPIAdded event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways//apis/`" + } + } + }, + "ApiManagementGatewayApiRemovedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayAPIRemoved event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways//apis/`" + } + } + }, + "ApiManagementGatewayCertificateAuthorityCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayCertificateAuthorityCreated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways//certificateAuthorities/`" + } + } + }, + "ApiManagementGatewayCertificateAuthorityDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways//certificateAuthorities/`" + } + } + }, + "ApiManagementGatewayCertificateAuthorityUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayCertificateAuthorityUpdated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways//certificateAuthorities/`" + } + } + }, + "ApiManagementGatewayCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayCreated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways/`" + } + } + }, + "ApiManagementGatewayDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayDeleted event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways/`" + } + } + }, + "ApiManagementGatewayHostnameConfigurationCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayHostnameConfigurationCreated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways//hostnameConfigurations/`" + } + } + }, + "ApiManagementGatewayHostnameConfigurationDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways//hostnameConfigurations/`" + } + } + }, + "ApiManagementGatewayHostnameConfigurationUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways//hostnameConfigurations/`" + } + } + }, + "ApiManagementGatewayUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayUpdated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways/`" + } + } + }, + "ApiManagementProductCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.ProductCreated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" + } + } + }, + "ApiManagementProductDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.ProductDeleted event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" + } + } + }, + "ApiManagementProductUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.ProductUpdated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" + } + } + }, + "ApiManagementSubscriptionCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.SubscriptionCreated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" + } + } + }, + "ApiManagementSubscriptionDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.SubscriptionDeleted event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" + } + } + }, + "ApiManagementSubscriptionUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.SubscriptionUpdated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" + } + } + }, + "ApiManagementUserCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.UserCreated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" + } + } + }, + "ApiManagementUserDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.UserDeleted event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" + } + } + }, + "ApiManagementUserUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.UserUpdated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" + } + } + }, + "AppAction": { + "type": "string", + "description": "Type of action of the operation", + "enum": [ + "Restarted", + "Stopped", + "ChangedAppSettings", + "Started", + "Completed", + "Failed" + ], + "x-ms-enum": { + "name": "AppAction", + "modelAsString": true, + "values": [ + { + "name": "Restarted", + "value": "Restarted", + "description": "Web app was restarted." + }, + { + "name": "Stopped", + "value": "Stopped", + "description": "Web app was stopped." + }, + { + "name": "ChangedAppSettings", + "value": "ChangedAppSettings", + "description": "There was an operation to change app setting on the web app." + }, + { + "name": "Started", + "value": "Started", + "description": "The job has started." + }, + { + "name": "Completed", + "value": "Completed", + "description": "The job has completed." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The job has failed to complete." + } + ] + } + }, + "AppConfigurationKeyValueDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AppConfiguration.KeyValueDeleted event.", + "properties": { + "key": { + "type": "string", + "description": "The key used to identify the key-value that was deleted." + }, + "label": { + "type": "string", + "description": "The label, if any, used to identify the key-value that was deleted." + }, + "etag": { + "type": "string", + "description": "The etag representing the key-value that was deleted." + }, + "syncToken": { + "type": "string", + "description": "The sync token representing the server state after the event." + } + } + }, + "AppConfigurationKeyValueModifiedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AppConfiguration.KeyValueModified event.", + "properties": { + "key": { + "type": "string", + "description": "The key used to identify the key-value that was modified." + }, + "label": { + "type": "string", + "description": "The label, if any, used to identify the key-value that was modified." + }, + "etag": { + "type": "string", + "description": "The etag representing the new state of the key-value." + }, + "syncToken": { + "type": "string", + "description": "The sync token representing the server state after the event." + } + } + }, + "AppConfigurationSnapshotCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AppConfiguration.SnapshotCreated event.", + "allOf": [ + { + "$ref": "#/definitions/AppConfigurationSnapshotEventData" + } + ] + }, + "AppConfigurationSnapshotEventData": { + "type": "object", + "description": "Schema of common properties of snapshot events", + "properties": { + "name": { + "type": "string", + "description": "The name of the snapshot." + }, + "etag": { + "type": "string", + "description": "The etag representing the new state of the snapshot." + }, + "syncToken": { + "type": "string", + "description": "The sync token representing the server state after the event." + } + } + }, + "AppConfigurationSnapshotModifiedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AppConfiguration.SnapshotModified event.", + "allOf": [ + { + "$ref": "#/definitions/AppConfigurationSnapshotEventData" + } + ] + }, + "AppEventTypeDetail": { + "type": "object", + "description": "Detail of action on the app.", + "properties": { + "action": { + "$ref": "#/definitions/AppAction", + "description": "Type of action of the operation." + } + } + }, + "AppServicePlanAction": { + "type": "string", + "description": "Type of action on the app service plan.", + "enum": [ + "Updated" + ], + "x-ms-enum": { + "name": "AppServicePlanAction", + "modelAsString": true, + "values": [ + { + "name": "Updated", + "value": "Updated", + "description": "App Service plan is being updated." + } + ] + } + }, + "AppServicePlanEventTypeDetail": { + "type": "object", + "description": "Detail of action on the app service plan.", + "properties": { + "stampKind": { + "$ref": "#/definitions/StampKind", + "description": "Kind of environment where app service plan is." + }, + "action": { + "$ref": "#/definitions/AppServicePlanAction", + "description": "Type of action on the app service plan." + }, + "status": { + "$ref": "#/definitions/AsyncStatus", + "description": "Asynchronous operation status of the operation on the app service plan." + } + } + }, + "AsyncStatus": { + "type": "string", + "description": "Asynchronous operation status of the operation on the app service plan.", + "enum": [ + "Started", + "Completed", + "Failed" + ], + "x-ms-enum": { + "name": "AsyncStatus", + "modelAsString": true, + "values": [ + { + "name": "Started", + "value": "Started", + "description": "Async operation has started." + }, + { + "name": "Completed", + "value": "Completed", + "description": "Async operation has completed." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Async operation failed to complete." + } + ] + } + }, + "AvsClusterCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterCreated event.", + "allOf": [ + { + "$ref": "#/definitions/AvsClusterEventData" + } + ] + }, + "AvsClusterDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterDeleted event.", + "allOf": [ + { + "$ref": "#/definitions/AvsClusterEventData" + } + ] + }, + "AvsClusterEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for Microsoft.AVS/clusters events.", + "properties": { + "operationId": { + "type": "string", + "description": "Id of the operation that caused this event." + }, + "addedHostNames": { + "type": "array", + "description": "Hosts added to the cluster in this event, if any.", + "items": { + "type": "string" + } + }, + "removedHostNames": { + "type": "array", + "description": "Hosts removed from the cluster in this event, if any.", + "items": { + "type": "string" + } + }, + "inMaintenanceHostNames": { + "type": "array", + "description": "Hosts in Maintenance mode in the cluster, if any.", + "items": { + "type": "string" + } + } + } + }, + "AvsClusterFailedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterFailed event.", + "properties": { + "failureMessage": { + "type": "string", + "description": "Failure reason of an event." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AvsClusterEventData" + } + ] + }, + "AvsClusterUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterUpdated event.", + "allOf": [ + { + "$ref": "#/definitions/AvsClusterEventData" + } + ] + }, + "AvsClusterUpdatingEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterUpdating event.", + "allOf": [ + { + "$ref": "#/definitions/AvsClusterEventData" + } + ] + }, + "AvsPrivateCloudEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for Microsoft.AVS/privateClouds events.", + "properties": { + "operationId": { + "type": "string", + "description": "Id of the operation that caused this event." + } + } + }, + "AvsPrivateCloudFailedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.PrivateCloudFailed event.", + "properties": { + "failureMessage": { + "type": "string", + "description": "Failure reason of an event." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AvsPrivateCloudEventData" + } + ] + }, + "AvsPrivateCloudUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.PrivateCloudUpdated event.", + "allOf": [ + { + "$ref": "#/definitions/AvsPrivateCloudEventData" + } + ] + }, + "AvsPrivateCloudUpdatingEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.PrivateCloudUpdating event.", + "allOf": [ + { + "$ref": "#/definitions/AvsPrivateCloudEventData" + } + ] + }, + "AvsScriptExecutionCancelledEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionCancelled event.", + "allOf": [ + { + "$ref": "#/definitions/AvsScriptExecutionEventData" + } + ] + }, + "AvsScriptExecutionEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for Microsoft.AVS/scriptExecutions events.", + "properties": { + "operationId": { + "type": "string", + "description": "Id of the operation that caused this event." + }, + "cmdletId": { + "type": "string", + "description": "Cmdlet referenced in the execution that caused this event." + }, + "output": { + "type": "array", + "description": "Stdout outputs from the execution, if any.", + "items": { + "type": "string" + } + } + } + }, + "AvsScriptExecutionFailedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionFailed event.", + "properties": { + "failureMessage": { + "type": "string", + "description": "Failure reason of an event." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AvsScriptExecutionEventData" + } + ] + }, + "AvsScriptExecutionFinishedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionFinished event.", + "properties": { + "namedOutputs": { + "type": "object", + "description": "Named outputs of completed execution, if any.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "namedOutputs" + ], + "allOf": [ + { + "$ref": "#/definitions/AvsScriptExecutionEventData" + } + ] + }, + "AvsScriptExecutionStartedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionStarted event.", + "allOf": [ + { + "$ref": "#/definitions/AvsScriptExecutionEventData" + } + ] + }, + "CommunicationCloudEnvironmentModel": { + "type": "string", + "description": "Communication cloud environment model.", + "enum": [ + "public", + "dod", + "gcch" + ], + "x-ms-enum": { + "name": "CommunicationCloudEnvironmentModel", + "modelAsString": true, + "values": [ + { + "name": "public", + "value": "public", + "description": "Public" + }, + { + "name": "dod", + "value": "dod", + "description": "Dod" + }, + { + "name": "gcch", + "value": "gcch", + "description": "Gcch" + } + ] + } + }, + "CommunicationIdentifierModel": { + "type": "object", + "description": "Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model must be interpreted as a union: Apart from rawId, at most one further property may be set.", + "properties": { + "kind": { + "$ref": "#/definitions/CommunicationIdentifierModelKind", + "description": "The identifier kind. Only required in responses." + }, + "rawId": { + "type": "string", + "description": "Raw Id of the identifier. Optional in requests, required in responses." + }, + "communicationUser": { + "$ref": "#/definitions/CommunicationUserIdentifierModel", + "description": "The communication user." + }, + "phoneNumber": { + "$ref": "#/definitions/PhoneNumberIdentifierModel", + "description": "The phone number." + }, + "microsoftTeamsUser": { + "$ref": "#/definitions/MicrosoftTeamsUserIdentifierModel", + "description": "The Microsoft Teams user." + }, + "microsoftTeamsApp": { + "$ref": "#/definitions/MicrosoftTeamsAppIdentifierModel", + "description": "The Microsoft Teams application." + } + }, + "required": [ + "communicationUser", + "phoneNumber", + "microsoftTeamsUser", + "microsoftTeamsApp" + ] + }, + "CommunicationIdentifierModelKind": { + "type": "string", + "description": "Communication model identifier kind", + "enum": [ + "unknown", + "communicationUser", + "phoneNumber", + "microsoftTeamsUser" + ], + "x-ms-enum": { + "name": "CommunicationIdentifierModelKind", + "modelAsString": true, + "values": [ + { + "name": "unknown", + "value": "unknown", + "description": "Unknown" + }, + { + "name": "communicationUser", + "value": "communicationUser", + "description": "Communication User" + }, + { + "name": "phoneNumber", + "value": "phoneNumber", + "description": "Phone Number" + }, + { + "name": "microsoftTeamsUser", + "value": "microsoftTeamsUser", + "description": "Microsoft Teams User" + } + ] + } + }, + "CommunicationUserIdentifierModel": { + "type": "object", + "description": "A user that got created with an Azure Communication Services resource.", + "properties": { + "id": { + "type": "string", + "description": "The Id of the communication user." + } + }, + "required": [ + "id" + ] + }, + "ContainerRegistryArtifactEventData": { + "type": "object", + "description": "The content of the event request message.", + "properties": { + "id": { + "type": "string", + "description": "The event ID." + }, + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The time at which the event occurred." + }, + "action": { + "type": "string", + "description": "The action that encompasses the provided event." + }, + "location": { + "type": "string", + "description": "The location of the event." + }, + "target": { + "$ref": "#/definitions/ContainerRegistryArtifactEventTarget", + "description": "The target of the event." + }, + "connectedRegistry": { + "$ref": "#/definitions/ContainerRegistryEventConnectedRegistry", + "description": "The connected registry information if the event is generated by a connected registry." + } + }, + "required": [ + "target", + "connectedRegistry" + ] + }, + "ContainerRegistryArtifactEventTarget": { + "type": "object", + "description": "The target of the event.", + "properties": { + "mediaType": { + "type": "string", + "description": "The MIME type of the artifact." + }, + "size": { + "type": "integer", + "format": "int64", + "description": "The size in bytes of the artifact." + }, + "digest": { + "type": "string", + "description": "The digest of the artifact." + }, + "repository": { + "type": "string", + "description": "The repository name of the artifact." + }, + "tag": { + "type": "string", + "description": "The tag of the artifact." + }, + "name": { + "type": "string", + "description": "The name of the artifact." + }, + "version": { + "type": "string", + "description": "The version of the artifact." + } + } + }, + "ContainerRegistryChartDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ChartDeleted event.", + "allOf": [ + { + "$ref": "#/definitions/ContainerRegistryArtifactEventData" + } + ] + }, + "ContainerRegistryChartPushedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ChartPushed event.", + "allOf": [ + { + "$ref": "#/definitions/ContainerRegistryArtifactEventData" + } + ] + }, + "ContainerRegistryEventActor": { + "type": "object", + "description": "The agent that initiated the event. For most situations, this could be from the authorization context of the request.", + "properties": { + "name": { + "type": "string", + "description": "The subject or username associated with the request context that generated the event." + } + } + }, + "ContainerRegistryEventConnectedRegistry": { + "type": "object", + "description": "The connected registry information if the event is generated by a connected registry.", + "properties": { + "name": { + "type": "string", + "description": "The name of the connected registry that generated this event." + } + } + }, + "ContainerRegistryEventData": { + "type": "object", + "description": "The content of the event request message.", + "properties": { + "id": { + "type": "string", + "description": "The event ID." + }, + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The time at which the event occurred." + }, + "action": { + "type": "string", + "description": "The action that encompasses the provided event." + }, + "location": { + "type": "string", + "description": "The location of the event." + }, + "target": { + "$ref": "#/definitions/ContainerRegistryEventTarget", + "description": "The target of the event." + }, + "request": { + "$ref": "#/definitions/ContainerRegistryEventRequest", + "description": "The request that generated the event." + }, + "actor": { + "$ref": "#/definitions/ContainerRegistryEventActor", + "description": "The agent that initiated the event. For most situations, this could be from the authorization context of the request." + }, + "source": { + "$ref": "#/definitions/ContainerRegistryEventSource", + "description": "The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it." + }, + "connectedRegistry": { + "$ref": "#/definitions/ContainerRegistryEventConnectedRegistry", + "description": "The connected registry information if the event is generated by a connected registry." + } + }, + "required": [ + "target", + "request", + "actor", + "source", + "connectedRegistry" + ] + }, + "ContainerRegistryEventRequest": { + "type": "object", + "description": "The request that generated the event.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the request that initiated the event." + }, + "addr": { + "type": "string", + "description": "The IP or hostname and possibly port of the client connection that initiated the event. This is the RemoteAddr from the standard http request." + }, + "host": { + "type": "string", + "description": "The externally accessible hostname of the registry instance, as specified by the http host header on incoming requests." + }, + "method": { + "type": "string", + "description": "The request method that generated the event." + }, + "useragent": { + "type": "string", + "description": "The user agent header of the request." + } + } + }, + "ContainerRegistryEventSource": { + "type": "object", + "description": "The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.", + "properties": { + "addr": { + "type": "string", + "description": "The IP or hostname and the port of the registry node that generated the event. Generally, this will be resolved by os.Hostname() along with the running port." + }, + "instanceID": { + "type": "string", + "description": "The running instance of an application. Changes after each restart." + } + } + }, + "ContainerRegistryEventTarget": { + "type": "object", + "description": "The target of the event.", + "properties": { + "mediaType": { + "type": "string", + "description": "The MIME type of the referenced object." + }, + "size": { + "type": "integer", + "format": "int64", + "description": "The number of bytes of the content. Same as Length field." + }, + "digest": { + "type": "string", + "description": "The digest of the content, as defined by the Registry V2 HTTP API Specification." + }, + "length": { + "type": "integer", + "format": "int64", + "description": "The number of bytes of the content. Same as Size field." + }, + "repository": { + "type": "string", + "description": "The repository name." + }, + "url": { + "type": "string", + "description": "The direct URL to the content." + }, + "tag": { + "type": "string", + "description": "The tag name." + } + } + }, + "ContainerRegistryImageDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ImageDeleted event.", + "allOf": [ + { + "$ref": "#/definitions/ContainerRegistryEventData" + } + ] + }, + "ContainerRegistryImagePushedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ImagePushed event.", + "allOf": [ + { + "$ref": "#/definitions/ContainerRegistryEventData" + } + ] + }, + "ContainerServiceClusterSupportEndedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.ClusterSupportEnded event", + "allOf": [ + { + "$ref": "#/definitions/ContainerServiceClusterSupportEventData" + } + ] + }, + "ContainerServiceClusterSupportEndingEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.ClusterSupportEnding event", + "allOf": [ + { + "$ref": "#/definitions/ContainerServiceClusterSupportEventData" + } + ] + }, + "ContainerServiceClusterSupportEventData": { + "type": "object", + "description": "Schema of common properties of cluster support events", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version of the ManagedCluster resource" + } + } + }, + "ContainerServiceNewKubernetesVersionAvailableEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.NewKubernetesVersionAvailable event", + "properties": { + "latestSupportedKubernetesVersion": { + "type": "string", + "description": "The highest PATCH Kubernetes version for the highest MINOR version supported by ManagedCluster resource" + }, + "latestStableKubernetesVersion": { + "type": "string", + "description": "The highest PATCH Kubernetes version for the MINOR version considered stable for the ManagedCluster resource" + }, + "lowestMinorKubernetesVersion": { + "type": "string", + "description": "The highest PATCH Kubernetes version for the lowest applicable MINOR version available for the ManagedCluster resource" + }, + "latestPreviewKubernetesVersion": { + "type": "string", + "description": "The highest PATCH Kubernetes version considered preview for the ManagedCluster resource. There might not be any version in preview at the time of publishing the event" + } + } + }, + "ContainerServiceNodePoolRollingEventData": { + "type": "object", + "description": "Schema of common properties of node pool rolling events", + "properties": { + "nodePoolName": { + "type": "string", + "description": "The name of the node pool in the ManagedCluster resource" + } + } + }, + "ContainerServiceNodePoolRollingFailedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.NodePoolRollingFailed event", + "allOf": [ + { + "$ref": "#/definitions/ContainerServiceNodePoolRollingEventData" + } + ] + }, + "ContainerServiceNodePoolRollingStartedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.NodePoolRollingStarted event", + "allOf": [ + { + "$ref": "#/definitions/ContainerServiceNodePoolRollingEventData" + } + ] + }, + "ContainerServiceNodePoolRollingSucceededEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.NodePoolRollingSucceeded event", + "allOf": [ + { + "$ref": "#/definitions/ContainerServiceNodePoolRollingEventData" + } + ] + }, + "DataBoxCopyCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.DataBox.CopyCompleted event.", + "properties": { + "serialNumber": { + "type": "string", + "description": "Serial Number of the device associated with the event. The list is comma separated if more than one serial number is associated." + }, + "stageName": { + "$ref": "#/definitions/DataBoxStageName", + "description": "Name of the current Stage" + }, + "stageTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the stage happened." + } + } + }, + "DataBoxCopyStartedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.DataBox.CopyStarted event.", + "properties": { + "serialNumber": { + "type": "string", + "description": "Serial Number of the device associated with the event. The list is comma separated if more than one serial number is associated." + }, + "stageName": { + "$ref": "#/definitions/DataBoxStageName", + "description": "Name of the current Stage" + }, + "stageTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the stage happened." + } + } + }, + "DataBoxOrderCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.DataBox.OrderCompleted event.", + "properties": { + "serialNumber": { + "type": "string", + "description": "Serial Number of the device associated with the event. The list is comma separated if more than one serial number is associated." + }, + "stageName": { + "$ref": "#/definitions/DataBoxStageName", + "description": "Name of the current Stage" + }, + "stageTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the stage happened." + } + } + }, + "DataBoxStageName": { + "type": "string", + "description": "Schema of DataBox Stage Name enumeration.", + "enum": [ + "CopyStarted", + "CopyCompleted", + "OrderCompleted" + ], + "x-ms-enum": { + "name": "DataBoxStageName", + "modelAsString": true, + "values": [ + { + "name": "CopyStarted", + "value": "CopyStarted", + "description": "Copy has started" + }, + { + "name": "CopyCompleted", + "value": "CopyCompleted", + "description": "Copy has completed" + }, + { + "name": "OrderCompleted", + "value": "OrderCompleted", + "description": "Order has been completed" + } + ] + } + }, + "DeviceConnectionStateEventInfo": { + "type": "object", + "description": "Information about the device connection state event.", + "properties": { + "sequenceNumber": { + "type": "string", + "description": "Sequence number is string representation of a hexadecimal number. string compare can be used to identify the larger number because both in ASCII and HEX numbers come after alphabets. If you are converting the string to hex, then the number is a 256 bit number." + } + } + }, + "DeviceConnectionStateEventProperties": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a device connection state event (DeviceConnected, DeviceDisconnected).", + "properties": { + "deviceId": { + "type": "string", + "description": "The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = `@` ; $ '." + }, + "moduleId": { + "type": "string", + "description": "The unique identifier of the module. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = `@` ; $ '." + }, + "hubName": { + "type": "string", + "description": "Name of the IoT Hub where the device was created or deleted." + }, + "deviceConnectionStateEventInfo": { + "$ref": "#/definitions/DeviceConnectionStateEventInfo", + "description": "Information about the device connection state event." + } + }, + "required": [ + "deviceConnectionStateEventInfo" + ] + }, + "DeviceLifeCycleEventProperties": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a device life cycle event (DeviceCreated, DeviceDeleted).", + "properties": { + "deviceId": { + "type": "string", + "description": "The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = `@` ; $ '." + }, + "hubName": { + "type": "string", + "description": "Name of the IoT Hub where the device was created or deleted." + }, + "twin": { + "$ref": "#/definitions/DeviceTwinInfo", + "description": "Information about the device twin, which is the cloud representation of application device metadata." + } + }, + "required": [ + "twin" + ] + }, + "DeviceTelemetryEventProperties": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a device telemetry event (DeviceTelemetry).", + "properties": { + "body": { + "type": "object", + "description": "The content of the message from the device.", + "additionalProperties": {} + }, + "properties": { + "type": "object", + "description": "Application properties are user-defined strings that can be added to the message. These fields are optional.", + "additionalProperties": { + "type": "string" + } + }, + "systemProperties": { + "type": "object", + "description": "System properties help identify contents and source of the messages.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "body", + "properties", + "systemProperties" + ] + }, + "DeviceTwinInfo": { + "type": "object", + "description": "Information about the device twin, which is the cloud representation of application device metadata.", + "properties": { + "authenticationType": { + "type": "string", + "description": "Authentication type used for this device: either SAS, SelfSigned, or CertificateAuthority." + }, + "cloudToDeviceMessageCount": { + "type": "number", + "format": "float", + "description": "Count of cloud to device messages sent to this device." + }, + "connectionState": { + "type": "string", + "description": "Whether the device is connected or disconnected." + }, + "deviceId": { + "type": "string", + "description": "The unique identifier of the device twin." + }, + "etag": { + "type": "string", + "description": "A piece of information that describes the content of the device twin. Each etag is guaranteed to be unique per device twin." + }, + "lastActivityTime": { + "type": "string", + "description": "The ISO8601 timestamp of the last activity." + }, + "properties": { + "$ref": "#/definitions/DeviceTwinInfoProperties", + "description": "Properties JSON element." + }, + "status": { + "type": "string", + "description": "Whether the device twin is enabled or disabled." + }, + "statusUpdateTime": { + "type": "string", + "description": "The ISO8601 timestamp of the last device twin status update." + }, + "version": { + "type": "number", + "format": "float", + "description": "An integer that is incremented by one each time the device twin is updated." + }, + "x509Thumbprint": { + "$ref": "#/definitions/DeviceTwinInfoX509Thumbprint", + "description": "The thumbprint is a unique value for the x509 certificate, commonly used to find a particular certificate in a certificate store. The thumbprint is dynamically generated using the SHA1 algorithm, and does not physically exist in the certificate." + } + }, + "required": [ + "properties", + "x509Thumbprint" + ] + }, + "DeviceTwinInfoProperties": { + "type": "object", + "description": "Properties JSON element.", + "properties": { + "desired": { + "$ref": "#/definitions/DeviceTwinProperties", + "description": "A portion of the properties that can be written only by the application back-end, and read by the device." + }, + "reported": { + "$ref": "#/definitions/DeviceTwinProperties", + "description": "A portion of the properties that can be written only by the device, and read by the application back-end." + } + }, + "required": [ + "desired", + "reported" + ] + }, + "DeviceTwinInfoX509Thumbprint": { + "type": "object", + "description": "The thumbprint is a unique value for the x509 certificate, commonly used to find a particular certificate in a certificate store. The thumbprint is dynamically generated using the SHA1 algorithm, and does not physically exist in the certificate.", + "properties": { + "primaryThumbprint": { + "type": "string", + "description": "Primary thumbprint for the x509 certificate." + }, + "secondaryThumbprint": { + "type": "string", + "description": "Secondary thumbprint for the x509 certificate." + } + } + }, + "DeviceTwinMetadata": { + "type": "object", + "description": "Metadata information for the properties JSON document.", + "properties": { + "lastUpdated": { + "type": "string", + "description": "The ISO8601 timestamp of the last time the properties were updated.", + "x-ms-client-name": "$lastUpdated" + } + } + }, + "DeviceTwinProperties": { + "type": "object", + "description": "A portion of the properties that can be written only by the application back-end, and read by the device.", + "properties": { + "metadata": { + "$ref": "#/definitions/DeviceTwinMetadata", + "description": "Metadata information for the properties JSON document.", + "x-ms-client-name": "$metadata" + }, + "version": { + "type": "number", + "format": "float", + "description": "Version of device twin properties.", + "x-ms-client-name": "$version" + } + }, + "required": [ + "metadata" + ] + }, + "EventGridMQTTClientCreatedOrUpdatedEventData": { + "type": "object", + "description": "Event data for Microsoft.EventGrid.MQTTClientCreatedOrUpdated event.", + "properties": { + "state": { + "$ref": "#/definitions/EventGridMQTTClientState", + "description": "Configured state of the client. The value could be Enabled or Disabled" + }, + "createdOn": { + "type": "string", + "format": "date-time", + "description": "Time the client resource is created based on the provider's UTC time." + }, + "updatedOn": { + "type": "string", + "format": "date-time", + "description": "Time the client resource is last updated based on the provider's UTC time. If\nthe client resource was never updated, this value is identical to the value of\nthe 'createdOn' property." + }, + "attributes": { + "type": "object", + "description": "The key-value attributes that are assigned to the client resource.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "attributes" + ], + "allOf": [ + { + "$ref": "#/definitions/EventGridMQTTClientEventData" + } + ] + }, + "EventGridMQTTClientDeletedEventData": { + "type": "object", + "description": "Event data for Microsoft.EventGrid.MQTTClientDeleted event.", + "allOf": [ + { + "$ref": "#/definitions/EventGridMQTTClientEventData" + } + ] + }, + "EventGridMQTTClientDisconnectionReason": { + "type": "string", + "description": "EventGrid MQTT Client Disconnection Reason", + "enum": [ + "ClientAuthenticationError", + "ClientAuthorizationError", + "ClientError", + "ClientInitiatedDisconnect", + "ConnectionLost", + "IpForbidden", + "QuotaExceeded", + "ServerError", + "ServerInitiatedDisconnect", + "SessionOverflow", + "SessionTakenOver" + ], + "x-ms-enum": { + "name": "EventGridMQTTClientDisconnectionReason", + "modelAsString": true, + "values": [ + { + "name": "ClientAuthenticationError", + "value": "ClientAuthenticationError", + "description": "The client got disconnected for any authentication reasons (for example, certificate expired, client got disabled, or client configuration changed)." + }, + { + "name": "ClientAuthorizationError", + "value": "ClientAuthorizationError", + "description": "The client got disconnected for any authorization reasons (for example, because of a change in the configuration of topic spaces, permission bindings, or client groups)." + }, + { + "name": "ClientError", + "value": "ClientError", + "description": "The client sent a bad request or used one of the unsupported features that resulted in a connection termination by the service." + }, + { + "name": "ClientInitiatedDisconnect", + "value": "ClientInitiatedDisconnect", + "description": "The client initiated a graceful disconnect through a DISCONNECT packet for MQTT or a close frame for MQTT over WebSocket." + }, + { + "name": "ConnectionLost", + "value": "ConnectionLost", + "description": "The client-server connection is lost. (EXCHANGE ONLINE PROTECTION)." + }, + { + "name": "IpForbidden", + "value": "IpForbidden", + "description": "The client's IP address is blocked by IP filter or Private links configuration." + }, + { + "name": "QuotaExceeded", + "value": "QuotaExceeded", + "description": "The client exceeded one or more of the throttling limits that resulted in a connection termination by the service." + }, + { + "name": "ServerError", + "value": "ServerError", + "description": "The connection got terminated due to an unexpected server error." + }, + { + "name": "ServerInitiatedDisconnect", + "value": "ServerInitiatedDisconnect", + "description": "The server initiates a graceful disconnect for any operational reason." + }, + { + "name": "SessionOverflow", + "value": "SessionOverflow", + "description": "The client's queue for unacknowledged QoS1 messages reached its limit, which resulted in a connection termination by the server." + }, + { + "name": "SessionTakenOver", + "value": "SessionTakenOver", + "description": "The client reconnected with the same authentication name, which resulted in the termination of the previous connection." + } + ] + } + }, + "EventGridMQTTClientEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for MQTT Client state changes.", + "properties": { + "clientAuthenticationName": { + "type": "string", + "description": "Unique identifier for the MQTT client that the client presents to the service\nfor authentication. This case-sensitive string can be up to 128 characters\nlong, and supports UTF-8 characters." + }, + "clientName": { + "type": "string", + "description": "Name of the client resource in the Event Grid namespace." + }, + "namespaceName": { + "type": "string", + "description": "Name of the Event Grid namespace where the MQTT client was created or updated." + } + } + }, + "EventGridMQTTClientSessionConnectedEventData": { + "type": "object", + "description": "Event data for Microsoft.EventGrid.MQTTClientSessionConnected event.", + "properties": { + "clientSessionName": { + "type": "string", + "description": "Unique identifier for the MQTT client's session. This case-sensitive string can\nbe up to 128 characters long, and supports UTF-8 characters." + }, + "sequenceNumber": { + "type": "integer", + "format": "int64", + "description": "A number that helps indicate order of MQTT client session connected or\ndisconnected events. Latest event will have a sequence number that is higher\nthan the previous event." + } + }, + "allOf": [ + { + "$ref": "#/definitions/EventGridMQTTClientEventData" + } + ] + }, + "EventGridMQTTClientSessionDisconnectedEventData": { + "type": "object", + "description": "Event data for Microsoft.EventGrid.MQTTClientSessionDisconnected event.", + "properties": { + "clientSessionName": { + "type": "string", + "description": "Unique identifier for the MQTT client's session. This case-sensitive string can\nbe up to 128 characters long, and supports UTF-8 characters." + }, + "sequenceNumber": { + "type": "integer", + "format": "int64", + "description": "A number that helps indicate order of MQTT client session connected or\ndisconnected events. Latest event will have a sequence number that is higher\nthan the previous event." + }, + "disconnectionReason": { + "$ref": "#/definitions/EventGridMQTTClientDisconnectionReason", + "description": "Reason for the disconnection of the MQTT client's session. The value could be\none of the values in the disconnection reasons table." + } + }, + "allOf": [ + { + "$ref": "#/definitions/EventGridMQTTClientEventData" + } + ] + }, + "EventGridMQTTClientState": { + "type": "string", + "description": "EventGrid MQTT Client State", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EventGridMQTTClientState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled" + } + ] + } + }, + "EventHubCaptureFileCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.EventHub.CaptureFileCreated event.", + "properties": { + "fileUrl": { + "type": "string", + "description": "The path to the capture file.", + "x-ms-client-name": "fileurl" + }, + "fileType": { + "type": "string", + "description": "The file type of the capture file." + }, + "partitionId": { + "type": "string", + "description": "The shard ID." + }, + "sizeInBytes": { + "type": "integer", + "format": "int32", + "description": "The file size." + }, + "eventCount": { + "type": "integer", + "format": "int32", + "description": "The number of events in the file." + }, + "firstSequenceNumber": { + "type": "integer", + "format": "int32", + "description": "The smallest sequence number from the queue." + }, + "lastSequenceNumber": { + "type": "integer", + "format": "int32", + "description": "The last sequence number from the queue." + }, + "firstEnqueueTime": { + "type": "string", + "format": "date-time", + "description": "The first time from the queue." + }, + "lastEnqueueTime": { + "type": "string", + "format": "date-time", + "description": "The last time from the queue." + } + } + }, + "HealthcareDicomImageCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.DicomImageCreated event.", + "properties": { + "partitionName": { + "type": "string", + "description": "Data partition name" + }, + "imageStudyInstanceUid": { + "type": "string", + "description": "Unique identifier for the Study" + }, + "imageSeriesInstanceUid": { + "type": "string", + "description": "Unique identifier for the Series" + }, + "imageSopInstanceUid": { + "type": "string", + "description": "Unique identifier for the DICOM Image" + }, + "serviceHostName": { + "type": "string", + "description": "Domain name of the DICOM account for this image." + }, + "sequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of the DICOM Service within Azure Health Data Services. It is unique for every image creation and deletion within the service." + } + } + }, + "HealthcareDicomImageDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.DicomImageDeleted event.", + "properties": { + "partitionName": { + "type": "string", + "description": "Data partition name" + }, + "imageStudyInstanceUid": { + "type": "string", + "description": "Unique identifier for the Study" + }, + "imageSeriesInstanceUid": { + "type": "string", + "description": "Unique identifier for the Series" + }, + "imageSopInstanceUid": { + "type": "string", + "description": "Unique identifier for the DICOM Image" + }, + "serviceHostName": { + "type": "string", + "description": "Host name of the DICOM account for this image." + }, + "sequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of the DICOM Service within Azure Health Data Services. It is unique for every image creation and deletion within the service." + } + } + }, + "HealthcareDicomImageUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.DicomImageUpdated event.", + "properties": { + "partitionName": { + "type": "string", + "description": "Data partition name" + }, + "imageStudyInstanceUid": { + "type": "string", + "description": "Unique identifier for the Study" + }, + "imageSeriesInstanceUid": { + "type": "string", + "description": "Unique identifier for the Series" + }, + "imageSopInstanceUid": { + "type": "string", + "description": "Unique identifier for the DICOM Image" + }, + "serviceHostName": { + "type": "string", + "description": "Domain name of the DICOM account for this image." + }, + "sequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of the DICOM Service within Azure Health Data Services. It is unique for every image creation, updation and deletion within the service." + } + } + }, + "HealthcareFhirResourceCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.FhirResourceCreated event.", + "properties": { + "resourceType": { + "$ref": "#/definitions/HealthcareFhirResourceType", + "description": "Type of HL7 FHIR resource.", + "x-ms-client-name": "FhirResourceType" + }, + "resourceFhirAccount": { + "type": "string", + "description": "Domain name of FHIR account for this resource.", + "x-ms-client-name": "FhirServiceHostName" + }, + "resourceFhirId": { + "type": "string", + "description": "Id of HL7 FHIR resource.", + "x-ms-client-name": "FhirResourceId" + }, + "resourceVersionId": { + "type": "integer", + "format": "int64", + "description": "VersionId of HL7 FHIR resource. It changes when the resource is created, updated, or deleted(soft-deletion).", + "x-ms-client-name": "FhirResourceVersionId" + } + } + }, + "HealthcareFhirResourceDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.FhirResourceDeleted event.", + "properties": { + "resourceType": { + "$ref": "#/definitions/HealthcareFhirResourceType", + "description": "Type of HL7 FHIR resource.", + "x-ms-client-name": "FhirResourceType" + }, + "resourceFhirAccount": { + "type": "string", + "description": "Domain name of FHIR account for this resource.", + "x-ms-client-name": "FhirServiceHostName" + }, + "resourceFhirId": { + "type": "string", + "description": "Id of HL7 FHIR resource.", + "x-ms-client-name": "FhirResourceId" + }, + "resourceVersionId": { + "type": "integer", + "format": "int64", + "description": "VersionId of HL7 FHIR resource. It changes when the resource is created, updated, or deleted(soft-deletion).", + "x-ms-client-name": "FhirResourceVersionId" + } + } + }, + "HealthcareFhirResourceType": { + "type": "string", + "description": "Schema of FHIR resource type enumeration.", + "enum": [ + "Account", + "ActivityDefinition", + "AdverseEvent", + "AllergyIntolerance", + "Appointment", + "AppointmentResponse", + "AuditEvent", + "Basic", + "Binary", + "BiologicallyDerivedProduct", + "BodySite", + "BodyStructure", + "Bundle", + "CapabilityStatement", + "CarePlan", + "CareTeam", + "CatalogEntry", + "ChargeItem", + "ChargeItemDefinition", + "Claim", + "ClaimResponse", + "ClinicalImpression", + "CodeSystem", + "Communication", + "CommunicationRequest", + "CompartmentDefinition", + "Composition", + "ConceptMap", + "Condition", + "Consent", + "Contract", + "Coverage", + "CoverageEligibilityRequest", + "CoverageEligibilityResponse", + "DataElement", + "DetectedIssue", + "Device", + "DeviceComponent", + "DeviceDefinition", + "DeviceMetric", + "DeviceRequest", + "DeviceUseStatement", + "DiagnosticReport", + "DocumentManifest", + "DocumentReference", + "DomainResource", + "EffectEvidenceSynthesis", + "EligibilityRequest", + "EligibilityResponse", + "Encounter", + "Endpoint", + "EnrollmentRequest", + "EnrollmentResponse", + "EpisodeOfCare", + "EventDefinition", + "Evidence", + "EvidenceVariable", + "ExampleScenario", + "ExpansionProfile", + "ExplanationOfBenefit", + "FamilyMemberHistory", + "Flag", + "Goal", + "GraphDefinition", + "Group", + "GuidanceResponse", + "HealthcareService", + "ImagingManifest", + "ImagingStudy", + "Immunization", + "ImmunizationEvaluation", + "ImmunizationRecommendation", + "ImplementationGuide", + "InsurancePlan", + "Invoice", + "Library", + "Linkage", + "List", + "Location", + "Measure", + "MeasureReport", + "Media", + "Medication", + "MedicationAdministration", + "MedicationDispense", + "MedicationKnowledge", + "MedicationRequest", + "MedicationStatement", + "MedicinalProduct", + "MedicinalProductAuthorization", + "MedicinalProductContraindication", + "MedicinalProductIndication", + "MedicinalProductIngredient", + "MedicinalProductInteraction", + "MedicinalProductManufactured", + "MedicinalProductPackaged", + "MedicinalProductPharmaceutical", + "MedicinalProductUndesirableEffect", + "MessageDefinition", + "MessageHeader", + "MolecularSequence", + "NamingSystem", + "NutritionOrder", + "Observation", + "ObservationDefinition", + "OperationDefinition", + "OperationOutcome", + "Organization", + "OrganizationAffiliation", + "Parameters", + "Patient", + "PaymentNotice", + "PaymentReconciliation", + "Person", + "PlanDefinition", + "Practitioner", + "PractitionerRole", + "Procedure", + "ProcedureRequest", + "ProcessRequest", + "ProcessResponse", + "Provenance", + "Questionnaire", + "QuestionnaireResponse", + "ReferralRequest", + "RelatedPerson", + "RequestGroup", + "ResearchDefinition", + "ResearchElementDefinition", + "ResearchStudy", + "ResearchSubject", + "Resource", + "RiskAssessment", + "RiskEvidenceSynthesis", + "Schedule", + "SearchParameter", + "Sequence", + "ServiceDefinition", + "ServiceRequest", + "Slot", + "Specimen", + "SpecimenDefinition", + "StructureDefinition", + "StructureMap", + "Subscription", + "Substance", + "SubstanceNucleicAcid", + "SubstancePolymer", + "SubstanceProtein", + "SubstanceReferenceInformation", + "SubstanceSourceMaterial", + "SubstanceSpecification", + "SupplyDelivery", + "SupplyRequest", + "Task", + "TerminologyCapabilities", + "TestReport", + "TestScript", + "ValueSet", + "VerificationResult", + "VisionPrescription" + ], + "x-ms-enum": { + "name": "HealthcareFhirResourceType", + "modelAsString": true, + "values": [ + { + "name": "Account", + "value": "Account", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "ActivityDefinition", + "value": "ActivityDefinition", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "AdverseEvent", + "value": "AdverseEvent", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "AllergyIntolerance", + "value": "AllergyIntolerance", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Appointment", + "value": "Appointment", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "AppointmentResponse", + "value": "AppointmentResponse", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "AuditEvent", + "value": "AuditEvent", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Basic", + "value": "Basic", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Binary", + "value": "Binary", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "BiologicallyDerivedProduct", + "value": "BiologicallyDerivedProduct", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "BodySite", + "value": "BodySite", + "description": "The FHIR resource type defined in STU3." + }, + { + "name": "BodyStructure", + "value": "BodyStructure", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "Bundle", + "value": "Bundle", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "CapabilityStatement", + "value": "CapabilityStatement", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "CarePlan", + "value": "CarePlan", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "CareTeam", + "value": "CareTeam", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "CatalogEntry", + "value": "CatalogEntry", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "ChargeItem", + "value": "ChargeItem", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "ChargeItemDefinition", + "value": "ChargeItemDefinition", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "Claim", + "value": "Claim", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "ClaimResponse", + "value": "ClaimResponse", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "ClinicalImpression", + "value": "ClinicalImpression", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "CodeSystem", + "value": "CodeSystem", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Communication", + "value": "Communication", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "CommunicationRequest", + "value": "CommunicationRequest", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "CompartmentDefinition", + "value": "CompartmentDefinition", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Composition", + "value": "Composition", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "ConceptMap", + "value": "ConceptMap", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Condition", + "value": "Condition", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Consent", + "value": "Consent", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Contract", + "value": "Contract", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Coverage", + "value": "Coverage", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "CoverageEligibilityRequest", + "value": "CoverageEligibilityRequest", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "CoverageEligibilityResponse", + "value": "CoverageEligibilityResponse", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "DataElement", + "value": "DataElement", + "description": "The FHIR resource type defined in STU3." + }, + { + "name": "DetectedIssue", + "value": "DetectedIssue", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Device", + "value": "Device", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "DeviceComponent", + "value": "DeviceComponent", + "description": "The FHIR resource type defined in STU3." + }, + { + "name": "DeviceDefinition", + "value": "DeviceDefinition", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "DeviceMetric", + "value": "DeviceMetric", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "DeviceRequest", + "value": "DeviceRequest", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "DeviceUseStatement", + "value": "DeviceUseStatement", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "DiagnosticReport", + "value": "DiagnosticReport", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "DocumentManifest", + "value": "DocumentManifest", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "DocumentReference", + "value": "DocumentReference", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "DomainResource", + "value": "DomainResource", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "EffectEvidenceSynthesis", + "value": "EffectEvidenceSynthesis", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "EligibilityRequest", + "value": "EligibilityRequest", + "description": "The FHIR resource type defined in STU3." + }, + { + "name": "EligibilityResponse", + "value": "EligibilityResponse", + "description": "The FHIR resource type defined in STU3." + }, + { + "name": "Encounter", + "value": "Encounter", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Endpoint", + "value": "Endpoint", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "EnrollmentRequest", + "value": "EnrollmentRequest", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "EnrollmentResponse", + "value": "EnrollmentResponse", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "EpisodeOfCare", + "value": "EpisodeOfCare", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "EventDefinition", + "value": "EventDefinition", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "Evidence", + "value": "Evidence", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "EvidenceVariable", + "value": "EvidenceVariable", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "ExampleScenario", + "value": "ExampleScenario", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "ExpansionProfile", + "value": "ExpansionProfile", + "description": "The FHIR resource type defined in STU3." + }, + { + "name": "ExplanationOfBenefit", + "value": "ExplanationOfBenefit", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "FamilyMemberHistory", + "value": "FamilyMemberHistory", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Flag", + "value": "Flag", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Goal", + "value": "Goal", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "GraphDefinition", + "value": "GraphDefinition", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Group", + "value": "Group", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "GuidanceResponse", + "value": "GuidanceResponse", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "HealthcareService", + "value": "HealthcareService", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "ImagingManifest", + "value": "ImagingManifest", + "description": "The FHIR resource type defined in STU3." + }, + { + "name": "ImagingStudy", + "value": "ImagingStudy", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Immunization", + "value": "Immunization", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "ImmunizationEvaluation", + "value": "ImmunizationEvaluation", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "ImmunizationRecommendation", + "value": "ImmunizationRecommendation", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "ImplementationGuide", + "value": "ImplementationGuide", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "InsurancePlan", + "value": "InsurancePlan", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "Invoice", + "value": "Invoice", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "Library", + "value": "Library", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Linkage", + "value": "Linkage", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "List", + "value": "List", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Location", + "value": "Location", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Measure", + "value": "Measure", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "MeasureReport", + "value": "MeasureReport", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Media", + "value": "Media", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Medication", + "value": "Medication", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "MedicationAdministration", + "value": "MedicationAdministration", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "MedicationDispense", + "value": "MedicationDispense", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "MedicationKnowledge", + "value": "MedicationKnowledge", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "MedicationRequest", + "value": "MedicationRequest", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "MedicationStatement", + "value": "MedicationStatement", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "MedicinalProduct", + "value": "MedicinalProduct", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "MedicinalProductAuthorization", + "value": "MedicinalProductAuthorization", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "MedicinalProductContraindication", + "value": "MedicinalProductContraindication", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "MedicinalProductIndication", + "value": "MedicinalProductIndication", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "MedicinalProductIngredient", + "value": "MedicinalProductIngredient", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "MedicinalProductInteraction", + "value": "MedicinalProductInteraction", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "MedicinalProductManufactured", + "value": "MedicinalProductManufactured", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "MedicinalProductPackaged", + "value": "MedicinalProductPackaged", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "MedicinalProductPharmaceutical", + "value": "MedicinalProductPharmaceutical", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "MedicinalProductUndesirableEffect", + "value": "MedicinalProductUndesirableEffect", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "MessageDefinition", + "value": "MessageDefinition", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "MessageHeader", + "value": "MessageHeader", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "MolecularSequence", + "value": "MolecularSequence", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "NamingSystem", + "value": "NamingSystem", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "NutritionOrder", + "value": "NutritionOrder", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Observation", + "value": "Observation", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "ObservationDefinition", + "value": "ObservationDefinition", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "OperationDefinition", + "value": "OperationDefinition", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "OperationOutcome", + "value": "OperationOutcome", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Organization", + "value": "Organization", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "OrganizationAffiliation", + "value": "OrganizationAffiliation", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "Parameters", + "value": "Parameters", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Patient", + "value": "Patient", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "PaymentNotice", + "value": "PaymentNotice", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "PaymentReconciliation", + "value": "PaymentReconciliation", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Person", + "value": "Person", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "PlanDefinition", + "value": "PlanDefinition", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Practitioner", + "value": "Practitioner", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "PractitionerRole", + "value": "PractitionerRole", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Procedure", + "value": "Procedure", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "ProcedureRequest", + "value": "ProcedureRequest", + "description": "The FHIR resource type defined in STU3." + }, + { + "name": "ProcessRequest", + "value": "ProcessRequest", + "description": "The FHIR resource type defined in STU3." + }, + { + "name": "ProcessResponse", + "value": "ProcessResponse", + "description": "The FHIR resource type defined in STU3." + }, + { + "name": "Provenance", + "value": "Provenance", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Questionnaire", + "value": "Questionnaire", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "QuestionnaireResponse", + "value": "QuestionnaireResponse", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "ReferralRequest", + "value": "ReferralRequest", + "description": "The FHIR resource type defined in STU3." + }, + { + "name": "RelatedPerson", + "value": "RelatedPerson", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "RequestGroup", + "value": "RequestGroup", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "ResearchDefinition", + "value": "ResearchDefinition", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "ResearchElementDefinition", + "value": "ResearchElementDefinition", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "ResearchStudy", + "value": "ResearchStudy", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "ResearchSubject", + "value": "ResearchSubject", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Resource", + "value": "Resource", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "RiskAssessment", + "value": "RiskAssessment", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "RiskEvidenceSynthesis", + "value": "RiskEvidenceSynthesis", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "Schedule", + "value": "Schedule", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "SearchParameter", + "value": "SearchParameter", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Sequence", + "value": "Sequence", + "description": "The FHIR resource type defined in STU3." + }, + { + "name": "ServiceDefinition", + "value": "ServiceDefinition", + "description": "The FHIR resource type defined in STU3." + }, + { + "name": "ServiceRequest", + "value": "ServiceRequest", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "Slot", + "value": "Slot", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Specimen", + "value": "Specimen", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "SpecimenDefinition", + "value": "SpecimenDefinition", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "StructureDefinition", + "value": "StructureDefinition", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "StructureMap", + "value": "StructureMap", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Subscription", + "value": "Subscription", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Substance", + "value": "Substance", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "SubstanceNucleicAcid", + "value": "SubstanceNucleicAcid", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "SubstancePolymer", + "value": "SubstancePolymer", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "SubstanceProtein", + "value": "SubstanceProtein", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "SubstanceReferenceInformation", + "value": "SubstanceReferenceInformation", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "SubstanceSourceMaterial", + "value": "SubstanceSourceMaterial", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "SubstanceSpecification", + "value": "SubstanceSpecification", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "SupplyDelivery", + "value": "SupplyDelivery", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "SupplyRequest", + "value": "SupplyRequest", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Task", + "value": "Task", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "TerminologyCapabilities", + "value": "TerminologyCapabilities", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "TestReport", + "value": "TestReport", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "TestScript", + "value": "TestScript", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "ValueSet", + "value": "ValueSet", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "VerificationResult", + "value": "VerificationResult", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "VisionPrescription", + "value": "VisionPrescription", + "description": "The FHIR resource type defined in STU3 and R4." + } + ] + } + }, + "HealthcareFhirResourceUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.FhirResourceUpdated event.", + "properties": { + "resourceType": { + "$ref": "#/definitions/HealthcareFhirResourceType", + "description": "Type of HL7 FHIR resource.", + "x-ms-client-name": "FhirResourceType" + }, + "resourceFhirAccount": { + "type": "string", + "description": "Domain name of FHIR account for this resource.", + "x-ms-client-name": "FhirServiceHostName" + }, + "resourceFhirId": { + "type": "string", + "description": "Id of HL7 FHIR resource.", + "x-ms-client-name": "FhirResourceId" + }, + "resourceVersionId": { + "type": "integer", + "format": "int64", + "description": "VersionId of HL7 FHIR resource. It changes when the resource is created, updated, or deleted(soft-deletion).", + "x-ms-client-name": "FhirResourceVersionId" + } + } + }, + "IotHubDeviceConnectedEventData": { + "type": "object", + "description": "Event data for Microsoft.Devices.DeviceConnected event.", + "allOf": [ + { + "$ref": "#/definitions/DeviceConnectionStateEventProperties" + } + ] + }, + "IotHubDeviceCreatedEventData": { + "type": "object", + "description": "Event data for Microsoft.Devices.DeviceCreated event.", + "allOf": [ + { + "$ref": "#/definitions/DeviceLifeCycleEventProperties" + } + ] + }, + "IotHubDeviceDeletedEventData": { + "type": "object", + "description": "Event data for Microsoft.Devices.DeviceDeleted event.", + "allOf": [ + { + "$ref": "#/definitions/DeviceLifeCycleEventProperties" + } + ] + }, + "IotHubDeviceDisconnectedEventData": { + "type": "object", + "description": "Event data for Microsoft.Devices.DeviceDisconnected event.", + "allOf": [ + { + "$ref": "#/definitions/DeviceConnectionStateEventProperties" + } + ] + }, + "IotHubDeviceTelemetryEventData": { + "type": "object", + "description": "Event data for Microsoft.Devices.DeviceTelemetry event.", + "allOf": [ + { + "$ref": "#/definitions/DeviceTelemetryEventProperties" + } + ] + }, + "KeyVaultAccessPolicyChangedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.VaultAccessPolicyChanged event.", + "properties": { + "Id": { + "type": "string", + "description": "The id of the object that triggered this event." + }, + "VaultName": { + "type": "string", + "description": "Key vault name of the object that triggered this event." + }, + "ObjectType": { + "type": "string", + "description": "The type of the object that triggered this event" + }, + "ObjectName": { + "type": "string", + "description": "The name of the object that triggered this event" + }, + "Version": { + "type": "string", + "description": "The version of the object that triggered this event" + }, + "NBF": { + "type": "number", + "format": "float", + "description": "Not before date of the object that triggered this event" + }, + "EXP": { + "type": "number", + "format": "float", + "description": "The expiration date of the object that triggered this event" + } + } + }, + "KeyVaultCertificateExpiredEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.CertificateExpired event.", + "properties": { + "Id": { + "type": "string", + "description": "The id of the object that triggered this event." + }, + "VaultName": { + "type": "string", + "description": "Key vault name of the object that triggered this event." + }, + "ObjectType": { + "type": "string", + "description": "The type of the object that triggered this event" + }, + "ObjectName": { + "type": "string", + "description": "The name of the object that triggered this event" + }, + "Version": { + "type": "string", + "description": "The version of the object that triggered this event" + }, + "NBF": { + "type": "number", + "format": "float", + "description": "Not before date of the object that triggered this event" + }, + "EXP": { + "type": "number", + "format": "float", + "description": "The expiration date of the object that triggered this event" + } + } + }, + "KeyVaultCertificateNearExpiryEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.CertificateNearExpiry event.", + "properties": { + "Id": { + "type": "string", + "description": "The id of the object that triggered this event." + }, + "VaultName": { + "type": "string", + "description": "Key vault name of the object that triggered this event." + }, + "ObjectType": { + "type": "string", + "description": "The type of the object that triggered this event" + }, + "ObjectName": { + "type": "string", + "description": "The name of the object that triggered this event" + }, + "Version": { + "type": "string", + "description": "The version of the object that triggered this event" + }, + "NBF": { + "type": "number", + "format": "float", + "description": "Not before date of the object that triggered this event" + }, + "EXP": { + "type": "number", + "format": "float", + "description": "The expiration date of the object that triggered this event" + } + } + }, + "KeyVaultCertificateNewVersionCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.CertificateNewVersionCreated event.", + "properties": { + "Id": { + "type": "string", + "description": "The id of the object that triggered this event." + }, + "VaultName": { + "type": "string", + "description": "Key vault name of the object that triggered this event." + }, + "ObjectType": { + "type": "string", + "description": "The type of the object that triggered this event" + }, + "ObjectName": { + "type": "string", + "description": "The name of the object that triggered this event" + }, + "Version": { + "type": "string", + "description": "The version of the object that triggered this event" + }, + "NBF": { + "type": "number", + "format": "float", + "description": "Not before date of the object that triggered this event" + }, + "EXP": { + "type": "number", + "format": "float", + "description": "The expiration date of the object that triggered this event" + } + } + }, + "KeyVaultKeyExpiredEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.KeyExpired event.", + "properties": { + "Id": { + "type": "string", + "description": "The id of the object that triggered this event." + }, + "VaultName": { + "type": "string", + "description": "Key vault name of the object that triggered this event." + }, + "ObjectType": { + "type": "string", + "description": "The type of the object that triggered this event" + }, + "ObjectName": { + "type": "string", + "description": "The name of the object that triggered this event" + }, + "Version": { + "type": "string", + "description": "The version of the object that triggered this event" + }, + "NBF": { + "type": "number", + "format": "float", + "description": "Not before date of the object that triggered this event" + }, + "EXP": { + "type": "number", + "format": "float", + "description": "The expiration date of the object that triggered this event" + } + } + }, + "KeyVaultKeyNearExpiryEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.KeyNearExpiry event.", + "properties": { + "Id": { + "type": "string", + "description": "The id of the object that triggered this event." + }, + "VaultName": { + "type": "string", + "description": "Key vault name of the object that triggered this event." + }, + "ObjectType": { + "type": "string", + "description": "The type of the object that triggered this event" + }, + "ObjectName": { + "type": "string", + "description": "The name of the object that triggered this event" + }, + "Version": { + "type": "string", + "description": "The version of the object that triggered this event" + }, + "NBF": { + "type": "number", + "format": "float", + "description": "Not before date of the object that triggered this event" + }, + "EXP": { + "type": "number", + "format": "float", + "description": "The expiration date of the object that triggered this event" + } + } + }, + "KeyVaultKeyNewVersionCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.KeyNewVersionCreated event.", + "properties": { + "Id": { + "type": "string", + "description": "The id of the object that triggered this event." + }, + "VaultName": { + "type": "string", + "description": "Key vault name of the object that triggered this event." + }, + "ObjectType": { + "type": "string", + "description": "The type of the object that triggered this event" + }, + "ObjectName": { + "type": "string", + "description": "The name of the object that triggered this event" + }, + "Version": { + "type": "string", + "description": "The version of the object that triggered this event" + }, + "NBF": { + "type": "number", + "format": "float", + "description": "Not before date of the object that triggered this event" + }, + "EXP": { + "type": "number", + "format": "float", + "description": "The expiration date of the object that triggered this event" + } + } + }, + "KeyVaultSecretExpiredEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.SecretExpired event.", + "properties": { + "Id": { + "type": "string", + "description": "The id of the object that triggered this event." + }, + "VaultName": { + "type": "string", + "description": "Key vault name of the object that triggered this event." + }, + "ObjectType": { + "type": "string", + "description": "The type of the object that triggered this event" + }, + "ObjectName": { + "type": "string", + "description": "The name of the object that triggered this event" + }, + "Version": { + "type": "string", + "description": "The version of the object that triggered this event" + }, + "NBF": { + "type": "number", + "format": "float", + "description": "Not before date of the object that triggered this event" + }, + "EXP": { + "type": "number", + "format": "float", + "description": "The expiration date of the object that triggered this event" + } + } + }, + "KeyVaultSecretNearExpiryEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.SecretNearExpiry event.", + "properties": { + "Id": { + "type": "string", + "description": "The id of the object that triggered this event." + }, + "VaultName": { + "type": "string", + "description": "Key vault name of the object that triggered this event." + }, + "ObjectType": { + "type": "string", + "description": "The type of the object that triggered this event" + }, + "ObjectName": { + "type": "string", + "description": "The name of the object that triggered this event" + }, + "Version": { + "type": "string", + "description": "The version of the object that triggered this event" + }, + "NBF": { + "type": "number", + "format": "float", + "description": "Not before date of the object that triggered this event" + }, + "EXP": { + "type": "number", + "format": "float", + "description": "The expiration date of the object that triggered this event" + } + } + }, + "KeyVaultSecretNewVersionCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.SecretNewVersionCreated event.", + "properties": { + "Id": { + "type": "string", + "description": "The id of the object that triggered this event." + }, + "VaultName": { + "type": "string", + "description": "Key vault name of the object that triggered this event." + }, + "ObjectType": { + "type": "string", + "description": "The type of the object that triggered this event" + }, + "ObjectName": { + "type": "string", + "description": "The name of the object that triggered this event" + }, + "Version": { + "type": "string", + "description": "The version of the object that triggered this event" + }, + "NBF": { + "type": "number", + "format": "float", + "description": "Not before date of the object that triggered this event" + }, + "EXP": { + "type": "number", + "format": "float", + "description": "The expiration date of the object that triggered this event" + } + } + }, + "MachineLearningServicesDatasetDriftDetectedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.DatasetDriftDetected event.", + "properties": { + "dataDriftId": { + "type": "string", + "description": "The ID of the data drift monitor that triggered the event." + }, + "dataDriftName": { + "type": "string", + "description": "The name of the data drift monitor that triggered the event." + }, + "runId": { + "type": "string", + "description": "The ID of the Run that detected data drift." + }, + "baseDatasetId": { + "type": "string", + "description": "The ID of the base Dataset used to detect drift." + }, + "targetDatasetId": { + "type": "string", + "description": "The ID of the target Dataset used to detect drift." + }, + "driftCoefficient": { + "type": "number", + "format": "double", + "description": "The coefficient result that triggered the event." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the target dataset time series that resulted in drift detection." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the target dataset time series that resulted in drift detection." + } + } + }, + "MachineLearningServicesModelDeployedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.ModelDeployed event.", + "properties": { + "serviceName": { + "type": "string", + "description": "The name of the deployed service." + }, + "serviceComputeType": { + "type": "string", + "description": "The compute type (e.g. ACI, AKS) of the deployed service." + }, + "modelIds": { + "type": "string", + "description": "A common separated list of model IDs. The IDs of the models deployed in the service." + }, + "serviceTags": { + "type": "object", + "description": "The tags of the deployed service.", + "additionalProperties": {} + }, + "serviceProperties": { + "type": "object", + "description": "The properties of the deployed service.", + "additionalProperties": {} + } + }, + "required": [ + "serviceTags", + "serviceProperties" + ] + }, + "MachineLearningServicesModelRegisteredEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.ModelRegistered event.", + "properties": { + "modelName": { + "type": "string", + "description": "The name of the model that was registered." + }, + "modelVersion": { + "type": "string", + "description": "The version of the model that was registered." + }, + "modelTags": { + "type": "object", + "description": "The tags of the model that was registered.", + "additionalProperties": {} + }, + "modelProperties": { + "type": "object", + "description": "The properties of the model that was registered.", + "additionalProperties": {} + } + }, + "required": [ + "modelTags", + "modelProperties" + ] + }, + "MachineLearningServicesRunCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.RunCompleted event.", + "properties": { + "experimentId": { + "type": "string", + "description": "The ID of the experiment that the run belongs to." + }, + "experimentName": { + "type": "string", + "description": "The name of the experiment that the run belongs to." + }, + "runId": { + "type": "string", + "description": "The ID of the Run that was completed." + }, + "runType": { + "type": "string", + "description": "The Run Type of the completed Run." + }, + "runTags": { + "type": "object", + "description": "The tags of the completed Run.", + "additionalProperties": {} + }, + "runProperties": { + "type": "object", + "description": "The properties of the completed Run.", + "additionalProperties": {} + } + }, + "required": [ + "runTags", + "runProperties" + ] + }, + "MachineLearningServicesRunStatusChangedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.RunStatusChanged event.", + "properties": { + "experimentId": { + "type": "string", + "description": "The ID of the experiment that the Machine Learning Run belongs to." + }, + "experimentName": { + "type": "string", + "description": "The name of the experiment that the Machine Learning Run belongs to." + }, + "runId": { + "type": "string", + "description": "The ID of the Machine Learning Run." + }, + "runType": { + "type": "string", + "description": "The Run Type of the Machine Learning Run." + }, + "runTags": { + "type": "object", + "description": "The tags of the Machine Learning Run.", + "additionalProperties": {} + }, + "runProperties": { + "type": "object", + "description": "The properties of the Machine Learning Run.", + "additionalProperties": {} + }, + "runStatus": { + "type": "string", + "description": "The status of the Machine Learning Run." + } + }, + "required": [ + "runTags", + "runProperties" + ] + }, + "MapsGeofenceEnteredEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceEntered event.", + "allOf": [ + { + "$ref": "#/definitions/MapsGeofenceEventProperties" + } + ] + }, + "MapsGeofenceEventProperties": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Geofence event (GeofenceEntered, GeofenceExited, GeofenceResult).", + "properties": { + "expiredGeofenceGeometryId": { + "type": "array", + "description": "Lists of the geometry ID of the geofence which is expired relative to the user time in the request.", + "items": { + "type": "string" + } + }, + "geometries": { + "type": "array", + "description": "Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.", + "items": { + "$ref": "#/definitions/MapsGeofenceGeometry" + }, + "x-ms-identifiers": [] + }, + "invalidPeriodGeofenceGeometryId": { + "type": "array", + "description": "Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.", + "items": { + "type": "string" + } + }, + "isEventPublished": { + "type": "boolean", + "description": "True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber." + } + }, + "required": [ + "geometries" + ] + }, + "MapsGeofenceExitedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceExited event.", + "allOf": [ + { + "$ref": "#/definitions/MapsGeofenceEventProperties" + } + ] + }, + "MapsGeofenceGeometry": { + "type": "object", + "description": "The geofence geometry.", + "properties": { + "deviceId": { + "type": "string", + "description": "ID of the device." + }, + "distance": { + "type": "number", + "format": "float", + "description": "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." + }, + "geometryId": { + "type": "string", + "description": "The unique ID for the geofence geometry." + }, + "nearestLat": { + "type": "number", + "format": "float", + "description": "Latitude of the nearest point of the geometry." + }, + "nearestLon": { + "type": "number", + "format": "float", + "description": "Longitude of the nearest point of the geometry." + }, + "udId": { + "type": "string", + "description": "The unique id returned from user upload service when uploading a geofence. Will not be included in geofencing post API." + } + } + }, + "MapsGeofenceResultEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceResult event.", + "allOf": [ + { + "$ref": "#/definitions/MapsGeofenceEventProperties" + } + ] + }, + "MediaJobCanceledEventData": { + "type": "object", + "description": "Job canceled event data. Schema of the data property of an EventGridEvent for a\nMicrosoft.Media.JobCanceled event.", + "properties": { + "outputs": { + "type": "array", + "description": "Gets the Job outputs.", + "items": { + "$ref": "#/definitions/MediaJobOutput" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "outputs" + ], + "allOf": [ + { + "$ref": "#/definitions/MediaJobStateChangeEventData" + } + ] + }, + "MediaJobCancelingEventData": { + "type": "object", + "description": "Job canceling event data. Schema of the data property of an EventGridEvent for\na Microsoft.Media.JobCanceling event.", + "allOf": [ + { + "$ref": "#/definitions/MediaJobStateChangeEventData" + } + ] + }, + "MediaJobError": { + "type": "object", + "description": "Details of JobOutput errors.", + "properties": { + "code": { + "$ref": "#/definitions/MediaJobErrorCode", + "description": "Error code describing the error." + }, + "message": { + "type": "string", + "description": "A human-readable language-dependent representation of the error." + }, + "category": { + "$ref": "#/definitions/MediaJobErrorCategory", + "description": "Helps with categorization of errors." + }, + "retry": { + "$ref": "#/definitions/MediaJobRetry", + "description": "Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/MediaJobErrorDetail" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "details" + ] + }, + "MediaJobErrorCategory": { + "type": "string", + "description": "Error categories for Media Job Errors.", + "enum": [ + "Service", + "Download", + "Upload", + "Configuration", + "Content", + "Account" + ], + "x-ms-enum": { + "name": "MediaJobErrorCategory", + "modelAsString": true, + "values": [ + { + "name": "Service", + "value": "Service", + "description": "The error is service related." + }, + { + "name": "Download", + "value": "Download", + "description": "The error is download related." + }, + { + "name": "Upload", + "value": "Upload", + "description": "The error is upload related." + }, + { + "name": "Configuration", + "value": "Configuration", + "description": "The error is configuration related." + }, + { + "name": "Content", + "value": "Content", + "description": "The error is related to data in the input files." + }, + { + "name": "Account", + "value": "Account", + "description": "The error is related to account information." + } + ] + } + }, + "MediaJobErrorCode": { + "type": "string", + "description": "Media Job Error Codes.", + "enum": [ + "ServiceError", + "ServiceTransientError", + "DownloadNotAccessible", + "DownloadTransientError", + "UploadNotAccessible", + "UploadTransientError", + "ConfigurationUnsupported", + "ContentMalformed", + "ContentUnsupported", + "IdentityUnsupported" + ], + "x-ms-enum": { + "name": "MediaJobErrorCode", + "modelAsString": true, + "values": [ + { + "name": "ServiceError", + "value": "ServiceError", + "description": "Fatal service error, please contact support." + }, + { + "name": "ServiceTransientError", + "value": "ServiceTransientError", + "description": "Transient error, please retry, if retry is unsuccessful, please contact support." + }, + { + "name": "DownloadNotAccessible", + "value": "DownloadNotAccessible", + "description": "While trying to download the input files, the files were not accessible, please check the availability of the source." + }, + { + "name": "DownloadTransientError", + "value": "DownloadTransientError", + "description": "While trying to download the input files, there was an issue during transfer (storage service, network errors), see details and check your source." + }, + { + "name": "UploadNotAccessible", + "value": "UploadNotAccessible", + "description": "While trying to upload the output files, the destination was not reachable, please check the availability of the destination." + }, + { + "name": "UploadTransientError", + "value": "UploadTransientError", + "description": "While trying to upload the output files, there was an issue during transfer (storage service, network errors), see details and check your destination." + }, + { + "name": "ConfigurationUnsupported", + "value": "ConfigurationUnsupported", + "description": "There was a problem with the combination of input files and the configuration settings applied, fix the configuration settings and retry with the same input, or change input to match the configuration." + }, + { + "name": "ContentMalformed", + "value": "ContentMalformed", + "description": "There was a problem with the input content (for example: zero byte files, or corrupt/non-decodable files), check the input files." + }, + { + "name": "ContentUnsupported", + "value": "ContentUnsupported", + "description": "There was a problem with the format of the input (not valid media file, or an unsupported file/codec), check the validity of the input files." + }, + { + "name": "IdentityUnsupported", + "value": "IdentityUnsupported", + "description": "There is an error verifying to the account identity. Check and fix the identity configurations and retry. If unsuccessful, please contact support." + } + ] + } + }, + "MediaJobErrorDetail": { + "type": "object", + "description": "Details of JobOutput errors.", + "properties": { + "code": { + "type": "string", + "description": "Code describing the error detail." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + } + } + }, + "MediaJobErroredEventData": { + "type": "object", + "description": "Job error state event data. Schema of the data property of an EventGridEvent\nfor a Microsoft.Media.JobErrored event.", + "properties": { + "outputs": { + "type": "array", + "description": "Gets the Job outputs.", + "items": { + "$ref": "#/definitions/MediaJobOutput" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "outputs" + ], + "allOf": [ + { + "$ref": "#/definitions/MediaJobStateChangeEventData" + } + ] + }, + "MediaJobFinishedEventData": { + "type": "object", + "description": "Job finished event data. Schema of the data property of an EventGridEvent for a\nMicrosoft.Media.JobFinished event.", + "properties": { + "outputs": { + "type": "array", + "description": "Gets the Job outputs.", + "items": { + "$ref": "#/definitions/MediaJobOutput" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "outputs" + ], + "allOf": [ + { + "$ref": "#/definitions/MediaJobStateChangeEventData" + } + ] + }, + "MediaJobOutput": { + "type": "object", + "description": "The event data for a Job output.", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + }, + "error": { + "$ref": "#/definitions/MediaJobError", + "description": "Gets the Job output error." + }, + "label": { + "type": "string", + "description": "Gets the Job output label." + }, + "progress": { + "type": "integer", + "format": "int64", + "description": "Gets the Job output progress." + }, + "state": { + "$ref": "#/definitions/MediaJobState", + "description": "Gets the Job output state." + } + }, + "discriminator": "@odata.type", + "required": [ + "@odata.type", + "error", + "progress" + ] + }, + "MediaJobOutputAsset": { + "type": "object", + "description": "The event data for a Job output asset.", + "properties": { + "assetName": { + "type": "string", + "description": "Gets the Job output asset name." + } + }, + "allOf": [ + { + "$ref": "#/definitions/MediaJobOutput" + } + ], + "x-ms-discriminator-value": "#Microsoft.Media.JobOutputAsset" + }, + "MediaJobOutputCanceledEventData": { + "type": "object", + "description": "Job output canceled event data. Schema of the data property of an\nEventGridEvent for a Microsoft.Media.JobOutputCanceled event.", + "allOf": [ + { + "$ref": "#/definitions/MediaJobOutputStateChangeEventData" + } + ] + }, + "MediaJobOutputCancelingEventData": { + "type": "object", + "description": "Job output canceling event data. Schema of the data property of an\nEventGridEvent for a Microsoft.Media.JobOutputCanceling event.", + "allOf": [ + { + "$ref": "#/definitions/MediaJobOutputStateChangeEventData" + } + ] + }, + "MediaJobOutputErroredEventData": { + "type": "object", + "description": "Job output error event data. Schema of the data property of an EventGridEvent\nfor a Microsoft.Media.JobOutputErrored event.", + "allOf": [ + { + "$ref": "#/definitions/MediaJobOutputStateChangeEventData" + } + ] + }, + "MediaJobOutputFinishedEventData": { + "type": "object", + "description": "Job output finished event data. Schema of the data property of an\nEventGridEvent for a Microsoft.Media.JobOutputFinished event.", + "allOf": [ + { + "$ref": "#/definitions/MediaJobOutputStateChangeEventData" + } + ] + }, + "MediaJobOutputProcessingEventData": { + "type": "object", + "description": "Job output processing event data. Schema of the data property of an\nEventGridEvent for a Microsoft.Media.JobOutputProcessing event.", + "allOf": [ + { + "$ref": "#/definitions/MediaJobOutputStateChangeEventData" + } + ] + }, + "MediaJobOutputProgressEventData": { + "type": "object", + "description": "Job Output Progress Event Data. Schema of the Data property of an\n EventGridEvent for a Microsoft.Media.JobOutputProgress event.", + "properties": { + "label": { + "type": "string", + "description": "Gets the Job output label." + }, + "progress": { + "type": "integer", + "format": "int64", + "description": "Gets the Job output progress." + }, + "jobCorrelationData": { + "type": "object", + "description": "Gets the Job correlation data.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "jobCorrelationData" + ] + }, + "MediaJobOutputScheduledEventData": { + "type": "object", + "description": "Job output scheduled event data. Schema of the data property of an\nEventGridEvent for a Microsoft.Media.JobOutputScheduled event.", + "allOf": [ + { + "$ref": "#/definitions/MediaJobOutputStateChangeEventData" + } + ] + }, + "MediaJobOutputStateChangeEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a\n Microsoft.Media.JobOutputStateChange event.", + "properties": { + "previousState": { + "$ref": "#/definitions/MediaJobState", + "description": "The previous state of the Job." + }, + "output": { + "$ref": "#/definitions/MediaJobOutput", + "description": "Gets the output." + }, + "jobCorrelationData": { + "type": "object", + "description": "Gets the Job correlation data.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "output", + "jobCorrelationData" + ] + }, + "MediaJobProcessingEventData": { + "type": "object", + "description": "Job processing event data. Schema of the data property of an EventGridEvent for\na Microsoft.Media.JobProcessing event.", + "allOf": [ + { + "$ref": "#/definitions/MediaJobStateChangeEventData" + } + ] + }, + "MediaJobRetry": { + "type": "string", + "description": "Media Job Retry Options.", + "enum": [ + "DoNotRetry", + "MayRetry" + ], + "x-ms-enum": { + "name": "MediaJobRetry", + "modelAsString": true, + "values": [ + { + "name": "DoNotRetry", + "value": "DoNotRetry", + "description": "Issue needs to be investigated and then the job resubmitted with corrections or retried once the underlying issue has been corrected." + }, + { + "name": "MayRetry", + "value": "MayRetry", + "description": "Issue may be resolved after waiting for a period of time and resubmitting the same Job." + } + ] + } + }, + "MediaJobScheduledEventData": { + "type": "object", + "description": "Job scheduled event data. Schema of the data property of an EventGridEvent for\na Microsoft.Media.JobScheduled event.", + "allOf": [ + { + "$ref": "#/definitions/MediaJobStateChangeEventData" + } + ] + }, + "MediaJobState": { + "type": "string", + "description": "State of a Media Job.", + "enum": [ + "Canceled", + "Canceling", + "Error", + "Finished", + "Processing", + "Queued", + "Scheduled" + ], + "x-ms-enum": { + "name": "MediaJobState", + "modelAsString": true, + "values": [ + { + "name": "Canceled", + "value": "Canceled", + "description": "The job was canceled. This is a final state for the job." + }, + { + "name": "Canceling", + "value": "Canceling", + "description": "The job is in the process of being canceled. This is a transient state for the job." + }, + { + "name": "Error", + "value": "Error", + "description": "The job has encountered an error. This is a final state for the job." + }, + { + "name": "Finished", + "value": "Finished", + "description": "The job is finished. This is a final state for the job." + }, + { + "name": "Processing", + "value": "Processing", + "description": "The job is processing. This is a transient state for the job." + }, + { + "name": "Queued", + "value": "Queued", + "description": "The job is in a queued state, waiting for resources to become available. This is a transient state." + }, + { + "name": "Scheduled", + "value": "Scheduled", + "description": "The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states." + } + ] + } + }, + "MediaJobStateChangeEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a\n Microsoft.Media.JobStateChange event.", + "properties": { + "previousState": { + "$ref": "#/definitions/MediaJobState", + "description": "The previous state of the Job." + }, + "state": { + "$ref": "#/definitions/MediaJobState", + "description": "The new state of the Job." + }, + "correlationData": { + "type": "object", + "description": "Gets the Job correlation data.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "correlationData" + ] + }, + "MediaLiveEventChannelArchiveHeartbeatEventData": { + "type": "object", + "description": "Channel Archive heartbeat event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventChannelArchiveHeartbeat event.", + "properties": { + "channelLatencyMs": { + "type": "string", + "description": "Gets the channel latency in ms." + }, + "latencyResultCode": { + "type": "string", + "description": "Gets the latency result code." + } + }, + "required": [ + "channelLatencyMs", + "latencyResultCode" + ] + }, + "MediaLiveEventConnectionRejectedEventData": { + "type": "object", + "description": "Encoder connection rejected event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventConnectionRejected event.", + "properties": { + "ingestUrl": { + "type": "string", + "description": "Gets the ingest URL provided by the live event." + }, + "streamId": { + "type": "string", + "description": "Gets the stream Id." + }, + "encoderIp": { + "type": "string", + "description": "Gets the remote IP." + }, + "encoderPort": { + "type": "string", + "description": "Gets the remote port." + }, + "resultCode": { + "type": "string", + "description": "Gets the result code." + } + } + }, + "MediaLiveEventEncoderConnectedEventData": { + "type": "object", + "description": "Encoder connect event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventEncoderConnected event.", + "properties": { + "ingestUrl": { + "type": "string", + "description": "Gets the ingest URL provided by the live event." + }, + "streamId": { + "type": "string", + "description": "Gets the stream Id." + }, + "encoderIp": { + "type": "string", + "description": "Gets the remote IP." + }, + "encoderPort": { + "type": "string", + "description": "Gets the remote port." + } + } + }, + "MediaLiveEventEncoderDisconnectedEventData": { + "type": "object", + "description": "Encoder disconnected event data. Schema of the Data property of an EventGridEvent for a Microsoft.Media.LiveEventEncoderDisconnected event.", + "properties": { + "ingestUrl": { + "type": "string", + "description": "Gets the ingest URL provided by the live event." + }, + "streamId": { + "type": "string", + "description": "Gets the stream Id." + }, + "encoderIp": { + "type": "string", + "description": "Gets the remote IP." + }, + "encoderPort": { + "type": "string", + "description": "Gets the remote port." + }, + "resultCode": { + "type": "string", + "description": "Gets the result code." + } + } + }, + "MediaLiveEventIncomingDataChunkDroppedEventData": { + "type": "object", + "description": "Ingest fragment dropped event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIncomingDataChunkDropped event.", + "properties": { + "timestamp": { + "type": "string", + "description": "Gets the timestamp of the data chunk dropped." + }, + "trackType": { + "type": "string", + "description": "Gets the type of the track (Audio / Video)." + }, + "bitrate": { + "type": "integer", + "format": "int64", + "description": "Gets the bitrate of the track." + }, + "timescale": { + "type": "string", + "description": "Gets the timescale of the Timestamp." + }, + "resultCode": { + "type": "string", + "description": "Gets the result code for fragment drop operation." + }, + "trackName": { + "type": "string", + "description": "Gets the name of the track for which fragment is dropped." + } + } + }, + "MediaLiveEventIncomingStreamReceivedEventData": { + "type": "object", + "description": "Encoder connect event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIncomingStreamReceived event.", + "properties": { + "ingestUrl": { + "type": "string", + "description": "Gets the ingest URL provided by the live event." + }, + "trackType": { + "type": "string", + "description": "Gets the type of the track (Audio / Video)." + }, + "trackName": { + "type": "string", + "description": "Gets the track name." + }, + "bitrate": { + "type": "integer", + "format": "int64", + "description": "Gets the bitrate of the track." + }, + "encoderIp": { + "type": "string", + "description": "Gets the remote IP." + }, + "encoderPort": { + "type": "string", + "description": "Gets the remote port." + }, + "timestamp": { + "type": "string", + "description": "Gets the first timestamp of the data chunk received." + }, + "duration": { + "type": "string", + "description": "Gets the duration of the first data chunk." + }, + "timescale": { + "type": "string", + "description": "Gets the timescale in which timestamp is represented." + } + } + }, + "MediaLiveEventIncomingStreamsOutOfSyncEventData": { + "type": "object", + "description": "Incoming streams out of sync event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIncomingStreamsOutOfSync event.", + "properties": { + "minLastTimestamp": { + "type": "string", + "description": "Gets the minimum last timestamp received." + }, + "typeOfStreamWithMinLastTimestamp": { + "type": "string", + "description": "Gets the type of stream with minimum last timestamp." + }, + "maxLastTimestamp": { + "type": "string", + "description": "Gets the maximum timestamp among all the tracks (audio or video)." + }, + "typeOfStreamWithMaxLastTimestamp": { + "type": "string", + "description": "Gets the type of stream with maximum last timestamp." + }, + "timescaleOfMinLastTimestamp": { + "type": "string", + "description": "Gets the timescale in which \\\"MinLastTimestamp\\\" is represented." + }, + "timescaleOfMaxLastTimestamp": { + "type": "string", + "description": "Gets the timescale in which \\\"MaxLastTimestamp\\\" is represented." + } + } + }, + "MediaLiveEventIncomingVideoStreamsOutOfSyncEventData": { + "type": "object", + "description": "Incoming video stream out of sync event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIncomingVideoStreamsOutOfSync event.", + "properties": { + "firstTimestamp": { + "type": "string", + "description": "Gets the first timestamp received for one of the quality levels." + }, + "firstDuration": { + "type": "string", + "description": "Gets the duration of the data chunk with first timestamp." + }, + "secondTimestamp": { + "type": "string", + "description": "Gets the timestamp received for some other quality levels." + }, + "secondDuration": { + "type": "string", + "description": "Gets the duration of the data chunk with second timestamp." + }, + "timescale": { + "type": "string", + "description": "Gets the timescale in which both the timestamps and durations are represented." + } + } + }, + "MediaLiveEventIngestHeartbeatEventData": { + "type": "object", + "description": "Ingest heartbeat event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIngestHeartbeat event.", + "properties": { + "trackType": { + "type": "string", + "description": "Gets the type of the track (Audio / Video)." + }, + "trackName": { + "type": "string", + "description": "Gets the track name." + }, + "transcriptionLanguage": { + "type": "string", + "description": "Gets the Live Transcription language." + }, + "transcriptionState": { + "type": "string", + "description": "Gets the Live Transcription state." + }, + "bitrate": { + "type": "integer", + "format": "int64", + "description": "Gets the bitrate of the track." + }, + "incomingBitrate": { + "type": "integer", + "format": "int64", + "description": "Gets the incoming bitrate." + }, + "ingestDriftValue": { + "type": "string", + "description": "Gets the track ingest drift value." + }, + "lastFragmentArrivalTime": { + "type": "string", + "description": "Gets the arrival UTC time of the last fragment." + }, + "lastTimestamp": { + "type": "string", + "description": "Gets the last timestamp." + }, + "timescale": { + "type": "string", + "description": "Gets the timescale of the last timestamp." + }, + "overlapCount": { + "type": "integer", + "format": "int64", + "description": "Gets the fragment Overlap count." + }, + "discontinuityCount": { + "type": "integer", + "format": "int64", + "description": "Gets the fragment Discontinuity count." + }, + "nonincreasingCount": { + "type": "integer", + "format": "int64", + "description": "Gets Non increasing count." + }, + "unexpectedBitrate": { + "type": "boolean", + "description": "Gets a value indicating whether unexpected bitrate is present or not." + }, + "state": { + "type": "string", + "description": "Gets the state of the live event." + }, + "healthy": { + "type": "boolean", + "description": "Gets a value indicating whether preview is healthy or not." + } + } + }, + "MediaLiveEventTrackDiscontinuityDetectedEventData": { + "type": "object", + "description": "Ingest track discontinuity detected event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventTrackDiscontinuityDetected event.", + "properties": { + "trackType": { + "type": "string", + "description": "Gets the type of the track (Audio / Video)." + }, + "trackName": { + "type": "string", + "description": "Gets the track name." + }, + "bitrate": { + "type": "integer", + "format": "int64", + "description": "Gets the bitrate." + }, + "previousTimestamp": { + "type": "string", + "description": "Gets the timestamp of the previous fragment." + }, + "newTimestamp": { + "type": "string", + "description": "Gets the timestamp of the current fragment." + }, + "timescale": { + "type": "string", + "description": "Gets the timescale in which both timestamps and discontinuity gap are represented." + }, + "discontinuityGap": { + "type": "string", + "description": "Gets the discontinuity gap between PreviousTimestamp and NewTimestamp." + } + } + }, + "MicrosoftTeamsAppIdentifierModel": { + "type": "object", + "description": "A Microsoft Teams application.", + "properties": { + "appId": { + "type": "string", + "description": "The Id of the Microsoft Teams application" + }, + "cloud": { + "$ref": "#/definitions/CommunicationCloudEnvironmentModel", + "description": "The cloud that the Microsoft Teams application belongs to. By default 'public' if missing." + } + }, + "required": [ + "appId" + ] + }, + "MicrosoftTeamsUserIdentifierModel": { + "type": "object", + "description": "A Microsoft Teams user.", + "properties": { + "userId": { + "type": "string", + "description": "The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user." + }, + "isAnonymous": { + "type": "boolean", + "description": "True if the Microsoft Teams user is anonymous. By default false if missing." + }, + "cloud": { + "$ref": "#/definitions/CommunicationCloudEnvironmentModel", + "description": "The cloud that the Microsoft Teams user belongs to. By default 'public' if missing." + } + }, + "required": [ + "userId" + ] + }, + "PhoneNumberIdentifierModel": { + "type": "object", + "description": "A phone number.", + "properties": { + "value": { + "type": "string", + "description": "The phone number in E.164 format." + } + }, + "required": [ + "value" + ] + }, + "PolicyInsightsPolicyStateChangedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.PolicyInsights.PolicyStateChanged event.", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The time that the resource was scanned by Azure Policy in the Universal ISO 8601 DateTime format yyyy-MM-ddTHH:mm:ss.fffffffZ." + }, + "policyAssignmentId": { + "type": "string", + "description": "The resource ID of the policy assignment." + }, + "policyDefinitionId": { + "type": "string", + "description": "The resource ID of the policy definition." + }, + "policyDefinitionReferenceId": { + "type": "string", + "description": "The reference ID for the policy definition inside the initiative definition, if the policy assignment is for an initiative. May be empty." + }, + "complianceState": { + "type": "string", + "description": "The compliance state of the resource with respect to the policy assignment." + }, + "subscriptionId": { + "type": "string", + "description": "The subscription ID of the resource." + }, + "complianceReasonCode": { + "type": "string", + "description": "The compliance reason code. May be empty." + } + } + }, + "PolicyInsightsPolicyStateCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.PolicyInsights.PolicyStateCreated event.", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The time that the resource was scanned by Azure Policy in the Universal ISO 8601 DateTime format yyyy-MM-ddTHH:mm:ss.fffffffZ." + }, + "policyAssignmentId": { + "type": "string", + "description": "The resource ID of the policy assignment." + }, + "policyDefinitionId": { + "type": "string", + "description": "The resource ID of the policy definition." + }, + "policyDefinitionReferenceId": { + "type": "string", + "description": "The reference ID for the policy definition inside the initiative definition, if the policy assignment is for an initiative. May be empty." + }, + "complianceState": { + "type": "string", + "description": "The compliance state of the resource with respect to the policy assignment." + }, + "subscriptionId": { + "type": "string", + "description": "The subscription ID of the resource." + }, + "complianceReasonCode": { + "type": "string", + "description": "The compliance reason code. May be empty." + } + } + }, + "PolicyInsightsPolicyStateDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.PolicyInsights.PolicyStateDeleted event.", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The time that the resource was scanned by Azure Policy in the Universal ISO 8601 DateTime format yyyy-MM-ddTHH:mm:ss.fffffffZ." + }, + "policyAssignmentId": { + "type": "string", + "description": "The resource ID of the policy assignment." + }, + "policyDefinitionId": { + "type": "string", + "description": "The resource ID of the policy definition." + }, + "policyDefinitionReferenceId": { + "type": "string", + "description": "The reference ID for the policy definition inside the initiative definition, if the policy assignment is for an initiative. May be empty." + }, + "complianceState": { + "type": "string", + "description": "The compliance state of the resource with respect to the policy assignment." + }, + "subscriptionId": { + "type": "string", + "description": "The subscription ID of the resource." + }, + "complianceReasonCode": { + "type": "string", + "description": "The compliance reason code. May be empty." + } + } + }, + "RedisExportRDBCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Cache.ExportRDBCompleted event.", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The time at which the event occurred." + }, + "name": { + "type": "string", + "description": "The name of this event." + }, + "status": { + "type": "string", + "description": "The status of this event. Failed or succeeded" + } + } + }, + "RedisImportRDBCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Cache.ImportRDBCompleted event.", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The time at which the event occurred." + }, + "name": { + "type": "string", + "description": "The name of this event." + }, + "status": { + "type": "string", + "description": "The status of this event. Failed or succeeded" + } + } + }, + "RedisPatchingCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Cache.PatchingCompleted event.", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The time at which the event occurred." + }, + "name": { + "type": "string", + "description": "The name of this event." + }, + "status": { + "type": "string", + "description": "The status of this event. Failed or succeeded" + } + } + }, + "RedisScalingCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Cache.ScalingCompleted event.", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The time at which the event occurred." + }, + "name": { + "type": "string", + "description": "The name of this event." + }, + "status": { + "type": "string", + "description": "The status of this event. Failed or succeeded" + } + } + }, + "ResourceActionCancelEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionCancel event. This is raised when a resource action operation is canceled.", + "properties": { + "tenantId": { + "type": "string", + "description": "The tenant ID of the resource." + }, + "subscriptionId": { + "type": "string", + "description": "The subscription ID of the resource." + }, + "resourceGroup": { + "type": "string", + "description": "The resource group of the resource." + }, + "resourceProvider": { + "type": "string", + "description": "The resource provider performing the operation." + }, + "resourceUri": { + "type": "string", + "description": "The URI of the resource in the operation." + }, + "operationName": { + "type": "string", + "description": "The operation that was performed." + }, + "status": { + "type": "string", + "description": "The status of the operation." + }, + "authorization": { + "$ref": "#/definitions/ResourceAuthorization", + "description": "The requested authorization for the operation." + }, + "claims": { + "type": "object", + "description": "The properties of the claims.", + "additionalProperties": { + "type": "string" + } + }, + "correlationId": { + "type": "string", + "description": "An operation ID used for troubleshooting." + }, + "httpRequest": { + "$ref": "#/definitions/ResourceHttpRequest", + "description": "The details of the operation." + } + }, + "required": [ + "authorization", + "claims", + "httpRequest" + ] + }, + "ResourceActionFailureEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionFailure event. This is raised when a resource action operation fails.", + "properties": { + "tenantId": { + "type": "string", + "description": "The tenant ID of the resource." + }, + "subscriptionId": { + "type": "string", + "description": "The subscription ID of the resource." + }, + "resourceGroup": { + "type": "string", + "description": "The resource group of the resource." + }, + "resourceProvider": { + "type": "string", + "description": "The resource provider performing the operation." + }, + "resourceUri": { + "type": "string", + "description": "The URI of the resource in the operation." + }, + "operationName": { + "type": "string", + "description": "The operation that was performed." + }, + "status": { + "type": "string", + "description": "The status of the operation." + }, + "authorization": { + "$ref": "#/definitions/ResourceAuthorization", + "description": "The requested authorization for the operation." + }, + "claims": { + "type": "object", + "description": "The properties of the claims.", + "additionalProperties": { + "type": "string" + } + }, + "correlationId": { + "type": "string", + "description": "An operation ID used for troubleshooting." + }, + "httpRequest": { + "$ref": "#/definitions/ResourceHttpRequest", + "description": "The details of the operation." + } + }, + "required": [ + "authorization", + "claims", + "httpRequest" + ] + }, + "ResourceActionSuccessEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionSuccess event. This is raised when a resource action operation succeeds.", + "properties": { + "tenantId": { + "type": "string", + "description": "The tenant ID of the resource." + }, + "subscriptionId": { + "type": "string", + "description": "The subscription ID of the resource." + }, + "resourceGroup": { + "type": "string", + "description": "The resource group of the resource." + }, + "resourceProvider": { + "type": "string", + "description": "The resource provider performing the operation." + }, + "resourceUri": { + "type": "string", + "description": "The URI of the resource in the operation." + }, + "operationName": { + "type": "string", + "description": "The operation that was performed." + }, + "status": { + "type": "string", + "description": "The status of the operation." + }, + "authorization": { + "$ref": "#/definitions/ResourceAuthorization", + "description": "The requested authorization for the operation." + }, + "claims": { + "type": "object", + "description": "The properties of the claims.", + "additionalProperties": { + "type": "string" + } + }, + "correlationId": { + "type": "string", + "description": "An operation ID used for troubleshooting." + }, + "httpRequest": { + "$ref": "#/definitions/ResourceHttpRequest", + "description": "The details of the operation." + } + }, + "required": [ + "authorization", + "claims", + "httpRequest" + ] + }, + "ResourceAuthorization": { + "type": "object", + "description": "The details of the authorization for the resource.", + "properties": { + "scope": { + "type": "string", + "description": "The scope of the authorization." + }, + "action": { + "type": "string", + "description": "The action being requested." + }, + "evidence": { + "type": "object", + "description": "The evidence for the authorization.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "evidence" + ] + }, + "ResourceDeleteCancelEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteCancel event. This is raised when a resource delete operation is canceled.", + "properties": { + "tenantId": { + "type": "string", + "description": "The tenant ID of the resource." + }, + "subscriptionId": { + "type": "string", + "description": "The subscription ID of the resource." + }, + "resourceGroup": { + "type": "string", + "description": "The resource group of the resource." + }, + "resourceProvider": { + "type": "string", + "description": "The resource provider performing the operation." + }, + "resourceUri": { + "type": "string", + "description": "The URI of the resource in the operation." + }, + "operationName": { + "type": "string", + "description": "The operation that was performed." + }, + "status": { + "type": "string", + "description": "The status of the operation." + }, + "authorization": { + "$ref": "#/definitions/ResourceAuthorization", + "description": "The requested authorization for the operation." + }, + "claims": { + "type": "object", + "description": "The properties of the claims.", + "additionalProperties": { + "type": "string" + } + }, + "correlationId": { + "type": "string", + "description": "An operation ID used for troubleshooting." + }, + "httpRequest": { + "$ref": "#/definitions/ResourceHttpRequest", + "description": "The details of the operation." + } + }, + "required": [ + "authorization", + "claims", + "httpRequest" + ] + }, + "ResourceDeleteFailureEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteFailure event. This is raised when a resource delete operation fails.", + "properties": { + "tenantId": { + "type": "string", + "description": "The tenant ID of the resource." + }, + "subscriptionId": { + "type": "string", + "description": "The subscription ID of the resource." + }, + "resourceGroup": { + "type": "string", + "description": "The resource group of the resource." + }, + "resourceProvider": { + "type": "string", + "description": "The resource provider performing the operation." + }, + "resourceUri": { + "type": "string", + "description": "The URI of the resource in the operation." + }, + "operationName": { + "type": "string", + "description": "The operation that was performed." + }, + "status": { + "type": "string", + "description": "The status of the operation." + }, + "authorization": { + "$ref": "#/definitions/ResourceAuthorization", + "description": "The requested authorization for the operation." + }, + "claims": { + "type": "object", + "description": "The properties of the claims.", + "additionalProperties": { + "type": "string" + } + }, + "correlationId": { + "type": "string", + "description": "An operation ID used for troubleshooting." + }, + "httpRequest": { + "$ref": "#/definitions/ResourceHttpRequest", + "description": "The details of the operation." + } + }, + "required": [ + "authorization", + "claims", + "httpRequest" + ] + }, + "ResourceDeleteSuccessEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteSuccess event. This is raised when a resource delete operation succeeds.", + "properties": { + "tenantId": { + "type": "string", + "description": "The tenant ID of the resource." + }, + "subscriptionId": { + "type": "string", + "description": "The subscription ID of the resource." + }, + "resourceGroup": { + "type": "string", + "description": "The resource group of the resource." + }, + "resourceProvider": { + "type": "string", + "description": "The resource provider performing the operation." + }, + "resourceUri": { + "type": "string", + "description": "The URI of the resource in the operation." + }, + "operationName": { + "type": "string", + "description": "The operation that was performed." + }, + "status": { + "type": "string", + "description": "The status of the operation." + }, + "authorization": { + "$ref": "#/definitions/ResourceAuthorization", + "description": "The requested authorization for the operation." + }, + "claims": { + "type": "object", + "description": "The properties of the claims.", + "additionalProperties": { + "type": "string" + } + }, + "correlationId": { + "type": "string", + "description": "An operation ID used for troubleshooting." + }, + "httpRequest": { + "$ref": "#/definitions/ResourceHttpRequest", + "description": "The details of the operation." + } + }, + "required": [ + "authorization", + "claims", + "httpRequest" + ] + }, + "ResourceHttpRequest": { + "type": "object", + "description": "The details of the HTTP request.", + "properties": { + "clientRequestId": { + "type": "string", + "description": "The client request ID." + }, + "clientIpAddress": { + "type": "string", + "description": "The client IP address." + }, + "method": { + "type": "string", + "description": "The request method." + }, + "url": { + "type": "string", + "description": "The url used in the request." + } + } + }, + "ResourceNotificationsHealthResourcesAnnotatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a\nMicrosoft.ResourceNotifications.HealthResources.ResourceAnnotated event.", + "allOf": [ + { + "$ref": "#/definitions/ResourceNotificationsResourceUpdatedEventData" + } + ] + }, + "ResourceNotificationsHealthResourcesAvailabilityStatusChangedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a\nMicrosoft.ResourceNotifications.HealthResources.AvailabilityStatusChanged\nevent.", + "allOf": [ + { + "$ref": "#/definitions/ResourceNotificationsResourceUpdatedEventData" + } + ] + }, + "ResourceNotificationsOperationalDetails": { + "type": "object", + "description": "details of operational info", + "properties": { + "resourceEventTime": { + "type": "string", + "format": "date-time", + "description": "Date and Time when resource was updated" + } + } + }, + "ResourceNotificationsResourceDeletedDetails": { + "type": "object", + "description": "Describes the schema of the properties under resource info which are common\nacross all ARN system topic delete events", + "properties": { + "id": { + "type": "string", + "description": "id of the resource for which the event is being emitted" + }, + "name": { + "type": "string", + "description": "name of the resource for which the event is being emitted" + }, + "type": { + "type": "string", + "description": "the type of the resource for which the event is being emitted" + } + } + }, + "ResourceNotificationsResourceDeletedEventData": { + "type": "object", + "description": "Describes the schema of the common properties across all ARN system topic\ndelete events", + "properties": { + "resourceInfo": { + "$ref": "#/definitions/ResourceNotificationsResourceDeletedDetails", + "description": "resourceInfo details for delete event", + "x-ms-client-name": "resourceDetails" + }, + "operationalInfo": { + "$ref": "#/definitions/ResourceNotificationsOperationalDetails", + "description": "details about operational info", + "x-ms-client-name": "operationalDetails" + } + }, + "required": [ + "resourceInfo", + "operationalInfo" + ] + }, + "ResourceNotificationsResourceManagementCreatedOrUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a\nMicrosoft.ResourceNotifications.Resources.CreatedOrUpdated event.", + "allOf": [ + { + "$ref": "#/definitions/ResourceNotificationsResourceUpdatedEventData" + } + ] + }, + "ResourceNotificationsResourceManagementDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a\nMicrosoft.ResourceNotifications.Resources.Deleted event.", + "allOf": [ + { + "$ref": "#/definitions/ResourceNotificationsResourceDeletedEventData" + } + ] + }, + "ResourceNotificationsResourceUpdatedDetails": { + "type": "object", + "description": "Describes the schema of the properties under resource info which are common\nacross all ARN system topic events", + "properties": { + "id": { + "type": "string", + "description": "id of the resource for which the event is being emitted" + }, + "name": { + "type": "string", + "description": "name of the resource for which the event is being emitted" + }, + "type": { + "type": "string", + "description": "the type of the resource for which the event is being emitted" + }, + "location": { + "type": "string", + "description": "the location of the resource for which the event is being emitted" + }, + "tags": { + "type": "object", + "description": "the tags on the resource for which the event is being emitted", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "type": "object", + "description": "properties in the payload of the resource for which the event is being emitted", + "additionalProperties": {} + } + }, + "required": [ + "tags", + "properties" + ] + }, + "ResourceNotificationsResourceUpdatedEventData": { + "type": "object", + "description": "Describes the schema of the common properties across all ARN system topic events", + "properties": { + "resourceInfo": { + "$ref": "#/definitions/ResourceNotificationsResourceUpdatedDetails", + "description": "resourceInfo details for update event", + "x-ms-client-name": "resourceDetails" + }, + "operationalInfo": { + "$ref": "#/definitions/ResourceNotificationsOperationalDetails", + "description": "details about operational info", + "x-ms-client-name": "operationalDetails" + }, + "apiVersion": { + "type": "string", + "description": "api version of the resource properties bag" + } + }, + "required": [ + "resourceInfo", + "operationalInfo" + ] + }, + "ResourceWriteCancelEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteCancel event. This is raised when a resource create or update operation is canceled.", + "properties": { + "tenantId": { + "type": "string", + "description": "The tenant ID of the resource." + }, + "subscriptionId": { + "type": "string", + "description": "The subscription ID of the resource." + }, + "resourceGroup": { + "type": "string", + "description": "The resource group of the resource." + }, + "resourceProvider": { + "type": "string", + "description": "The resource provider performing the operation." + }, + "resourceUri": { + "type": "string", + "description": "The URI of the resource in the operation." + }, + "operationName": { + "type": "string", + "description": "The operation that was performed." + }, + "status": { + "type": "string", + "description": "The status of the operation." + }, + "authorization": { + "$ref": "#/definitions/ResourceAuthorization", + "description": "The requested authorization for the operation." + }, + "claims": { + "type": "object", + "description": "The properties of the claims.", + "additionalProperties": { + "type": "string" + } + }, + "correlationId": { + "type": "string", + "description": "An operation ID used for troubleshooting." + }, + "httpRequest": { + "$ref": "#/definitions/ResourceHttpRequest", + "description": "The details of the operation." + } + }, + "required": [ + "authorization", + "claims", + "httpRequest" + ] + }, + "ResourceWriteFailureEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteFailure event. This is raised when a resource create or update operation fails.", + "properties": { + "tenantId": { + "type": "string", + "description": "The tenant ID of the resource." + }, + "subscriptionId": { + "type": "string", + "description": "The subscription ID of the resource." + }, + "resourceGroup": { + "type": "string", + "description": "The resource group of the resource." + }, + "resourceProvider": { + "type": "string", + "description": "The resource provider performing the operation." + }, + "resourceUri": { + "type": "string", + "description": "The URI of the resource in the operation." + }, + "operationName": { + "type": "string", + "description": "The operation that was performed." + }, + "status": { + "type": "string", + "description": "The status of the operation." + }, + "authorization": { + "$ref": "#/definitions/ResourceAuthorization", + "description": "The requested authorization for the operation." + }, + "claims": { + "type": "object", + "description": "The properties of the claims.", + "additionalProperties": { + "type": "string" + } + }, + "correlationId": { + "type": "string", + "description": "An operation ID used for troubleshooting." + }, + "httpRequest": { + "$ref": "#/definitions/ResourceHttpRequest", + "description": "The details of the operation." + } + }, + "required": [ + "authorization", + "claims", + "httpRequest" + ] + }, + "ResourceWriteSuccessEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteSuccess event. This is raised when a resource create or update operation succeeds.", + "properties": { + "tenantId": { + "type": "string", + "description": "The tenant ID of the resource." + }, + "subscriptionId": { + "type": "string", + "description": "The subscription ID of the resource." + }, + "resourceGroup": { + "type": "string", + "description": "The resource group of the resource." + }, + "resourceProvider": { + "type": "string", + "description": "The resource provider performing the operation." + }, + "resourceUri": { + "type": "string", + "description": "The URI of the resource in the operation." + }, + "operationName": { + "type": "string", + "description": "The operation that was performed." + }, + "status": { + "type": "string", + "description": "The status of the operation." + }, + "authorization": { + "$ref": "#/definitions/ResourceAuthorization", + "description": "The requested authorization for the operation." + }, + "claims": { + "type": "object", + "description": "The properties of the claims.", + "additionalProperties": { + "type": "string" + } + }, + "correlationId": { + "type": "string", + "description": "An operation ID used for troubleshooting." + }, + "httpRequest": { + "$ref": "#/definitions/ResourceHttpRequest", + "description": "The details of the operation." + } + }, + "required": [ + "authorization", + "claims", + "httpRequest" + ] + }, + "ServiceBusActiveMessagesAvailablePeriodicNotificationsEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.ActiveMessagesAvailablePeriodicNotifications event.", + "properties": { + "namespaceName": { + "type": "string", + "description": "The namespace name of the Microsoft.ServiceBus resource." + }, + "requestUri": { + "type": "string", + "description": "The endpoint of the Microsoft.ServiceBus resource." + }, + "entityType": { + "type": "string", + "description": "The entity type of the Microsoft.ServiceBus resource. Could be one of 'queue' or 'subscriber'." + }, + "queueName": { + "type": "string", + "description": "The name of the Microsoft.ServiceBus queue. If the entity type is of type 'subscriber', then this value will be null." + }, + "topicName": { + "type": "string", + "description": "The name of the Microsoft.ServiceBus topic. If the entity type is of type 'queue', then this value will be null." + }, + "subscriptionName": { + "type": "string", + "description": "The name of the Microsoft.ServiceBus topic's subscription. If the entity type is of type 'queue', then this value will be null." + } + } + }, + "ServiceBusActiveMessagesAvailableWithNoListenersEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.ActiveMessagesAvailableWithNoListeners event.", + "properties": { + "namespaceName": { + "type": "string", + "description": "The namespace name of the Microsoft.ServiceBus resource." + }, + "requestUri": { + "type": "string", + "description": "The endpoint of the Microsoft.ServiceBus resource." + }, + "entityType": { + "type": "string", + "description": "The entity type of the Microsoft.ServiceBus resource. Could be one of 'queue' or 'subscriber'." + }, + "queueName": { + "type": "string", + "description": "The name of the Microsoft.ServiceBus queue. If the entity type is of type 'subscriber', then this value will be null." + }, + "topicName": { + "type": "string", + "description": "The name of the Microsoft.ServiceBus topic. If the entity type is of type 'queue', then this value will be null." + }, + "subscriptionName": { + "type": "string", + "description": "The name of the Microsoft.ServiceBus topic's subscription. If the entity type is of type 'queue', then this value will be null." + } + } + }, + "ServiceBusDeadletterMessagesAvailablePeriodicNotificationsEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.DeadletterMessagesAvailablePeriodicNotifications event.", + "properties": { + "namespaceName": { + "type": "string", + "description": "The namespace name of the Microsoft.ServiceBus resource." + }, + "requestUri": { + "type": "string", + "description": "The endpoint of the Microsoft.ServiceBus resource." + }, + "entityType": { + "type": "string", + "description": "The entity type of the Microsoft.ServiceBus resource. Could be one of 'queue' or 'subscriber'." + }, + "queueName": { + "type": "string", + "description": "The name of the Microsoft.ServiceBus queue. If the entity type is of type 'subscriber', then this value will be null." + }, + "topicName": { + "type": "string", + "description": "The name of the Microsoft.ServiceBus topic. If the entity type is of type 'queue', then this value will be null." + }, + "subscriptionName": { + "type": "string", + "description": "The name of the Microsoft.ServiceBus topic's subscription. If the entity type is of type 'queue', then this value will be null." + } + } + }, + "ServiceBusDeadletterMessagesAvailableWithNoListenersEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.DeadletterMessagesAvailableWithNoListeners event.", + "properties": { + "namespaceName": { + "type": "string", + "description": "The namespace name of the Microsoft.ServiceBus resource." + }, + "requestUri": { + "type": "string", + "description": "The endpoint of the Microsoft.ServiceBus resource." + }, + "entityType": { + "type": "string", + "description": "The entity type of the Microsoft.ServiceBus resource. Could be one of 'queue' or 'subscriber'." + }, + "queueName": { + "type": "string", + "description": "The name of the Microsoft.ServiceBus queue. If the entity type is of type 'subscriber', then this value will be null." + }, + "topicName": { + "type": "string", + "description": "The name of the Microsoft.ServiceBus topic. If the entity type is of type 'queue', then this value will be null." + }, + "subscriptionName": { + "type": "string", + "description": "The name of the Microsoft.ServiceBus topic's subscription. If the entity type is of type 'queue', then this value will be null." + } + } + }, + "SignalRServiceClientConnectionConnectedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.SignalRService.ClientConnectionConnected event.", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The time at which the event occurred." + }, + "hubName": { + "type": "string", + "description": "The hub of connected client connection." + }, + "connectionId": { + "type": "string", + "description": "The connection Id of connected client connection." + }, + "userId": { + "type": "string", + "description": "The user Id of connected client connection." + } + } + }, + "SignalRServiceClientConnectionDisconnectedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.SignalRService.ClientConnectionDisconnected event.", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The time at which the event occurred." + }, + "hubName": { + "type": "string", + "description": "The hub of connected client connection." + }, + "connectionId": { + "type": "string", + "description": "The connection Id of connected client connection." + }, + "userId": { + "type": "string", + "description": "The user Id of connected client connection." + }, + "errorMessage": { + "type": "string", + "description": "The message of error that cause the client connection disconnected." + } + } + }, + "StampKind": { + "type": "string", + "description": "Kind of environment where app service plan is.", + "enum": [ + "Public", + "AseV1", + "AseV2" + ], + "x-ms-enum": { + "name": "StampKind", + "modelAsString": true, + "values": [ + { + "name": "Public", + "value": "Public", + "description": "App Service Plan is running on a public stamp." + }, + { + "name": "AseV1", + "value": "AseV1", + "description": "App Service Plan is running on an App Service Environment V1." + }, + { + "name": "AseV2", + "value": "AseV2", + "description": "App Service Plan is running on an App Service Environment V2." + } + ] + } + }, + "StorageAsyncOperationInitiatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.AsyncOperationInitiated event.", + "properties": { + "api": { + "type": "string", + "description": "The name of the API/operation that triggered this event." + }, + "clientRequestId": { + "type": "string", + "description": "A request id provided by the client of the storage API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the storage service for the storage API operation that triggered this event." + }, + "contentType": { + "type": "string", + "description": "The content type of the blob. This is the same as what would be returned in the Content-Type header from the blob." + }, + "contentLength": { + "type": "integer", + "format": "int64", + "description": "The size of the blob in bytes. This is the same as what would be returned in the Content-Length header from the blob." + }, + "blobType": { + "type": "string", + "description": "The type of blob." + }, + "url": { + "type": "string", + "description": "The path to the blob." + }, + "sequencer": { + "type": "string", + "description": "An opaque string value representing the logical sequence of events for any particular blob name. Users can use standard string comparison to understand the relative sequence of two events on the same blob name." + }, + "identity": { + "type": "string", + "description": "The identity of the requester that triggered this event." + }, + "storageDiagnostics": { + "type": "object", + "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", + "additionalProperties": {} + } + }, + "required": [ + "storageDiagnostics" + ] + }, + "StorageBlobCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.BlobCreated event.", + "properties": { + "api": { + "type": "string", + "description": "The name of the API/operation that triggered this event." + }, + "clientRequestId": { + "type": "string", + "description": "A request id provided by the client of the storage API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the storage service for the storage API operation that triggered this event." + }, + "eTag": { + "type": "string", + "description": "The etag of the blob at the time this event was triggered." + }, + "contentType": { + "type": "string", + "description": "The content type of the blob. This is the same as what would be returned in the Content-Type header from the blob." + }, + "contentLength": { + "type": "integer", + "format": "int64", + "description": "The size of the blob in bytes. This is the same as what would be returned in the Content-Length header from the blob." + }, + "contentOffset": { + "type": "integer", + "format": "int64", + "description": "The offset of the blob in bytes." + }, + "blobType": { + "type": "string", + "description": "The type of blob." + }, + "url": { + "type": "string", + "description": "The path to the blob." + }, + "sequencer": { + "type": "string", + "description": "An opaque string value representing the logical sequence of events for any particular blob name. Users can use standard string comparison to understand the relative sequence of two events on the same blob name." + }, + "identity": { + "type": "string", + "description": "The identity of the requester that triggered this event." + }, + "storageDiagnostics": { + "type": "object", + "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", + "additionalProperties": {} + } + }, + "required": [ + "storageDiagnostics" + ] + }, + "StorageBlobDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.BlobDeleted event.", + "properties": { + "api": { + "type": "string", + "description": "The name of the API/operation that triggered this event." + }, + "clientRequestId": { + "type": "string", + "description": "A request id provided by the client of the storage API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the storage service for the storage API operation that triggered this event." + }, + "contentType": { + "type": "string", + "description": "The content type of the blob. This is the same as what would be returned in the Content-Type header from the blob." + }, + "blobType": { + "type": "string", + "description": "The type of blob." + }, + "url": { + "type": "string", + "description": "The path to the blob." + }, + "sequencer": { + "type": "string", + "description": "An opaque string value representing the logical sequence of events for any particular blob name. Users can use standard string comparison to understand the relative sequence of two events on the same blob name." + }, + "identity": { + "type": "string", + "description": "The identity of the requester that triggered this event." + }, + "storageDiagnostics": { + "type": "object", + "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", + "additionalProperties": {} + } + }, + "required": [ + "storageDiagnostics" + ] + }, + "StorageBlobInventoryPolicyCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Storage.BlobInventoryPolicyCompleted event.", + "properties": { + "scheduleDateTime": { + "type": "string", + "format": "date-time", + "description": "The time at which inventory policy was scheduled." + }, + "accountName": { + "type": "string", + "description": "The account name for which inventory policy is registered." + }, + "ruleName": { + "type": "string", + "description": "The rule name for inventory policy." + }, + "policyRunStatus": { + "type": "string", + "description": "The status of inventory run, it can be Succeeded/PartiallySucceeded/Failed." + }, + "policyRunStatusMessage": { + "type": "string", + "description": "The status message for inventory run." + }, + "policyRunId": { + "type": "string", + "description": "The policy run id for inventory run." + }, + "manifestBlobUrl": { + "type": "string", + "description": "The blob URL for manifest file for inventory run." + } + } + }, + "StorageBlobRenamedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.BlobRenamed event.", + "properties": { + "api": { + "type": "string", + "description": "The name of the API/operation that triggered this event." + }, + "clientRequestId": { + "type": "string", + "description": "A request id provided by the client of the storage API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the storage service for the storage API operation that triggered this event." + }, + "sourceUrl": { + "type": "string", + "description": "The path to the blob that was renamed." + }, + "destinationUrl": { + "type": "string", + "description": "The new path to the blob after the rename operation." + }, + "sequencer": { + "type": "string", + "description": "An opaque string value representing the logical sequence of events for any particular blob name. Users can use standard string comparison to understand the relative sequence of two events on the same blob name." + }, + "identity": { + "type": "string", + "description": "The identity of the requester that triggered this event." + }, + "storageDiagnostics": { + "type": "object", + "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", + "additionalProperties": {} + } + }, + "required": [ + "storageDiagnostics" + ] + }, + "StorageBlobTierChangedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.BlobTierChanged event.", + "properties": { + "api": { + "type": "string", + "description": "The name of the API/operation that triggered this event." + }, + "clientRequestId": { + "type": "string", + "description": "A request id provided by the client of the storage API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the storage service for the storage API operation that triggered this event." + }, + "contentType": { + "type": "string", + "description": "The content type of the blob. This is the same as what would be returned in the Content-Type header from the blob." + }, + "contentLength": { + "type": "integer", + "format": "int64", + "description": "The size of the blob in bytes. This is the same as what would be returned in the Content-Length header from the blob." + }, + "blobType": { + "type": "string", + "description": "The type of blob." + }, + "url": { + "type": "string", + "description": "The path to the blob." + }, + "sequencer": { + "type": "string", + "description": "An opaque string value representing the logical sequence of events for any particular blob name. Users can use standard string comparison to understand the relative sequence of two events on the same blob name." + }, + "identity": { + "type": "string", + "description": "The identity of the requester that triggered this event." + }, + "storageDiagnostics": { + "type": "object", + "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", + "additionalProperties": {} + } + }, + "required": [ + "storageDiagnostics" + ] + }, + "StorageDirectoryCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.DirectoryCreated event.", + "properties": { + "api": { + "type": "string", + "description": "The name of the API/operation that triggered this event." + }, + "clientRequestId": { + "type": "string", + "description": "A request id provided by the client of the storage API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the storage service for the storage API operation that triggered this event." + }, + "eTag": { + "type": "string", + "description": "The etag of the directory at the time this event was triggered." + }, + "url": { + "type": "string", + "description": "The path to the directory." + }, + "sequencer": { + "type": "string", + "description": "An opaque string value representing the logical sequence of events for any particular directory name. Users can use standard string comparison to understand the relative sequence of two events on the same directory name." + }, + "identity": { + "type": "string", + "description": "The identity of the requester that triggered this event." + }, + "storageDiagnostics": { + "type": "object", + "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", + "additionalProperties": {} + } + }, + "required": [ + "storageDiagnostics" + ] + }, + "StorageDirectoryDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.DirectoryDeleted event.", + "properties": { + "api": { + "type": "string", + "description": "The name of the API/operation that triggered this event." + }, + "clientRequestId": { + "type": "string", + "description": "A request id provided by the client of the storage API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the storage service for the storage API operation that triggered this event." + }, + "url": { + "type": "string", + "description": "The path to the deleted directory." + }, + "recursive": { + "type": "string", + "description": "Is this event for a recursive delete operation." + }, + "sequencer": { + "type": "string", + "description": "An opaque string value representing the logical sequence of events for any particular directory name. Users can use standard string comparison to understand the relative sequence of two events on the same directory name." + }, + "identity": { + "type": "string", + "description": "The identity of the requester that triggered this event." + }, + "storageDiagnostics": { + "type": "object", + "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", + "additionalProperties": {} + } + }, + "required": [ + "storageDiagnostics" + ] + }, + "StorageDirectoryRenamedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.DirectoryRenamed event.", + "properties": { + "api": { + "type": "string", + "description": "The name of the API/operation that triggered this event." + }, + "clientRequestId": { + "type": "string", + "description": "A request id provided by the client of the storage API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the storage service for the storage API operation that triggered this event." + }, + "sourceUrl": { + "type": "string", + "description": "The path to the directory that was renamed." + }, + "destinationUrl": { + "type": "string", + "description": "The new path to the directory after the rename operation." + }, + "sequencer": { + "type": "string", + "description": "An opaque string value representing the logical sequence of events for any particular directory name. Users can use standard string comparison to understand the relative sequence of two events on the same directory name." + }, + "identity": { + "type": "string", + "description": "The identity of the requester that triggered this event." + }, + "storageDiagnostics": { + "type": "object", + "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", + "additionalProperties": {} + } + }, + "required": [ + "storageDiagnostics" + ] + }, + "StorageLifecyclePolicyActionSummaryDetail": { + "type": "object", + "description": "Execution statistics of a specific policy action in a Blob Management cycle.", + "properties": { + "totalObjectsCount": { + "type": "integer", + "format": "int64", + "description": "Total number of objects to be acted on by this action." + }, + "successCount": { + "type": "integer", + "format": "int64", + "description": "Number of success operations of this action." + }, + "errorList": { + "type": "string", + "description": "Error messages of this action if any." + } + } + }, + "StorageLifecyclePolicyCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.LifecyclePolicyCompleted event.", + "properties": { + "scheduleTime": { + "type": "string", + "description": "The time the policy task was scheduled." + }, + "deleteSummary": { + "$ref": "#/definitions/StorageLifecyclePolicyActionSummaryDetail", + "description": "Execution statistics of a specific policy action in a Blob Management cycle." + }, + "tierToCoolSummary": { + "$ref": "#/definitions/StorageLifecyclePolicyActionSummaryDetail", + "description": "Execution statistics of a specific policy action in a Blob Management cycle." + }, + "tierToArchiveSummary": { + "$ref": "#/definitions/StorageLifecyclePolicyActionSummaryDetail", + "description": "Execution statistics of a specific policy action in a Blob Management cycle." + } + }, + "required": [ + "deleteSummary", + "tierToCoolSummary", + "tierToArchiveSummary" + ] + }, + "StorageTaskAssignmentCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskAssignmentCompleted event.", + "properties": { + "status": { + "$ref": "#/definitions/StorageTaskAssignmentCompletedStatus", + "description": "The status for a storage task." + }, + "completedDateTime": { + "type": "string", + "format": "date-time", + "description": "The time at which a storage task was completed.", + "x-ms-client-name": "completedOn" + }, + "taskExecutionId": { + "type": "string", + "description": "The execution id for a storage task." + }, + "taskName": { + "type": "string", + "description": "The task name for a storage task." + }, + "summaryReportBlobUrl": { + "type": "string", + "format": "uri", + "description": "The summary report blob url for a storage task", + "x-ms-client-name": "summaryReportBlobUri" + } + }, + "required": [ + "summaryReportBlobUrl" + ] + }, + "StorageTaskAssignmentCompletedStatus": { + "type": "string", + "description": "The status for a storage task.", + "enum": [ + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "StorageTaskAssignmentCompletedStatus", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Succeeded" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed" + } + ] + } + }, + "StorageTaskAssignmentQueuedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskAssignmentQueued event.", + "properties": { + "queuedDateTime": { + "type": "string", + "format": "date-time", + "description": "The time at which a storage task was queued.", + "x-ms-client-name": "queuedOn" + }, + "taskExecutionId": { + "type": "string", + "description": "The execution id for a storage task." + } + } + }, + "StorageTaskCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskCompleted event.", + "properties": { + "status": { + "$ref": "#/definitions/StorageTaskCompletedStatus", + "description": "The status for a storage task." + }, + "completedDateTime": { + "type": "string", + "format": "date-time", + "description": "The time at which a storage task was completed." + }, + "taskExecutionId": { + "type": "string", + "description": "The execution id for a storage task." + }, + "taskName": { + "type": "string", + "description": "The task name for a storage task." + }, + "summaryReportBlobUrl": { + "type": "string", + "format": "uri", + "description": "The summary report blob url for a storage task" + } + }, + "required": [ + "summaryReportBlobUrl" + ] + }, + "StorageTaskCompletedStatus": { + "type": "string", + "description": "The status for a storage task.", + "enum": [ + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "StorageTaskCompletedStatus", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Succeeded" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed" + } + ] + } + }, + "StorageTaskQueuedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskQueued event.", + "properties": { + "queuedDateTime": { + "type": "string", + "format": "date-time", + "description": "The time at which a storage task was queued." + }, + "taskExecutionId": { + "type": "string", + "description": "The execution id for a storage task." + } + } + }, + "SubscriptionDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a\nMicrosoft.EventGrid.SubscriptionDeletedEvent event.", + "properties": { + "eventSubscriptionId": { + "type": "string", + "description": "The Azure resource ID of the deleted event subscription." + } + } + }, + "SubscriptionValidationEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.EventGrid.SubscriptionValidationEvent event.", + "properties": { + "validationCode": { + "type": "string", + "description": "The validation code sent by Azure Event Grid to validate an event subscription.\nTo complete the validation handshake, the subscriber must either respond with this validation code as part of the validation response,\nor perform a GET request on the validationUrl (available starting version 2018-05-01-preview)." + }, + "validationUrl": { + "type": "string", + "description": "The validation URL sent by Azure Event Grid (available starting version 2018-05-01-preview).\nTo complete the validation handshake, the subscriber must either respond with the validationCode as part of the validation response,\nor perform a GET request on the validationUrl (available starting version 2018-05-01-preview)." + } + } + }, + "SubscriptionValidationResponse": { + "type": "object", + "description": "To complete an event subscription validation handshake, a subscriber can use\neither the validationCode or the validationUrl received in a\nSubscriptionValidationEvent. When the validationCode is used, the\nSubscriptionValidationResponse can be used to build the response.", + "properties": { + "validationResponse": { + "type": "string", + "description": "The validation response sent by the subscriber to Azure Event Grid to complete the validation of an event subscription." + } + } + }, + "WebAppServicePlanUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.AppServicePlanUpdated event.", + "properties": { + "appServicePlanEventTypeDetail": { + "$ref": "#/definitions/AppServicePlanEventTypeDetail", + "description": "Detail of action on the app service plan." + }, + "sku": { + "$ref": "#/definitions/WebAppServicePlanUpdatedEventDataSku", + "description": "sku of app service plan." + }, + "name": { + "type": "string", + "description": "name of the app service plan that had this event." + }, + "clientRequestId": { + "type": "string", + "description": "The client request id generated by the app service for the app service plan API operation that triggered this event." + }, + "correlationRequestId": { + "type": "string", + "description": "The correlation request id generated by the app service for the app service plan API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the app service for the app service plan API operation that triggered this event." + }, + "address": { + "type": "string", + "description": "HTTP request URL of this operation." + }, + "verb": { + "type": "string", + "description": "HTTP verb of this operation." + } + }, + "required": [ + "appServicePlanEventTypeDetail", + "sku" + ] + }, + "WebAppServicePlanUpdatedEventDataSku": { + "type": "object", + "description": "sku of app service plan.", + "properties": { + "name": { + "type": "string", + "description": "name of app service plan sku." + }, + "Tier": { + "type": "string", + "description": "tier of app service plan sku." + }, + "Size": { + "type": "string", + "description": "size of app service plan sku." + }, + "Family": { + "type": "string", + "description": "family of app service plan sku." + }, + "Capacity": { + "type": "string", + "description": "capacity of app service plan sku." + } + } + }, + "WebAppUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.AppUpdated event.", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail", + "description": "Detail of action on the app." + }, + "name": { + "type": "string", + "description": "name of the web site that had this event." + }, + "clientRequestId": { + "type": "string", + "description": "The client request id generated by the app service for the site API operation that triggered this event." + }, + "correlationRequestId": { + "type": "string", + "description": "The correlation request id generated by the app service for the site API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the app service for the site API operation that triggered this event." + }, + "address": { + "type": "string", + "description": "HTTP request URL of this operation." + }, + "verb": { + "type": "string", + "description": "HTTP verb of this operation." + } + }, + "required": [ + "appEventTypeDetail" + ] + }, + "WebBackupOperationCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.BackupOperationCompleted event.", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail", + "description": "Detail of action on the app." + }, + "name": { + "type": "string", + "description": "name of the web site that had this event." + }, + "clientRequestId": { + "type": "string", + "description": "The client request id generated by the app service for the site API operation that triggered this event." + }, + "correlationRequestId": { + "type": "string", + "description": "The correlation request id generated by the app service for the site API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the app service for the site API operation that triggered this event." + }, + "address": { + "type": "string", + "description": "HTTP request URL of this operation." + }, + "verb": { + "type": "string", + "description": "HTTP verb of this operation." + } + }, + "required": [ + "appEventTypeDetail" + ] + }, + "WebBackupOperationFailedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.BackupOperationFailed event.", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail", + "description": "Detail of action on the app." + }, + "name": { + "type": "string", + "description": "name of the web site that had this event." + }, + "clientRequestId": { + "type": "string", + "description": "The client request id generated by the app service for the site API operation that triggered this event." + }, + "correlationRequestId": { + "type": "string", + "description": "The correlation request id generated by the app service for the site API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the app service for the site API operation that triggered this event." + }, + "address": { + "type": "string", + "description": "HTTP request URL of this operation." + }, + "verb": { + "type": "string", + "description": "HTTP verb of this operation." + } + }, + "required": [ + "appEventTypeDetail" + ] + }, + "WebBackupOperationStartedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.BackupOperationStarted event.", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail", + "description": "Detail of action on the app." + }, + "name": { + "type": "string", + "description": "name of the web site that had this event." + }, + "clientRequestId": { + "type": "string", + "description": "The client request id generated by the app service for the site API operation that triggered this event." + }, + "correlationRequestId": { + "type": "string", + "description": "The correlation request id generated by the app service for the site API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the app service for the site API operation that triggered this event." + }, + "address": { + "type": "string", + "description": "HTTP request URL of this operation." + }, + "verb": { + "type": "string", + "description": "HTTP verb of this operation." + } + }, + "required": [ + "appEventTypeDetail" + ] + }, + "WebRestoreOperationCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.RestoreOperationCompleted event.", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail", + "description": "Detail of action on the app." + }, + "name": { + "type": "string", + "description": "name of the web site that had this event." + }, + "clientRequestId": { + "type": "string", + "description": "The client request id generated by the app service for the site API operation that triggered this event." + }, + "correlationRequestId": { + "type": "string", + "description": "The correlation request id generated by the app service for the site API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the app service for the site API operation that triggered this event." + }, + "address": { + "type": "string", + "description": "HTTP request URL of this operation." + }, + "verb": { + "type": "string", + "description": "HTTP verb of this operation." + } + }, + "required": [ + "appEventTypeDetail" + ] + }, + "WebRestoreOperationFailedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.RestoreOperationFailed event.", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail", + "description": "Detail of action on the app." + }, + "name": { + "type": "string", + "description": "name of the web site that had this event." + }, + "clientRequestId": { + "type": "string", + "description": "The client request id generated by the app service for the site API operation that triggered this event." + }, + "correlationRequestId": { + "type": "string", + "description": "The correlation request id generated by the app service for the site API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the app service for the site API operation that triggered this event." + }, + "address": { + "type": "string", + "description": "HTTP request URL of this operation." + }, + "verb": { + "type": "string", + "description": "HTTP verb of this operation." + } + }, + "required": [ + "appEventTypeDetail" + ] + }, + "WebRestoreOperationStartedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.RestoreOperationStarted event.", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail", + "description": "Detail of action on the app." + }, + "name": { + "type": "string", + "description": "name of the web site that had this event." + }, + "clientRequestId": { + "type": "string", + "description": "The client request id generated by the app service for the site API operation that triggered this event." + }, + "correlationRequestId": { + "type": "string", + "description": "The correlation request id generated by the app service for the site API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the app service for the site API operation that triggered this event." + }, + "address": { + "type": "string", + "description": "HTTP request URL of this operation." + }, + "verb": { + "type": "string", + "description": "HTTP verb of this operation." + } + }, + "required": [ + "appEventTypeDetail" + ] + }, + "WebSlotSwapCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.SlotSwapCompleted event.", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail", + "description": "Detail of action on the app." + }, + "name": { + "type": "string", + "description": "name of the web site that had this event." + }, + "clientRequestId": { + "type": "string", + "description": "The client request id generated by the app service for the site API operation that triggered this event." + }, + "correlationRequestId": { + "type": "string", + "description": "The correlation request id generated by the app service for the site API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the app service for the site API operation that triggered this event." + }, + "address": { + "type": "string", + "description": "HTTP request URL of this operation." + }, + "verb": { + "type": "string", + "description": "HTTP verb of this operation." + } + }, + "required": [ + "appEventTypeDetail" + ] + }, + "WebSlotSwapFailedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.SlotSwapFailed event.", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail", + "description": "Detail of action on the app." + }, + "name": { + "type": "string", + "description": "name of the web site that had this event." + }, + "clientRequestId": { + "type": "string", + "description": "The client request id generated by the app service for the site API operation that triggered this event." + }, + "correlationRequestId": { + "type": "string", + "description": "The correlation request id generated by the app service for the site API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the app service for the site API operation that triggered this event." + }, + "address": { + "type": "string", + "description": "HTTP request URL of this operation." + }, + "verb": { + "type": "string", + "description": "HTTP verb of this operation." + } + }, + "required": [ + "appEventTypeDetail" + ] + }, + "WebSlotSwapStartedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.SlotSwapStarted event.", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail", + "description": "Detail of action on the app." + }, + "name": { + "type": "string", + "description": "name of the web site that had this event." + }, + "clientRequestId": { + "type": "string", + "description": "The client request id generated by the app service for the site API operation that triggered this event." + }, + "correlationRequestId": { + "type": "string", + "description": "The correlation request id generated by the app service for the site API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the app service for the site API operation that triggered this event." + }, + "address": { + "type": "string", + "description": "HTTP request URL of this operation." + }, + "verb": { + "type": "string", + "description": "HTTP verb of this operation." + } + }, + "required": [ + "appEventTypeDetail" + ] + }, + "WebSlotSwapWithPreviewCancelledEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.SlotSwapWithPreviewCancelled event.", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail", + "description": "Detail of action on the app." + }, + "name": { + "type": "string", + "description": "name of the web site that had this event." + }, + "clientRequestId": { + "type": "string", + "description": "The client request id generated by the app service for the site API operation that triggered this event." + }, + "correlationRequestId": { + "type": "string", + "description": "The correlation request id generated by the app service for the site API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the app service for the site API operation that triggered this event." + }, + "address": { + "type": "string", + "description": "HTTP request URL of this operation." + }, + "verb": { + "type": "string", + "description": "HTTP verb of this operation." + } + }, + "required": [ + "appEventTypeDetail" + ] + }, + "WebSlotSwapWithPreviewStartedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.SlotSwapWithPreviewStarted event.", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail", + "description": "Detail of action on the app." + }, + "name": { + "type": "string", + "description": "name of the web site that had this event." + }, + "clientRequestId": { + "type": "string", + "description": "The client request id generated by the app service for the site API operation that triggered this event." + }, + "correlationRequestId": { + "type": "string", + "description": "The correlation request id generated by the app service for the site API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the app service for the site API operation that triggered this event." + }, + "address": { + "type": "string", + "description": "HTTP request URL of this operation." + }, + "verb": { + "type": "string", + "description": "HTTP verb of this operation." + } + }, + "required": [ + "appEventTypeDetail" + ] + }, + "recordingChannelType": { + "type": "string", + "description": "Recording channel type", + "enum": [ + "Mixed", + "Unmixed" + ], + "x-ms-enum": { + "name": "recordingChannelType", + "modelAsString": true, + "values": [ + { + "name": "Mixed", + "value": "Mixed", + "description": "Mixed channel type" + }, + { + "name": "Unmixed", + "value": "Unmixed", + "description": "Unmixed channel type" + } + ] + } + }, + "recordingContentType": { + "type": "string", + "description": "Recording content type", + "enum": [ + "AudioVideo", + "Audio" + ], + "x-ms-enum": { + "name": "recordingContentType", + "modelAsString": true, + "values": [ + { + "name": "AudioVideo", + "value": "AudioVideo", + "description": "AudioVideo content type" + }, + { + "name": "Audio", + "value": "Audio", + "description": "Audio content type" + } + ] + } + }, + "recordingFormatType": { + "type": "string", + "description": "Recording format type", + "enum": [ + "Wav", + "Mp3", + "Mp4" + ], + "x-ms-enum": { + "name": "recordingFormatType", + "modelAsString": true, + "values": [ + { + "name": "Wav", + "value": "Wav", + "description": "WAV format" + }, + { + "name": "Mp3", + "value": "Mp3", + "description": "MP3 format" + }, + { + "name": "Mp4", + "value": "Mp4", + "description": "MP4 format" + } + ] + } + } + }, + "parameters": {} +} 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 new file mode 100644 index 000000000000..3de7019fb636 --- /dev/null +++ b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/GeneratedSystemEvents.json @@ -0,0 +1,9400 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure.Messaging.SystemEvents", + "version": "2024-01-01", + "description": "Azure Messaging EventGrid SystemEvents", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "tags": [], + "paths": {}, + "definitions": { + "AcsChatEventBaseProperties": { + "type": "object", + "description": "Schema of common properties of all chat events", + "properties": { + "recipientCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the target user" + }, + "transactionId": { + "type": "string", + "description": "The transaction id will be used as co-relation vector" + }, + "threadId": { + "type": "string", + "description": "The chat thread id" + } + }, + "required": [ + "recipientCommunicationIdentifier" + ] + }, + "AcsChatEventInThreadBaseProperties": { + "type": "object", + "description": "Schema of common properties of all thread-level chat events", + "properties": { + "transactionId": { + "type": "string", + "description": "The transaction id will be used as co-relation vector" + }, + "threadId": { + "type": "string", + "description": "The chat thread id" + } + } + }, + "AcsChatMessageDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageDeleted event.", + "properties": { + "deleteTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the message was deleted" + } + }, + "required": [ + "deleteTime" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatMessageEventBaseProperties" + } + ] + }, + "AcsChatMessageDeletedInThreadEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageDeletedInThread event.", + "properties": { + "deleteTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the message was deleted" + } + }, + "required": [ + "deleteTime" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatMessageEventInThreadBaseProperties" + } + ] + }, + "AcsChatMessageEditedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageEdited event.", + "properties": { + "messageBody": { + "type": "string", + "description": "The body of the chat message" + }, + "metadata": { + "type": "object", + "description": "The chat message metadata", + "additionalProperties": { + "type": "string" + } + }, + "editTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the message was edited" + } + }, + "required": [ + "metadata", + "editTime" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatMessageEventBaseProperties" + } + ] + }, + "AcsChatMessageEditedInThreadEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageEditedInThread event.", + "properties": { + "messageBody": { + "type": "string", + "description": "The body of the chat message" + }, + "metadata": { + "type": "object", + "description": "The chat message metadata", + "additionalProperties": { + "type": "string" + } + }, + "editTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the message was edited" + } + }, + "required": [ + "metadata", + "editTime" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatMessageEventInThreadBaseProperties" + } + ] + }, + "AcsChatMessageEventBaseProperties": { + "type": "object", + "description": "Schema of common properties of all chat message events", + "properties": { + "messageId": { + "type": "string", + "description": "The chat message id" + }, + "senderCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the sender" + }, + "senderDisplayName": { + "type": "string", + "description": "The display name of the sender" + }, + "composeTime": { + "type": "string", + "format": "date-time", + "description": "The original compose time of the message" + }, + "type": { + "type": "string", + "description": "The type of the message" + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the message" + } + }, + "required": [ + "senderCommunicationIdentifier", + "composeTime" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatEventBaseProperties" + } + ] + }, + "AcsChatMessageEventInThreadBaseProperties": { + "type": "object", + "description": "Schema of common properties of all thread-level chat message events", + "properties": { + "messageId": { + "type": "string", + "description": "The chat message id" + }, + "senderCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the sender" + }, + "senderDisplayName": { + "type": "string", + "description": "The display name of the sender" + }, + "composeTime": { + "type": "string", + "format": "date-time", + "description": "The original compose time of the message" + }, + "type": { + "type": "string", + "description": "The type of the message" + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the message" + } + }, + "required": [ + "senderCommunicationIdentifier", + "composeTime" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatEventInThreadBaseProperties" + } + ] + }, + "AcsChatMessageReceivedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageReceived event.", + "properties": { + "messageBody": { + "type": "string", + "description": "The body of the chat message" + }, + "metadata": { + "type": "object", + "description": "The chat message metadata", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "metadata" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatMessageEventBaseProperties" + } + ] + }, + "AcsChatMessageReceivedInThreadEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageReceivedInThread event.", + "properties": { + "messageBody": { + "type": "string", + "description": "The body of the chat message" + }, + "metadata": { + "type": "object", + "description": "The chat message metadata", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "metadata" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatMessageEventInThreadBaseProperties" + } + ] + }, + "AcsChatParticipantAddedToThreadEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadParticipantAdded event.", + "properties": { + "time": { + "type": "string", + "format": "date-time", + "description": "The time at which the user was added to the thread" + }, + "addedByCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the user who added the user" + }, + "participantAdded": { + "$ref": "#/definitions/AcsChatThreadParticipantProperties", + "description": "The details of the user who was added" + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the thread" + } + }, + "required": [ + "time", + "addedByCommunicationIdentifier", + "participantAdded" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatEventInThreadBaseProperties" + } + ] + }, + "AcsChatParticipantAddedToThreadWithUserEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatParticipantAddedToThreadWithUser event.", + "properties": { + "time": { + "type": "string", + "format": "date-time", + "description": "The time at which the user was added to the thread" + }, + "addedByCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the user who added the user" + }, + "participantAdded": { + "$ref": "#/definitions/AcsChatThreadParticipantProperties", + "description": "The details of the user who was added" + } + }, + "required": [ + "time", + "addedByCommunicationIdentifier", + "participantAdded" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatThreadEventBaseProperties" + } + ] + }, + "AcsChatParticipantRemovedFromThreadEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadParticipantRemoved event.", + "properties": { + "time": { + "type": "string", + "format": "date-time", + "description": "The time at which the user was removed to the thread" + }, + "removedByCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the user who removed the user" + }, + "participantRemoved": { + "$ref": "#/definitions/AcsChatThreadParticipantProperties", + "description": "The details of the user who was removed" + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the thread" + } + }, + "required": [ + "time", + "removedByCommunicationIdentifier", + "participantRemoved" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatEventInThreadBaseProperties" + } + ] + }, + "AcsChatParticipantRemovedFromThreadWithUserEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatParticipantRemovedFromThreadWithUser event.", + "properties": { + "time": { + "type": "string", + "format": "date-time", + "description": "The time at which the user was removed to the thread" + }, + "removedByCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the user who removed the user" + }, + "participantRemoved": { + "$ref": "#/definitions/AcsChatThreadParticipantProperties", + "description": "The details of the user who was removed" + } + }, + "required": [ + "time", + "removedByCommunicationIdentifier", + "participantRemoved" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatThreadEventBaseProperties" + } + ] + }, + "AcsChatThreadCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadCreated event.", + "properties": { + "createdByCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the user who created the thread" + }, + "properties": { + "type": "object", + "description": "The thread properties", + "additionalProperties": {} + }, + "metadata": { + "type": "object", + "description": "The thread metadata", + "additionalProperties": { + "type": "string" + } + }, + "participants": { + "type": "array", + "description": "The list of properties of participants who are part of the thread", + "items": { + "$ref": "#/definitions/AcsChatThreadParticipantProperties" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "createdByCommunicationIdentifier", + "properties", + "metadata", + "participants" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatThreadEventInThreadBaseProperties" + } + ] + }, + "AcsChatThreadCreatedWithUserEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadCreatedWithUser event.", + "properties": { + "createdByCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the user who created the thread" + }, + "properties": { + "type": "object", + "description": "The thread properties", + "additionalProperties": {} + }, + "metadata": { + "type": "object", + "description": "The thread metadata", + "additionalProperties": { + "type": "string" + } + }, + "participants": { + "type": "array", + "description": "The list of properties of participants who are part of the thread", + "items": { + "$ref": "#/definitions/AcsChatThreadParticipantProperties" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "createdByCommunicationIdentifier", + "properties", + "metadata", + "participants" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatThreadEventBaseProperties" + } + ] + }, + "AcsChatThreadDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadDeleted event.", + "properties": { + "deletedByCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the user who deleted the thread" + }, + "deleteTime": { + "type": "string", + "format": "date-time", + "description": "The deletion time of the thread" + } + }, + "required": [ + "deletedByCommunicationIdentifier", + "deleteTime" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatThreadEventInThreadBaseProperties" + } + ] + }, + "AcsChatThreadEventBaseProperties": { + "type": "object", + "description": "Schema of common properties of all chat thread events", + "properties": { + "createTime": { + "type": "string", + "format": "date-time", + "description": "The original creation time of the thread" + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the thread" + } + }, + "required": [ + "createTime" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatEventBaseProperties" + } + ] + }, + "AcsChatThreadEventInThreadBaseProperties": { + "type": "object", + "description": "Schema of common properties of all chat thread events", + "properties": { + "createTime": { + "type": "string", + "format": "date-time", + "description": "The original creation time of the thread" + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the thread" + } + }, + "required": [ + "createTime" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatEventInThreadBaseProperties" + } + ] + }, + "AcsChatThreadParticipantProperties": { + "type": "object", + "description": "Schema of the chat thread participant", + "properties": { + "displayName": { + "type": "string", + "description": "The name of the user" + }, + "participantCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the user" + }, + "metadata": { + "type": "object", + "description": "The metadata of the user", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "participantCommunicationIdentifier", + "metadata" + ] + }, + "AcsChatThreadPropertiesUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadPropertiesUpdated event.", + "properties": { + "editedByCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the user who updated the thread properties" + }, + "editTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the properties of the thread were updated" + }, + "properties": { + "type": "object", + "description": "The updated thread properties", + "additionalProperties": {} + }, + "metadata": { + "type": "object", + "description": "The thread metadata", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "editedByCommunicationIdentifier", + "editTime", + "properties", + "metadata" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatThreadEventInThreadBaseProperties" + } + ] + }, + "AcsChatThreadPropertiesUpdatedPerUserEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadPropertiesUpdatedPerUser event.", + "properties": { + "editedByCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the user who updated the thread properties" + }, + "editTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the properties of the thread were updated" + }, + "metadata": { + "type": "object", + "description": "The thread metadata", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "type": "object", + "description": "The updated thread properties", + "additionalProperties": {} + } + }, + "required": [ + "editedByCommunicationIdentifier", + "editTime", + "metadata", + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatThreadEventBaseProperties" + } + ] + }, + "AcsChatThreadWithUserDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadWithUserDeleted event.", + "properties": { + "deletedByCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the user who deleted the thread" + }, + "deleteTime": { + "type": "string", + "format": "date-time", + "description": "The deletion time of the thread" + } + }, + "required": [ + "deletedByCommunicationIdentifier", + "deleteTime" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsChatThreadEventBaseProperties" + } + ] + }, + "AcsEmailDeliveryReportReceivedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.EmailDeliveryReportReceived event.", + "properties": { + "sender": { + "type": "string", + "description": "The Sender Email Address" + }, + "recipient": { + "type": "string", + "description": "The recipient Email Address" + }, + "messageId": { + "type": "string", + "description": "The Id of the email been sent" + }, + "status": { + "$ref": "#/definitions/AcsEmailDeliveryReportStatus", + "description": "The status of the email. Any value other than Delivered is considered failed." + }, + "deliveryStatusDetails": { + "$ref": "#/definitions/AcsEmailDeliveryReportStatusDetails", + "description": "Detailed information about the status if any" + }, + "deliveryAttemptTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time at which the email delivery report received timestamp" + } + }, + "required": [ + "status", + "deliveryStatusDetails", + "deliveryAttemptTimestamp" + ] + }, + "AcsEmailDeliveryReportStatus": { + "type": "string", + "description": "The status of the email. Any value other than Delivered is considered failed.", + "enum": [ + "Bounced", + "Delivered", + "Failed", + "FilteredSpam", + "Quarantined", + "Suppressed" + ], + "x-ms-enum": { + "name": "AcsEmailDeliveryReportStatus", + "modelAsString": true, + "values": [ + { + "name": "Bounced", + "value": "Bounced", + "description": "Hard bounce detected while sending the email" + }, + { + "name": "Delivered", + "value": "Delivered", + "description": "The email was delivered" + }, + { + "name": "Failed", + "value": "Failed", + "description": "The email failed to be delivered" + }, + { + "name": "FilteredSpam", + "value": "FilteredSpam", + "description": "The message was identified as spam and was rejected or blocked (not quarantined)." + }, + { + "name": "Quarantined", + "value": "Quarantined", + "description": "The message was quarantined (as spam, bulk mail, or phishing). For more information, see Quarantined email messages in EOP (EXCHANGE ONLINE PROTECTION)." + }, + { + "name": "Suppressed", + "value": "Suppressed", + "description": "The email was suppressed" + } + ] + } + }, + "AcsEmailDeliveryReportStatusDetails": { + "type": "object", + "description": "Detailed information about the status if any", + "properties": { + "statusMessage": { + "type": "string", + "description": "Detailed status message" + } + } + }, + "AcsEmailEngagementTrackingReportReceivedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.EmailEngagementTrackingReportReceived event.", + "properties": { + "sender": { + "type": "string", + "description": "The Sender Email Address" + }, + "recipient": { + "type": "string", + "description": "The Recipient Email Address" + }, + "messageId": { + "type": "string", + "description": "The Id of the email that has been sent" + }, + "userActionTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time at which the user interacted with the email" + }, + "engagementContext": { + "type": "string", + "description": "The context of the type of engagement user had with email" + }, + "userAgent": { + "type": "string", + "description": "The user agent interacting with the email" + }, + "engagementType": { + "$ref": "#/definitions/AcsUserEngagement", + "description": "The type of engagement user have with email", + "x-ms-client-name": "engagement" + } + }, + "required": [ + "userActionTimestamp", + "engagementType" + ] + }, + "AcsIncomingCallCustomContext": { + "type": "object", + "description": "Custom Context of Incoming Call", + "properties": { + "sipHeaders": { + "type": "object", + "description": "Sip Headers for incoming call", + "additionalProperties": { + "type": "string" + } + }, + "voipHeaders": { + "type": "object", + "description": "Voip Headers for incoming call", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "sipHeaders", + "voipHeaders" + ] + }, + "AcsIncomingCallEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.IncomingCall event", + "properties": { + "to": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the target user.", + "x-ms-client-name": "toCommunicationIdentifier" + }, + "from": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the user who initiated the call.", + "x-ms-client-name": "fromCommunicationIdentifier" + }, + "serverCallId": { + "type": "string", + "description": "The Id of the server call" + }, + "callerDisplayName": { + "type": "string", + "description": "Display name of caller." + }, + "customContext": { + "$ref": "#/definitions/AcsIncomingCallCustomContext", + "description": "Custom Context of Incoming Call" + }, + "incomingCallContext": { + "type": "string", + "description": "Signed incoming call context." + }, + "correlationId": { + "type": "string", + "description": "CorrelationId (CallId)." + } + }, + "required": [ + "to", + "from", + "customContext" + ] + }, + "AcsInteractiveReplyKind": { + "type": "string", + "description": "Interactive reply kind", + "enum": [ + "buttonReply", + "listReply", + "unknown" + ], + "x-ms-enum": { + "name": "AcsInteractiveReplyKind", + "modelAsString": true, + "values": [ + { + "name": "buttonReply", + "value": "buttonReply", + "description": "Messaged interactive reply type is ButtonReply" + }, + { + "name": "listReply", + "value": "listReply", + "description": "Messaged interactive reply type is ListReply" + }, + { + "name": "unknown", + "value": "unknown", + "description": "Messaged interactive reply type is Unknown" + } + ] + } + }, + "AcsMessageButtonContent": { + "type": "object", + "description": "Message Button Content", + "properties": { + "text": { + "type": "string", + "description": "The Text of the button" + }, + "payload": { + "type": "string", + "description": "The Payload of the button which was clicked by the user, setup by the business" + } + } + }, + "AcsMessageChannelEventError": { + "type": "object", + "description": "Message Channel Event Error", + "properties": { + "channelCode": { + "type": "string", + "description": "The channel error code" + }, + "channelMessage": { + "type": "string", + "description": "The channel error message" + } + } + }, + "AcsMessageChannelKind": { + "type": "string", + "description": "Message channel kind", + "enum": [ + "whatsapp" + ], + "x-ms-enum": { + "name": "AcsMessageChannelKind", + "modelAsString": true, + "values": [ + { + "name": "whatsapp", + "value": "whatsapp", + "description": "Updated message channel type is WhatsApp" + } + ] + } + }, + "AcsMessageContext": { + "type": "object", + "description": "Message Context", + "properties": { + "from": { + "type": "string", + "description": "The WhatsApp ID for the customer who replied to an inbound message." + }, + "id": { + "type": "string", + "description": "The message ID for the sent message for an inbound reply", + "x-ms-client-name": "messageId" + } + } + }, + "AcsMessageDeliveryStatus": { + "type": "string", + "description": "Message delivery status", + "enum": [ + "read", + "delivered", + "failed", + "sent", + "warning", + "unknown" + ], + "x-ms-enum": { + "name": "AcsMessageDeliveryStatus", + "modelAsString": true, + "values": [ + { + "name": "read", + "value": "read", + "description": "Read" + }, + { + "name": "delivered", + "value": "delivered", + "description": "Delivered" + }, + { + "name": "failed", + "value": "failed", + "description": "Failed" + }, + { + "name": "sent", + "value": "sent", + "description": "Sent" + }, + { + "name": "warning", + "value": "warning", + "description": "Warning" + }, + { + "name": "unknown", + "value": "unknown", + "description": "Unknown" + } + ] + } + }, + "AcsMessageDeliveryStatusUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated event.", + "properties": { + "messageId": { + "type": "string", + "description": "The message id" + }, + "status": { + "$ref": "#/definitions/AcsMessageDeliveryStatus", + "description": "The updated message status" + }, + "channelType": { + "$ref": "#/definitions/AcsMessageChannelKind", + "description": "The updated message channel type", + "x-ms-client-name": "channelKind" + } + }, + "required": [ + "status", + "channelType" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsMessageEventData" + } + ] + }, + "AcsMessageEventData": { + "type": "object", + "description": "Schema of common properties of all chat thread events", + "properties": { + "from": { + "type": "string", + "description": "The message sender" + }, + "to": { + "type": "string", + "description": "The message recipient" + }, + "receivedTimeStamp": { + "type": "string", + "format": "date-time", + "description": "The time message was received" + }, + "error": { + "$ref": "#/definitions/AcsMessageChannelEventError", + "description": "The channel event error" + } + }, + "required": [ + "receivedTimeStamp", + "error" + ] + }, + "AcsMessageInteractiveButtonReplyContent": { + "type": "object", + "description": "Message Interactive button reply content for a user to business message", + "properties": { + "id": { + "type": "string", + "description": "The ID of the button", + "x-ms-client-name": "buttonId" + }, + "title": { + "type": "string", + "description": "The title of the button" + } + } + }, + "AcsMessageInteractiveContent": { + "type": "object", + "description": "Message Interactive Content", + "properties": { + "type": { + "$ref": "#/definitions/AcsInteractiveReplyKind", + "description": "The Message interactive reply type", + "x-ms-client-name": "replyKind" + }, + "buttonReply": { + "$ref": "#/definitions/AcsMessageInteractiveButtonReplyContent", + "description": "The Message Sent when a customer clicks a button" + }, + "listReply": { + "$ref": "#/definitions/AcsMessageInteractiveListReplyContent", + "description": "The Message Sent when a customer selects an item from a list" + } + }, + "required": [ + "type", + "buttonReply", + "listReply" + ] + }, + "AcsMessageInteractiveListReplyContent": { + "type": "object", + "description": "Message Interactive list reply content for a user to business message", + "properties": { + "id": { + "type": "string", + "description": "The ID of the selected list item", + "x-ms-client-name": "listItemId" + }, + "title": { + "type": "string", + "description": "The title of the selected list item" + }, + "description": { + "type": "string", + "description": "The description of the selected row" + } + } + }, + "AcsMessageMediaContent": { + "type": "object", + "description": "Message Media Content", + "properties": { + "mimeType": { + "type": "string", + "description": "The MIME type of the file this media represents" + }, + "id": { + "type": "string", + "description": "The media identifier", + "x-ms-client-name": "mediaId" + }, + "fileName": { + "type": "string", + "description": "The filename of the underlying media file as specified when uploaded" + }, + "caption": { + "type": "string", + "description": "The caption for the media object, if supported and provided" + } + } + }, + "AcsMessageReceivedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.AdvancedMessageReceived event.", + "properties": { + "content": { + "type": "string", + "description": "The message content" + }, + "channelType": { + "$ref": "#/definitions/AcsMessageChannelKind", + "description": "The message channel type", + "x-ms-client-name": "channelKind" + }, + "media": { + "$ref": "#/definitions/AcsMessageMediaContent", + "description": "The received message media content", + "x-ms-client-name": "mediaContent" + }, + "context": { + "$ref": "#/definitions/AcsMessageContext", + "description": "The received message context" + }, + "button": { + "$ref": "#/definitions/AcsMessageButtonContent", + "description": "The received message button content" + }, + "interactive": { + "$ref": "#/definitions/AcsMessageInteractiveContent", + "description": "The received message interactive content", + "x-ms-client-name": "interactiveContent" + } + }, + "required": [ + "channelType", + "media", + "context", + "button", + "interactive" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsMessageEventData" + } + ] + }, + "AcsRecordingChunkInfoProperties": { + "type": "object", + "description": "Schema for all properties of Recording Chunk Information.", + "properties": { + "documentId": { + "type": "string", + "description": "The documentId of the recording chunk" + }, + "index": { + "type": "integer", + "format": "int64", + "description": "The index of the recording chunk" + }, + "endReason": { + "type": "string", + "description": "The reason for ending the recording chunk" + }, + "metadataLocation": { + "type": "string", + "description": "The location of the metadata for this chunk" + }, + "contentLocation": { + "type": "string", + "description": "The location of the content for this chunk" + }, + "deleteLocation": { + "type": "string", + "description": "The location to delete all chunk storage" + } + } + }, + "AcsRecordingFileStatusUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RecordingFileStatusUpdated event.", + "properties": { + "recordingStorageInfo": { + "$ref": "#/definitions/AcsRecordingStorageInfoProperties", + "description": "The details of recording storage information" + }, + "recordingStartTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the recording started" + }, + "recordingDurationMs": { + "type": "integer", + "format": "int64", + "description": "The recording duration in milliseconds" + }, + "recordingContentType": { + "$ref": "#/definitions/recordingContentType", + "description": "The recording content type- AudioVideo, or Audio" + }, + "recordingChannelType": { + "$ref": "#/definitions/recordingChannelType", + "description": "The recording channel type - Mixed, Unmixed" + }, + "recordingFormatType": { + "$ref": "#/definitions/recordingFormatType", + "description": "The recording format type - Mp4, Mp3, Wav" + }, + "sessionEndReason": { + "type": "string", + "description": "The reason for ending recording session" + } + }, + "required": [ + "recordingStorageInfo", + "recordingStartTime", + "recordingContentType", + "recordingChannelType", + "recordingFormatType" + ] + }, + "AcsRecordingStorageInfoProperties": { + "type": "object", + "description": "Schema for all properties of Recording Storage Information.", + "properties": { + "recordingChunks": { + "type": "array", + "description": "List of details of recording chunks information", + "items": { + "$ref": "#/definitions/AcsRecordingChunkInfoProperties" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "recordingChunks" + ] + }, + "AcsRouterChannelConfiguration": { + "type": "object", + "description": "Router Channel Configuration", + "properties": { + "channelId": { + "type": "string", + "description": "Channel ID for Router Job" + }, + "capacityCostPerJob": { + "type": "integer", + "format": "int32", + "description": "Capacity Cost Per Job for Router Job" + }, + "maxNumberOfJobs": { + "type": "integer", + "format": "int32", + "description": "Max Number of Jobs for Router Job" + } + } + }, + "AcsRouterCommunicationError": { + "type": "object", + "description": "Router Communication Error", + "properties": { + "code": { + "type": "string", + "description": "Router Communication Error Code" + }, + "message": { + "type": "string", + "description": "Router Communication Error Message" + }, + "target": { + "type": "string", + "description": "Router Communication Error Target" + }, + "innererror": { + "$ref": "#/definitions/AcsRouterCommunicationError", + "description": "Router Communication Inner Error" + }, + "details": { + "type": "array", + "description": "List of Router Communication Errors", + "items": { + "$ref": "#/definitions/AcsRouterCommunicationError" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "innererror", + "details" + ] + }, + "AcsRouterEventData": { + "type": "object", + "description": "Schema of common properties of all Router events", + "properties": { + "jobId": { + "type": "string", + "description": "Router Event Job ID" + }, + "channelReference": { + "type": "string", + "description": "Router Event Channel Reference" + }, + "channelId": { + "type": "string", + "description": "Router Event Channel ID" + } + } + }, + "AcsRouterJobCancelledEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobCancelled event", + "properties": { + "note": { + "type": "string", + "description": "Router Job Note" + }, + "dispositionCode": { + "type": "string", + "description": "Router Job Disposition Code" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ] + }, + "AcsRouterJobClassificationFailedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobClassificationFailed event", + "properties": { + "classificationPolicyId": { + "type": "string", + "description": "Router Job Classification Policy Id" + }, + "errors": { + "type": "array", + "description": "Router Job Classification Failed Errors", + "items": { + "$ref": "#/definitions/AcsRouterCommunicationError" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "errors" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ] + }, + "AcsRouterJobClassifiedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobClassified event", + "properties": { + "queueDetails": { + "$ref": "#/definitions/AcsRouterQueueDetails", + "description": "Router Job Queue Info" + }, + "classificationPolicyId": { + "type": "string", + "description": "Router Job Classification Policy Id" + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "Router Job Priority" + }, + "attachedWorkerSelectors": { + "type": "array", + "description": "Router Job Attached Worker Selector", + "items": { + "$ref": "#/definitions/AcsRouterWorkerSelector" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "queueDetails", + "attachedWorkerSelectors" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ] + }, + "AcsRouterJobClosedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobClosed event", + "properties": { + "assignmentId": { + "type": "string", + "description": "Router Job Closed Assignment Id" + }, + "workerId": { + "type": "string", + "description": "Router Job Closed Worker Id" + }, + "dispositionCode": { + "type": "string", + "description": "Router Job Closed Disposition Code" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ] + }, + "AcsRouterJobCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobCompleted event", + "properties": { + "assignmentId": { + "type": "string", + "description": "Router Job Completed Assignment Id" + }, + "workerId": { + "type": "string", + "description": "Router Job Completed Worker Id" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ] + }, + "AcsRouterJobDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobDeleted event", + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ] + }, + "AcsRouterJobEventData": { + "type": "object", + "description": "Schema of common properties of all Router Job events", + "properties": { + "queueId": { + "type": "string", + "description": "Router Job events Queue Id" + }, + "labels": { + "type": "object", + "description": "Router Job events Labels", + "additionalProperties": { + "type": "string" + } + }, + "tags": { + "type": "object", + "description": "Router Jobs events Tags", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "labels", + "tags" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsRouterEventData" + } + ] + }, + "AcsRouterJobExceptionTriggeredEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobExceptionTriggered event", + "properties": { + "ruleKey": { + "type": "string", + "description": "Router Job Exception Triggered Rule Key" + }, + "exceptionRuleId": { + "type": "string", + "description": "Router Job Exception Triggered Rule Id" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ] + }, + "AcsRouterJobQueuedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobQueued event", + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "description": "Router Job Priority" + }, + "attachedWorkerSelectors": { + "type": "array", + "description": "Router Job Queued Attached Worker Selector", + "items": { + "$ref": "#/definitions/AcsRouterWorkerSelector" + }, + "x-ms-identifiers": [] + }, + "requestedWorkerSelectors": { + "type": "array", + "description": "Router Job Queued Requested Worker Selector", + "items": { + "$ref": "#/definitions/AcsRouterWorkerSelector" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "attachedWorkerSelectors", + "requestedWorkerSelectors" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ] + }, + "AcsRouterJobReceivedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobReceived event", + "properties": { + "jobStatus": { + "$ref": "#/definitions/AcsRouterJobStatus", + "description": "Router Job Received Job Status" + }, + "classificationPolicyId": { + "type": "string", + "description": "Router Job Classification Policy Id" + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "Router Job Priority" + }, + "requestedWorkerSelectors": { + "type": "array", + "description": "Router Job Received Requested Worker Selectors", + "items": { + "$ref": "#/definitions/AcsRouterWorkerSelector" + }, + "x-ms-identifiers": [] + }, + "scheduledOn": { + "type": "string", + "format": "date-time", + "description": "Router Job Received Scheduled Time in UTC" + }, + "unavailableForMatching": { + "type": "boolean", + "description": "Unavailable For Matching for Router Job Received" + } + }, + "required": [ + "jobStatus", + "requestedWorkerSelectors", + "scheduledOn", + "unavailableForMatching" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ] + }, + "AcsRouterJobSchedulingFailedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobSchedulingFailed event", + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "description": "Router Job Priority" + }, + "expiredAttachedWorkerSelectors": { + "type": "array", + "description": "Router Job Scheduling Failed Attached Worker Selector Expired", + "items": { + "$ref": "#/definitions/AcsRouterWorkerSelector" + }, + "x-ms-identifiers": [] + }, + "expiredRequestedWorkerSelectors": { + "type": "array", + "description": "Router Job Scheduling Failed Requested Worker Selector Expired", + "items": { + "$ref": "#/definitions/AcsRouterWorkerSelector" + }, + "x-ms-identifiers": [] + }, + "scheduledOn": { + "type": "string", + "format": "date-time", + "description": "Router Job Scheduling Failed Scheduled Time in UTC" + }, + "failureReason": { + "type": "string", + "description": "Router Job Scheduling Failed Reason" + } + }, + "required": [ + "expiredAttachedWorkerSelectors", + "expiredRequestedWorkerSelectors", + "scheduledOn" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ] + }, + "AcsRouterJobStatus": { + "type": "string", + "description": "Acs Router Job Status", + "enum": [ + "PendingClassification", + "Queued", + "Assigned", + "Completed", + "Closed", + "Cancelled", + "ClassificationFailed", + "Created", + "PendingSchedule", + "Scheduled", + "ScheduleFailed", + "WaitingForActivation" + ], + "x-ms-enum": { + "name": "AcsRouterJobStatus", + "modelAsString": true, + "values": [ + { + "name": "PendingClassification", + "value": "PendingClassification", + "description": "Router Job Status Pending Classification" + }, + { + "name": "Queued", + "value": "Queued", + "description": "Router Job Status Queued" + }, + { + "name": "Assigned", + "value": "Assigned", + "description": "Router Job Status Assigned" + }, + { + "name": "Completed", + "value": "Completed", + "description": "Router Job Status Completed" + }, + { + "name": "Closed", + "value": "Closed", + "description": "Router Job Status Closed" + }, + { + "name": "Cancelled", + "value": "Cancelled", + "description": "Router Job Status Cancelled" + }, + { + "name": "ClassificationFailed", + "value": "ClassificationFailed", + "description": "Router Job Status Classification Failed" + }, + { + "name": "Created", + "value": "Created", + "description": "Router Job Status Created" + }, + { + "name": "PendingSchedule", + "value": "PendingSchedule", + "description": "Router Job Status Pending Schedule" + }, + { + "name": "Scheduled", + "value": "Scheduled", + "description": "Router Job Status Scheduled" + }, + { + "name": "ScheduleFailed", + "value": "ScheduleFailed", + "description": "Router Job Status Schedule Failed" + }, + { + "name": "WaitingForActivation", + "value": "WaitingForActivation", + "description": "Router Job Status Waiting For Activation" + } + ] + } + }, + "AcsRouterJobUnassignedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobUnassigned event", + "properties": { + "assignmentId": { + "type": "string", + "description": "Router Job Unassigned Assignment Id" + }, + "workerId": { + "type": "string", + "description": "Router Job Unassigned Worker Id" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ] + }, + "AcsRouterJobWaitingForActivationEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobWaitingForActivation event", + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "description": "Router Job Waiting For Activation Priority" + }, + "expiredAttachedWorkerSelectors": { + "type": "array", + "description": "Router Job Waiting For Activation Worker Selector Expired", + "items": { + "$ref": "#/definitions/AcsRouterWorkerSelector" + }, + "x-ms-identifiers": [] + }, + "expiredRequestedWorkerSelectors": { + "type": "array", + "description": "Router Job Waiting For Activation Requested Worker Selector Expired", + "items": { + "$ref": "#/definitions/AcsRouterWorkerSelector" + }, + "x-ms-identifiers": [] + }, + "scheduledOn": { + "type": "string", + "format": "date-time", + "description": "Router Job Waiting For Activation Scheduled Time in UTC" + }, + "unavailableForMatching": { + "type": "boolean", + "description": "Router Job Waiting For Activation Unavailable For Matching" + } + }, + "required": [ + "expiredAttachedWorkerSelectors", + "expiredRequestedWorkerSelectors", + "scheduledOn", + "unavailableForMatching" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ] + }, + "AcsRouterJobWorkerSelectorsExpiredEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobWorkerSelectorsExpired event", + "properties": { + "expiredRequestedWorkerSelectors": { + "type": "array", + "description": "Router Job Worker Selectors Expired Requested Worker Selectors", + "items": { + "$ref": "#/definitions/AcsRouterWorkerSelector" + }, + "x-ms-identifiers": [] + }, + "expiredAttachedWorkerSelectors": { + "type": "array", + "description": "Router Job Worker Selectors Expired Attached Worker Selectors", + "items": { + "$ref": "#/definitions/AcsRouterWorkerSelector" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "expiredRequestedWorkerSelectors", + "expiredAttachedWorkerSelectors" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ] + }, + "AcsRouterLabelOperator": { + "type": "string", + "description": "Router Job Worker Selector Label Operator", + "enum": [ + "Equal", + "NotEqual", + "Greater", + "Less", + "GreaterThanOrEqual", + "LessThanOrEqual" + ], + "x-ms-enum": { + "name": "AcsRouterLabelOperator", + "modelAsString": true, + "values": [ + { + "name": "Equal", + "value": "Equal", + "description": "Router Label Operator Equal" + }, + { + "name": "NotEqual", + "value": "NotEqual", + "description": "Router Label Operator Not Equal" + }, + { + "name": "Greater", + "value": "Greater", + "description": "Router Label Operator Greater" + }, + { + "name": "Less", + "value": "Less", + "description": "Router Label Operator Less" + }, + { + "name": "GreaterThanOrEqual", + "value": "GreaterThanOrEqual", + "description": "Router Label Operator Greater than or equal" + }, + { + "name": "LessThanOrEqual", + "value": "LessThanOrEqual", + "description": "Router Label Operator Less than or equal" + } + ] + } + }, + "AcsRouterQueueDetails": { + "type": "object", + "description": "Router Queue Details", + "properties": { + "id": { + "type": "string", + "description": "Router Queue Id" + }, + "name": { + "type": "string", + "description": "Router Queue Name" + }, + "labels": { + "type": "object", + "description": "Router Queue Labels", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "labels" + ] + }, + "AcsRouterUpdatedWorkerProperty": { + "type": "string", + "description": "Worker properties that can be updated", + "enum": [ + "AvailableForOffers", + "TotalCapacity", + "QueueAssignments", + "Labels", + "Tags", + "ChannelConfigurations" + ], + "x-ms-enum": { + "name": "AcsRouterUpdatedWorkerProperty", + "modelAsString": true, + "values": [ + { + "name": "AvailableForOffers", + "value": "AvailableForOffers", + "description": "AvailableForOffers" + }, + { + "name": "TotalCapacity", + "value": "TotalCapacity", + "description": "TotalCapacity" + }, + { + "name": "QueueAssignments", + "value": "QueueAssignments", + "description": "QueueAssignments" + }, + { + "name": "Labels", + "value": "Labels", + "description": "Labels" + }, + { + "name": "Tags", + "value": "Tags", + "description": "Tags" + }, + { + "name": "ChannelConfigurations", + "value": "ChannelConfigurations", + "description": "ChannelConfigurations" + } + ] + } + }, + "AcsRouterWorkerDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerDeleted event", + "allOf": [ + { + "$ref": "#/definitions/AcsRouterWorkerEventData" + } + ] + }, + "AcsRouterWorkerDeregisteredEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerDeregistered event", + "properties": { + "workerId": { + "type": "string", + "description": "Router Worker Deregistered Worker Id" + } + } + }, + "AcsRouterWorkerEventData": { + "type": "object", + "description": "Schema of common properties of all Router Worker events", + "properties": { + "workerId": { + "type": "string", + "description": "Router Worker events Worker Id" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AcsRouterEventData" + } + ] + }, + "AcsRouterWorkerOfferAcceptedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferAccepted event", + "properties": { + "queueId": { + "type": "string", + "description": "Router Worker Offer Accepted Queue Id" + }, + "offerId": { + "type": "string", + "description": "Router Worker Offer Accepted Offer Id" + }, + "assignmentId": { + "type": "string", + "description": "Router Worker Offer Accepted Assignment Id" + }, + "jobPriority": { + "type": "integer", + "format": "int32", + "description": "Router Worker Offer Accepted Job Priority" + }, + "workerLabels": { + "type": "object", + "description": "Router Worker Offer Accepted Worker Labels", + "additionalProperties": { + "type": "string" + } + }, + "workerTags": { + "type": "object", + "description": "Router Worker Offer Accepted Worker Tags", + "additionalProperties": { + "type": "string" + } + }, + "jobLabels": { + "type": "object", + "description": "Router Worker Offer Accepted Job Labels", + "additionalProperties": { + "type": "string" + } + }, + "jobTags": { + "type": "object", + "description": "Router Worker Offer Accepted Job Tags", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "workerLabels", + "workerTags", + "jobLabels", + "jobTags" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsRouterWorkerEventData" + } + ] + }, + "AcsRouterWorkerOfferDeclinedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferDeclined event", + "properties": { + "queueId": { + "type": "string", + "description": "Router Worker Offer Declined Queue Id" + }, + "offerId": { + "type": "string", + "description": "Router Worker Offer Declined Offer Id" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AcsRouterWorkerEventData" + } + ] + }, + "AcsRouterWorkerOfferExpiredEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferExpired event", + "properties": { + "queueId": { + "type": "string", + "description": "Router Worker Offer Expired Queue Id" + }, + "offerId": { + "type": "string", + "description": "Router Worker Offer Expired Offer Id" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AcsRouterWorkerEventData" + } + ] + }, + "AcsRouterWorkerOfferIssuedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferIssued event", + "properties": { + "queueId": { + "type": "string", + "description": "Router Worker Offer Issued Queue Id" + }, + "offerId": { + "type": "string", + "description": "Router Worker Offer Issued Offer Id" + }, + "jobPriority": { + "type": "integer", + "format": "int32", + "description": "Router Worker Offer Issued Job Priority" + }, + "workerLabels": { + "type": "object", + "description": "Router Worker Offer Issued Worker Labels", + "additionalProperties": { + "type": "string" + } + }, + "offeredOn": { + "type": "string", + "format": "date-time", + "description": "Router Worker Offer Issued Time in UTC" + }, + "expiresOn": { + "type": "string", + "format": "date-time", + "description": "Router Worker Offer Issued Expiration Time in UTC" + }, + "workerTags": { + "type": "object", + "description": "Router Worker Offer Issued Worker Tags", + "additionalProperties": { + "type": "string" + } + }, + "jobLabels": { + "type": "object", + "description": "Router Worker Offer Issued Job Labels", + "additionalProperties": { + "type": "string" + } + }, + "jobTags": { + "type": "object", + "description": "Router Worker Offer Issued Job Tags", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "workerLabels", + "offeredOn", + "expiresOn", + "workerTags", + "jobLabels", + "jobTags" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsRouterWorkerEventData" + } + ] + }, + "AcsRouterWorkerOfferRevokedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferRevoked event", + "properties": { + "queueId": { + "type": "string", + "description": "Router Worker Offer Revoked Queue Id" + }, + "offerId": { + "type": "string", + "description": "Router Worker Offer Revoked Offer Id" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AcsRouterWorkerEventData" + } + ] + }, + "AcsRouterWorkerRegisteredEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerRegistered event", + "properties": { + "workerId": { + "type": "string", + "description": "Router Worker Registered Worker Id" + }, + "queueAssignments": { + "type": "array", + "description": "Router Worker Registered Queue Info", + "items": { + "$ref": "#/definitions/AcsRouterQueueDetails" + } + }, + "channelConfigurations": { + "type": "array", + "description": "Router Worker Registered Channel Configuration", + "items": { + "$ref": "#/definitions/AcsRouterChannelConfiguration" + }, + "x-ms-identifiers": [] + }, + "totalCapacity": { + "type": "integer", + "format": "int32", + "description": "Router Worker Register Total Capacity" + }, + "labels": { + "type": "object", + "description": "Router Worker Registered Labels", + "additionalProperties": { + "type": "string" + } + }, + "tags": { + "type": "object", + "description": "Router Worker Registered Tags", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "queueAssignments", + "channelConfigurations", + "labels", + "tags" + ] + }, + "AcsRouterWorkerSelector": { + "type": "object", + "description": "Router Job Worker Selector", + "properties": { + "key": { + "type": "string", + "description": "Router Job Worker Selector Key" + }, + "labelOperator": { + "$ref": "#/definitions/AcsRouterLabelOperator", + "description": "Router Job Worker Selector Label Operator" + }, + "value": { + "description": "Router Job Worker Selector Value", + "x-ms-client-name": "labelValue" + }, + "ttlSeconds": { + "type": "number", + "format": "double", + "description": "Router Job Worker Selector Time to Live in Seconds" + }, + "state": { + "$ref": "#/definitions/AcsRouterWorkerSelectorState", + "description": "Router Job Worker Selector State" + }, + "expirationTime": { + "type": "string", + "format": "date-time", + "description": "Router Job Worker Selector Expiration Time" + } + }, + "required": [ + "labelOperator", + "value", + "ttlSeconds", + "state", + "expirationTime" + ] + }, + "AcsRouterWorkerSelectorState": { + "type": "string", + "description": "Router Worker Selector State", + "enum": [ + "active", + "expired" + ], + "x-ms-enum": { + "name": "AcsRouterWorkerSelectorState", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "active", + "description": "Router Worker Selector State Active" + }, + { + "name": "Expired", + "value": "expired", + "description": "Router Worker Selector State Expired" + } + ] + } + }, + "AcsRouterWorkerUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerUpdated event.", + "properties": { + "workerId": { + "type": "string", + "description": "Router Worker Updated Worker Id" + }, + "queueAssignments": { + "type": "array", + "description": "Router Worker Updated Queue Info", + "items": { + "$ref": "#/definitions/AcsRouterQueueDetails" + } + }, + "channelConfigurations": { + "type": "array", + "description": "Router Worker Updated Channel Configuration", + "items": { + "$ref": "#/definitions/AcsRouterChannelConfiguration" + }, + "x-ms-identifiers": [] + }, + "totalCapacity": { + "type": "integer", + "format": "int32", + "description": "Router Worker Updated Total Capacity" + }, + "labels": { + "type": "object", + "description": "Router Worker Updated Labels", + "additionalProperties": { + "type": "string" + } + }, + "tags": { + "type": "object", + "description": "Router Worker Updated Tags", + "additionalProperties": { + "type": "string" + } + }, + "updatedWorkerProperties": { + "type": "array", + "description": "Router Worker Properties Updated", + "items": { + "$ref": "#/definitions/AcsRouterUpdatedWorkerProperty" + } + } + }, + "required": [ + "queueAssignments", + "channelConfigurations", + "labels", + "tags", + "updatedWorkerProperties" + ] + }, + "AcsSmsDeliveryAttemptProperties": { + "type": "object", + "description": "Schema for details of a delivery attempt", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "description": "TimeStamp when delivery was attempted" + }, + "segmentsSucceeded": { + "type": "integer", + "format": "int32", + "description": "Number of segments that were successfully delivered" + }, + "segmentsFailed": { + "type": "integer", + "format": "int32", + "description": "Number of segments whose delivery failed" + } + }, + "required": [ + "timestamp" + ] + }, + "AcsSmsDeliveryReportReceivedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.SMSDeliveryReportReceived event.", + "properties": { + "deliveryStatus": { + "type": "string", + "description": "Status of Delivery" + }, + "deliveryStatusDetails": { + "type": "string", + "description": "Details about Delivery Status" + }, + "deliveryAttempts": { + "type": "array", + "description": "List of details of delivery attempts made", + "items": { + "$ref": "#/definitions/AcsSmsDeliveryAttemptProperties" + }, + "x-ms-identifiers": [] + }, + "receivedTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time at which the SMS delivery report was received" + }, + "tag": { + "type": "string", + "description": "Customer Content" + } + }, + "required": [ + "deliveryAttempts", + "receivedTimestamp" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsSmsEventBaseProperties" + } + ] + }, + "AcsSmsEventBaseProperties": { + "type": "object", + "description": "Schema of common properties of all SMS events", + "properties": { + "messageId": { + "type": "string", + "description": "The identity of the SMS message" + }, + "from": { + "type": "string", + "description": "The identity of SMS message sender" + }, + "to": { + "type": "string", + "description": "The identity of SMS message receiver" + } + } + }, + "AcsSmsReceivedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.SMSReceived event.", + "properties": { + "message": { + "type": "string", + "description": "The SMS content" + }, + "receivedTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time at which the SMS was received" + } + }, + "required": [ + "receivedTimestamp" + ], + "allOf": [ + { + "$ref": "#/definitions/AcsSmsEventBaseProperties" + } + ] + }, + "AcsUserDisconnectedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.UserDisconnected event.", + "properties": { + "userCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the user who was disconnected" + } + }, + "required": [ + "userCommunicationIdentifier" + ] + }, + "AcsUserEngagement": { + "type": "string", + "description": "The type of engagement user have with email.", + "enum": [ + "view", + "click" + ], + "x-ms-enum": { + "name": "AcsUserEngagement", + "modelAsString": true, + "values": [ + { + "name": "view", + "value": "view", + "description": "View" + }, + { + "name": "click", + "value": "click", + "description": "Click" + } + ] + } + }, + "ApiCenterApiDefinitionAddedEventData": { + "type": "object", + "description": "Schema of the data property of an EventGridEvent for a Microsoft.ApiCenter.ApiDefinitionAdded event.", + "properties": { + "title": { + "type": "string", + "description": "API definition title." + }, + "description": { + "type": "string", + "description": "API definition description." + }, + "specification": { + "$ref": "#/definitions/ApiCenterApiSpecification", + "description": "API definition specification." + } + }, + "required": [ + "specification" + ] + }, + "ApiCenterApiDefinitionUpdatedEventData": { + "type": "object", + "description": "Schema of the data property of an EventGridEvent for a Microsoft.ApiCenter.ApiDefinitionUpdated event.", + "properties": { + "title": { + "type": "string", + "description": "API definition title." + }, + "description": { + "type": "string", + "description": "API definition description." + }, + "specification": { + "$ref": "#/definitions/ApiCenterApiSpecification", + "description": "API definition specification." + } + }, + "required": [ + "specification" + ] + }, + "ApiCenterApiSpecification": { + "type": "object", + "description": "API specification details.", + "properties": { + "name": { + "type": "string", + "description": "Specification name." + }, + "version": { + "type": "string", + "description": "Specification version." + } + } + }, + "ApiManagementApiCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APICreated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" + } + } + }, + "ApiManagementApiDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIDeleted event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" + } + } + }, + "ApiManagementApiReleaseCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIReleaseCreated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" + } + } + }, + "ApiManagementApiReleaseDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIReleaseDeleted event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" + } + } + }, + "ApiManagementApiReleaseUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIReleaseUpdated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" + } + } + }, + "ApiManagementApiUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIUpdated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" + } + } + }, + "ApiManagementGatewayApiAddedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayAPIAdded event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways//apis/`" + } + } + }, + "ApiManagementGatewayApiRemovedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayAPIRemoved event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways//apis/`" + } + } + }, + "ApiManagementGatewayCertificateAuthorityCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayCertificateAuthorityCreated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways//certificateAuthorities/`" + } + } + }, + "ApiManagementGatewayCertificateAuthorityDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways//certificateAuthorities/`" + } + } + }, + "ApiManagementGatewayCertificateAuthorityUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayCertificateAuthorityUpdated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways//certificateAuthorities/`" + } + } + }, + "ApiManagementGatewayCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayCreated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways/`" + } + } + }, + "ApiManagementGatewayDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayDeleted event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways/`" + } + } + }, + "ApiManagementGatewayHostnameConfigurationCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayHostnameConfigurationCreated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways//hostnameConfigurations/`" + } + } + }, + "ApiManagementGatewayHostnameConfigurationDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways//hostnameConfigurations/`" + } + } + }, + "ApiManagementGatewayHostnameConfigurationUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways//hostnameConfigurations/`" + } + } + }, + "ApiManagementGatewayUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayUpdated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways/`" + } + } + }, + "ApiManagementProductCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.ProductCreated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" + } + } + }, + "ApiManagementProductDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.ProductDeleted event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" + } + } + }, + "ApiManagementProductUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.ProductUpdated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" + } + } + }, + "ApiManagementSubscriptionCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.SubscriptionCreated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" + } + } + }, + "ApiManagementSubscriptionDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.SubscriptionDeleted event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" + } + } + }, + "ApiManagementSubscriptionUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.SubscriptionUpdated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" + } + } + }, + "ApiManagementUserCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.UserCreated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" + } + } + }, + "ApiManagementUserDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.UserDeleted event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" + } + } + }, + "ApiManagementUserUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.UserUpdated event.", + "properties": { + "resourceUri": { + "type": "string", + "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" + } + } + }, + "AppAction": { + "type": "string", + "description": "Type of action of the operation", + "enum": [ + "Restarted", + "Stopped", + "ChangedAppSettings", + "Started", + "Completed", + "Failed" + ], + "x-ms-enum": { + "name": "AppAction", + "modelAsString": true, + "values": [ + { + "name": "Restarted", + "value": "Restarted", + "description": "Web app was restarted." + }, + { + "name": "Stopped", + "value": "Stopped", + "description": "Web app was stopped." + }, + { + "name": "ChangedAppSettings", + "value": "ChangedAppSettings", + "description": "There was an operation to change app setting on the web app." + }, + { + "name": "Started", + "value": "Started", + "description": "The job has started." + }, + { + "name": "Completed", + "value": "Completed", + "description": "The job has completed." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The job has failed to complete." + } + ] + } + }, + "AppConfigurationKeyValueDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AppConfiguration.KeyValueDeleted event.", + "properties": { + "key": { + "type": "string", + "description": "The key used to identify the key-value that was deleted." + }, + "label": { + "type": "string", + "description": "The label, if any, used to identify the key-value that was deleted." + }, + "etag": { + "type": "string", + "description": "The etag representing the key-value that was deleted." + }, + "syncToken": { + "type": "string", + "description": "The sync token representing the server state after the event." + } + } + }, + "AppConfigurationKeyValueModifiedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AppConfiguration.KeyValueModified event.", + "properties": { + "key": { + "type": "string", + "description": "The key used to identify the key-value that was modified." + }, + "label": { + "type": "string", + "description": "The label, if any, used to identify the key-value that was modified." + }, + "etag": { + "type": "string", + "description": "The etag representing the new state of the key-value." + }, + "syncToken": { + "type": "string", + "description": "The sync token representing the server state after the event." + } + } + }, + "AppConfigurationSnapshotCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AppConfiguration.SnapshotCreated event.", + "allOf": [ + { + "$ref": "#/definitions/AppConfigurationSnapshotEventData" + } + ] + }, + "AppConfigurationSnapshotEventData": { + "type": "object", + "description": "Schema of common properties of snapshot events", + "properties": { + "name": { + "type": "string", + "description": "The name of the snapshot." + }, + "etag": { + "type": "string", + "description": "The etag representing the new state of the snapshot." + }, + "syncToken": { + "type": "string", + "description": "The sync token representing the server state after the event." + } + } + }, + "AppConfigurationSnapshotModifiedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AppConfiguration.SnapshotModified event.", + "allOf": [ + { + "$ref": "#/definitions/AppConfigurationSnapshotEventData" + } + ] + }, + "AppEventTypeDetail": { + "type": "object", + "description": "Detail of action on the app.", + "properties": { + "action": { + "$ref": "#/definitions/AppAction", + "description": "Type of action of the operation." + } + }, + "required": [ + "action" + ] + }, + "AppServicePlanAction": { + "type": "string", + "description": "Type of action on the app service plan.", + "enum": [ + "Updated" + ], + "x-ms-enum": { + "name": "AppServicePlanAction", + "modelAsString": true, + "values": [ + { + "name": "Updated", + "value": "Updated", + "description": "App Service plan is being updated." + } + ] + } + }, + "AppServicePlanEventTypeDetail": { + "type": "object", + "description": "Detail of action on the app service plan.", + "properties": { + "stampKind": { + "$ref": "#/definitions/StampKind", + "description": "Kind of environment where app service plan is." + }, + "action": { + "$ref": "#/definitions/AppServicePlanAction", + "description": "Type of action on the app service plan." + }, + "status": { + "$ref": "#/definitions/AsyncStatus", + "description": "Asynchronous operation status of the operation on the app service plan." + } + }, + "required": [ + "stampKind", + "action", + "status" + ] + }, + "AsyncStatus": { + "type": "string", + "description": "Asynchronous operation status of the operation on the app service plan.", + "enum": [ + "Started", + "Completed", + "Failed" + ], + "x-ms-enum": { + "name": "AsyncStatus", + "modelAsString": true, + "values": [ + { + "name": "Started", + "value": "Started", + "description": "Async operation has started." + }, + { + "name": "Completed", + "value": "Completed", + "description": "Async operation has completed." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Async operation failed to complete." + } + ] + } + }, + "AvsClusterCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterCreated event.", + "allOf": [ + { + "$ref": "#/definitions/AvsClusterEventData" + } + ] + }, + "AvsClusterDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterDeleted event.", + "allOf": [ + { + "$ref": "#/definitions/AvsClusterEventData" + } + ] + }, + "AvsClusterEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for Microsoft.AVS/clusters events.", + "properties": { + "operationId": { + "type": "string", + "description": "Id of the operation that caused this event." + }, + "addedHostNames": { + "type": "array", + "description": "Hosts added to the cluster in this event, if any.", + "items": { + "type": "string" + } + }, + "removedHostNames": { + "type": "array", + "description": "Hosts removed from the cluster in this event, if any.", + "items": { + "type": "string" + } + }, + "inMaintenanceHostNames": { + "type": "array", + "description": "Hosts in Maintenance mode in the cluster, if any.", + "items": { + "type": "string" + } + } + } + }, + "AvsClusterFailedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterFailed event.", + "properties": { + "failureMessage": { + "type": "string", + "description": "Failure reason of an event." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AvsClusterEventData" + } + ] + }, + "AvsClusterUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterUpdated event.", + "allOf": [ + { + "$ref": "#/definitions/AvsClusterEventData" + } + ] + }, + "AvsClusterUpdatingEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterUpdating event.", + "allOf": [ + { + "$ref": "#/definitions/AvsClusterEventData" + } + ] + }, + "AvsPrivateCloudEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for Microsoft.AVS/privateClouds events.", + "properties": { + "operationId": { + "type": "string", + "description": "Id of the operation that caused this event." + } + } + }, + "AvsPrivateCloudFailedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.PrivateCloudFailed event.", + "properties": { + "failureMessage": { + "type": "string", + "description": "Failure reason of an event." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AvsPrivateCloudEventData" + } + ] + }, + "AvsPrivateCloudUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.PrivateCloudUpdated event.", + "allOf": [ + { + "$ref": "#/definitions/AvsPrivateCloudEventData" + } + ] + }, + "AvsPrivateCloudUpdatingEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.PrivateCloudUpdating event.", + "allOf": [ + { + "$ref": "#/definitions/AvsPrivateCloudEventData" + } + ] + }, + "AvsScriptExecutionCancelledEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionCancelled event.", + "allOf": [ + { + "$ref": "#/definitions/AvsScriptExecutionEventData" + } + ] + }, + "AvsScriptExecutionEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for Microsoft.AVS/scriptExecutions events.", + "properties": { + "operationId": { + "type": "string", + "description": "Id of the operation that caused this event." + }, + "cmdletId": { + "type": "string", + "description": "Cmdlet referenced in the execution that caused this event." + }, + "output": { + "type": "array", + "description": "Stdout outputs from the execution, if any.", + "items": { + "type": "string" + } + } + } + }, + "AvsScriptExecutionFailedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionFailed event.", + "properties": { + "failureMessage": { + "type": "string", + "description": "Failure reason of an event." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AvsScriptExecutionEventData" + } + ] + }, + "AvsScriptExecutionFinishedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionFinished event.", + "properties": { + "namedOutputs": { + "type": "object", + "description": "Named outputs of completed execution, if any.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "namedOutputs" + ], + "allOf": [ + { + "$ref": "#/definitions/AvsScriptExecutionEventData" + } + ] + }, + "AvsScriptExecutionStartedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionStarted event.", + "allOf": [ + { + "$ref": "#/definitions/AvsScriptExecutionEventData" + } + ] + }, + "CommunicationCloudEnvironmentModel": { + "type": "string", + "description": "Communication cloud environment model.", + "enum": [ + "public", + "dod", + "gcch" + ], + "x-ms-enum": { + "name": "CommunicationCloudEnvironmentModel", + "modelAsString": true, + "values": [ + { + "name": "public", + "value": "public", + "description": "Public" + }, + { + "name": "dod", + "value": "dod", + "description": "Dod" + }, + { + "name": "gcch", + "value": "gcch", + "description": "Gcch" + } + ] + } + }, + "CommunicationIdentifierModel": { + "type": "object", + "description": "Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model must be interpreted as a union: Apart from rawId, at most one further property may be set.", + "properties": { + "kind": { + "$ref": "#/definitions/CommunicationIdentifierModelKind", + "description": "The identifier kind. Only required in responses." + }, + "rawId": { + "type": "string", + "description": "Raw Id of the identifier. Optional in requests, required in responses." + }, + "communicationUser": { + "$ref": "#/definitions/CommunicationUserIdentifierModel", + "description": "The communication user." + }, + "phoneNumber": { + "$ref": "#/definitions/PhoneNumberIdentifierModel", + "description": "The phone number." + }, + "microsoftTeamsUser": { + "$ref": "#/definitions/MicrosoftTeamsUserIdentifierModel", + "description": "The Microsoft Teams user." + }, + "microsoftTeamsApp": { + "$ref": "#/definitions/MicrosoftTeamsAppIdentifierModel", + "description": "The Microsoft Teams application." + } + }, + "required": [ + "kind", + "communicationUser", + "phoneNumber", + "microsoftTeamsUser", + "microsoftTeamsApp" + ] + }, + "CommunicationIdentifierModelKind": { + "type": "string", + "description": "Communication model identifier kind", + "enum": [ + "unknown", + "communicationUser", + "phoneNumber", + "microsoftTeamsUser" + ], + "x-ms-enum": { + "name": "CommunicationIdentifierModelKind", + "modelAsString": true, + "values": [ + { + "name": "unknown", + "value": "unknown", + "description": "Unknown" + }, + { + "name": "communicationUser", + "value": "communicationUser", + "description": "Communication User" + }, + { + "name": "phoneNumber", + "value": "phoneNumber", + "description": "Phone Number" + }, + { + "name": "microsoftTeamsUser", + "value": "microsoftTeamsUser", + "description": "Microsoft Teams User" + } + ] + } + }, + "CommunicationUserIdentifierModel": { + "type": "object", + "description": "A user that got created with an Azure Communication Services resource.", + "properties": { + "id": { + "type": "string", + "description": "The Id of the communication user." + } + }, + "required": [ + "id" + ] + }, + "ContainerRegistryArtifactEventData": { + "type": "object", + "description": "The content of the event request message.", + "properties": { + "id": { + "type": "string", + "description": "The event ID." + }, + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The time at which the event occurred." + }, + "action": { + "type": "string", + "description": "The action that encompasses the provided event." + }, + "location": { + "type": "string", + "description": "The location of the event." + }, + "target": { + "$ref": "#/definitions/ContainerRegistryArtifactEventTarget", + "description": "The target of the event." + }, + "connectedRegistry": { + "$ref": "#/definitions/ContainerRegistryEventConnectedRegistry", + "description": "The connected registry information if the event is generated by a connected registry." + } + }, + "required": [ + "timestamp", + "target", + "connectedRegistry" + ] + }, + "ContainerRegistryArtifactEventTarget": { + "type": "object", + "description": "The target of the event.", + "properties": { + "mediaType": { + "type": "string", + "description": "The MIME type of the artifact." + }, + "size": { + "type": "integer", + "format": "int64", + "description": "The size in bytes of the artifact." + }, + "digest": { + "type": "string", + "description": "The digest of the artifact." + }, + "repository": { + "type": "string", + "description": "The repository name of the artifact." + }, + "tag": { + "type": "string", + "description": "The tag of the artifact." + }, + "name": { + "type": "string", + "description": "The name of the artifact." + }, + "version": { + "type": "string", + "description": "The version of the artifact." + } + } + }, + "ContainerRegistryChartDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ChartDeleted event.", + "allOf": [ + { + "$ref": "#/definitions/ContainerRegistryArtifactEventData" + } + ] + }, + "ContainerRegistryChartPushedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ChartPushed event.", + "allOf": [ + { + "$ref": "#/definitions/ContainerRegistryArtifactEventData" + } + ] + }, + "ContainerRegistryEventActor": { + "type": "object", + "description": "The agent that initiated the event. For most situations, this could be from the authorization context of the request.", + "properties": { + "name": { + "type": "string", + "description": "The subject or username associated with the request context that generated the event." + } + } + }, + "ContainerRegistryEventConnectedRegistry": { + "type": "object", + "description": "The connected registry information if the event is generated by a connected registry.", + "properties": { + "name": { + "type": "string", + "description": "The name of the connected registry that generated this event." + } + } + }, + "ContainerRegistryEventData": { + "type": "object", + "description": "The content of the event request message.", + "properties": { + "id": { + "type": "string", + "description": "The event ID." + }, + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The time at which the event occurred." + }, + "action": { + "type": "string", + "description": "The action that encompasses the provided event." + }, + "location": { + "type": "string", + "description": "The location of the event." + }, + "target": { + "$ref": "#/definitions/ContainerRegistryEventTarget", + "description": "The target of the event." + }, + "request": { + "$ref": "#/definitions/ContainerRegistryEventRequest", + "description": "The request that generated the event." + }, + "actor": { + "$ref": "#/definitions/ContainerRegistryEventActor", + "description": "The agent that initiated the event. For most situations, this could be from the authorization context of the request." + }, + "source": { + "$ref": "#/definitions/ContainerRegistryEventSource", + "description": "The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it." + }, + "connectedRegistry": { + "$ref": "#/definitions/ContainerRegistryEventConnectedRegistry", + "description": "The connected registry information if the event is generated by a connected registry." + } + }, + "required": [ + "timestamp", + "target", + "request", + "actor", + "source", + "connectedRegistry" + ] + }, + "ContainerRegistryEventRequest": { + "type": "object", + "description": "The request that generated the event.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the request that initiated the event." + }, + "addr": { + "type": "string", + "description": "The IP or hostname and possibly port of the client connection that initiated the event. This is the RemoteAddr from the standard http request." + }, + "host": { + "type": "string", + "description": "The externally accessible hostname of the registry instance, as specified by the http host header on incoming requests." + }, + "method": { + "type": "string", + "description": "The request method that generated the event." + }, + "useragent": { + "type": "string", + "description": "The user agent header of the request." + } + } + }, + "ContainerRegistryEventSource": { + "type": "object", + "description": "The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.", + "properties": { + "addr": { + "type": "string", + "description": "The IP or hostname and the port of the registry node that generated the event. Generally, this will be resolved by os.Hostname() along with the running port." + }, + "instanceID": { + "type": "string", + "description": "The running instance of an application. Changes after each restart." + } + } + }, + "ContainerRegistryEventTarget": { + "type": "object", + "description": "The target of the event.", + "properties": { + "mediaType": { + "type": "string", + "description": "The MIME type of the referenced object." + }, + "size": { + "type": "integer", + "format": "int64", + "description": "The number of bytes of the content. Same as Length field." + }, + "digest": { + "type": "string", + "description": "The digest of the content, as defined by the Registry V2 HTTP API Specification." + }, + "length": { + "type": "integer", + "format": "int64", + "description": "The number of bytes of the content. Same as Size field." + }, + "repository": { + "type": "string", + "description": "The repository name." + }, + "url": { + "type": "string", + "description": "The direct URL to the content." + }, + "tag": { + "type": "string", + "description": "The tag name." + } + } + }, + "ContainerRegistryImageDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ImageDeleted event.", + "allOf": [ + { + "$ref": "#/definitions/ContainerRegistryEventData" + } + ] + }, + "ContainerRegistryImagePushedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ImagePushed event.", + "allOf": [ + { + "$ref": "#/definitions/ContainerRegistryEventData" + } + ] + }, + "ContainerServiceClusterSupportEndedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.ClusterSupportEnded event", + "allOf": [ + { + "$ref": "#/definitions/ContainerServiceClusterSupportEventData" + } + ] + }, + "ContainerServiceClusterSupportEndingEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.ClusterSupportEnding event", + "allOf": [ + { + "$ref": "#/definitions/ContainerServiceClusterSupportEventData" + } + ] + }, + "ContainerServiceClusterSupportEventData": { + "type": "object", + "description": "Schema of common properties of cluster support events", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version of the ManagedCluster resource" + } + } + }, + "ContainerServiceNewKubernetesVersionAvailableEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.NewKubernetesVersionAvailable event", + "properties": { + "latestSupportedKubernetesVersion": { + "type": "string", + "description": "The highest PATCH Kubernetes version for the highest MINOR version supported by ManagedCluster resource" + }, + "latestStableKubernetesVersion": { + "type": "string", + "description": "The highest PATCH Kubernetes version for the MINOR version considered stable for the ManagedCluster resource" + }, + "lowestMinorKubernetesVersion": { + "type": "string", + "description": "The highest PATCH Kubernetes version for the lowest applicable MINOR version available for the ManagedCluster resource" + }, + "latestPreviewKubernetesVersion": { + "type": "string", + "description": "The highest PATCH Kubernetes version considered preview for the ManagedCluster resource. There might not be any version in preview at the time of publishing the event" + } + } + }, + "ContainerServiceNodePoolRollingEventData": { + "type": "object", + "description": "Schema of common properties of node pool rolling events", + "properties": { + "nodePoolName": { + "type": "string", + "description": "The name of the node pool in the ManagedCluster resource" + } + } + }, + "ContainerServiceNodePoolRollingFailedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.NodePoolRollingFailed event", + "allOf": [ + { + "$ref": "#/definitions/ContainerServiceNodePoolRollingEventData" + } + ] + }, + "ContainerServiceNodePoolRollingStartedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.NodePoolRollingStarted event", + "allOf": [ + { + "$ref": "#/definitions/ContainerServiceNodePoolRollingEventData" + } + ] + }, + "ContainerServiceNodePoolRollingSucceededEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.NodePoolRollingSucceeded event", + "allOf": [ + { + "$ref": "#/definitions/ContainerServiceNodePoolRollingEventData" + } + ] + }, + "DataBoxCopyCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.DataBox.CopyCompleted event.", + "properties": { + "serialNumber": { + "type": "string", + "description": "Serial Number of the device associated with the event. The list is comma separated if more than one serial number is associated." + }, + "stageName": { + "$ref": "#/definitions/DataBoxStageName", + "description": "Name of the current Stage" + }, + "stageTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the stage happened." + } + }, + "required": [ + "stageName", + "stageTime" + ] + }, + "DataBoxCopyStartedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.DataBox.CopyStarted event.", + "properties": { + "serialNumber": { + "type": "string", + "description": "Serial Number of the device associated with the event. The list is comma separated if more than one serial number is associated." + }, + "stageName": { + "$ref": "#/definitions/DataBoxStageName", + "description": "Name of the current Stage" + }, + "stageTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the stage happened." + } + }, + "required": [ + "stageName", + "stageTime" + ] + }, + "DataBoxOrderCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.DataBox.OrderCompleted event.", + "properties": { + "serialNumber": { + "type": "string", + "description": "Serial Number of the device associated with the event. The list is comma separated if more than one serial number is associated." + }, + "stageName": { + "$ref": "#/definitions/DataBoxStageName", + "description": "Name of the current Stage" + }, + "stageTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the stage happened." + } + }, + "required": [ + "stageName", + "stageTime" + ] + }, + "DataBoxStageName": { + "type": "string", + "description": "Schema of DataBox Stage Name enumeration.", + "enum": [ + "CopyStarted", + "CopyCompleted", + "OrderCompleted" + ], + "x-ms-enum": { + "name": "DataBoxStageName", + "modelAsString": true, + "values": [ + { + "name": "CopyStarted", + "value": "CopyStarted", + "description": "Copy has started" + }, + { + "name": "CopyCompleted", + "value": "CopyCompleted", + "description": "Copy has completed" + }, + { + "name": "OrderCompleted", + "value": "OrderCompleted", + "description": "Order has been completed" + } + ] + } + }, + "DeviceConnectionStateEventInfo": { + "type": "object", + "description": "Information about the device connection state event.", + "properties": { + "sequenceNumber": { + "type": "string", + "description": "Sequence number is string representation of a hexadecimal number. string compare can be used to identify the larger number because both in ASCII and HEX numbers come after alphabets. If you are converting the string to hex, then the number is a 256 bit number." + } + } + }, + "DeviceConnectionStateEventProperties": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a device connection state event (DeviceConnected, DeviceDisconnected).", + "properties": { + "deviceId": { + "type": "string", + "description": "The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = `@` ; $ '." + }, + "moduleId": { + "type": "string", + "description": "The unique identifier of the module. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = `@` ; $ '." + }, + "hubName": { + "type": "string", + "description": "Name of the IoT Hub where the device was created or deleted." + }, + "deviceConnectionStateEventInfo": { + "$ref": "#/definitions/DeviceConnectionStateEventInfo", + "description": "Information about the device connection state event." + } + }, + "required": [ + "deviceConnectionStateEventInfo" + ] + }, + "DeviceLifeCycleEventProperties": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a device life cycle event (DeviceCreated, DeviceDeleted).", + "properties": { + "deviceId": { + "type": "string", + "description": "The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = `@` ; $ '." + }, + "hubName": { + "type": "string", + "description": "Name of the IoT Hub where the device was created or deleted." + }, + "twin": { + "$ref": "#/definitions/DeviceTwinInfo", + "description": "Information about the device twin, which is the cloud representation of application device metadata." + } + }, + "required": [ + "twin" + ] + }, + "DeviceTelemetryEventProperties": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a device telemetry event (DeviceTelemetry).", + "properties": { + "body": { + "type": "object", + "description": "The content of the message from the device.", + "additionalProperties": {} + }, + "properties": { + "type": "object", + "description": "Application properties are user-defined strings that can be added to the message. These fields are optional.", + "additionalProperties": { + "type": "string" + } + }, + "systemProperties": { + "type": "object", + "description": "System properties help identify contents and source of the messages.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "body", + "properties", + "systemProperties" + ] + }, + "DeviceTwinInfo": { + "type": "object", + "description": "Information about the device twin, which is the cloud representation of application device metadata.", + "properties": { + "authenticationType": { + "type": "string", + "description": "Authentication type used for this device: either SAS, SelfSigned, or CertificateAuthority." + }, + "cloudToDeviceMessageCount": { + "type": "number", + "format": "float", + "description": "Count of cloud to device messages sent to this device." + }, + "connectionState": { + "type": "string", + "description": "Whether the device is connected or disconnected." + }, + "deviceId": { + "type": "string", + "description": "The unique identifier of the device twin." + }, + "etag": { + "type": "string", + "description": "A piece of information that describes the content of the device twin. Each etag is guaranteed to be unique per device twin." + }, + "lastActivityTime": { + "type": "string", + "description": "The ISO8601 timestamp of the last activity." + }, + "properties": { + "$ref": "#/definitions/DeviceTwinInfoProperties", + "description": "Properties JSON element." + }, + "status": { + "type": "string", + "description": "Whether the device twin is enabled or disabled." + }, + "statusUpdateTime": { + "type": "string", + "description": "The ISO8601 timestamp of the last device twin status update." + }, + "version": { + "type": "number", + "format": "float", + "description": "An integer that is incremented by one each time the device twin is updated." + }, + "x509Thumbprint": { + "$ref": "#/definitions/DeviceTwinInfoX509Thumbprint", + "description": "The thumbprint is a unique value for the x509 certificate, commonly used to find a particular certificate in a certificate store. The thumbprint is dynamically generated using the SHA1 algorithm, and does not physically exist in the certificate." + } + }, + "required": [ + "properties", + "x509Thumbprint" + ] + }, + "DeviceTwinInfoProperties": { + "type": "object", + "description": "Properties JSON element.", + "properties": { + "desired": { + "$ref": "#/definitions/DeviceTwinProperties", + "description": "A portion of the properties that can be written only by the application back-end, and read by the device." + }, + "reported": { + "$ref": "#/definitions/DeviceTwinProperties", + "description": "A portion of the properties that can be written only by the device, and read by the application back-end." + } + }, + "required": [ + "desired", + "reported" + ] + }, + "DeviceTwinInfoX509Thumbprint": { + "type": "object", + "description": "The thumbprint is a unique value for the x509 certificate, commonly used to find a particular certificate in a certificate store. The thumbprint is dynamically generated using the SHA1 algorithm, and does not physically exist in the certificate.", + "properties": { + "primaryThumbprint": { + "type": "string", + "description": "Primary thumbprint for the x509 certificate." + }, + "secondaryThumbprint": { + "type": "string", + "description": "Secondary thumbprint for the x509 certificate." + } + } + }, + "DeviceTwinMetadata": { + "type": "object", + "description": "Metadata information for the properties JSON document.", + "properties": { + "lastUpdated": { + "type": "string", + "description": "The ISO8601 timestamp of the last time the properties were updated.", + "x-ms-client-name": "$lastUpdated" + } + } + }, + "DeviceTwinProperties": { + "type": "object", + "description": "A portion of the properties that can be written only by the application back-end, and read by the device.", + "properties": { + "metadata": { + "$ref": "#/definitions/DeviceTwinMetadata", + "description": "Metadata information for the properties JSON document.", + "x-ms-client-name": "$metadata" + }, + "version": { + "type": "number", + "format": "float", + "description": "Version of device twin properties.", + "x-ms-client-name": "$version" + } + }, + "required": [ + "metadata" + ] + }, + "EventGridMQTTClientCreatedOrUpdatedEventData": { + "type": "object", + "description": "Event data for Microsoft.EventGrid.MQTTClientCreatedOrUpdated event.", + "properties": { + "state": { + "$ref": "#/definitions/EventGridMQTTClientState", + "description": "Configured state of the client. The value could be Enabled or Disabled" + }, + "createdOn": { + "type": "string", + "format": "date-time", + "description": "Time the client resource is created based on the provider's UTC time." + }, + "updatedOn": { + "type": "string", + "format": "date-time", + "description": "Time the client resource is last updated based on the provider's UTC time. If\nthe client resource was never updated, this value is identical to the value of\nthe 'createdOn' property." + }, + "attributes": { + "type": "object", + "description": "The key-value attributes that are assigned to the client resource.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "state", + "createdOn", + "updatedOn", + "attributes" + ], + "allOf": [ + { + "$ref": "#/definitions/EventGridMQTTClientEventData" + } + ] + }, + "EventGridMQTTClientDeletedEventData": { + "type": "object", + "description": "Event data for Microsoft.EventGrid.MQTTClientDeleted event.", + "allOf": [ + { + "$ref": "#/definitions/EventGridMQTTClientEventData" + } + ] + }, + "EventGridMQTTClientDisconnectionReason": { + "type": "string", + "description": "EventGrid MQTT Client Disconnection Reason", + "enum": [ + "ClientAuthenticationError", + "ClientAuthorizationError", + "ClientError", + "ClientInitiatedDisconnect", + "ConnectionLost", + "IpForbidden", + "QuotaExceeded", + "ServerError", + "ServerInitiatedDisconnect", + "SessionOverflow", + "SessionTakenOver" + ], + "x-ms-enum": { + "name": "EventGridMQTTClientDisconnectionReason", + "modelAsString": true, + "values": [ + { + "name": "ClientAuthenticationError", + "value": "ClientAuthenticationError", + "description": "The client got disconnected for any authentication reasons (for example, certificate expired, client got disabled, or client configuration changed)." + }, + { + "name": "ClientAuthorizationError", + "value": "ClientAuthorizationError", + "description": "The client got disconnected for any authorization reasons (for example, because of a change in the configuration of topic spaces, permission bindings, or client groups)." + }, + { + "name": "ClientError", + "value": "ClientError", + "description": "The client sent a bad request or used one of the unsupported features that resulted in a connection termination by the service." + }, + { + "name": "ClientInitiatedDisconnect", + "value": "ClientInitiatedDisconnect", + "description": "The client initiated a graceful disconnect through a DISCONNECT packet for MQTT or a close frame for MQTT over WebSocket." + }, + { + "name": "ConnectionLost", + "value": "ConnectionLost", + "description": "The client-server connection is lost. (EXCHANGE ONLINE PROTECTION)." + }, + { + "name": "IpForbidden", + "value": "IpForbidden", + "description": "The client's IP address is blocked by IP filter or Private links configuration." + }, + { + "name": "QuotaExceeded", + "value": "QuotaExceeded", + "description": "The client exceeded one or more of the throttling limits that resulted in a connection termination by the service." + }, + { + "name": "ServerError", + "value": "ServerError", + "description": "The connection got terminated due to an unexpected server error." + }, + { + "name": "ServerInitiatedDisconnect", + "value": "ServerInitiatedDisconnect", + "description": "The server initiates a graceful disconnect for any operational reason." + }, + { + "name": "SessionOverflow", + "value": "SessionOverflow", + "description": "The client's queue for unacknowledged QoS1 messages reached its limit, which resulted in a connection termination by the server." + }, + { + "name": "SessionTakenOver", + "value": "SessionTakenOver", + "description": "The client reconnected with the same authentication name, which resulted in the termination of the previous connection." + } + ] + } + }, + "EventGridMQTTClientEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for MQTT Client state changes.", + "properties": { + "clientAuthenticationName": { + "type": "string", + "description": "Unique identifier for the MQTT client that the client presents to the service\nfor authentication. This case-sensitive string can be up to 128 characters\nlong, and supports UTF-8 characters." + }, + "clientName": { + "type": "string", + "description": "Name of the client resource in the Event Grid namespace." + }, + "namespaceName": { + "type": "string", + "description": "Name of the Event Grid namespace where the MQTT client was created or updated." + } + } + }, + "EventGridMQTTClientSessionConnectedEventData": { + "type": "object", + "description": "Event data for Microsoft.EventGrid.MQTTClientSessionConnected event.", + "properties": { + "clientSessionName": { + "type": "string", + "description": "Unique identifier for the MQTT client's session. This case-sensitive string can\nbe up to 128 characters long, and supports UTF-8 characters." + }, + "sequenceNumber": { + "type": "integer", + "format": "int64", + "description": "A number that helps indicate order of MQTT client session connected or\ndisconnected events. Latest event will have a sequence number that is higher\nthan the previous event." + } + }, + "allOf": [ + { + "$ref": "#/definitions/EventGridMQTTClientEventData" + } + ] + }, + "EventGridMQTTClientSessionDisconnectedEventData": { + "type": "object", + "description": "Event data for Microsoft.EventGrid.MQTTClientSessionDisconnected event.", + "properties": { + "clientSessionName": { + "type": "string", + "description": "Unique identifier for the MQTT client's session. This case-sensitive string can\nbe up to 128 characters long, and supports UTF-8 characters." + }, + "sequenceNumber": { + "type": "integer", + "format": "int64", + "description": "A number that helps indicate order of MQTT client session connected or\ndisconnected events. Latest event will have a sequence number that is higher\nthan the previous event." + }, + "disconnectionReason": { + "$ref": "#/definitions/EventGridMQTTClientDisconnectionReason", + "description": "Reason for the disconnection of the MQTT client's session. The value could be\none of the values in the disconnection reasons table." + } + }, + "required": [ + "disconnectionReason" + ], + "allOf": [ + { + "$ref": "#/definitions/EventGridMQTTClientEventData" + } + ] + }, + "EventGridMQTTClientState": { + "type": "string", + "description": "EventGrid MQTT Client State", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EventGridMQTTClientState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled" + } + ] + } + }, + "EventHubCaptureFileCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.EventHub.CaptureFileCreated event.", + "properties": { + "fileUrl": { + "type": "string", + "description": "The path to the capture file.", + "x-ms-client-name": "fileurl" + }, + "fileType": { + "type": "string", + "description": "The file type of the capture file." + }, + "partitionId": { + "type": "string", + "description": "The shard ID." + }, + "sizeInBytes": { + "type": "integer", + "format": "int32", + "description": "The file size." + }, + "eventCount": { + "type": "integer", + "format": "int32", + "description": "The number of events in the file." + }, + "firstSequenceNumber": { + "type": "integer", + "format": "int32", + "description": "The smallest sequence number from the queue." + }, + "lastSequenceNumber": { + "type": "integer", + "format": "int32", + "description": "The last sequence number from the queue." + }, + "firstEnqueueTime": { + "type": "string", + "format": "date-time", + "description": "The first time from the queue." + }, + "lastEnqueueTime": { + "type": "string", + "format": "date-time", + "description": "The last time from the queue." + } + }, + "required": [ + "firstEnqueueTime", + "lastEnqueueTime" + ] + }, + "HealthcareDicomImageCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.DicomImageCreated event.", + "properties": { + "partitionName": { + "type": "string", + "description": "Data partition name" + }, + "imageStudyInstanceUid": { + "type": "string", + "description": "Unique identifier for the Study" + }, + "imageSeriesInstanceUid": { + "type": "string", + "description": "Unique identifier for the Series" + }, + "imageSopInstanceUid": { + "type": "string", + "description": "Unique identifier for the DICOM Image" + }, + "serviceHostName": { + "type": "string", + "description": "Domain name of the DICOM account for this image." + }, + "sequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of the DICOM Service within Azure Health Data Services. It is unique for every image creation and deletion within the service." + } + } + }, + "HealthcareDicomImageDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.DicomImageDeleted event.", + "properties": { + "partitionName": { + "type": "string", + "description": "Data partition name" + }, + "imageStudyInstanceUid": { + "type": "string", + "description": "Unique identifier for the Study" + }, + "imageSeriesInstanceUid": { + "type": "string", + "description": "Unique identifier for the Series" + }, + "imageSopInstanceUid": { + "type": "string", + "description": "Unique identifier for the DICOM Image" + }, + "serviceHostName": { + "type": "string", + "description": "Host name of the DICOM account for this image." + }, + "sequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of the DICOM Service within Azure Health Data Services. It is unique for every image creation and deletion within the service." + } + } + }, + "HealthcareDicomImageUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.DicomImageUpdated event.", + "properties": { + "partitionName": { + "type": "string", + "description": "Data partition name" + }, + "imageStudyInstanceUid": { + "type": "string", + "description": "Unique identifier for the Study" + }, + "imageSeriesInstanceUid": { + "type": "string", + "description": "Unique identifier for the Series" + }, + "imageSopInstanceUid": { + "type": "string", + "description": "Unique identifier for the DICOM Image" + }, + "serviceHostName": { + "type": "string", + "description": "Domain name of the DICOM account for this image." + }, + "sequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of the DICOM Service within Azure Health Data Services. It is unique for every image creation, updation and deletion within the service." + } + } + }, + "HealthcareFhirResourceCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.FhirResourceCreated event.", + "properties": { + "resourceType": { + "$ref": "#/definitions/HealthcareFhirResourceType", + "description": "Type of HL7 FHIR resource.", + "x-ms-client-name": "FhirResourceType" + }, + "resourceFhirAccount": { + "type": "string", + "description": "Domain name of FHIR account for this resource.", + "x-ms-client-name": "FhirServiceHostName" + }, + "resourceFhirId": { + "type": "string", + "description": "Id of HL7 FHIR resource.", + "x-ms-client-name": "FhirResourceId" + }, + "resourceVersionId": { + "type": "integer", + "format": "int64", + "description": "VersionId of HL7 FHIR resource. It changes when the resource is created, updated, or deleted(soft-deletion).", + "x-ms-client-name": "FhirResourceVersionId" + } + }, + "required": [ + "resourceType" + ] + }, + "HealthcareFhirResourceDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.FhirResourceDeleted event.", + "properties": { + "resourceType": { + "$ref": "#/definitions/HealthcareFhirResourceType", + "description": "Type of HL7 FHIR resource.", + "x-ms-client-name": "FhirResourceType" + }, + "resourceFhirAccount": { + "type": "string", + "description": "Domain name of FHIR account for this resource.", + "x-ms-client-name": "FhirServiceHostName" + }, + "resourceFhirId": { + "type": "string", + "description": "Id of HL7 FHIR resource.", + "x-ms-client-name": "FhirResourceId" + }, + "resourceVersionId": { + "type": "integer", + "format": "int64", + "description": "VersionId of HL7 FHIR resource. It changes when the resource is created, updated, or deleted(soft-deletion).", + "x-ms-client-name": "FhirResourceVersionId" + } + }, + "required": [ + "resourceType" + ] + }, + "HealthcareFhirResourceType": { + "type": "string", + "description": "Schema of FHIR resource type enumeration.", + "enum": [ + "Account", + "ActivityDefinition", + "AdverseEvent", + "AllergyIntolerance", + "Appointment", + "AppointmentResponse", + "AuditEvent", + "Basic", + "Binary", + "BiologicallyDerivedProduct", + "BodySite", + "BodyStructure", + "Bundle", + "CapabilityStatement", + "CarePlan", + "CareTeam", + "CatalogEntry", + "ChargeItem", + "ChargeItemDefinition", + "Claim", + "ClaimResponse", + "ClinicalImpression", + "CodeSystem", + "Communication", + "CommunicationRequest", + "CompartmentDefinition", + "Composition", + "ConceptMap", + "Condition", + "Consent", + "Contract", + "Coverage", + "CoverageEligibilityRequest", + "CoverageEligibilityResponse", + "DataElement", + "DetectedIssue", + "Device", + "DeviceComponent", + "DeviceDefinition", + "DeviceMetric", + "DeviceRequest", + "DeviceUseStatement", + "DiagnosticReport", + "DocumentManifest", + "DocumentReference", + "DomainResource", + "EffectEvidenceSynthesis", + "EligibilityRequest", + "EligibilityResponse", + "Encounter", + "Endpoint", + "EnrollmentRequest", + "EnrollmentResponse", + "EpisodeOfCare", + "EventDefinition", + "Evidence", + "EvidenceVariable", + "ExampleScenario", + "ExpansionProfile", + "ExplanationOfBenefit", + "FamilyMemberHistory", + "Flag", + "Goal", + "GraphDefinition", + "Group", + "GuidanceResponse", + "HealthcareService", + "ImagingManifest", + "ImagingStudy", + "Immunization", + "ImmunizationEvaluation", + "ImmunizationRecommendation", + "ImplementationGuide", + "InsurancePlan", + "Invoice", + "Library", + "Linkage", + "List", + "Location", + "Measure", + "MeasureReport", + "Media", + "Medication", + "MedicationAdministration", + "MedicationDispense", + "MedicationKnowledge", + "MedicationRequest", + "MedicationStatement", + "MedicinalProduct", + "MedicinalProductAuthorization", + "MedicinalProductContraindication", + "MedicinalProductIndication", + "MedicinalProductIngredient", + "MedicinalProductInteraction", + "MedicinalProductManufactured", + "MedicinalProductPackaged", + "MedicinalProductPharmaceutical", + "MedicinalProductUndesirableEffect", + "MessageDefinition", + "MessageHeader", + "MolecularSequence", + "NamingSystem", + "NutritionOrder", + "Observation", + "ObservationDefinition", + "OperationDefinition", + "OperationOutcome", + "Organization", + "OrganizationAffiliation", + "Parameters", + "Patient", + "PaymentNotice", + "PaymentReconciliation", + "Person", + "PlanDefinition", + "Practitioner", + "PractitionerRole", + "Procedure", + "ProcedureRequest", + "ProcessRequest", + "ProcessResponse", + "Provenance", + "Questionnaire", + "QuestionnaireResponse", + "ReferralRequest", + "RelatedPerson", + "RequestGroup", + "ResearchDefinition", + "ResearchElementDefinition", + "ResearchStudy", + "ResearchSubject", + "Resource", + "RiskAssessment", + "RiskEvidenceSynthesis", + "Schedule", + "SearchParameter", + "Sequence", + "ServiceDefinition", + "ServiceRequest", + "Slot", + "Specimen", + "SpecimenDefinition", + "StructureDefinition", + "StructureMap", + "Subscription", + "Substance", + "SubstanceNucleicAcid", + "SubstancePolymer", + "SubstanceProtein", + "SubstanceReferenceInformation", + "SubstanceSourceMaterial", + "SubstanceSpecification", + "SupplyDelivery", + "SupplyRequest", + "Task", + "TerminologyCapabilities", + "TestReport", + "TestScript", + "ValueSet", + "VerificationResult", + "VisionPrescription" + ], + "x-ms-enum": { + "name": "HealthcareFhirResourceType", + "modelAsString": true, + "values": [ + { + "name": "Account", + "value": "Account", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "ActivityDefinition", + "value": "ActivityDefinition", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "AdverseEvent", + "value": "AdverseEvent", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "AllergyIntolerance", + "value": "AllergyIntolerance", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Appointment", + "value": "Appointment", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "AppointmentResponse", + "value": "AppointmentResponse", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "AuditEvent", + "value": "AuditEvent", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Basic", + "value": "Basic", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Binary", + "value": "Binary", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "BiologicallyDerivedProduct", + "value": "BiologicallyDerivedProduct", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "BodySite", + "value": "BodySite", + "description": "The FHIR resource type defined in STU3." + }, + { + "name": "BodyStructure", + "value": "BodyStructure", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "Bundle", + "value": "Bundle", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "CapabilityStatement", + "value": "CapabilityStatement", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "CarePlan", + "value": "CarePlan", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "CareTeam", + "value": "CareTeam", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "CatalogEntry", + "value": "CatalogEntry", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "ChargeItem", + "value": "ChargeItem", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "ChargeItemDefinition", + "value": "ChargeItemDefinition", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "Claim", + "value": "Claim", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "ClaimResponse", + "value": "ClaimResponse", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "ClinicalImpression", + "value": "ClinicalImpression", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "CodeSystem", + "value": "CodeSystem", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Communication", + "value": "Communication", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "CommunicationRequest", + "value": "CommunicationRequest", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "CompartmentDefinition", + "value": "CompartmentDefinition", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Composition", + "value": "Composition", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "ConceptMap", + "value": "ConceptMap", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Condition", + "value": "Condition", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Consent", + "value": "Consent", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Contract", + "value": "Contract", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Coverage", + "value": "Coverage", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "CoverageEligibilityRequest", + "value": "CoverageEligibilityRequest", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "CoverageEligibilityResponse", + "value": "CoverageEligibilityResponse", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "DataElement", + "value": "DataElement", + "description": "The FHIR resource type defined in STU3." + }, + { + "name": "DetectedIssue", + "value": "DetectedIssue", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Device", + "value": "Device", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "DeviceComponent", + "value": "DeviceComponent", + "description": "The FHIR resource type defined in STU3." + }, + { + "name": "DeviceDefinition", + "value": "DeviceDefinition", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "DeviceMetric", + "value": "DeviceMetric", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "DeviceRequest", + "value": "DeviceRequest", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "DeviceUseStatement", + "value": "DeviceUseStatement", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "DiagnosticReport", + "value": "DiagnosticReport", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "DocumentManifest", + "value": "DocumentManifest", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "DocumentReference", + "value": "DocumentReference", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "DomainResource", + "value": "DomainResource", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "EffectEvidenceSynthesis", + "value": "EffectEvidenceSynthesis", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "EligibilityRequest", + "value": "EligibilityRequest", + "description": "The FHIR resource type defined in STU3." + }, + { + "name": "EligibilityResponse", + "value": "EligibilityResponse", + "description": "The FHIR resource type defined in STU3." + }, + { + "name": "Encounter", + "value": "Encounter", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Endpoint", + "value": "Endpoint", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "EnrollmentRequest", + "value": "EnrollmentRequest", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "EnrollmentResponse", + "value": "EnrollmentResponse", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "EpisodeOfCare", + "value": "EpisodeOfCare", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "EventDefinition", + "value": "EventDefinition", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "Evidence", + "value": "Evidence", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "EvidenceVariable", + "value": "EvidenceVariable", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "ExampleScenario", + "value": "ExampleScenario", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "ExpansionProfile", + "value": "ExpansionProfile", + "description": "The FHIR resource type defined in STU3." + }, + { + "name": "ExplanationOfBenefit", + "value": "ExplanationOfBenefit", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "FamilyMemberHistory", + "value": "FamilyMemberHistory", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Flag", + "value": "Flag", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Goal", + "value": "Goal", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "GraphDefinition", + "value": "GraphDefinition", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Group", + "value": "Group", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "GuidanceResponse", + "value": "GuidanceResponse", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "HealthcareService", + "value": "HealthcareService", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "ImagingManifest", + "value": "ImagingManifest", + "description": "The FHIR resource type defined in STU3." + }, + { + "name": "ImagingStudy", + "value": "ImagingStudy", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Immunization", + "value": "Immunization", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "ImmunizationEvaluation", + "value": "ImmunizationEvaluation", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "ImmunizationRecommendation", + "value": "ImmunizationRecommendation", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "ImplementationGuide", + "value": "ImplementationGuide", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "InsurancePlan", + "value": "InsurancePlan", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "Invoice", + "value": "Invoice", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "Library", + "value": "Library", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Linkage", + "value": "Linkage", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "List", + "value": "List", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Location", + "value": "Location", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Measure", + "value": "Measure", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "MeasureReport", + "value": "MeasureReport", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Media", + "value": "Media", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Medication", + "value": "Medication", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "MedicationAdministration", + "value": "MedicationAdministration", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "MedicationDispense", + "value": "MedicationDispense", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "MedicationKnowledge", + "value": "MedicationKnowledge", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "MedicationRequest", + "value": "MedicationRequest", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "MedicationStatement", + "value": "MedicationStatement", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "MedicinalProduct", + "value": "MedicinalProduct", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "MedicinalProductAuthorization", + "value": "MedicinalProductAuthorization", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "MedicinalProductContraindication", + "value": "MedicinalProductContraindication", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "MedicinalProductIndication", + "value": "MedicinalProductIndication", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "MedicinalProductIngredient", + "value": "MedicinalProductIngredient", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "MedicinalProductInteraction", + "value": "MedicinalProductInteraction", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "MedicinalProductManufactured", + "value": "MedicinalProductManufactured", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "MedicinalProductPackaged", + "value": "MedicinalProductPackaged", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "MedicinalProductPharmaceutical", + "value": "MedicinalProductPharmaceutical", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "MedicinalProductUndesirableEffect", + "value": "MedicinalProductUndesirableEffect", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "MessageDefinition", + "value": "MessageDefinition", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "MessageHeader", + "value": "MessageHeader", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "MolecularSequence", + "value": "MolecularSequence", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "NamingSystem", + "value": "NamingSystem", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "NutritionOrder", + "value": "NutritionOrder", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Observation", + "value": "Observation", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "ObservationDefinition", + "value": "ObservationDefinition", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "OperationDefinition", + "value": "OperationDefinition", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "OperationOutcome", + "value": "OperationOutcome", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Organization", + "value": "Organization", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "OrganizationAffiliation", + "value": "OrganizationAffiliation", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "Parameters", + "value": "Parameters", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Patient", + "value": "Patient", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "PaymentNotice", + "value": "PaymentNotice", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "PaymentReconciliation", + "value": "PaymentReconciliation", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Person", + "value": "Person", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "PlanDefinition", + "value": "PlanDefinition", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Practitioner", + "value": "Practitioner", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "PractitionerRole", + "value": "PractitionerRole", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Procedure", + "value": "Procedure", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "ProcedureRequest", + "value": "ProcedureRequest", + "description": "The FHIR resource type defined in STU3." + }, + { + "name": "ProcessRequest", + "value": "ProcessRequest", + "description": "The FHIR resource type defined in STU3." + }, + { + "name": "ProcessResponse", + "value": "ProcessResponse", + "description": "The FHIR resource type defined in STU3." + }, + { + "name": "Provenance", + "value": "Provenance", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Questionnaire", + "value": "Questionnaire", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "QuestionnaireResponse", + "value": "QuestionnaireResponse", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "ReferralRequest", + "value": "ReferralRequest", + "description": "The FHIR resource type defined in STU3." + }, + { + "name": "RelatedPerson", + "value": "RelatedPerson", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "RequestGroup", + "value": "RequestGroup", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "ResearchDefinition", + "value": "ResearchDefinition", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "ResearchElementDefinition", + "value": "ResearchElementDefinition", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "ResearchStudy", + "value": "ResearchStudy", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "ResearchSubject", + "value": "ResearchSubject", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Resource", + "value": "Resource", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "RiskAssessment", + "value": "RiskAssessment", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "RiskEvidenceSynthesis", + "value": "RiskEvidenceSynthesis", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "Schedule", + "value": "Schedule", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "SearchParameter", + "value": "SearchParameter", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Sequence", + "value": "Sequence", + "description": "The FHIR resource type defined in STU3." + }, + { + "name": "ServiceDefinition", + "value": "ServiceDefinition", + "description": "The FHIR resource type defined in STU3." + }, + { + "name": "ServiceRequest", + "value": "ServiceRequest", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "Slot", + "value": "Slot", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Specimen", + "value": "Specimen", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "SpecimenDefinition", + "value": "SpecimenDefinition", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "StructureDefinition", + "value": "StructureDefinition", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "StructureMap", + "value": "StructureMap", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Subscription", + "value": "Subscription", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Substance", + "value": "Substance", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "SubstanceNucleicAcid", + "value": "SubstanceNucleicAcid", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "SubstancePolymer", + "value": "SubstancePolymer", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "SubstanceProtein", + "value": "SubstanceProtein", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "SubstanceReferenceInformation", + "value": "SubstanceReferenceInformation", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "SubstanceSourceMaterial", + "value": "SubstanceSourceMaterial", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "SubstanceSpecification", + "value": "SubstanceSpecification", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "SupplyDelivery", + "value": "SupplyDelivery", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "SupplyRequest", + "value": "SupplyRequest", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "Task", + "value": "Task", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "TerminologyCapabilities", + "value": "TerminologyCapabilities", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "TestReport", + "value": "TestReport", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "TestScript", + "value": "TestScript", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "ValueSet", + "value": "ValueSet", + "description": "The FHIR resource type defined in STU3 and R4." + }, + { + "name": "VerificationResult", + "value": "VerificationResult", + "description": "The FHIR resource type defined in R4." + }, + { + "name": "VisionPrescription", + "value": "VisionPrescription", + "description": "The FHIR resource type defined in STU3 and R4." + } + ] + } + }, + "HealthcareFhirResourceUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.FhirResourceUpdated event.", + "properties": { + "resourceType": { + "$ref": "#/definitions/HealthcareFhirResourceType", + "description": "Type of HL7 FHIR resource.", + "x-ms-client-name": "FhirResourceType" + }, + "resourceFhirAccount": { + "type": "string", + "description": "Domain name of FHIR account for this resource.", + "x-ms-client-name": "FhirServiceHostName" + }, + "resourceFhirId": { + "type": "string", + "description": "Id of HL7 FHIR resource.", + "x-ms-client-name": "FhirResourceId" + }, + "resourceVersionId": { + "type": "integer", + "format": "int64", + "description": "VersionId of HL7 FHIR resource. It changes when the resource is created, updated, or deleted(soft-deletion).", + "x-ms-client-name": "FhirResourceVersionId" + } + }, + "required": [ + "resourceType" + ] + }, + "IotHubDeviceConnectedEventData": { + "type": "object", + "description": "Event data for Microsoft.Devices.DeviceConnected event.", + "allOf": [ + { + "$ref": "#/definitions/DeviceConnectionStateEventProperties" + } + ] + }, + "IotHubDeviceCreatedEventData": { + "type": "object", + "description": "Event data for Microsoft.Devices.DeviceCreated event.", + "allOf": [ + { + "$ref": "#/definitions/DeviceLifeCycleEventProperties" + } + ] + }, + "IotHubDeviceDeletedEventData": { + "type": "object", + "description": "Event data for Microsoft.Devices.DeviceDeleted event.", + "allOf": [ + { + "$ref": "#/definitions/DeviceLifeCycleEventProperties" + } + ] + }, + "IotHubDeviceDisconnectedEventData": { + "type": "object", + "description": "Event data for Microsoft.Devices.DeviceDisconnected event.", + "allOf": [ + { + "$ref": "#/definitions/DeviceConnectionStateEventProperties" + } + ] + }, + "IotHubDeviceTelemetryEventData": { + "type": "object", + "description": "Event data for Microsoft.Devices.DeviceTelemetry event.", + "allOf": [ + { + "$ref": "#/definitions/DeviceTelemetryEventProperties" + } + ] + }, + "KeyVaultAccessPolicyChangedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.VaultAccessPolicyChanged event.", + "properties": { + "Id": { + "type": "string", + "description": "The id of the object that triggered this event." + }, + "VaultName": { + "type": "string", + "description": "Key vault name of the object that triggered this event." + }, + "ObjectType": { + "type": "string", + "description": "The type of the object that triggered this event" + }, + "ObjectName": { + "type": "string", + "description": "The name of the object that triggered this event" + }, + "Version": { + "type": "string", + "description": "The version of the object that triggered this event" + }, + "NBF": { + "type": "number", + "format": "float", + "description": "Not before date of the object that triggered this event" + }, + "EXP": { + "type": "number", + "format": "float", + "description": "The expiration date of the object that triggered this event" + } + } + }, + "KeyVaultCertificateExpiredEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.CertificateExpired event.", + "properties": { + "Id": { + "type": "string", + "description": "The id of the object that triggered this event." + }, + "VaultName": { + "type": "string", + "description": "Key vault name of the object that triggered this event." + }, + "ObjectType": { + "type": "string", + "description": "The type of the object that triggered this event" + }, + "ObjectName": { + "type": "string", + "description": "The name of the object that triggered this event" + }, + "Version": { + "type": "string", + "description": "The version of the object that triggered this event" + }, + "NBF": { + "type": "number", + "format": "float", + "description": "Not before date of the object that triggered this event" + }, + "EXP": { + "type": "number", + "format": "float", + "description": "The expiration date of the object that triggered this event" + } + } + }, + "KeyVaultCertificateNearExpiryEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.CertificateNearExpiry event.", + "properties": { + "Id": { + "type": "string", + "description": "The id of the object that triggered this event." + }, + "VaultName": { + "type": "string", + "description": "Key vault name of the object that triggered this event." + }, + "ObjectType": { + "type": "string", + "description": "The type of the object that triggered this event" + }, + "ObjectName": { + "type": "string", + "description": "The name of the object that triggered this event" + }, + "Version": { + "type": "string", + "description": "The version of the object that triggered this event" + }, + "NBF": { + "type": "number", + "format": "float", + "description": "Not before date of the object that triggered this event" + }, + "EXP": { + "type": "number", + "format": "float", + "description": "The expiration date of the object that triggered this event" + } + } + }, + "KeyVaultCertificateNewVersionCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.CertificateNewVersionCreated event.", + "properties": { + "Id": { + "type": "string", + "description": "The id of the object that triggered this event." + }, + "VaultName": { + "type": "string", + "description": "Key vault name of the object that triggered this event." + }, + "ObjectType": { + "type": "string", + "description": "The type of the object that triggered this event" + }, + "ObjectName": { + "type": "string", + "description": "The name of the object that triggered this event" + }, + "Version": { + "type": "string", + "description": "The version of the object that triggered this event" + }, + "NBF": { + "type": "number", + "format": "float", + "description": "Not before date of the object that triggered this event" + }, + "EXP": { + "type": "number", + "format": "float", + "description": "The expiration date of the object that triggered this event" + } + } + }, + "KeyVaultKeyExpiredEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.KeyExpired event.", + "properties": { + "Id": { + "type": "string", + "description": "The id of the object that triggered this event." + }, + "VaultName": { + "type": "string", + "description": "Key vault name of the object that triggered this event." + }, + "ObjectType": { + "type": "string", + "description": "The type of the object that triggered this event" + }, + "ObjectName": { + "type": "string", + "description": "The name of the object that triggered this event" + }, + "Version": { + "type": "string", + "description": "The version of the object that triggered this event" + }, + "NBF": { + "type": "number", + "format": "float", + "description": "Not before date of the object that triggered this event" + }, + "EXP": { + "type": "number", + "format": "float", + "description": "The expiration date of the object that triggered this event" + } + } + }, + "KeyVaultKeyNearExpiryEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.KeyNearExpiry event.", + "properties": { + "Id": { + "type": "string", + "description": "The id of the object that triggered this event." + }, + "VaultName": { + "type": "string", + "description": "Key vault name of the object that triggered this event." + }, + "ObjectType": { + "type": "string", + "description": "The type of the object that triggered this event" + }, + "ObjectName": { + "type": "string", + "description": "The name of the object that triggered this event" + }, + "Version": { + "type": "string", + "description": "The version of the object that triggered this event" + }, + "NBF": { + "type": "number", + "format": "float", + "description": "Not before date of the object that triggered this event" + }, + "EXP": { + "type": "number", + "format": "float", + "description": "The expiration date of the object that triggered this event" + } + } + }, + "KeyVaultKeyNewVersionCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.KeyNewVersionCreated event.", + "properties": { + "Id": { + "type": "string", + "description": "The id of the object that triggered this event." + }, + "VaultName": { + "type": "string", + "description": "Key vault name of the object that triggered this event." + }, + "ObjectType": { + "type": "string", + "description": "The type of the object that triggered this event" + }, + "ObjectName": { + "type": "string", + "description": "The name of the object that triggered this event" + }, + "Version": { + "type": "string", + "description": "The version of the object that triggered this event" + }, + "NBF": { + "type": "number", + "format": "float", + "description": "Not before date of the object that triggered this event" + }, + "EXP": { + "type": "number", + "format": "float", + "description": "The expiration date of the object that triggered this event" + } + } + }, + "KeyVaultSecretExpiredEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.SecretExpired event.", + "properties": { + "Id": { + "type": "string", + "description": "The id of the object that triggered this event." + }, + "VaultName": { + "type": "string", + "description": "Key vault name of the object that triggered this event." + }, + "ObjectType": { + "type": "string", + "description": "The type of the object that triggered this event" + }, + "ObjectName": { + "type": "string", + "description": "The name of the object that triggered this event" + }, + "Version": { + "type": "string", + "description": "The version of the object that triggered this event" + }, + "NBF": { + "type": "number", + "format": "float", + "description": "Not before date of the object that triggered this event" + }, + "EXP": { + "type": "number", + "format": "float", + "description": "The expiration date of the object that triggered this event" + } + } + }, + "KeyVaultSecretNearExpiryEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.SecretNearExpiry event.", + "properties": { + "Id": { + "type": "string", + "description": "The id of the object that triggered this event." + }, + "VaultName": { + "type": "string", + "description": "Key vault name of the object that triggered this event." + }, + "ObjectType": { + "type": "string", + "description": "The type of the object that triggered this event" + }, + "ObjectName": { + "type": "string", + "description": "The name of the object that triggered this event" + }, + "Version": { + "type": "string", + "description": "The version of the object that triggered this event" + }, + "NBF": { + "type": "number", + "format": "float", + "description": "Not before date of the object that triggered this event" + }, + "EXP": { + "type": "number", + "format": "float", + "description": "The expiration date of the object that triggered this event" + } + } + }, + "KeyVaultSecretNewVersionCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.SecretNewVersionCreated event.", + "properties": { + "Id": { + "type": "string", + "description": "The id of the object that triggered this event." + }, + "VaultName": { + "type": "string", + "description": "Key vault name of the object that triggered this event." + }, + "ObjectType": { + "type": "string", + "description": "The type of the object that triggered this event" + }, + "ObjectName": { + "type": "string", + "description": "The name of the object that triggered this event" + }, + "Version": { + "type": "string", + "description": "The version of the object that triggered this event" + }, + "NBF": { + "type": "number", + "format": "float", + "description": "Not before date of the object that triggered this event" + }, + "EXP": { + "type": "number", + "format": "float", + "description": "The expiration date of the object that triggered this event" + } + } + }, + "MachineLearningServicesDatasetDriftDetectedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.DatasetDriftDetected event.", + "properties": { + "dataDriftId": { + "type": "string", + "description": "The ID of the data drift monitor that triggered the event." + }, + "dataDriftName": { + "type": "string", + "description": "The name of the data drift monitor that triggered the event." + }, + "runId": { + "type": "string", + "description": "The ID of the Run that detected data drift." + }, + "baseDatasetId": { + "type": "string", + "description": "The ID of the base Dataset used to detect drift." + }, + "targetDatasetId": { + "type": "string", + "description": "The ID of the target Dataset used to detect drift." + }, + "driftCoefficient": { + "type": "number", + "format": "double", + "description": "The coefficient result that triggered the event." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the target dataset time series that resulted in drift detection." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the target dataset time series that resulted in drift detection." + } + }, + "required": [ + "startTime", + "endTime" + ] + }, + "MachineLearningServicesModelDeployedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.ModelDeployed event.", + "properties": { + "serviceName": { + "type": "string", + "description": "The name of the deployed service." + }, + "serviceComputeType": { + "type": "string", + "description": "The compute type (e.g. ACI, AKS) of the deployed service." + }, + "modelIds": { + "type": "string", + "description": "A common separated list of model IDs. The IDs of the models deployed in the service." + }, + "serviceTags": { + "type": "object", + "description": "The tags of the deployed service.", + "additionalProperties": {} + }, + "serviceProperties": { + "type": "object", + "description": "The properties of the deployed service.", + "additionalProperties": {} + } + }, + "required": [ + "serviceTags", + "serviceProperties" + ] + }, + "MachineLearningServicesModelRegisteredEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.ModelRegistered event.", + "properties": { + "modelName": { + "type": "string", + "description": "The name of the model that was registered." + }, + "modelVersion": { + "type": "string", + "description": "The version of the model that was registered." + }, + "modelTags": { + "type": "object", + "description": "The tags of the model that was registered.", + "additionalProperties": {} + }, + "modelProperties": { + "type": "object", + "description": "The properties of the model that was registered.", + "additionalProperties": {} + } + }, + "required": [ + "modelTags", + "modelProperties" + ] + }, + "MachineLearningServicesRunCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.RunCompleted event.", + "properties": { + "experimentId": { + "type": "string", + "description": "The ID of the experiment that the run belongs to." + }, + "experimentName": { + "type": "string", + "description": "The name of the experiment that the run belongs to." + }, + "runId": { + "type": "string", + "description": "The ID of the Run that was completed." + }, + "runType": { + "type": "string", + "description": "The Run Type of the completed Run." + }, + "runTags": { + "type": "object", + "description": "The tags of the completed Run.", + "additionalProperties": {} + }, + "runProperties": { + "type": "object", + "description": "The properties of the completed Run.", + "additionalProperties": {} + } + }, + "required": [ + "runTags", + "runProperties" + ] + }, + "MachineLearningServicesRunStatusChangedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.RunStatusChanged event.", + "properties": { + "experimentId": { + "type": "string", + "description": "The ID of the experiment that the Machine Learning Run belongs to." + }, + "experimentName": { + "type": "string", + "description": "The name of the experiment that the Machine Learning Run belongs to." + }, + "runId": { + "type": "string", + "description": "The ID of the Machine Learning Run." + }, + "runType": { + "type": "string", + "description": "The Run Type of the Machine Learning Run." + }, + "runTags": { + "type": "object", + "description": "The tags of the Machine Learning Run.", + "additionalProperties": {} + }, + "runProperties": { + "type": "object", + "description": "The properties of the Machine Learning Run.", + "additionalProperties": {} + }, + "runStatus": { + "type": "string", + "description": "The status of the Machine Learning Run." + } + }, + "required": [ + "runTags", + "runProperties" + ] + }, + "MapsGeofenceEnteredEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceEntered event.", + "allOf": [ + { + "$ref": "#/definitions/MapsGeofenceEventProperties" + } + ] + }, + "MapsGeofenceEventProperties": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Geofence event (GeofenceEntered, GeofenceExited, GeofenceResult).", + "properties": { + "expiredGeofenceGeometryId": { + "type": "array", + "description": "Lists of the geometry ID of the geofence which is expired relative to the user time in the request.", + "items": { + "type": "string" + } + }, + "geometries": { + "type": "array", + "description": "Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.", + "items": { + "$ref": "#/definitions/MapsGeofenceGeometry" + }, + "x-ms-identifiers": [] + }, + "invalidPeriodGeofenceGeometryId": { + "type": "array", + "description": "Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.", + "items": { + "type": "string" + } + }, + "isEventPublished": { + "type": "boolean", + "description": "True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber." + } + }, + "required": [ + "geometries" + ] + }, + "MapsGeofenceExitedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceExited event.", + "allOf": [ + { + "$ref": "#/definitions/MapsGeofenceEventProperties" + } + ] + }, + "MapsGeofenceGeometry": { + "type": "object", + "description": "The geofence geometry.", + "properties": { + "deviceId": { + "type": "string", + "description": "ID of the device." + }, + "distance": { + "type": "number", + "format": "float", + "description": "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." + }, + "geometryId": { + "type": "string", + "description": "The unique ID for the geofence geometry." + }, + "nearestLat": { + "type": "number", + "format": "float", + "description": "Latitude of the nearest point of the geometry." + }, + "nearestLon": { + "type": "number", + "format": "float", + "description": "Longitude of the nearest point of the geometry." + }, + "udId": { + "type": "string", + "description": "The unique id returned from user upload service when uploading a geofence. Will not be included in geofencing post API." + } + } + }, + "MapsGeofenceResultEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceResult event.", + "allOf": [ + { + "$ref": "#/definitions/MapsGeofenceEventProperties" + } + ] + }, + "MediaJobCanceledEventData": { + "type": "object", + "description": "Job canceled event data. Schema of the data property of an EventGridEvent for a\nMicrosoft.Media.JobCanceled event.", + "properties": { + "outputs": { + "type": "array", + "description": "Gets the Job outputs.", + "items": { + "$ref": "#/definitions/MediaJobOutput" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "outputs" + ], + "allOf": [ + { + "$ref": "#/definitions/MediaJobStateChangeEventData" + } + ] + }, + "MediaJobCancelingEventData": { + "type": "object", + "description": "Job canceling event data. Schema of the data property of an EventGridEvent for\na Microsoft.Media.JobCanceling event.", + "allOf": [ + { + "$ref": "#/definitions/MediaJobStateChangeEventData" + } + ] + }, + "MediaJobError": { + "type": "object", + "description": "Details of JobOutput errors.", + "properties": { + "code": { + "$ref": "#/definitions/MediaJobErrorCode", + "description": "Error code describing the error." + }, + "message": { + "type": "string", + "description": "A human-readable language-dependent representation of the error." + }, + "category": { + "$ref": "#/definitions/MediaJobErrorCategory", + "description": "Helps with categorization of errors." + }, + "retry": { + "$ref": "#/definitions/MediaJobRetry", + "description": "Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/MediaJobErrorDetail" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "code", + "category", + "retry", + "details" + ] + }, + "MediaJobErrorCategory": { + "type": "string", + "description": "Error categories for Media Job Errors.", + "enum": [ + "Service", + "Download", + "Upload", + "Configuration", + "Content", + "Account" + ], + "x-ms-enum": { + "name": "MediaJobErrorCategory", + "modelAsString": true, + "values": [ + { + "name": "Service", + "value": "Service", + "description": "The error is service related." + }, + { + "name": "Download", + "value": "Download", + "description": "The error is download related." + }, + { + "name": "Upload", + "value": "Upload", + "description": "The error is upload related." + }, + { + "name": "Configuration", + "value": "Configuration", + "description": "The error is configuration related." + }, + { + "name": "Content", + "value": "Content", + "description": "The error is related to data in the input files." + }, + { + "name": "Account", + "value": "Account", + "description": "The error is related to account information." + } + ] + } + }, + "MediaJobErrorCode": { + "type": "string", + "description": "Media Job Error Codes.", + "enum": [ + "ServiceError", + "ServiceTransientError", + "DownloadNotAccessible", + "DownloadTransientError", + "UploadNotAccessible", + "UploadTransientError", + "ConfigurationUnsupported", + "ContentMalformed", + "ContentUnsupported", + "IdentityUnsupported" + ], + "x-ms-enum": { + "name": "MediaJobErrorCode", + "modelAsString": true, + "values": [ + { + "name": "ServiceError", + "value": "ServiceError", + "description": "Fatal service error, please contact support." + }, + { + "name": "ServiceTransientError", + "value": "ServiceTransientError", + "description": "Transient error, please retry, if retry is unsuccessful, please contact support." + }, + { + "name": "DownloadNotAccessible", + "value": "DownloadNotAccessible", + "description": "While trying to download the input files, the files were not accessible, please check the availability of the source." + }, + { + "name": "DownloadTransientError", + "value": "DownloadTransientError", + "description": "While trying to download the input files, there was an issue during transfer (storage service, network errors), see details and check your source." + }, + { + "name": "UploadNotAccessible", + "value": "UploadNotAccessible", + "description": "While trying to upload the output files, the destination was not reachable, please check the availability of the destination." + }, + { + "name": "UploadTransientError", + "value": "UploadTransientError", + "description": "While trying to upload the output files, there was an issue during transfer (storage service, network errors), see details and check your destination." + }, + { + "name": "ConfigurationUnsupported", + "value": "ConfigurationUnsupported", + "description": "There was a problem with the combination of input files and the configuration settings applied, fix the configuration settings and retry with the same input, or change input to match the configuration." + }, + { + "name": "ContentMalformed", + "value": "ContentMalformed", + "description": "There was a problem with the input content (for example: zero byte files, or corrupt/non-decodable files), check the input files." + }, + { + "name": "ContentUnsupported", + "value": "ContentUnsupported", + "description": "There was a problem with the format of the input (not valid media file, or an unsupported file/codec), check the validity of the input files." + }, + { + "name": "IdentityUnsupported", + "value": "IdentityUnsupported", + "description": "There is an error verifying to the account identity. Check and fix the identity configurations and retry. If unsuccessful, please contact support." + } + ] + } + }, + "MediaJobErrorDetail": { + "type": "object", + "description": "Details of JobOutput errors.", + "properties": { + "code": { + "type": "string", + "description": "Code describing the error detail." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + } + } + }, + "MediaJobErroredEventData": { + "type": "object", + "description": "Job error state event data. Schema of the data property of an EventGridEvent\nfor a Microsoft.Media.JobErrored event.", + "properties": { + "outputs": { + "type": "array", + "description": "Gets the Job outputs.", + "items": { + "$ref": "#/definitions/MediaJobOutput" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "outputs" + ], + "allOf": [ + { + "$ref": "#/definitions/MediaJobStateChangeEventData" + } + ] + }, + "MediaJobFinishedEventData": { + "type": "object", + "description": "Job finished event data. Schema of the data property of an EventGridEvent for a\nMicrosoft.Media.JobFinished event.", + "properties": { + "outputs": { + "type": "array", + "description": "Gets the Job outputs.", + "items": { + "$ref": "#/definitions/MediaJobOutput" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "outputs" + ], + "allOf": [ + { + "$ref": "#/definitions/MediaJobStateChangeEventData" + } + ] + }, + "MediaJobOutput": { + "type": "object", + "description": "The event data for a Job output.", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + }, + "error": { + "$ref": "#/definitions/MediaJobError", + "description": "Gets the Job output error." + }, + "label": { + "type": "string", + "description": "Gets the Job output label." + }, + "progress": { + "type": "integer", + "format": "int64", + "description": "Gets the Job output progress." + }, + "state": { + "$ref": "#/definitions/MediaJobState", + "description": "Gets the Job output state." + } + }, + "discriminator": "@odata.type", + "required": [ + "@odata.type", + "error", + "progress", + "state" + ] + }, + "MediaJobOutputAsset": { + "type": "object", + "description": "The event data for a Job output asset.", + "properties": { + "assetName": { + "type": "string", + "description": "Gets the Job output asset name." + } + }, + "allOf": [ + { + "$ref": "#/definitions/MediaJobOutput" + } + ], + "x-ms-discriminator-value": "#Microsoft.Media.JobOutputAsset" + }, + "MediaJobOutputCanceledEventData": { + "type": "object", + "description": "Job output canceled event data. Schema of the data property of an\nEventGridEvent for a Microsoft.Media.JobOutputCanceled event.", + "allOf": [ + { + "$ref": "#/definitions/MediaJobOutputStateChangeEventData" + } + ] + }, + "MediaJobOutputCancelingEventData": { + "type": "object", + "description": "Job output canceling event data. Schema of the data property of an\nEventGridEvent for a Microsoft.Media.JobOutputCanceling event.", + "allOf": [ + { + "$ref": "#/definitions/MediaJobOutputStateChangeEventData" + } + ] + }, + "MediaJobOutputErroredEventData": { + "type": "object", + "description": "Job output error event data. Schema of the data property of an EventGridEvent\nfor a Microsoft.Media.JobOutputErrored event.", + "allOf": [ + { + "$ref": "#/definitions/MediaJobOutputStateChangeEventData" + } + ] + }, + "MediaJobOutputFinishedEventData": { + "type": "object", + "description": "Job output finished event data. Schema of the data property of an\nEventGridEvent for a Microsoft.Media.JobOutputFinished event.", + "allOf": [ + { + "$ref": "#/definitions/MediaJobOutputStateChangeEventData" + } + ] + }, + "MediaJobOutputProcessingEventData": { + "type": "object", + "description": "Job output processing event data. Schema of the data property of an\nEventGridEvent for a Microsoft.Media.JobOutputProcessing event.", + "allOf": [ + { + "$ref": "#/definitions/MediaJobOutputStateChangeEventData" + } + ] + }, + "MediaJobOutputProgressEventData": { + "type": "object", + "description": "Job Output Progress Event Data. Schema of the Data property of an\n EventGridEvent for a Microsoft.Media.JobOutputProgress event.", + "properties": { + "label": { + "type": "string", + "description": "Gets the Job output label." + }, + "progress": { + "type": "integer", + "format": "int64", + "description": "Gets the Job output progress." + }, + "jobCorrelationData": { + "type": "object", + "description": "Gets the Job correlation data.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "jobCorrelationData" + ] + }, + "MediaJobOutputScheduledEventData": { + "type": "object", + "description": "Job output scheduled event data. Schema of the data property of an\nEventGridEvent for a Microsoft.Media.JobOutputScheduled event.", + "allOf": [ + { + "$ref": "#/definitions/MediaJobOutputStateChangeEventData" + } + ] + }, + "MediaJobOutputStateChangeEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a\n Microsoft.Media.JobOutputStateChange event.", + "properties": { + "previousState": { + "$ref": "#/definitions/MediaJobState", + "description": "The previous state of the Job." + }, + "output": { + "$ref": "#/definitions/MediaJobOutput", + "description": "Gets the output." + }, + "jobCorrelationData": { + "type": "object", + "description": "Gets the Job correlation data.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "previousState", + "output", + "jobCorrelationData" + ] + }, + "MediaJobProcessingEventData": { + "type": "object", + "description": "Job processing event data. Schema of the data property of an EventGridEvent for\na Microsoft.Media.JobProcessing event.", + "allOf": [ + { + "$ref": "#/definitions/MediaJobStateChangeEventData" + } + ] + }, + "MediaJobRetry": { + "type": "string", + "description": "Media Job Retry Options.", + "enum": [ + "DoNotRetry", + "MayRetry" + ], + "x-ms-enum": { + "name": "MediaJobRetry", + "modelAsString": true, + "values": [ + { + "name": "DoNotRetry", + "value": "DoNotRetry", + "description": "Issue needs to be investigated and then the job resubmitted with corrections or retried once the underlying issue has been corrected." + }, + { + "name": "MayRetry", + "value": "MayRetry", + "description": "Issue may be resolved after waiting for a period of time and resubmitting the same Job." + } + ] + } + }, + "MediaJobScheduledEventData": { + "type": "object", + "description": "Job scheduled event data. Schema of the data property of an EventGridEvent for\na Microsoft.Media.JobScheduled event.", + "allOf": [ + { + "$ref": "#/definitions/MediaJobStateChangeEventData" + } + ] + }, + "MediaJobState": { + "type": "string", + "description": "State of a Media Job.", + "enum": [ + "Canceled", + "Canceling", + "Error", + "Finished", + "Processing", + "Queued", + "Scheduled" + ], + "x-ms-enum": { + "name": "MediaJobState", + "modelAsString": true, + "values": [ + { + "name": "Canceled", + "value": "Canceled", + "description": "The job was canceled. This is a final state for the job." + }, + { + "name": "Canceling", + "value": "Canceling", + "description": "The job is in the process of being canceled. This is a transient state for the job." + }, + { + "name": "Error", + "value": "Error", + "description": "The job has encountered an error. This is a final state for the job." + }, + { + "name": "Finished", + "value": "Finished", + "description": "The job is finished. This is a final state for the job." + }, + { + "name": "Processing", + "value": "Processing", + "description": "The job is processing. This is a transient state for the job." + }, + { + "name": "Queued", + "value": "Queued", + "description": "The job is in a queued state, waiting for resources to become available. This is a transient state." + }, + { + "name": "Scheduled", + "value": "Scheduled", + "description": "The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states." + } + ] + } + }, + "MediaJobStateChangeEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a\n Microsoft.Media.JobStateChange event.", + "properties": { + "previousState": { + "$ref": "#/definitions/MediaJobState", + "description": "The previous state of the Job." + }, + "state": { + "$ref": "#/definitions/MediaJobState", + "description": "The new state of the Job." + }, + "correlationData": { + "type": "object", + "description": "Gets the Job correlation data.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "previousState", + "state", + "correlationData" + ] + }, + "MediaLiveEventChannelArchiveHeartbeatEventData": { + "type": "object", + "description": "Channel Archive heartbeat event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventChannelArchiveHeartbeat event.", + "properties": { + "channelLatencyMs": { + "type": "string", + "description": "Gets the channel latency in ms." + }, + "latencyResultCode": { + "type": "string", + "description": "Gets the latency result code." + } + }, + "required": [ + "channelLatencyMs", + "latencyResultCode" + ] + }, + "MediaLiveEventConnectionRejectedEventData": { + "type": "object", + "description": "Encoder connection rejected event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventConnectionRejected event.", + "properties": { + "ingestUrl": { + "type": "string", + "description": "Gets the ingest URL provided by the live event." + }, + "streamId": { + "type": "string", + "description": "Gets the stream Id." + }, + "encoderIp": { + "type": "string", + "description": "Gets the remote IP." + }, + "encoderPort": { + "type": "string", + "description": "Gets the remote port." + }, + "resultCode": { + "type": "string", + "description": "Gets the result code." + } + } + }, + "MediaLiveEventEncoderConnectedEventData": { + "type": "object", + "description": "Encoder connect event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventEncoderConnected event.", + "properties": { + "ingestUrl": { + "type": "string", + "description": "Gets the ingest URL provided by the live event." + }, + "streamId": { + "type": "string", + "description": "Gets the stream Id." + }, + "encoderIp": { + "type": "string", + "description": "Gets the remote IP." + }, + "encoderPort": { + "type": "string", + "description": "Gets the remote port." + } + } + }, + "MediaLiveEventEncoderDisconnectedEventData": { + "type": "object", + "description": "Encoder disconnected event data. Schema of the Data property of an EventGridEvent for a Microsoft.Media.LiveEventEncoderDisconnected event.", + "properties": { + "ingestUrl": { + "type": "string", + "description": "Gets the ingest URL provided by the live event." + }, + "streamId": { + "type": "string", + "description": "Gets the stream Id." + }, + "encoderIp": { + "type": "string", + "description": "Gets the remote IP." + }, + "encoderPort": { + "type": "string", + "description": "Gets the remote port." + }, + "resultCode": { + "type": "string", + "description": "Gets the result code." + } + } + }, + "MediaLiveEventIncomingDataChunkDroppedEventData": { + "type": "object", + "description": "Ingest fragment dropped event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIncomingDataChunkDropped event.", + "properties": { + "timestamp": { + "type": "string", + "description": "Gets the timestamp of the data chunk dropped." + }, + "trackType": { + "type": "string", + "description": "Gets the type of the track (Audio / Video)." + }, + "bitrate": { + "type": "integer", + "format": "int64", + "description": "Gets the bitrate of the track." + }, + "timescale": { + "type": "string", + "description": "Gets the timescale of the Timestamp." + }, + "resultCode": { + "type": "string", + "description": "Gets the result code for fragment drop operation." + }, + "trackName": { + "type": "string", + "description": "Gets the name of the track for which fragment is dropped." + } + } + }, + "MediaLiveEventIncomingStreamReceivedEventData": { + "type": "object", + "description": "Encoder connect event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIncomingStreamReceived event.", + "properties": { + "ingestUrl": { + "type": "string", + "description": "Gets the ingest URL provided by the live event." + }, + "trackType": { + "type": "string", + "description": "Gets the type of the track (Audio / Video)." + }, + "trackName": { + "type": "string", + "description": "Gets the track name." + }, + "bitrate": { + "type": "integer", + "format": "int64", + "description": "Gets the bitrate of the track." + }, + "encoderIp": { + "type": "string", + "description": "Gets the remote IP." + }, + "encoderPort": { + "type": "string", + "description": "Gets the remote port." + }, + "timestamp": { + "type": "string", + "description": "Gets the first timestamp of the data chunk received." + }, + "duration": { + "type": "string", + "description": "Gets the duration of the first data chunk." + }, + "timescale": { + "type": "string", + "description": "Gets the timescale in which timestamp is represented." + } + } + }, + "MediaLiveEventIncomingStreamsOutOfSyncEventData": { + "type": "object", + "description": "Incoming streams out of sync event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIncomingStreamsOutOfSync event.", + "properties": { + "minLastTimestamp": { + "type": "string", + "description": "Gets the minimum last timestamp received." + }, + "typeOfStreamWithMinLastTimestamp": { + "type": "string", + "description": "Gets the type of stream with minimum last timestamp." + }, + "maxLastTimestamp": { + "type": "string", + "description": "Gets the maximum timestamp among all the tracks (audio or video)." + }, + "typeOfStreamWithMaxLastTimestamp": { + "type": "string", + "description": "Gets the type of stream with maximum last timestamp." + }, + "timescaleOfMinLastTimestamp": { + "type": "string", + "description": "Gets the timescale in which \\\"MinLastTimestamp\\\" is represented." + }, + "timescaleOfMaxLastTimestamp": { + "type": "string", + "description": "Gets the timescale in which \\\"MaxLastTimestamp\\\" is represented." + } + } + }, + "MediaLiveEventIncomingVideoStreamsOutOfSyncEventData": { + "type": "object", + "description": "Incoming video stream out of sync event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIncomingVideoStreamsOutOfSync event.", + "properties": { + "firstTimestamp": { + "type": "string", + "description": "Gets the first timestamp received for one of the quality levels." + }, + "firstDuration": { + "type": "string", + "description": "Gets the duration of the data chunk with first timestamp." + }, + "secondTimestamp": { + "type": "string", + "description": "Gets the timestamp received for some other quality levels." + }, + "secondDuration": { + "type": "string", + "description": "Gets the duration of the data chunk with second timestamp." + }, + "timescale": { + "type": "string", + "description": "Gets the timescale in which both the timestamps and durations are represented." + } + } + }, + "MediaLiveEventIngestHeartbeatEventData": { + "type": "object", + "description": "Ingest heartbeat event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIngestHeartbeat event.", + "properties": { + "trackType": { + "type": "string", + "description": "Gets the type of the track (Audio / Video)." + }, + "trackName": { + "type": "string", + "description": "Gets the track name." + }, + "transcriptionLanguage": { + "type": "string", + "description": "Gets the Live Transcription language." + }, + "transcriptionState": { + "type": "string", + "description": "Gets the Live Transcription state." + }, + "bitrate": { + "type": "integer", + "format": "int64", + "description": "Gets the bitrate of the track." + }, + "incomingBitrate": { + "type": "integer", + "format": "int64", + "description": "Gets the incoming bitrate." + }, + "ingestDriftValue": { + "type": "string", + "description": "Gets the track ingest drift value." + }, + "lastFragmentArrivalTime": { + "type": "string", + "description": "Gets the arrival UTC time of the last fragment." + }, + "lastTimestamp": { + "type": "string", + "description": "Gets the last timestamp." + }, + "timescale": { + "type": "string", + "description": "Gets the timescale of the last timestamp." + }, + "overlapCount": { + "type": "integer", + "format": "int64", + "description": "Gets the fragment Overlap count." + }, + "discontinuityCount": { + "type": "integer", + "format": "int64", + "description": "Gets the fragment Discontinuity count." + }, + "nonincreasingCount": { + "type": "integer", + "format": "int64", + "description": "Gets Non increasing count." + }, + "unexpectedBitrate": { + "type": "boolean", + "description": "Gets a value indicating whether unexpected bitrate is present or not." + }, + "state": { + "type": "string", + "description": "Gets the state of the live event." + }, + "healthy": { + "type": "boolean", + "description": "Gets a value indicating whether preview is healthy or not." + } + } + }, + "MediaLiveEventTrackDiscontinuityDetectedEventData": { + "type": "object", + "description": "Ingest track discontinuity detected event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventTrackDiscontinuityDetected event.", + "properties": { + "trackType": { + "type": "string", + "description": "Gets the type of the track (Audio / Video)." + }, + "trackName": { + "type": "string", + "description": "Gets the track name." + }, + "bitrate": { + "type": "integer", + "format": "int64", + "description": "Gets the bitrate." + }, + "previousTimestamp": { + "type": "string", + "description": "Gets the timestamp of the previous fragment." + }, + "newTimestamp": { + "type": "string", + "description": "Gets the timestamp of the current fragment." + }, + "timescale": { + "type": "string", + "description": "Gets the timescale in which both timestamps and discontinuity gap are represented." + }, + "discontinuityGap": { + "type": "string", + "description": "Gets the discontinuity gap between PreviousTimestamp and NewTimestamp." + } + } + }, + "MicrosoftTeamsAppIdentifierModel": { + "type": "object", + "description": "A Microsoft Teams application.", + "properties": { + "appId": { + "type": "string", + "description": "The Id of the Microsoft Teams application" + }, + "cloud": { + "$ref": "#/definitions/CommunicationCloudEnvironmentModel", + "description": "The cloud that the Microsoft Teams application belongs to. By default 'public' if missing." + } + }, + "required": [ + "appId", + "cloud" + ] + }, + "MicrosoftTeamsUserIdentifierModel": { + "type": "object", + "description": "A Microsoft Teams user.", + "properties": { + "userId": { + "type": "string", + "description": "The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user." + }, + "isAnonymous": { + "type": "boolean", + "description": "True if the Microsoft Teams user is anonymous. By default false if missing." + }, + "cloud": { + "$ref": "#/definitions/CommunicationCloudEnvironmentModel", + "description": "The cloud that the Microsoft Teams user belongs to. By default 'public' if missing." + } + }, + "required": [ + "userId", + "cloud" + ] + }, + "PhoneNumberIdentifierModel": { + "type": "object", + "description": "A phone number.", + "properties": { + "value": { + "type": "string", + "description": "The phone number in E.164 format." + } + }, + "required": [ + "value" + ] + }, + "PolicyInsightsPolicyStateChangedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.PolicyInsights.PolicyStateChanged event.", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The time that the resource was scanned by Azure Policy in the Universal ISO 8601 DateTime format yyyy-MM-ddTHH:mm:ss.fffffffZ." + }, + "policyAssignmentId": { + "type": "string", + "description": "The resource ID of the policy assignment." + }, + "policyDefinitionId": { + "type": "string", + "description": "The resource ID of the policy definition." + }, + "policyDefinitionReferenceId": { + "type": "string", + "description": "The reference ID for the policy definition inside the initiative definition, if the policy assignment is for an initiative. May be empty." + }, + "complianceState": { + "type": "string", + "description": "The compliance state of the resource with respect to the policy assignment." + }, + "subscriptionId": { + "type": "string", + "description": "The subscription ID of the resource." + }, + "complianceReasonCode": { + "type": "string", + "description": "The compliance reason code. May be empty." + } + }, + "required": [ + "timestamp" + ] + }, + "PolicyInsightsPolicyStateCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.PolicyInsights.PolicyStateCreated event.", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The time that the resource was scanned by Azure Policy in the Universal ISO 8601 DateTime format yyyy-MM-ddTHH:mm:ss.fffffffZ." + }, + "policyAssignmentId": { + "type": "string", + "description": "The resource ID of the policy assignment." + }, + "policyDefinitionId": { + "type": "string", + "description": "The resource ID of the policy definition." + }, + "policyDefinitionReferenceId": { + "type": "string", + "description": "The reference ID for the policy definition inside the initiative definition, if the policy assignment is for an initiative. May be empty." + }, + "complianceState": { + "type": "string", + "description": "The compliance state of the resource with respect to the policy assignment." + }, + "subscriptionId": { + "type": "string", + "description": "The subscription ID of the resource." + }, + "complianceReasonCode": { + "type": "string", + "description": "The compliance reason code. May be empty." + } + }, + "required": [ + "timestamp" + ] + }, + "PolicyInsightsPolicyStateDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.PolicyInsights.PolicyStateDeleted event.", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The time that the resource was scanned by Azure Policy in the Universal ISO 8601 DateTime format yyyy-MM-ddTHH:mm:ss.fffffffZ." + }, + "policyAssignmentId": { + "type": "string", + "description": "The resource ID of the policy assignment." + }, + "policyDefinitionId": { + "type": "string", + "description": "The resource ID of the policy definition." + }, + "policyDefinitionReferenceId": { + "type": "string", + "description": "The reference ID for the policy definition inside the initiative definition, if the policy assignment is for an initiative. May be empty." + }, + "complianceState": { + "type": "string", + "description": "The compliance state of the resource with respect to the policy assignment." + }, + "subscriptionId": { + "type": "string", + "description": "The subscription ID of the resource." + }, + "complianceReasonCode": { + "type": "string", + "description": "The compliance reason code. May be empty." + } + }, + "required": [ + "timestamp" + ] + }, + "RedisExportRDBCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Cache.ExportRDBCompleted event.", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The time at which the event occurred." + }, + "name": { + "type": "string", + "description": "The name of this event." + }, + "status": { + "type": "string", + "description": "The status of this event. Failed or succeeded" + } + }, + "required": [ + "timestamp" + ] + }, + "RedisImportRDBCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Cache.ImportRDBCompleted event.", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The time at which the event occurred." + }, + "name": { + "type": "string", + "description": "The name of this event." + }, + "status": { + "type": "string", + "description": "The status of this event. Failed or succeeded" + } + }, + "required": [ + "timestamp" + ] + }, + "RedisPatchingCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Cache.PatchingCompleted event.", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The time at which the event occurred." + }, + "name": { + "type": "string", + "description": "The name of this event." + }, + "status": { + "type": "string", + "description": "The status of this event. Failed or succeeded" + } + }, + "required": [ + "timestamp" + ] + }, + "RedisScalingCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Cache.ScalingCompleted event.", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The time at which the event occurred." + }, + "name": { + "type": "string", + "description": "The name of this event." + }, + "status": { + "type": "string", + "description": "The status of this event. Failed or succeeded" + } + }, + "required": [ + "timestamp" + ] + }, + "ResourceActionCancelEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionCancel event. This is raised when a resource action operation is canceled.", + "properties": { + "tenantId": { + "type": "string", + "description": "The tenant ID of the resource." + }, + "subscriptionId": { + "type": "string", + "description": "The subscription ID of the resource." + }, + "resourceGroup": { + "type": "string", + "description": "The resource group of the resource." + }, + "resourceProvider": { + "type": "string", + "description": "The resource provider performing the operation." + }, + "resourceUri": { + "type": "string", + "description": "The URI of the resource in the operation." + }, + "operationName": { + "type": "string", + "description": "The operation that was performed." + }, + "status": { + "type": "string", + "description": "The status of the operation." + }, + "authorization": { + "$ref": "#/definitions/ResourceAuthorization", + "description": "The requested authorization for the operation." + }, + "claims": { + "type": "object", + "description": "The properties of the claims.", + "additionalProperties": { + "type": "string" + } + }, + "correlationId": { + "type": "string", + "description": "An operation ID used for troubleshooting." + }, + "httpRequest": { + "$ref": "#/definitions/ResourceHttpRequest", + "description": "The details of the operation." + } + }, + "required": [ + "authorization", + "claims", + "httpRequest" + ] + }, + "ResourceActionFailureEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionFailure event. This is raised when a resource action operation fails.", + "properties": { + "tenantId": { + "type": "string", + "description": "The tenant ID of the resource." + }, + "subscriptionId": { + "type": "string", + "description": "The subscription ID of the resource." + }, + "resourceGroup": { + "type": "string", + "description": "The resource group of the resource." + }, + "resourceProvider": { + "type": "string", + "description": "The resource provider performing the operation." + }, + "resourceUri": { + "type": "string", + "description": "The URI of the resource in the operation." + }, + "operationName": { + "type": "string", + "description": "The operation that was performed." + }, + "status": { + "type": "string", + "description": "The status of the operation." + }, + "authorization": { + "$ref": "#/definitions/ResourceAuthorization", + "description": "The requested authorization for the operation." + }, + "claims": { + "type": "object", + "description": "The properties of the claims.", + "additionalProperties": { + "type": "string" + } + }, + "correlationId": { + "type": "string", + "description": "An operation ID used for troubleshooting." + }, + "httpRequest": { + "$ref": "#/definitions/ResourceHttpRequest", + "description": "The details of the operation." + } + }, + "required": [ + "authorization", + "claims", + "httpRequest" + ] + }, + "ResourceActionSuccessEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionSuccess event. This is raised when a resource action operation succeeds.", + "properties": { + "tenantId": { + "type": "string", + "description": "The tenant ID of the resource." + }, + "subscriptionId": { + "type": "string", + "description": "The subscription ID of the resource." + }, + "resourceGroup": { + "type": "string", + "description": "The resource group of the resource." + }, + "resourceProvider": { + "type": "string", + "description": "The resource provider performing the operation." + }, + "resourceUri": { + "type": "string", + "description": "The URI of the resource in the operation." + }, + "operationName": { + "type": "string", + "description": "The operation that was performed." + }, + "status": { + "type": "string", + "description": "The status of the operation." + }, + "authorization": { + "$ref": "#/definitions/ResourceAuthorization", + "description": "The requested authorization for the operation." + }, + "claims": { + "type": "object", + "description": "The properties of the claims.", + "additionalProperties": { + "type": "string" + } + }, + "correlationId": { + "type": "string", + "description": "An operation ID used for troubleshooting." + }, + "httpRequest": { + "$ref": "#/definitions/ResourceHttpRequest", + "description": "The details of the operation." + } + }, + "required": [ + "authorization", + "claims", + "httpRequest" + ] + }, + "ResourceAuthorization": { + "type": "object", + "description": "The details of the authorization for the resource.", + "properties": { + "scope": { + "type": "string", + "description": "The scope of the authorization." + }, + "action": { + "type": "string", + "description": "The action being requested." + }, + "evidence": { + "type": "object", + "description": "The evidence for the authorization.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "evidence" + ] + }, + "ResourceDeleteCancelEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteCancel event. This is raised when a resource delete operation is canceled.", + "properties": { + "tenantId": { + "type": "string", + "description": "The tenant ID of the resource." + }, + "subscriptionId": { + "type": "string", + "description": "The subscription ID of the resource." + }, + "resourceGroup": { + "type": "string", + "description": "The resource group of the resource." + }, + "resourceProvider": { + "type": "string", + "description": "The resource provider performing the operation." + }, + "resourceUri": { + "type": "string", + "description": "The URI of the resource in the operation." + }, + "operationName": { + "type": "string", + "description": "The operation that was performed." + }, + "status": { + "type": "string", + "description": "The status of the operation." + }, + "authorization": { + "$ref": "#/definitions/ResourceAuthorization", + "description": "The requested authorization for the operation." + }, + "claims": { + "type": "object", + "description": "The properties of the claims.", + "additionalProperties": { + "type": "string" + } + }, + "correlationId": { + "type": "string", + "description": "An operation ID used for troubleshooting." + }, + "httpRequest": { + "$ref": "#/definitions/ResourceHttpRequest", + "description": "The details of the operation." + } + }, + "required": [ + "authorization", + "claims", + "httpRequest" + ] + }, + "ResourceDeleteFailureEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteFailure event. This is raised when a resource delete operation fails.", + "properties": { + "tenantId": { + "type": "string", + "description": "The tenant ID of the resource." + }, + "subscriptionId": { + "type": "string", + "description": "The subscription ID of the resource." + }, + "resourceGroup": { + "type": "string", + "description": "The resource group of the resource." + }, + "resourceProvider": { + "type": "string", + "description": "The resource provider performing the operation." + }, + "resourceUri": { + "type": "string", + "description": "The URI of the resource in the operation." + }, + "operationName": { + "type": "string", + "description": "The operation that was performed." + }, + "status": { + "type": "string", + "description": "The status of the operation." + }, + "authorization": { + "$ref": "#/definitions/ResourceAuthorization", + "description": "The requested authorization for the operation." + }, + "claims": { + "type": "object", + "description": "The properties of the claims.", + "additionalProperties": { + "type": "string" + } + }, + "correlationId": { + "type": "string", + "description": "An operation ID used for troubleshooting." + }, + "httpRequest": { + "$ref": "#/definitions/ResourceHttpRequest", + "description": "The details of the operation." + } + }, + "required": [ + "authorization", + "claims", + "httpRequest" + ] + }, + "ResourceDeleteSuccessEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteSuccess event. This is raised when a resource delete operation succeeds.", + "properties": { + "tenantId": { + "type": "string", + "description": "The tenant ID of the resource." + }, + "subscriptionId": { + "type": "string", + "description": "The subscription ID of the resource." + }, + "resourceGroup": { + "type": "string", + "description": "The resource group of the resource." + }, + "resourceProvider": { + "type": "string", + "description": "The resource provider performing the operation." + }, + "resourceUri": { + "type": "string", + "description": "The URI of the resource in the operation." + }, + "operationName": { + "type": "string", + "description": "The operation that was performed." + }, + "status": { + "type": "string", + "description": "The status of the operation." + }, + "authorization": { + "$ref": "#/definitions/ResourceAuthorization", + "description": "The requested authorization for the operation." + }, + "claims": { + "type": "object", + "description": "The properties of the claims.", + "additionalProperties": { + "type": "string" + } + }, + "correlationId": { + "type": "string", + "description": "An operation ID used for troubleshooting." + }, + "httpRequest": { + "$ref": "#/definitions/ResourceHttpRequest", + "description": "The details of the operation." + } + }, + "required": [ + "authorization", + "claims", + "httpRequest" + ] + }, + "ResourceHttpRequest": { + "type": "object", + "description": "The details of the HTTP request.", + "properties": { + "clientRequestId": { + "type": "string", + "description": "The client request ID." + }, + "clientIpAddress": { + "type": "string", + "description": "The client IP address." + }, + "method": { + "type": "string", + "description": "The request method." + }, + "url": { + "type": "string", + "description": "The url used in the request." + } + } + }, + "ResourceNotificationsHealthResourcesAnnotatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a\nMicrosoft.ResourceNotifications.HealthResources.ResourceAnnotated event.", + "allOf": [ + { + "$ref": "#/definitions/ResourceNotificationsResourceUpdatedEventData" + } + ] + }, + "ResourceNotificationsHealthResourcesAvailabilityStatusChangedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a\nMicrosoft.ResourceNotifications.HealthResources.AvailabilityStatusChanged\nevent.", + "allOf": [ + { + "$ref": "#/definitions/ResourceNotificationsResourceUpdatedEventData" + } + ] + }, + "ResourceNotificationsOperationalDetails": { + "type": "object", + "description": "details of operational info", + "properties": { + "resourceEventTime": { + "type": "string", + "format": "date-time", + "description": "Date and Time when resource was updated" + } + }, + "required": [ + "resourceEventTime" + ] + }, + "ResourceNotificationsResourceDeletedDetails": { + "type": "object", + "description": "Describes the schema of the properties under resource info which are common\nacross all ARN system topic delete events", + "properties": { + "id": { + "type": "string", + "description": "id of the resource for which the event is being emitted" + }, + "name": { + "type": "string", + "description": "name of the resource for which the event is being emitted" + }, + "type": { + "type": "string", + "description": "the type of the resource for which the event is being emitted" + } + } + }, + "ResourceNotificationsResourceDeletedEventData": { + "type": "object", + "description": "Describes the schema of the common properties across all ARN system topic\ndelete events", + "properties": { + "resourceInfo": { + "$ref": "#/definitions/ResourceNotificationsResourceDeletedDetails", + "description": "resourceInfo details for delete event", + "x-ms-client-name": "resourceDetails" + }, + "operationalInfo": { + "$ref": "#/definitions/ResourceNotificationsOperationalDetails", + "description": "details about operational info", + "x-ms-client-name": "operationalDetails" + } + }, + "required": [ + "resourceInfo", + "operationalInfo" + ] + }, + "ResourceNotificationsResourceManagementCreatedOrUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a\nMicrosoft.ResourceNotifications.Resources.CreatedOrUpdated event.", + "allOf": [ + { + "$ref": "#/definitions/ResourceNotificationsResourceUpdatedEventData" + } + ] + }, + "ResourceNotificationsResourceManagementDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a\nMicrosoft.ResourceNotifications.Resources.Deleted event.", + "allOf": [ + { + "$ref": "#/definitions/ResourceNotificationsResourceDeletedEventData" + } + ] + }, + "ResourceNotificationsResourceUpdatedDetails": { + "type": "object", + "description": "Describes the schema of the properties under resource info which are common\nacross all ARN system topic events", + "properties": { + "id": { + "type": "string", + "description": "id of the resource for which the event is being emitted" + }, + "name": { + "type": "string", + "description": "name of the resource for which the event is being emitted" + }, + "type": { + "type": "string", + "description": "the type of the resource for which the event is being emitted" + }, + "location": { + "type": "string", + "description": "the location of the resource for which the event is being emitted" + }, + "tags": { + "type": "object", + "description": "the tags on the resource for which the event is being emitted", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "type": "object", + "description": "properties in the payload of the resource for which the event is being emitted", + "additionalProperties": {} + } + }, + "required": [ + "tags", + "properties" + ] + }, + "ResourceNotificationsResourceUpdatedEventData": { + "type": "object", + "description": "Describes the schema of the common properties across all ARN system topic events", + "properties": { + "resourceInfo": { + "$ref": "#/definitions/ResourceNotificationsResourceUpdatedDetails", + "description": "resourceInfo details for update event", + "x-ms-client-name": "resourceDetails" + }, + "operationalInfo": { + "$ref": "#/definitions/ResourceNotificationsOperationalDetails", + "description": "details about operational info", + "x-ms-client-name": "operationalDetails" + }, + "apiVersion": { + "type": "string", + "description": "api version of the resource properties bag" + } + }, + "required": [ + "resourceInfo", + "operationalInfo" + ] + }, + "ResourceWriteCancelEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteCancel event. This is raised when a resource create or update operation is canceled.", + "properties": { + "tenantId": { + "type": "string", + "description": "The tenant ID of the resource." + }, + "subscriptionId": { + "type": "string", + "description": "The subscription ID of the resource." + }, + "resourceGroup": { + "type": "string", + "description": "The resource group of the resource." + }, + "resourceProvider": { + "type": "string", + "description": "The resource provider performing the operation." + }, + "resourceUri": { + "type": "string", + "description": "The URI of the resource in the operation." + }, + "operationName": { + "type": "string", + "description": "The operation that was performed." + }, + "status": { + "type": "string", + "description": "The status of the operation." + }, + "authorization": { + "$ref": "#/definitions/ResourceAuthorization", + "description": "The requested authorization for the operation." + }, + "claims": { + "type": "object", + "description": "The properties of the claims.", + "additionalProperties": { + "type": "string" + } + }, + "correlationId": { + "type": "string", + "description": "An operation ID used for troubleshooting." + }, + "httpRequest": { + "$ref": "#/definitions/ResourceHttpRequest", + "description": "The details of the operation." + } + }, + "required": [ + "authorization", + "claims", + "httpRequest" + ] + }, + "ResourceWriteFailureEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteFailure event. This is raised when a resource create or update operation fails.", + "properties": { + "tenantId": { + "type": "string", + "description": "The tenant ID of the resource." + }, + "subscriptionId": { + "type": "string", + "description": "The subscription ID of the resource." + }, + "resourceGroup": { + "type": "string", + "description": "The resource group of the resource." + }, + "resourceProvider": { + "type": "string", + "description": "The resource provider performing the operation." + }, + "resourceUri": { + "type": "string", + "description": "The URI of the resource in the operation." + }, + "operationName": { + "type": "string", + "description": "The operation that was performed." + }, + "status": { + "type": "string", + "description": "The status of the operation." + }, + "authorization": { + "$ref": "#/definitions/ResourceAuthorization", + "description": "The requested authorization for the operation." + }, + "claims": { + "type": "object", + "description": "The properties of the claims.", + "additionalProperties": { + "type": "string" + } + }, + "correlationId": { + "type": "string", + "description": "An operation ID used for troubleshooting." + }, + "httpRequest": { + "$ref": "#/definitions/ResourceHttpRequest", + "description": "The details of the operation." + } + }, + "required": [ + "authorization", + "claims", + "httpRequest" + ] + }, + "ResourceWriteSuccessEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteSuccess event. This is raised when a resource create or update operation succeeds.", + "properties": { + "tenantId": { + "type": "string", + "description": "The tenant ID of the resource." + }, + "subscriptionId": { + "type": "string", + "description": "The subscription ID of the resource." + }, + "resourceGroup": { + "type": "string", + "description": "The resource group of the resource." + }, + "resourceProvider": { + "type": "string", + "description": "The resource provider performing the operation." + }, + "resourceUri": { + "type": "string", + "description": "The URI of the resource in the operation." + }, + "operationName": { + "type": "string", + "description": "The operation that was performed." + }, + "status": { + "type": "string", + "description": "The status of the operation." + }, + "authorization": { + "$ref": "#/definitions/ResourceAuthorization", + "description": "The requested authorization for the operation." + }, + "claims": { + "type": "object", + "description": "The properties of the claims.", + "additionalProperties": { + "type": "string" + } + }, + "correlationId": { + "type": "string", + "description": "An operation ID used for troubleshooting." + }, + "httpRequest": { + "$ref": "#/definitions/ResourceHttpRequest", + "description": "The details of the operation." + } + }, + "required": [ + "authorization", + "claims", + "httpRequest" + ] + }, + "ServiceBusActiveMessagesAvailablePeriodicNotificationsEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.ActiveMessagesAvailablePeriodicNotifications event.", + "properties": { + "namespaceName": { + "type": "string", + "description": "The namespace name of the Microsoft.ServiceBus resource." + }, + "requestUri": { + "type": "string", + "description": "The endpoint of the Microsoft.ServiceBus resource." + }, + "entityType": { + "type": "string", + "description": "The entity type of the Microsoft.ServiceBus resource. Could be one of 'queue' or 'subscriber'." + }, + "queueName": { + "type": "string", + "description": "The name of the Microsoft.ServiceBus queue. If the entity type is of type 'subscriber', then this value will be null." + }, + "topicName": { + "type": "string", + "description": "The name of the Microsoft.ServiceBus topic. If the entity type is of type 'queue', then this value will be null." + }, + "subscriptionName": { + "type": "string", + "description": "The name of the Microsoft.ServiceBus topic's subscription. If the entity type is of type 'queue', then this value will be null." + } + } + }, + "ServiceBusActiveMessagesAvailableWithNoListenersEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.ActiveMessagesAvailableWithNoListeners event.", + "properties": { + "namespaceName": { + "type": "string", + "description": "The namespace name of the Microsoft.ServiceBus resource." + }, + "requestUri": { + "type": "string", + "description": "The endpoint of the Microsoft.ServiceBus resource." + }, + "entityType": { + "type": "string", + "description": "The entity type of the Microsoft.ServiceBus resource. Could be one of 'queue' or 'subscriber'." + }, + "queueName": { + "type": "string", + "description": "The name of the Microsoft.ServiceBus queue. If the entity type is of type 'subscriber', then this value will be null." + }, + "topicName": { + "type": "string", + "description": "The name of the Microsoft.ServiceBus topic. If the entity type is of type 'queue', then this value will be null." + }, + "subscriptionName": { + "type": "string", + "description": "The name of the Microsoft.ServiceBus topic's subscription. If the entity type is of type 'queue', then this value will be null." + } + } + }, + "ServiceBusDeadletterMessagesAvailablePeriodicNotificationsEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.DeadletterMessagesAvailablePeriodicNotifications event.", + "properties": { + "namespaceName": { + "type": "string", + "description": "The namespace name of the Microsoft.ServiceBus resource." + }, + "requestUri": { + "type": "string", + "description": "The endpoint of the Microsoft.ServiceBus resource." + }, + "entityType": { + "type": "string", + "description": "The entity type of the Microsoft.ServiceBus resource. Could be one of 'queue' or 'subscriber'." + }, + "queueName": { + "type": "string", + "description": "The name of the Microsoft.ServiceBus queue. If the entity type is of type 'subscriber', then this value will be null." + }, + "topicName": { + "type": "string", + "description": "The name of the Microsoft.ServiceBus topic. If the entity type is of type 'queue', then this value will be null." + }, + "subscriptionName": { + "type": "string", + "description": "The name of the Microsoft.ServiceBus topic's subscription. If the entity type is of type 'queue', then this value will be null." + } + } + }, + "ServiceBusDeadletterMessagesAvailableWithNoListenersEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.DeadletterMessagesAvailableWithNoListeners event.", + "properties": { + "namespaceName": { + "type": "string", + "description": "The namespace name of the Microsoft.ServiceBus resource." + }, + "requestUri": { + "type": "string", + "description": "The endpoint of the Microsoft.ServiceBus resource." + }, + "entityType": { + "type": "string", + "description": "The entity type of the Microsoft.ServiceBus resource. Could be one of 'queue' or 'subscriber'." + }, + "queueName": { + "type": "string", + "description": "The name of the Microsoft.ServiceBus queue. If the entity type is of type 'subscriber', then this value will be null." + }, + "topicName": { + "type": "string", + "description": "The name of the Microsoft.ServiceBus topic. If the entity type is of type 'queue', then this value will be null." + }, + "subscriptionName": { + "type": "string", + "description": "The name of the Microsoft.ServiceBus topic's subscription. If the entity type is of type 'queue', then this value will be null." + } + } + }, + "SignalRServiceClientConnectionConnectedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.SignalRService.ClientConnectionConnected event.", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The time at which the event occurred." + }, + "hubName": { + "type": "string", + "description": "The hub of connected client connection." + }, + "connectionId": { + "type": "string", + "description": "The connection Id of connected client connection." + }, + "userId": { + "type": "string", + "description": "The user Id of connected client connection." + } + }, + "required": [ + "timestamp" + ] + }, + "SignalRServiceClientConnectionDisconnectedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.SignalRService.ClientConnectionDisconnected event.", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The time at which the event occurred." + }, + "hubName": { + "type": "string", + "description": "The hub of connected client connection." + }, + "connectionId": { + "type": "string", + "description": "The connection Id of connected client connection." + }, + "userId": { + "type": "string", + "description": "The user Id of connected client connection." + }, + "errorMessage": { + "type": "string", + "description": "The message of error that cause the client connection disconnected." + } + }, + "required": [ + "timestamp" + ] + }, + "StampKind": { + "type": "string", + "description": "Kind of environment where app service plan is.", + "enum": [ + "Public", + "AseV1", + "AseV2" + ], + "x-ms-enum": { + "name": "StampKind", + "modelAsString": true, + "values": [ + { + "name": "Public", + "value": "Public", + "description": "App Service Plan is running on a public stamp." + }, + { + "name": "AseV1", + "value": "AseV1", + "description": "App Service Plan is running on an App Service Environment V1." + }, + { + "name": "AseV2", + "value": "AseV2", + "description": "App Service Plan is running on an App Service Environment V2." + } + ] + } + }, + "StorageAsyncOperationInitiatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.AsyncOperationInitiated event.", + "properties": { + "api": { + "type": "string", + "description": "The name of the API/operation that triggered this event." + }, + "clientRequestId": { + "type": "string", + "description": "A request id provided by the client of the storage API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the storage service for the storage API operation that triggered this event." + }, + "contentType": { + "type": "string", + "description": "The content type of the blob. This is the same as what would be returned in the Content-Type header from the blob." + }, + "contentLength": { + "type": "integer", + "format": "int64", + "description": "The size of the blob in bytes. This is the same as what would be returned in the Content-Length header from the blob." + }, + "blobType": { + "type": "string", + "description": "The type of blob." + }, + "url": { + "type": "string", + "description": "The path to the blob." + }, + "sequencer": { + "type": "string", + "description": "An opaque string value representing the logical sequence of events for any particular blob name. Users can use standard string comparison to understand the relative sequence of two events on the same blob name." + }, + "identity": { + "type": "string", + "description": "The identity of the requester that triggered this event." + }, + "storageDiagnostics": { + "type": "object", + "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", + "additionalProperties": {} + } + }, + "required": [ + "storageDiagnostics" + ] + }, + "StorageBlobCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.BlobCreated event.", + "properties": { + "api": { + "type": "string", + "description": "The name of the API/operation that triggered this event." + }, + "clientRequestId": { + "type": "string", + "description": "A request id provided by the client of the storage API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the storage service for the storage API operation that triggered this event." + }, + "eTag": { + "type": "string", + "description": "The etag of the blob at the time this event was triggered." + }, + "contentType": { + "type": "string", + "description": "The content type of the blob. This is the same as what would be returned in the Content-Type header from the blob." + }, + "contentLength": { + "type": "integer", + "format": "int64", + "description": "The size of the blob in bytes. This is the same as what would be returned in the Content-Length header from the blob." + }, + "contentOffset": { + "type": "integer", + "format": "int64", + "description": "The offset of the blob in bytes." + }, + "blobType": { + "type": "string", + "description": "The type of blob." + }, + "url": { + "type": "string", + "description": "The path to the blob." + }, + "sequencer": { + "type": "string", + "description": "An opaque string value representing the logical sequence of events for any particular blob name. Users can use standard string comparison to understand the relative sequence of two events on the same blob name." + }, + "identity": { + "type": "string", + "description": "The identity of the requester that triggered this event." + }, + "storageDiagnostics": { + "type": "object", + "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", + "additionalProperties": {} + } + }, + "required": [ + "storageDiagnostics" + ] + }, + "StorageBlobDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.BlobDeleted event.", + "properties": { + "api": { + "type": "string", + "description": "The name of the API/operation that triggered this event." + }, + "clientRequestId": { + "type": "string", + "description": "A request id provided by the client of the storage API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the storage service for the storage API operation that triggered this event." + }, + "contentType": { + "type": "string", + "description": "The content type of the blob. This is the same as what would be returned in the Content-Type header from the blob." + }, + "blobType": { + "type": "string", + "description": "The type of blob." + }, + "url": { + "type": "string", + "description": "The path to the blob." + }, + "sequencer": { + "type": "string", + "description": "An opaque string value representing the logical sequence of events for any particular blob name. Users can use standard string comparison to understand the relative sequence of two events on the same blob name." + }, + "identity": { + "type": "string", + "description": "The identity of the requester that triggered this event." + }, + "storageDiagnostics": { + "type": "object", + "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", + "additionalProperties": {} + } + }, + "required": [ + "storageDiagnostics" + ] + }, + "StorageBlobInventoryPolicyCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Storage.BlobInventoryPolicyCompleted event.", + "properties": { + "scheduleDateTime": { + "type": "string", + "format": "date-time", + "description": "The time at which inventory policy was scheduled." + }, + "accountName": { + "type": "string", + "description": "The account name for which inventory policy is registered." + }, + "ruleName": { + "type": "string", + "description": "The rule name for inventory policy." + }, + "policyRunStatus": { + "type": "string", + "description": "The status of inventory run, it can be Succeeded/PartiallySucceeded/Failed." + }, + "policyRunStatusMessage": { + "type": "string", + "description": "The status message for inventory run." + }, + "policyRunId": { + "type": "string", + "description": "The policy run id for inventory run." + }, + "manifestBlobUrl": { + "type": "string", + "description": "The blob URL for manifest file for inventory run." + } + }, + "required": [ + "scheduleDateTime" + ] + }, + "StorageBlobRenamedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.BlobRenamed event.", + "properties": { + "api": { + "type": "string", + "description": "The name of the API/operation that triggered this event." + }, + "clientRequestId": { + "type": "string", + "description": "A request id provided by the client of the storage API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the storage service for the storage API operation that triggered this event." + }, + "sourceUrl": { + "type": "string", + "description": "The path to the blob that was renamed." + }, + "destinationUrl": { + "type": "string", + "description": "The new path to the blob after the rename operation." + }, + "sequencer": { + "type": "string", + "description": "An opaque string value representing the logical sequence of events for any particular blob name. Users can use standard string comparison to understand the relative sequence of two events on the same blob name." + }, + "identity": { + "type": "string", + "description": "The identity of the requester that triggered this event." + }, + "storageDiagnostics": { + "type": "object", + "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", + "additionalProperties": {} + } + }, + "required": [ + "storageDiagnostics" + ] + }, + "StorageBlobTierChangedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.BlobTierChanged event.", + "properties": { + "api": { + "type": "string", + "description": "The name of the API/operation that triggered this event." + }, + "clientRequestId": { + "type": "string", + "description": "A request id provided by the client of the storage API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the storage service for the storage API operation that triggered this event." + }, + "contentType": { + "type": "string", + "description": "The content type of the blob. This is the same as what would be returned in the Content-Type header from the blob." + }, + "contentLength": { + "type": "integer", + "format": "int64", + "description": "The size of the blob in bytes. This is the same as what would be returned in the Content-Length header from the blob." + }, + "blobType": { + "type": "string", + "description": "The type of blob." + }, + "url": { + "type": "string", + "description": "The path to the blob." + }, + "sequencer": { + "type": "string", + "description": "An opaque string value representing the logical sequence of events for any particular blob name. Users can use standard string comparison to understand the relative sequence of two events on the same blob name." + }, + "identity": { + "type": "string", + "description": "The identity of the requester that triggered this event." + }, + "storageDiagnostics": { + "type": "object", + "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", + "additionalProperties": {} + } + }, + "required": [ + "storageDiagnostics" + ] + }, + "StorageDirectoryCreatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.DirectoryCreated event.", + "properties": { + "api": { + "type": "string", + "description": "The name of the API/operation that triggered this event." + }, + "clientRequestId": { + "type": "string", + "description": "A request id provided by the client of the storage API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the storage service for the storage API operation that triggered this event." + }, + "eTag": { + "type": "string", + "description": "The etag of the directory at the time this event was triggered." + }, + "url": { + "type": "string", + "description": "The path to the directory." + }, + "sequencer": { + "type": "string", + "description": "An opaque string value representing the logical sequence of events for any particular directory name. Users can use standard string comparison to understand the relative sequence of two events on the same directory name." + }, + "identity": { + "type": "string", + "description": "The identity of the requester that triggered this event." + }, + "storageDiagnostics": { + "type": "object", + "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", + "additionalProperties": {} + } + }, + "required": [ + "storageDiagnostics" + ] + }, + "StorageDirectoryDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.DirectoryDeleted event.", + "properties": { + "api": { + "type": "string", + "description": "The name of the API/operation that triggered this event." + }, + "clientRequestId": { + "type": "string", + "description": "A request id provided by the client of the storage API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the storage service for the storage API operation that triggered this event." + }, + "url": { + "type": "string", + "description": "The path to the deleted directory." + }, + "recursive": { + "type": "string", + "description": "Is this event for a recursive delete operation." + }, + "sequencer": { + "type": "string", + "description": "An opaque string value representing the logical sequence of events for any particular directory name. Users can use standard string comparison to understand the relative sequence of two events on the same directory name." + }, + "identity": { + "type": "string", + "description": "The identity of the requester that triggered this event." + }, + "storageDiagnostics": { + "type": "object", + "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", + "additionalProperties": {} + } + }, + "required": [ + "storageDiagnostics" + ] + }, + "StorageDirectoryRenamedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.DirectoryRenamed event.", + "properties": { + "api": { + "type": "string", + "description": "The name of the API/operation that triggered this event." + }, + "clientRequestId": { + "type": "string", + "description": "A request id provided by the client of the storage API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the storage service for the storage API operation that triggered this event." + }, + "sourceUrl": { + "type": "string", + "description": "The path to the directory that was renamed." + }, + "destinationUrl": { + "type": "string", + "description": "The new path to the directory after the rename operation." + }, + "sequencer": { + "type": "string", + "description": "An opaque string value representing the logical sequence of events for any particular directory name. Users can use standard string comparison to understand the relative sequence of two events on the same directory name." + }, + "identity": { + "type": "string", + "description": "The identity of the requester that triggered this event." + }, + "storageDiagnostics": { + "type": "object", + "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", + "additionalProperties": {} + } + }, + "required": [ + "storageDiagnostics" + ] + }, + "StorageLifecyclePolicyActionSummaryDetail": { + "type": "object", + "description": "Execution statistics of a specific policy action in a Blob Management cycle.", + "properties": { + "totalObjectsCount": { + "type": "integer", + "format": "int64", + "description": "Total number of objects to be acted on by this action." + }, + "successCount": { + "type": "integer", + "format": "int64", + "description": "Number of success operations of this action." + }, + "errorList": { + "type": "string", + "description": "Error messages of this action if any." + } + } + }, + "StorageLifecyclePolicyCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.LifecyclePolicyCompleted event.", + "properties": { + "scheduleTime": { + "type": "string", + "description": "The time the policy task was scheduled." + }, + "deleteSummary": { + "$ref": "#/definitions/StorageLifecyclePolicyActionSummaryDetail", + "description": "Execution statistics of a specific policy action in a Blob Management cycle." + }, + "tierToCoolSummary": { + "$ref": "#/definitions/StorageLifecyclePolicyActionSummaryDetail", + "description": "Execution statistics of a specific policy action in a Blob Management cycle." + }, + "tierToArchiveSummary": { + "$ref": "#/definitions/StorageLifecyclePolicyActionSummaryDetail", + "description": "Execution statistics of a specific policy action in a Blob Management cycle." + } + }, + "required": [ + "deleteSummary", + "tierToCoolSummary", + "tierToArchiveSummary" + ] + }, + "StorageTaskAssignmentCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskAssignmentCompleted event.", + "properties": { + "status": { + "$ref": "#/definitions/StorageTaskAssignmentCompletedStatus", + "description": "The status for a storage task." + }, + "completedDateTime": { + "type": "string", + "format": "date-time", + "description": "The time at which a storage task was completed.", + "x-ms-client-name": "completedOn" + }, + "taskExecutionId": { + "type": "string", + "description": "The execution id for a storage task." + }, + "taskName": { + "type": "string", + "description": "The task name for a storage task." + }, + "summaryReportBlobUrl": { + "type": "string", + "format": "uri", + "description": "The summary report blob url for a storage task", + "x-ms-client-name": "summaryReportBlobUri" + } + }, + "required": [ + "status", + "completedDateTime", + "summaryReportBlobUrl" + ] + }, + "StorageTaskAssignmentCompletedStatus": { + "type": "string", + "description": "The status for a storage task.", + "enum": [ + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "StorageTaskAssignmentCompletedStatus", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Succeeded" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed" + } + ] + } + }, + "StorageTaskAssignmentQueuedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskAssignmentQueued event.", + "properties": { + "queuedDateTime": { + "type": "string", + "format": "date-time", + "description": "The time at which a storage task was queued.", + "x-ms-client-name": "queuedOn" + }, + "taskExecutionId": { + "type": "string", + "description": "The execution id for a storage task." + } + }, + "required": [ + "queuedDateTime" + ] + }, + "StorageTaskCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskCompleted event.", + "properties": { + "status": { + "$ref": "#/definitions/StorageTaskCompletedStatus", + "description": "The status for a storage task." + }, + "completedDateTime": { + "type": "string", + "format": "date-time", + "description": "The time at which a storage task was completed." + }, + "taskExecutionId": { + "type": "string", + "description": "The execution id for a storage task." + }, + "taskName": { + "type": "string", + "description": "The task name for a storage task." + }, + "summaryReportBlobUrl": { + "type": "string", + "format": "uri", + "description": "The summary report blob url for a storage task" + } + }, + "required": [ + "status", + "completedDateTime", + "summaryReportBlobUrl" + ] + }, + "StorageTaskCompletedStatus": { + "type": "string", + "description": "The status for a storage task.", + "enum": [ + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "StorageTaskCompletedStatus", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Succeeded" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed" + } + ] + } + }, + "StorageTaskQueuedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskQueued event.", + "properties": { + "queuedDateTime": { + "type": "string", + "format": "date-time", + "description": "The time at which a storage task was queued." + }, + "taskExecutionId": { + "type": "string", + "description": "The execution id for a storage task." + } + }, + "required": [ + "queuedDateTime" + ] + }, + "SubscriptionDeletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a\nMicrosoft.EventGrid.SubscriptionDeletedEvent event.", + "properties": { + "eventSubscriptionId": { + "type": "string", + "description": "The Azure resource ID of the deleted event subscription." + } + } + }, + "SubscriptionValidationEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.EventGrid.SubscriptionValidationEvent event.", + "properties": { + "validationCode": { + "type": "string", + "description": "The validation code sent by Azure Event Grid to validate an event subscription.\nTo complete the validation handshake, the subscriber must either respond with this validation code as part of the validation response,\nor perform a GET request on the validationUrl (available starting version 2018-05-01-preview)." + }, + "validationUrl": { + "type": "string", + "description": "The validation URL sent by Azure Event Grid (available starting version 2018-05-01-preview).\nTo complete the validation handshake, the subscriber must either respond with the validationCode as part of the validation response,\nor perform a GET request on the validationUrl (available starting version 2018-05-01-preview)." + } + } + }, + "SubscriptionValidationResponse": { + "type": "object", + "description": "To complete an event subscription validation handshake, a subscriber can use\neither the validationCode or the validationUrl received in a\nSubscriptionValidationEvent. When the validationCode is used, the\nSubscriptionValidationResponse can be used to build the response.", + "properties": { + "validationResponse": { + "type": "string", + "description": "The validation response sent by the subscriber to Azure Event Grid to complete the validation of an event subscription." + } + } + }, + "WebAppServicePlanUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.AppServicePlanUpdated event.", + "properties": { + "appServicePlanEventTypeDetail": { + "$ref": "#/definitions/AppServicePlanEventTypeDetail", + "description": "Detail of action on the app service plan." + }, + "sku": { + "$ref": "#/definitions/WebAppServicePlanUpdatedEventDataSku", + "description": "sku of app service plan." + }, + "name": { + "type": "string", + "description": "name of the app service plan that had this event." + }, + "clientRequestId": { + "type": "string", + "description": "The client request id generated by the app service for the app service plan API operation that triggered this event." + }, + "correlationRequestId": { + "type": "string", + "description": "The correlation request id generated by the app service for the app service plan API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the app service for the app service plan API operation that triggered this event." + }, + "address": { + "type": "string", + "description": "HTTP request URL of this operation." + }, + "verb": { + "type": "string", + "description": "HTTP verb of this operation." + } + }, + "required": [ + "appServicePlanEventTypeDetail", + "sku" + ] + }, + "WebAppServicePlanUpdatedEventDataSku": { + "type": "object", + "description": "sku of app service plan.", + "properties": { + "name": { + "type": "string", + "description": "name of app service plan sku." + }, + "Tier": { + "type": "string", + "description": "tier of app service plan sku." + }, + "Size": { + "type": "string", + "description": "size of app service plan sku." + }, + "Family": { + "type": "string", + "description": "family of app service plan sku." + }, + "Capacity": { + "type": "string", + "description": "capacity of app service plan sku." + } + } + }, + "WebAppUpdatedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.AppUpdated event.", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail", + "description": "Detail of action on the app." + }, + "name": { + "type": "string", + "description": "name of the web site that had this event." + }, + "clientRequestId": { + "type": "string", + "description": "The client request id generated by the app service for the site API operation that triggered this event." + }, + "correlationRequestId": { + "type": "string", + "description": "The correlation request id generated by the app service for the site API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the app service for the site API operation that triggered this event." + }, + "address": { + "type": "string", + "description": "HTTP request URL of this operation." + }, + "verb": { + "type": "string", + "description": "HTTP verb of this operation." + } + }, + "required": [ + "appEventTypeDetail" + ] + }, + "WebBackupOperationCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.BackupOperationCompleted event.", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail", + "description": "Detail of action on the app." + }, + "name": { + "type": "string", + "description": "name of the web site that had this event." + }, + "clientRequestId": { + "type": "string", + "description": "The client request id generated by the app service for the site API operation that triggered this event." + }, + "correlationRequestId": { + "type": "string", + "description": "The correlation request id generated by the app service for the site API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the app service for the site API operation that triggered this event." + }, + "address": { + "type": "string", + "description": "HTTP request URL of this operation." + }, + "verb": { + "type": "string", + "description": "HTTP verb of this operation." + } + }, + "required": [ + "appEventTypeDetail" + ] + }, + "WebBackupOperationFailedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.BackupOperationFailed event.", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail", + "description": "Detail of action on the app." + }, + "name": { + "type": "string", + "description": "name of the web site that had this event." + }, + "clientRequestId": { + "type": "string", + "description": "The client request id generated by the app service for the site API operation that triggered this event." + }, + "correlationRequestId": { + "type": "string", + "description": "The correlation request id generated by the app service for the site API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the app service for the site API operation that triggered this event." + }, + "address": { + "type": "string", + "description": "HTTP request URL of this operation." + }, + "verb": { + "type": "string", + "description": "HTTP verb of this operation." + } + }, + "required": [ + "appEventTypeDetail" + ] + }, + "WebBackupOperationStartedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.BackupOperationStarted event.", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail", + "description": "Detail of action on the app." + }, + "name": { + "type": "string", + "description": "name of the web site that had this event." + }, + "clientRequestId": { + "type": "string", + "description": "The client request id generated by the app service for the site API operation that triggered this event." + }, + "correlationRequestId": { + "type": "string", + "description": "The correlation request id generated by the app service for the site API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the app service for the site API operation that triggered this event." + }, + "address": { + "type": "string", + "description": "HTTP request URL of this operation." + }, + "verb": { + "type": "string", + "description": "HTTP verb of this operation." + } + }, + "required": [ + "appEventTypeDetail" + ] + }, + "WebRestoreOperationCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.RestoreOperationCompleted event.", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail", + "description": "Detail of action on the app." + }, + "name": { + "type": "string", + "description": "name of the web site that had this event." + }, + "clientRequestId": { + "type": "string", + "description": "The client request id generated by the app service for the site API operation that triggered this event." + }, + "correlationRequestId": { + "type": "string", + "description": "The correlation request id generated by the app service for the site API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the app service for the site API operation that triggered this event." + }, + "address": { + "type": "string", + "description": "HTTP request URL of this operation." + }, + "verb": { + "type": "string", + "description": "HTTP verb of this operation." + } + }, + "required": [ + "appEventTypeDetail" + ] + }, + "WebRestoreOperationFailedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.RestoreOperationFailed event.", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail", + "description": "Detail of action on the app." + }, + "name": { + "type": "string", + "description": "name of the web site that had this event." + }, + "clientRequestId": { + "type": "string", + "description": "The client request id generated by the app service for the site API operation that triggered this event." + }, + "correlationRequestId": { + "type": "string", + "description": "The correlation request id generated by the app service for the site API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the app service for the site API operation that triggered this event." + }, + "address": { + "type": "string", + "description": "HTTP request URL of this operation." + }, + "verb": { + "type": "string", + "description": "HTTP verb of this operation." + } + }, + "required": [ + "appEventTypeDetail" + ] + }, + "WebRestoreOperationStartedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.RestoreOperationStarted event.", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail", + "description": "Detail of action on the app." + }, + "name": { + "type": "string", + "description": "name of the web site that had this event." + }, + "clientRequestId": { + "type": "string", + "description": "The client request id generated by the app service for the site API operation that triggered this event." + }, + "correlationRequestId": { + "type": "string", + "description": "The correlation request id generated by the app service for the site API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the app service for the site API operation that triggered this event." + }, + "address": { + "type": "string", + "description": "HTTP request URL of this operation." + }, + "verb": { + "type": "string", + "description": "HTTP verb of this operation." + } + }, + "required": [ + "appEventTypeDetail" + ] + }, + "WebSlotSwapCompletedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.SlotSwapCompleted event.", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail", + "description": "Detail of action on the app." + }, + "name": { + "type": "string", + "description": "name of the web site that had this event." + }, + "clientRequestId": { + "type": "string", + "description": "The client request id generated by the app service for the site API operation that triggered this event." + }, + "correlationRequestId": { + "type": "string", + "description": "The correlation request id generated by the app service for the site API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the app service for the site API operation that triggered this event." + }, + "address": { + "type": "string", + "description": "HTTP request URL of this operation." + }, + "verb": { + "type": "string", + "description": "HTTP verb of this operation." + } + }, + "required": [ + "appEventTypeDetail" + ] + }, + "WebSlotSwapFailedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.SlotSwapFailed event.", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail", + "description": "Detail of action on the app." + }, + "name": { + "type": "string", + "description": "name of the web site that had this event." + }, + "clientRequestId": { + "type": "string", + "description": "The client request id generated by the app service for the site API operation that triggered this event." + }, + "correlationRequestId": { + "type": "string", + "description": "The correlation request id generated by the app service for the site API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the app service for the site API operation that triggered this event." + }, + "address": { + "type": "string", + "description": "HTTP request URL of this operation." + }, + "verb": { + "type": "string", + "description": "HTTP verb of this operation." + } + }, + "required": [ + "appEventTypeDetail" + ] + }, + "WebSlotSwapStartedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.SlotSwapStarted event.", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail", + "description": "Detail of action on the app." + }, + "name": { + "type": "string", + "description": "name of the web site that had this event." + }, + "clientRequestId": { + "type": "string", + "description": "The client request id generated by the app service for the site API operation that triggered this event." + }, + "correlationRequestId": { + "type": "string", + "description": "The correlation request id generated by the app service for the site API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the app service for the site API operation that triggered this event." + }, + "address": { + "type": "string", + "description": "HTTP request URL of this operation." + }, + "verb": { + "type": "string", + "description": "HTTP verb of this operation." + } + }, + "required": [ + "appEventTypeDetail" + ] + }, + "WebSlotSwapWithPreviewCancelledEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.SlotSwapWithPreviewCancelled event.", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail", + "description": "Detail of action on the app." + }, + "name": { + "type": "string", + "description": "name of the web site that had this event." + }, + "clientRequestId": { + "type": "string", + "description": "The client request id generated by the app service for the site API operation that triggered this event." + }, + "correlationRequestId": { + "type": "string", + "description": "The correlation request id generated by the app service for the site API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the app service for the site API operation that triggered this event." + }, + "address": { + "type": "string", + "description": "HTTP request URL of this operation." + }, + "verb": { + "type": "string", + "description": "HTTP verb of this operation." + } + }, + "required": [ + "appEventTypeDetail" + ] + }, + "WebSlotSwapWithPreviewStartedEventData": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.SlotSwapWithPreviewStarted event.", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail", + "description": "Detail of action on the app." + }, + "name": { + "type": "string", + "description": "name of the web site that had this event." + }, + "clientRequestId": { + "type": "string", + "description": "The client request id generated by the app service for the site API operation that triggered this event." + }, + "correlationRequestId": { + "type": "string", + "description": "The correlation request id generated by the app service for the site API operation that triggered this event." + }, + "requestId": { + "type": "string", + "description": "The request id generated by the app service for the site API operation that triggered this event." + }, + "address": { + "type": "string", + "description": "HTTP request URL of this operation." + }, + "verb": { + "type": "string", + "description": "HTTP verb of this operation." + } + }, + "required": [ + "appEventTypeDetail" + ] + }, + "recordingChannelType": { + "type": "string", + "description": "Recording channel type", + "enum": [ + "Mixed", + "Unmixed" + ], + "x-ms-enum": { + "name": "recordingChannelType", + "modelAsString": true, + "values": [ + { + "name": "Mixed", + "value": "Mixed", + "description": "Mixed channel type" + }, + { + "name": "Unmixed", + "value": "Unmixed", + "description": "Unmixed channel type" + } + ] + } + }, + "recordingContentType": { + "type": "string", + "description": "Recording content type", + "enum": [ + "AudioVideo", + "Audio" + ], + "x-ms-enum": { + "name": "recordingContentType", + "modelAsString": true, + "values": [ + { + "name": "AudioVideo", + "value": "AudioVideo", + "description": "AudioVideo content type" + }, + { + "name": "Audio", + "value": "Audio", + "description": "Audio content type" + } + ] + } + }, + "recordingFormatType": { + "type": "string", + "description": "Recording format type", + "enum": [ + "Wav", + "Mp3", + "Mp4" + ], + "x-ms-enum": { + "name": "recordingFormatType", + "modelAsString": true, + "values": [ + { + "name": "Wav", + "value": "Wav", + "description": "WAV format" + }, + { + "name": "Mp3", + "value": "Mp3", + "description": "MP3 format" + }, + { + "name": "Mp4", + "value": "Mp4", + "description": "MP4 format" + } + ] + } + } + }, + "parameters": {} +} diff --git a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/SystemEvents.json b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/SystemEvents.json deleted file mode 100644 index 292cc198dde2..000000000000 --- a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/SystemEvents.json +++ /dev/null @@ -1,9402 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure.Messaging.SystemEvents", - "version": "2024-01-01", - "description": "Azure Messaging EventGrid SystemEvents", - "x-typespec-generated": [ - { - "emitter": "@azure-tools/typespec-autorest" - } - ] - }, - "schemes": [ - "https" - ], - "produces": [ - "application/json" - ], - "consumes": [ - "application/json" - ], - "tags": [], - "paths": {}, - "definitions": { - "AcsChatEventBaseProperties": { - "type": "object", - "description": "Schema of common properties of all chat events", - "properties": { - "recipientCommunicationIdentifier": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "The communication identifier of the target user" - }, - "transactionId": { - "type": "string", - "description": "The transaction id will be used as co-relation vector" - }, - "threadId": { - "type": "string", - "description": "The chat thread id" - } - }, - "required": [ - "recipientCommunicationIdentifier" - ] - }, - "AcsChatEventInThreadBaseProperties": { - "type": "object", - "description": "Schema of common properties of all thread-level chat events", - "properties": { - "transactionId": { - "type": "string", - "description": "The transaction id will be used as co-relation vector" - }, - "threadId": { - "type": "string", - "description": "The chat thread id" - } - } - }, - "AcsChatMessageDeletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageDeleted event.", - "properties": { - "deleteTime": { - "type": "string", - "format": "date-time", - "description": "The time at which the message was deleted" - } - }, - "required": [ - "deleteTime" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsChatMessageEventBaseProperties" - } - ] - }, - "AcsChatMessageDeletedInThreadEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageDeletedInThread event.", - "properties": { - "deleteTime": { - "type": "string", - "format": "date-time", - "description": "The time at which the message was deleted" - } - }, - "required": [ - "deleteTime" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsChatMessageEventInThreadBaseProperties" - } - ] - }, - "AcsChatMessageEditedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageEdited event.", - "properties": { - "messageBody": { - "type": "string", - "description": "The body of the chat message" - }, - "metadata": { - "type": "object", - "description": "The chat message metadata", - "additionalProperties": { - "type": "string" - } - }, - "editTime": { - "type": "string", - "format": "date-time", - "description": "The time at which the message was edited" - } - }, - "required": [ - "metadata", - "editTime" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsChatMessageEventBaseProperties" - } - ] - }, - "AcsChatMessageEditedInThreadEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageEditedInThread event.", - "properties": { - "messageBody": { - "type": "string", - "description": "The body of the chat message" - }, - "metadata": { - "type": "object", - "description": "The chat message metadata", - "additionalProperties": { - "type": "string" - } - }, - "editTime": { - "type": "string", - "format": "date-time", - "description": "The time at which the message was edited" - } - }, - "required": [ - "metadata", - "editTime" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsChatMessageEventInThreadBaseProperties" - } - ] - }, - "AcsChatMessageEventBaseProperties": { - "type": "object", - "description": "Schema of common properties of all chat message events", - "properties": { - "messageId": { - "type": "string", - "description": "The chat message id" - }, - "senderCommunicationIdentifier": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "The communication identifier of the sender" - }, - "senderDisplayName": { - "type": "string", - "description": "The display name of the sender" - }, - "composeTime": { - "type": "string", - "format": "date-time", - "description": "The original compose time of the message" - }, - "type": { - "type": "string", - "description": "The type of the message" - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the message" - } - }, - "required": [ - "senderCommunicationIdentifier", - "composeTime" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsChatEventBaseProperties" - } - ] - }, - "AcsChatMessageEventInThreadBaseProperties": { - "type": "object", - "description": "Schema of common properties of all thread-level chat message events", - "properties": { - "messageId": { - "type": "string", - "description": "The chat message id" - }, - "senderCommunicationIdentifier": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "The communication identifier of the sender" - }, - "senderDisplayName": { - "type": "string", - "description": "The display name of the sender" - }, - "composeTime": { - "type": "string", - "format": "date-time", - "description": "The original compose time of the message" - }, - "type": { - "type": "string", - "description": "The type of the message" - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the message" - } - }, - "required": [ - "senderCommunicationIdentifier", - "composeTime" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsChatEventInThreadBaseProperties" - } - ] - }, - "AcsChatMessageReceivedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageReceived event.", - "properties": { - "messageBody": { - "type": "string", - "description": "The body of the chat message" - }, - "metadata": { - "type": "object", - "description": "The chat message metadata", - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "metadata" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsChatMessageEventBaseProperties" - } - ] - }, - "AcsChatMessageReceivedInThreadEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageReceivedInThread event.", - "properties": { - "messageBody": { - "type": "string", - "description": "The body of the chat message" - }, - "metadata": { - "type": "object", - "description": "The chat message metadata", - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "metadata" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsChatMessageEventInThreadBaseProperties" - } - ] - }, - "AcsChatParticipantAddedToThreadEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadParticipantAdded event.", - "properties": { - "time": { - "type": "string", - "format": "date-time", - "description": "The time at which the user was added to the thread" - }, - "addedByCommunicationIdentifier": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "The communication identifier of the user who added the user" - }, - "participantAdded": { - "$ref": "#/definitions/AcsChatThreadParticipantProperties", - "description": "The details of the user who was added" - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the thread" - } - }, - "required": [ - "time", - "addedByCommunicationIdentifier", - "participantAdded" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsChatEventInThreadBaseProperties" - } - ] - }, - "AcsChatParticipantAddedToThreadWithUserEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatParticipantAddedToThreadWithUser event.", - "properties": { - "time": { - "type": "string", - "format": "date-time", - "description": "The time at which the user was added to the thread" - }, - "addedByCommunicationIdentifier": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "The communication identifier of the user who added the user" - }, - "participantAdded": { - "$ref": "#/definitions/AcsChatThreadParticipantProperties", - "description": "The details of the user who was added" - } - }, - "required": [ - "time", - "addedByCommunicationIdentifier", - "participantAdded" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsChatThreadEventBaseProperties" - } - ] - }, - "AcsChatParticipantRemovedFromThreadEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadParticipantRemoved event.", - "properties": { - "time": { - "type": "string", - "format": "date-time", - "description": "The time at which the user was removed to the thread" - }, - "removedByCommunicationIdentifier": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "The communication identifier of the user who removed the user" - }, - "participantRemoved": { - "$ref": "#/definitions/AcsChatThreadParticipantProperties", - "description": "The details of the user who was removed" - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the thread" - } - }, - "required": [ - "time", - "removedByCommunicationIdentifier", - "participantRemoved" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsChatEventInThreadBaseProperties" - } - ] - }, - "AcsChatParticipantRemovedFromThreadWithUserEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatParticipantRemovedFromThreadWithUser event.", - "properties": { - "time": { - "type": "string", - "format": "date-time", - "description": "The time at which the user was removed to the thread" - }, - "removedByCommunicationIdentifier": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "The communication identifier of the user who removed the user" - }, - "participantRemoved": { - "$ref": "#/definitions/AcsChatThreadParticipantProperties", - "description": "The details of the user who was removed" - } - }, - "required": [ - "time", - "removedByCommunicationIdentifier", - "participantRemoved" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsChatThreadEventBaseProperties" - } - ] - }, - "AcsChatThreadCreatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadCreated event.", - "properties": { - "createdByCommunicationIdentifier": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "The communication identifier of the user who created the thread" - }, - "properties": { - "type": "object", - "description": "The thread properties", - "additionalProperties": {} - }, - "metadata": { - "type": "object", - "description": "The thread metadata", - "additionalProperties": { - "type": "string" - } - }, - "participants": { - "type": "array", - "description": "The list of properties of participants who are part of the thread", - "items": { - "$ref": "#/definitions/AcsChatThreadParticipantProperties" - }, - "x-ms-identifiers": [] - } - }, - "required": [ - "createdByCommunicationIdentifier", - "properties", - "metadata", - "participants" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsChatThreadEventInThreadBaseProperties" - } - ] - }, - "AcsChatThreadCreatedWithUserEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadCreatedWithUser event.", - "properties": { - "createdByCommunicationIdentifier": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "The communication identifier of the user who created the thread" - }, - "properties": { - "type": "object", - "description": "The thread properties", - "additionalProperties": {} - }, - "metadata": { - "type": "object", - "description": "The thread metadata", - "additionalProperties": { - "type": "string" - } - }, - "participants": { - "type": "array", - "description": "The list of properties of participants who are part of the thread", - "items": { - "$ref": "#/definitions/AcsChatThreadParticipantProperties" - }, - "x-ms-identifiers": [] - } - }, - "required": [ - "createdByCommunicationIdentifier", - "properties", - "metadata", - "participants" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsChatThreadEventBaseProperties" - } - ] - }, - "AcsChatThreadDeletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadDeleted event.", - "properties": { - "deletedByCommunicationIdentifier": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "The communication identifier of the user who deleted the thread" - }, - "deleteTime": { - "type": "string", - "format": "date-time", - "description": "The deletion time of the thread" - } - }, - "required": [ - "deletedByCommunicationIdentifier", - "deleteTime" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsChatThreadEventInThreadBaseProperties" - } - ] - }, - "AcsChatThreadEventBaseProperties": { - "type": "object", - "description": "Schema of common properties of all chat thread events", - "properties": { - "createTime": { - "type": "string", - "format": "date-time", - "description": "The original creation time of the thread" - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the thread" - } - }, - "required": [ - "createTime" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsChatEventBaseProperties" - } - ] - }, - "AcsChatThreadEventInThreadBaseProperties": { - "type": "object", - "description": "Schema of common properties of all chat thread events", - "properties": { - "createTime": { - "type": "string", - "format": "date-time", - "description": "The original creation time of the thread" - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the thread" - } - }, - "required": [ - "createTime" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsChatEventInThreadBaseProperties" - } - ] - }, - "AcsChatThreadParticipantProperties": { - "type": "object", - "description": "Schema of the chat thread participant", - "properties": { - "displayName": { - "type": "string", - "description": "The name of the user" - }, - "participantCommunicationIdentifier": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "The communication identifier of the user" - }, - "metadata": { - "type": "object", - "description": "The metadata of the user", - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "participantCommunicationIdentifier", - "metadata" - ] - }, - "AcsChatThreadPropertiesUpdatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadPropertiesUpdated event.", - "properties": { - "editedByCommunicationIdentifier": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "The communication identifier of the user who updated the thread properties" - }, - "editTime": { - "type": "string", - "format": "date-time", - "description": "The time at which the properties of the thread were updated" - }, - "properties": { - "type": "object", - "description": "The updated thread properties", - "additionalProperties": {} - }, - "metadata": { - "type": "object", - "description": "The thread metadata", - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "editedByCommunicationIdentifier", - "editTime", - "properties", - "metadata" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsChatThreadEventInThreadBaseProperties" - } - ] - }, - "AcsChatThreadPropertiesUpdatedPerUserEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadPropertiesUpdatedPerUser event.", - "properties": { - "editedByCommunicationIdentifier": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "The communication identifier of the user who updated the thread properties" - }, - "editTime": { - "type": "string", - "format": "date-time", - "description": "The time at which the properties of the thread were updated" - }, - "metadata": { - "type": "object", - "description": "The thread metadata", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "type": "object", - "description": "The updated thread properties", - "additionalProperties": {} - } - }, - "required": [ - "editedByCommunicationIdentifier", - "editTime", - "metadata", - "properties" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsChatThreadEventBaseProperties" - } - ] - }, - "AcsChatThreadWithUserDeletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadWithUserDeleted event.", - "properties": { - "deletedByCommunicationIdentifier": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "The communication identifier of the user who deleted the thread" - }, - "deleteTime": { - "type": "string", - "format": "date-time", - "description": "The deletion time of the thread" - } - }, - "required": [ - "deletedByCommunicationIdentifier", - "deleteTime" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsChatThreadEventBaseProperties" - } - ] - }, - "AcsEmailDeliveryReportReceivedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.EmailDeliveryReportReceived event.", - "properties": { - "sender": { - "type": "string", - "description": "The Sender Email Address" - }, - "recipient": { - "type": "string", - "description": "The recipient Email Address" - }, - "messageId": { - "type": "string", - "description": "The Id of the email been sent" - }, - "status": { - "$ref": "#/definitions/AcsEmailDeliveryReportStatus", - "description": "The status of the email. Any value other than Delivered is considered failed." - }, - "deliveryStatusDetails": { - "$ref": "#/definitions/AcsEmailDeliveryReportStatusDetails", - "description": "Detailed information about the status if any" - }, - "deliveryAttemptTimeStamp": { - "type": "string", - "format": "date-time", - "description": "The time at which the email delivery report received timestamp", - "x-ms-client-name": "deliveryAttemptTimestamp" - } - }, - "required": [ - "status", - "deliveryStatusDetails", - "deliveryAttemptTimeStamp" - ] - }, - "AcsEmailDeliveryReportStatus": { - "type": "string", - "description": "The status of the email. Any value other than Delivered is considered failed.", - "enum": [ - "Bounced", - "Delivered", - "Failed", - "FilteredSpam", - "Quarantined", - "Suppressed" - ], - "x-ms-enum": { - "name": "AcsEmailDeliveryReportStatus", - "modelAsString": true, - "values": [ - { - "name": "Bounced", - "value": "Bounced", - "description": "Hard bounce detected while sending the email" - }, - { - "name": "Delivered", - "value": "Delivered", - "description": "The email was delivered" - }, - { - "name": "Failed", - "value": "Failed", - "description": "The email failed to be delivered" - }, - { - "name": "FilteredSpam", - "value": "FilteredSpam", - "description": "The message was identified as spam and was rejected or blocked (not quarantined)." - }, - { - "name": "Quarantined", - "value": "Quarantined", - "description": "The message was quarantined (as spam, bulk mail, or phishing). For more information, see Quarantined email messages in EOP (EXCHANGE ONLINE PROTECTION)." - }, - { - "name": "Suppressed", - "value": "Suppressed", - "description": "The email was suppressed" - } - ] - } - }, - "AcsEmailDeliveryReportStatusDetails": { - "type": "object", - "description": "Detailed information about the status if any", - "properties": { - "statusMessage": { - "type": "string", - "description": "Detailed status message" - } - } - }, - "AcsEmailEngagementTrackingReportReceivedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.EmailEngagementTrackingReportReceived event.", - "properties": { - "sender": { - "type": "string", - "description": "The Sender Email Address" - }, - "recipient": { - "type": "string", - "description": "The Recipient Email Address" - }, - "messageId": { - "type": "string", - "description": "The Id of the email that has been sent" - }, - "userActionTimeStamp": { - "type": "string", - "format": "date-time", - "description": "The time at which the user interacted with the email", - "x-ms-client-name": "userActionTimestamp" - }, - "engagementContext": { - "type": "string", - "description": "The context of the type of engagement user had with email" - }, - "userAgent": { - "type": "string", - "description": "The user agent interacting with the email" - }, - "engagementType": { - "$ref": "#/definitions/AcsUserEngagement", - "description": "The type of engagement user have with email", - "x-ms-client-name": "engagement" - } - }, - "required": [ - "userActionTimeStamp", - "engagementType" - ] - }, - "AcsIncomingCallCustomContext": { - "type": "object", - "description": "Custom Context of Incoming Call", - "properties": { - "sipHeaders": { - "type": "object", - "description": "Sip Headers for incoming call", - "additionalProperties": { - "type": "string" - } - }, - "voipHeaders": { - "type": "object", - "description": "Voip Headers for incoming call", - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "sipHeaders", - "voipHeaders" - ] - }, - "AcsIncomingCallEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.IncomingCall event", - "properties": { - "to": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "The communication identifier of the target user.", - "x-ms-client-name": "toCommunicationIdentifier" - }, - "from": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "The communication identifier of the user who initiated the call.", - "x-ms-client-name": "fromCommunicationIdentifier" - }, - "serverCallId": { - "type": "string", - "description": "The Id of the server call" - }, - "callerDisplayName": { - "type": "string", - "description": "Display name of caller." - }, - "customContext": { - "$ref": "#/definitions/AcsIncomingCallCustomContext", - "description": "Custom Context of Incoming Call" - }, - "incomingCallContext": { - "type": "string", - "description": "Signed incoming call context." - }, - "correlationId": { - "type": "string", - "description": "CorrelationId (CallId)." - } - }, - "required": [ - "to", - "from", - "customContext" - ] - }, - "AcsInteractiveReplyKind": { - "type": "string", - "description": "Interactive reply kind", - "enum": [ - "buttonReply", - "listReply", - "unknown" - ], - "x-ms-enum": { - "name": "AcsInteractiveReplyKind", - "modelAsString": true, - "values": [ - { - "name": "buttonReply", - "value": "buttonReply", - "description": "Messaged interactive reply type is ButtonReply" - }, - { - "name": "listReply", - "value": "listReply", - "description": "Messaged interactive reply type is ListReply" - }, - { - "name": "unknown", - "value": "unknown", - "description": "Messaged interactive reply type is Unknown" - } - ] - } - }, - "AcsMessageButtonContent": { - "type": "object", - "description": "Message Button Content", - "properties": { - "text": { - "type": "string", - "description": "The Text of the button" - }, - "payload": { - "type": "string", - "description": "The Payload of the button which was clicked by the user, setup by the business" - } - } - }, - "AcsMessageChannelEventError": { - "type": "object", - "description": "Message Channel Event Error", - "properties": { - "channelCode": { - "type": "string", - "description": "The channel error code" - }, - "channelMessage": { - "type": "string", - "description": "The channel error message" - } - } - }, - "AcsMessageChannelKind": { - "type": "string", - "description": "Message channel kind", - "enum": [ - "whatsapp" - ], - "x-ms-enum": { - "name": "AcsMessageChannelKind", - "modelAsString": true, - "values": [ - { - "name": "whatsapp", - "value": "whatsapp", - "description": "Updated message channel type is WhatsApp" - } - ] - } - }, - "AcsMessageContext": { - "type": "object", - "description": "Message Context", - "properties": { - "from": { - "type": "string", - "description": "The WhatsApp ID for the customer who replied to an inbound message." - }, - "id": { - "type": "string", - "description": "The message ID for the sent message for an inbound reply", - "x-ms-client-name": "messageId" - } - } - }, - "AcsMessageDeliveryStatus": { - "type": "string", - "description": "Message delivery status", - "enum": [ - "read", - "delivered", - "failed", - "sent", - "warning", - "unknown" - ], - "x-ms-enum": { - "name": "AcsMessageDeliveryStatus", - "modelAsString": true, - "values": [ - { - "name": "read", - "value": "read", - "description": "Read" - }, - { - "name": "delivered", - "value": "delivered", - "description": "Delivered" - }, - { - "name": "failed", - "value": "failed", - "description": "Failed" - }, - { - "name": "sent", - "value": "sent", - "description": "Sent" - }, - { - "name": "warning", - "value": "warning", - "description": "Warning" - }, - { - "name": "unknown", - "value": "unknown", - "description": "Unknown" - } - ] - } - }, - "AcsMessageDeliveryStatusUpdatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated event.", - "properties": { - "messageId": { - "type": "string", - "description": "The message id" - }, - "status": { - "$ref": "#/definitions/AcsMessageDeliveryStatus", - "description": "The updated message status" - }, - "channelType": { - "$ref": "#/definitions/AcsMessageChannelKind", - "description": "The updated message channel type", - "x-ms-client-name": "channelKind" - } - }, - "required": [ - "status", - "channelType" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsMessageEventData" - } - ] - }, - "AcsMessageEventData": { - "type": "object", - "description": "Schema of common properties of all chat thread events", - "properties": { - "from": { - "type": "string", - "description": "The message sender" - }, - "to": { - "type": "string", - "description": "The message recipient" - }, - "receivedTimeStamp": { - "type": "string", - "format": "date-time", - "description": "The time message was received" - }, - "error": { - "$ref": "#/definitions/AcsMessageChannelEventError", - "description": "The channel event error" - } - }, - "required": [ - "receivedTimeStamp", - "error" - ] - }, - "AcsMessageInteractiveButtonReplyContent": { - "type": "object", - "description": "Message Interactive button reply content for a user to business message", - "properties": { - "id": { - "type": "string", - "description": "The ID of the button", - "x-ms-client-name": "buttonId" - }, - "title": { - "type": "string", - "description": "The title of the button" - } - } - }, - "AcsMessageInteractiveContent": { - "type": "object", - "description": "Message Interactive Content", - "properties": { - "type": { - "$ref": "#/definitions/AcsInteractiveReplyKind", - "description": "The Message interactive reply type", - "x-ms-client-name": "replyKind" - }, - "buttonReply": { - "$ref": "#/definitions/AcsMessageInteractiveButtonReplyContent", - "description": "The Message Sent when a customer clicks a button" - }, - "listReply": { - "$ref": "#/definitions/AcsMessageInteractiveListReplyContent", - "description": "The Message Sent when a customer selects an item from a list" - } - }, - "required": [ - "type", - "buttonReply", - "listReply" - ] - }, - "AcsMessageInteractiveListReplyContent": { - "type": "object", - "description": "Message Interactive list reply content for a user to business message", - "properties": { - "id": { - "type": "string", - "description": "The ID of the selected list item", - "x-ms-client-name": "listItemId" - }, - "title": { - "type": "string", - "description": "The title of the selected list item" - }, - "description": { - "type": "string", - "description": "The description of the selected row" - } - } - }, - "AcsMessageMediaContent": { - "type": "object", - "description": "Message Media Content", - "properties": { - "mimeType": { - "type": "string", - "description": "The MIME type of the file this media represents" - }, - "id": { - "type": "string", - "description": "The media identifier", - "x-ms-client-name": "mediaId" - }, - "fileName": { - "type": "string", - "description": "The filename of the underlying media file as specified when uploaded" - }, - "caption": { - "type": "string", - "description": "The caption for the media object, if supported and provided" - } - } - }, - "AcsMessageReceivedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.AdvancedMessageReceived event.", - "properties": { - "content": { - "type": "string", - "description": "The message content" - }, - "channelType": { - "$ref": "#/definitions/AcsMessageChannelKind", - "description": "The message channel type", - "x-ms-client-name": "channelKind" - }, - "media": { - "$ref": "#/definitions/AcsMessageMediaContent", - "description": "The received message media content", - "x-ms-client-name": "mediaContent" - }, - "context": { - "$ref": "#/definitions/AcsMessageContext", - "description": "The received message context" - }, - "button": { - "$ref": "#/definitions/AcsMessageButtonContent", - "description": "The received message button content" - }, - "interactive": { - "$ref": "#/definitions/AcsMessageInteractiveContent", - "description": "The received message interactive content", - "x-ms-client-name": "interactiveContent" - } - }, - "required": [ - "channelType", - "media", - "context", - "button", - "interactive" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsMessageEventData" - } - ] - }, - "AcsRecordingChunkInfoProperties": { - "type": "object", - "description": "Schema for all properties of Recording Chunk Information.", - "properties": { - "documentId": { - "type": "string", - "description": "The documentId of the recording chunk" - }, - "index": { - "type": "integer", - "format": "int64", - "description": "The index of the recording chunk" - }, - "endReason": { - "type": "string", - "description": "The reason for ending the recording chunk" - }, - "metadataLocation": { - "type": "string", - "description": "The location of the metadata for this chunk" - }, - "contentLocation": { - "type": "string", - "description": "The location of the content for this chunk" - }, - "deleteLocation": { - "type": "string", - "description": "The location to delete all chunk storage" - } - } - }, - "AcsRecordingFileStatusUpdatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RecordingFileStatusUpdated event.", - "properties": { - "recordingStorageInfo": { - "$ref": "#/definitions/AcsRecordingStorageInfoProperties", - "description": "The details of recording storage information" - }, - "recordingStartTime": { - "type": "string", - "format": "date-time", - "description": "The time at which the recording started" - }, - "recordingDurationMs": { - "type": "integer", - "format": "int64", - "description": "The recording duration in milliseconds" - }, - "recordingContentType": { - "$ref": "#/definitions/recordingContentType", - "description": "The recording content type- AudioVideo, or Audio" - }, - "recordingChannelType": { - "$ref": "#/definitions/recordingChannelType", - "description": "The recording channel type - Mixed, Unmixed" - }, - "recordingFormatType": { - "$ref": "#/definitions/recordingFormatType", - "description": "The recording format type - Mp4, Mp3, Wav" - }, - "sessionEndReason": { - "type": "string", - "description": "The reason for ending recording session" - } - }, - "required": [ - "recordingStorageInfo", - "recordingStartTime", - "recordingContentType", - "recordingChannelType", - "recordingFormatType" - ] - }, - "AcsRecordingStorageInfoProperties": { - "type": "object", - "description": "Schema for all properties of Recording Storage Information.", - "properties": { - "recordingChunks": { - "type": "array", - "description": "List of details of recording chunks information", - "items": { - "$ref": "#/definitions/AcsRecordingChunkInfoProperties" - }, - "x-ms-identifiers": [] - } - }, - "required": [ - "recordingChunks" - ] - }, - "AcsRouterChannelConfiguration": { - "type": "object", - "description": "Router Channel Configuration", - "properties": { - "channelId": { - "type": "string", - "description": "Channel ID for Router Job" - }, - "capacityCostPerJob": { - "type": "integer", - "format": "int32", - "description": "Capacity Cost Per Job for Router Job" - }, - "maxNumberOfJobs": { - "type": "integer", - "format": "int32", - "description": "Max Number of Jobs for Router Job" - } - } - }, - "AcsRouterCommunicationError": { - "type": "object", - "description": "Router Communication Error", - "properties": { - "code": { - "type": "string", - "description": "Router Communication Error Code" - }, - "message": { - "type": "string", - "description": "Router Communication Error Message" - }, - "target": { - "type": "string", - "description": "Router Communication Error Target" - }, - "innererror": { - "$ref": "#/definitions/AcsRouterCommunicationError", - "description": "Router Communication Inner Error" - }, - "details": { - "type": "array", - "description": "List of Router Communication Errors", - "items": { - "$ref": "#/definitions/AcsRouterCommunicationError" - }, - "x-ms-identifiers": [] - } - }, - "required": [ - "innererror", - "details" - ] - }, - "AcsRouterEventData": { - "type": "object", - "description": "Schema of common properties of all Router events", - "properties": { - "jobId": { - "type": "string", - "description": "Router Event Job ID" - }, - "channelReference": { - "type": "string", - "description": "Router Event Channel Reference" - }, - "channelId": { - "type": "string", - "description": "Router Event Channel ID" - } - } - }, - "AcsRouterJobCancelledEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobCancelled event", - "properties": { - "note": { - "type": "string", - "description": "Router Job Note" - }, - "dispositionCode": { - "type": "string", - "description": "Router Job Disposition Code" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AcsRouterJobEventData" - } - ] - }, - "AcsRouterJobClassificationFailedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobClassificationFailed event", - "properties": { - "classificationPolicyId": { - "type": "string", - "description": "Router Job Classification Policy Id" - }, - "errors": { - "type": "array", - "description": "Router Job Classification Failed Errors", - "items": { - "$ref": "#/definitions/AcsRouterCommunicationError" - }, - "x-ms-identifiers": [] - } - }, - "required": [ - "errors" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsRouterJobEventData" - } - ] - }, - "AcsRouterJobClassifiedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobClassified event", - "properties": { - "queueDetails": { - "$ref": "#/definitions/AcsRouterQueueDetails", - "description": "Router Job Queue Info" - }, - "classificationPolicyId": { - "type": "string", - "description": "Router Job Classification Policy Id" - }, - "priority": { - "type": "integer", - "format": "int32", - "description": "Router Job Priority" - }, - "attachedWorkerSelectors": { - "type": "array", - "description": "Router Job Attached Worker Selector", - "items": { - "$ref": "#/definitions/AcsRouterWorkerSelector" - }, - "x-ms-identifiers": [] - } - }, - "required": [ - "queueDetails", - "attachedWorkerSelectors" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsRouterJobEventData" - } - ] - }, - "AcsRouterJobClosedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobClosed event", - "properties": { - "assignmentId": { - "type": "string", - "description": "Router Job Closed Assignment Id" - }, - "workerId": { - "type": "string", - "description": "Router Job Closed Worker Id" - }, - "dispositionCode": { - "type": "string", - "description": "Router Job Closed Disposition Code" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AcsRouterJobEventData" - } - ] - }, - "AcsRouterJobCompletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobCompleted event", - "properties": { - "assignmentId": { - "type": "string", - "description": "Router Job Completed Assignment Id" - }, - "workerId": { - "type": "string", - "description": "Router Job Completed Worker Id" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AcsRouterJobEventData" - } - ] - }, - "AcsRouterJobDeletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobDeleted event", - "allOf": [ - { - "$ref": "#/definitions/AcsRouterJobEventData" - } - ] - }, - "AcsRouterJobEventData": { - "type": "object", - "description": "Schema of common properties of all Router Job events", - "properties": { - "queueId": { - "type": "string", - "description": "Router Job events Queue Id" - }, - "labels": { - "type": "object", - "description": "Router Job events Labels", - "additionalProperties": { - "type": "string" - } - }, - "tags": { - "type": "object", - "description": "Router Jobs events Tags", - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "labels", - "tags" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsRouterEventData" - } - ] - }, - "AcsRouterJobExceptionTriggeredEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobExceptionTriggered event", - "properties": { - "ruleKey": { - "type": "string", - "description": "Router Job Exception Triggered Rule Key" - }, - "exceptionRuleId": { - "type": "string", - "description": "Router Job Exception Triggered Rule Id" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AcsRouterJobEventData" - } - ] - }, - "AcsRouterJobQueuedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobQueued event", - "properties": { - "priority": { - "type": "integer", - "format": "int32", - "description": "Router Job Priority" - }, - "attachedWorkerSelectors": { - "type": "array", - "description": "Router Job Queued Attached Worker Selector", - "items": { - "$ref": "#/definitions/AcsRouterWorkerSelector" - }, - "x-ms-identifiers": [] - }, - "requestedWorkerSelectors": { - "type": "array", - "description": "Router Job Queued Requested Worker Selector", - "items": { - "$ref": "#/definitions/AcsRouterWorkerSelector" - }, - "x-ms-identifiers": [] - } - }, - "required": [ - "attachedWorkerSelectors", - "requestedWorkerSelectors" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsRouterJobEventData" - } - ] - }, - "AcsRouterJobReceivedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobReceived event", - "properties": { - "jobStatus": { - "$ref": "#/definitions/AcsRouterJobStatus", - "description": "Router Job Received Job Status" - }, - "classificationPolicyId": { - "type": "string", - "description": "Router Job Classification Policy Id" - }, - "priority": { - "type": "integer", - "format": "int32", - "description": "Router Job Priority" - }, - "requestedWorkerSelectors": { - "type": "array", - "description": "Router Job Received Requested Worker Selectors", - "items": { - "$ref": "#/definitions/AcsRouterWorkerSelector" - }, - "x-ms-identifiers": [] - }, - "scheduledOn": { - "type": "string", - "format": "date-time", - "description": "Router Job Received Scheduled Time in UTC" - }, - "unavailableForMatching": { - "type": "boolean", - "description": "Unavailable For Matching for Router Job Received" - } - }, - "required": [ - "jobStatus", - "requestedWorkerSelectors", - "scheduledOn", - "unavailableForMatching" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsRouterJobEventData" - } - ] - }, - "AcsRouterJobSchedulingFailedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobSchedulingFailed event", - "properties": { - "priority": { - "type": "integer", - "format": "int32", - "description": "Router Job Priority" - }, - "expiredAttachedWorkerSelectors": { - "type": "array", - "description": "Router Job Scheduling Failed Attached Worker Selector Expired", - "items": { - "$ref": "#/definitions/AcsRouterWorkerSelector" - }, - "x-ms-identifiers": [] - }, - "expiredRequestedWorkerSelectors": { - "type": "array", - "description": "Router Job Scheduling Failed Requested Worker Selector Expired", - "items": { - "$ref": "#/definitions/AcsRouterWorkerSelector" - }, - "x-ms-identifiers": [] - }, - "scheduledOn": { - "type": "string", - "format": "date-time", - "description": "Router Job Scheduling Failed Scheduled Time in UTC" - }, - "failureReason": { - "type": "string", - "description": "Router Job Scheduling Failed Reason" - } - }, - "required": [ - "expiredAttachedWorkerSelectors", - "expiredRequestedWorkerSelectors", - "scheduledOn" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsRouterJobEventData" - } - ] - }, - "AcsRouterJobStatus": { - "type": "string", - "description": "Acs Router Job Status", - "enum": [ - "PendingClassification", - "Queued", - "Assigned", - "Completed", - "Closed", - "Cancelled", - "ClassificationFailed", - "Created", - "PendingSchedule", - "Scheduled", - "ScheduleFailed", - "WaitingForActivation" - ], - "x-ms-enum": { - "name": "AcsRouterJobStatus", - "modelAsString": true, - "values": [ - { - "name": "PendingClassification", - "value": "PendingClassification", - "description": "Router Job Status Pending Classification" - }, - { - "name": "Queued", - "value": "Queued", - "description": "Router Job Status Queued" - }, - { - "name": "Assigned", - "value": "Assigned", - "description": "Router Job Status Assigned" - }, - { - "name": "Completed", - "value": "Completed", - "description": "Router Job Status Completed" - }, - { - "name": "Closed", - "value": "Closed", - "description": "Router Job Status Closed" - }, - { - "name": "Cancelled", - "value": "Cancelled", - "description": "Router Job Status Cancelled" - }, - { - "name": "ClassificationFailed", - "value": "ClassificationFailed", - "description": "Router Job Status Classification Failed" - }, - { - "name": "Created", - "value": "Created", - "description": "Router Job Status Created" - }, - { - "name": "PendingSchedule", - "value": "PendingSchedule", - "description": "Router Job Status Pending Schedule" - }, - { - "name": "Scheduled", - "value": "Scheduled", - "description": "Router Job Status Scheduled" - }, - { - "name": "ScheduleFailed", - "value": "ScheduleFailed", - "description": "Router Job Status Schedule Failed" - }, - { - "name": "WaitingForActivation", - "value": "WaitingForActivation", - "description": "Router Job Status Waiting For Activation" - } - ] - } - }, - "AcsRouterJobUnassignedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobUnassigned event", - "properties": { - "assignmentId": { - "type": "string", - "description": "Router Job Unassigned Assignment Id" - }, - "workerId": { - "type": "string", - "description": "Router Job Unassigned Worker Id" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AcsRouterJobEventData" - } - ] - }, - "AcsRouterJobWaitingForActivationEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobWaitingForActivation event", - "properties": { - "priority": { - "type": "integer", - "format": "int32", - "description": "Router Job Waiting For Activation Priority" - }, - "expiredAttachedWorkerSelectors": { - "type": "array", - "description": "Router Job Waiting For Activation Worker Selector Expired", - "items": { - "$ref": "#/definitions/AcsRouterWorkerSelector" - }, - "x-ms-identifiers": [] - }, - "expiredRequestedWorkerSelectors": { - "type": "array", - "description": "Router Job Waiting For Activation Requested Worker Selector Expired", - "items": { - "$ref": "#/definitions/AcsRouterWorkerSelector" - }, - "x-ms-identifiers": [] - }, - "scheduledOn": { - "type": "string", - "format": "date-time", - "description": "Router Job Waiting For Activation Scheduled Time in UTC" - }, - "unavailableForMatching": { - "type": "boolean", - "description": "Router Job Waiting For Activation Unavailable For Matching" - } - }, - "required": [ - "expiredAttachedWorkerSelectors", - "expiredRequestedWorkerSelectors", - "scheduledOn", - "unavailableForMatching" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsRouterJobEventData" - } - ] - }, - "AcsRouterJobWorkerSelectorsExpiredEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobWorkerSelectorsExpired event", - "properties": { - "expiredRequestedWorkerSelectors": { - "type": "array", - "description": "Router Job Worker Selectors Expired Requested Worker Selectors", - "items": { - "$ref": "#/definitions/AcsRouterWorkerSelector" - }, - "x-ms-identifiers": [] - }, - "expiredAttachedWorkerSelectors": { - "type": "array", - "description": "Router Job Worker Selectors Expired Attached Worker Selectors", - "items": { - "$ref": "#/definitions/AcsRouterWorkerSelector" - }, - "x-ms-identifiers": [] - } - }, - "required": [ - "expiredRequestedWorkerSelectors", - "expiredAttachedWorkerSelectors" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsRouterJobEventData" - } - ] - }, - "AcsRouterLabelOperator": { - "type": "string", - "description": "Router Job Worker Selector Label Operator", - "enum": [ - "Equal", - "NotEqual", - "Greater", - "Less", - "GreaterThanOrEqual", - "LessThanOrEqual" - ], - "x-ms-enum": { - "name": "AcsRouterLabelOperator", - "modelAsString": true, - "values": [ - { - "name": "Equal", - "value": "Equal", - "description": "Router Label Operator Equal" - }, - { - "name": "NotEqual", - "value": "NotEqual", - "description": "Router Label Operator Not Equal" - }, - { - "name": "Greater", - "value": "Greater", - "description": "Router Label Operator Greater" - }, - { - "name": "Less", - "value": "Less", - "description": "Router Label Operator Less" - }, - { - "name": "GreaterThanOrEqual", - "value": "GreaterThanOrEqual", - "description": "Router Label Operator Greater than or equal" - }, - { - "name": "LessThanOrEqual", - "value": "LessThanOrEqual", - "description": "Router Label Operator Less than or equal" - } - ] - } - }, - "AcsRouterQueueDetails": { - "type": "object", - "description": "Router Queue Details", - "properties": { - "id": { - "type": "string", - "description": "Router Queue Id" - }, - "name": { - "type": "string", - "description": "Router Queue Name" - }, - "labels": { - "type": "object", - "description": "Router Queue Labels", - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "labels" - ] - }, - "AcsRouterUpdatedWorkerProperty": { - "type": "string", - "description": "Worker properties that can be updated", - "enum": [ - "AvailableForOffers", - "TotalCapacity", - "QueueAssignments", - "Labels", - "Tags", - "ChannelConfigurations" - ], - "x-ms-enum": { - "name": "AcsRouterUpdatedWorkerProperty", - "modelAsString": true, - "values": [ - { - "name": "AvailableForOffers", - "value": "AvailableForOffers", - "description": "AvailableForOffers" - }, - { - "name": "TotalCapacity", - "value": "TotalCapacity", - "description": "TotalCapacity" - }, - { - "name": "QueueAssignments", - "value": "QueueAssignments", - "description": "QueueAssignments" - }, - { - "name": "Labels", - "value": "Labels", - "description": "Labels" - }, - { - "name": "Tags", - "value": "Tags", - "description": "Tags" - }, - { - "name": "ChannelConfigurations", - "value": "ChannelConfigurations", - "description": "ChannelConfigurations" - } - ] - } - }, - "AcsRouterWorkerDeletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerDeleted event", - "allOf": [ - { - "$ref": "#/definitions/AcsRouterWorkerEventData" - } - ] - }, - "AcsRouterWorkerDeregisteredEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerDeregistered event", - "properties": { - "workerId": { - "type": "string", - "description": "Router Worker Deregistered Worker Id" - } - } - }, - "AcsRouterWorkerEventData": { - "type": "object", - "description": "Schema of common properties of all Router Worker events", - "properties": { - "workerId": { - "type": "string", - "description": "Router Worker events Worker Id" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AcsRouterEventData" - } - ] - }, - "AcsRouterWorkerOfferAcceptedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferAccepted event", - "properties": { - "queueId": { - "type": "string", - "description": "Router Worker Offer Accepted Queue Id" - }, - "offerId": { - "type": "string", - "description": "Router Worker Offer Accepted Offer Id" - }, - "assignmentId": { - "type": "string", - "description": "Router Worker Offer Accepted Assignment Id" - }, - "jobPriority": { - "type": "integer", - "format": "int32", - "description": "Router Worker Offer Accepted Job Priority" - }, - "workerLabels": { - "type": "object", - "description": "Router Worker Offer Accepted Worker Labels", - "additionalProperties": { - "type": "string" - } - }, - "workerTags": { - "type": "object", - "description": "Router Worker Offer Accepted Worker Tags", - "additionalProperties": { - "type": "string" - } - }, - "jobLabels": { - "type": "object", - "description": "Router Worker Offer Accepted Job Labels", - "additionalProperties": { - "type": "string" - } - }, - "jobTags": { - "type": "object", - "description": "Router Worker Offer Accepted Job Tags", - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "workerLabels", - "workerTags", - "jobLabels", - "jobTags" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsRouterWorkerEventData" - } - ] - }, - "AcsRouterWorkerOfferDeclinedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferDeclined event", - "properties": { - "queueId": { - "type": "string", - "description": "Router Worker Offer Declined Queue Id" - }, - "offerId": { - "type": "string", - "description": "Router Worker Offer Declined Offer Id" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AcsRouterWorkerEventData" - } - ] - }, - "AcsRouterWorkerOfferExpiredEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferExpired event", - "properties": { - "queueId": { - "type": "string", - "description": "Router Worker Offer Expired Queue Id" - }, - "offerId": { - "type": "string", - "description": "Router Worker Offer Expired Offer Id" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AcsRouterWorkerEventData" - } - ] - }, - "AcsRouterWorkerOfferIssuedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferIssued event", - "properties": { - "queueId": { - "type": "string", - "description": "Router Worker Offer Issued Queue Id" - }, - "offerId": { - "type": "string", - "description": "Router Worker Offer Issued Offer Id" - }, - "jobPriority": { - "type": "integer", - "format": "int32", - "description": "Router Worker Offer Issued Job Priority" - }, - "workerLabels": { - "type": "object", - "description": "Router Worker Offer Issued Worker Labels", - "additionalProperties": { - "type": "string" - } - }, - "offeredOn": { - "type": "string", - "format": "date-time", - "description": "Router Worker Offer Issued Time in UTC" - }, - "expiresOn": { - "type": "string", - "format": "date-time", - "description": "Router Worker Offer Issued Expiration Time in UTC" - }, - "workerTags": { - "type": "object", - "description": "Router Worker Offer Issued Worker Tags", - "additionalProperties": { - "type": "string" - } - }, - "jobLabels": { - "type": "object", - "description": "Router Worker Offer Issued Job Labels", - "additionalProperties": { - "type": "string" - } - }, - "jobTags": { - "type": "object", - "description": "Router Worker Offer Issued Job Tags", - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "workerLabels", - "offeredOn", - "expiresOn", - "workerTags", - "jobLabels", - "jobTags" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsRouterWorkerEventData" - } - ] - }, - "AcsRouterWorkerOfferRevokedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferRevoked event", - "properties": { - "queueId": { - "type": "string", - "description": "Router Worker Offer Revoked Queue Id" - }, - "offerId": { - "type": "string", - "description": "Router Worker Offer Revoked Offer Id" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AcsRouterWorkerEventData" - } - ] - }, - "AcsRouterWorkerRegisteredEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerRegistered event", - "properties": { - "workerId": { - "type": "string", - "description": "Router Worker Registered Worker Id" - }, - "queueAssignments": { - "type": "array", - "description": "Router Worker Registered Queue Info", - "items": { - "$ref": "#/definitions/AcsRouterQueueDetails" - } - }, - "channelConfigurations": { - "type": "array", - "description": "Router Worker Registered Channel Configuration", - "items": { - "$ref": "#/definitions/AcsRouterChannelConfiguration" - }, - "x-ms-identifiers": [] - }, - "totalCapacity": { - "type": "integer", - "format": "int32", - "description": "Router Worker Register Total Capacity" - }, - "labels": { - "type": "object", - "description": "Router Worker Registered Labels", - "additionalProperties": { - "type": "string" - } - }, - "tags": { - "type": "object", - "description": "Router Worker Registered Tags", - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "queueAssignments", - "channelConfigurations", - "labels", - "tags" - ] - }, - "AcsRouterWorkerSelector": { - "type": "object", - "description": "Router Job Worker Selector", - "properties": { - "key": { - "type": "string", - "description": "Router Job Worker Selector Key" - }, - "labelOperator": { - "$ref": "#/definitions/AcsRouterLabelOperator", - "description": "Router Job Worker Selector Label Operator" - }, - "value": { - "description": "Router Job Worker Selector Value", - "x-ms-client-name": "labelValue" - }, - "ttlSeconds": { - "type": "number", - "format": "double", - "description": "Router Job Worker Selector Time to Live in Seconds" - }, - "state": { - "$ref": "#/definitions/AcsRouterWorkerSelectorState", - "description": "Router Job Worker Selector State" - }, - "expirationTime": { - "type": "string", - "format": "date-time", - "description": "Router Job Worker Selector Expiration Time" - } - }, - "required": [ - "labelOperator", - "value", - "ttlSeconds", - "state", - "expirationTime" - ] - }, - "AcsRouterWorkerSelectorState": { - "type": "string", - "description": "Router Worker Selector State", - "enum": [ - "active", - "expired" - ], - "x-ms-enum": { - "name": "AcsRouterWorkerSelectorState", - "modelAsString": true, - "values": [ - { - "name": "Active", - "value": "active", - "description": "Router Worker Selector State Active" - }, - { - "name": "Expired", - "value": "expired", - "description": "Router Worker Selector State Expired" - } - ] - } - }, - "AcsRouterWorkerUpdatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerUpdated event.", - "properties": { - "workerId": { - "type": "string", - "description": "Router Worker Updated Worker Id" - }, - "queueAssignments": { - "type": "array", - "description": "Router Worker Updated Queue Info", - "items": { - "$ref": "#/definitions/AcsRouterQueueDetails" - } - }, - "channelConfigurations": { - "type": "array", - "description": "Router Worker Updated Channel Configuration", - "items": { - "$ref": "#/definitions/AcsRouterChannelConfiguration" - }, - "x-ms-identifiers": [] - }, - "totalCapacity": { - "type": "integer", - "format": "int32", - "description": "Router Worker Updated Total Capacity" - }, - "labels": { - "type": "object", - "description": "Router Worker Updated Labels", - "additionalProperties": { - "type": "string" - } - }, - "tags": { - "type": "object", - "description": "Router Worker Updated Tags", - "additionalProperties": { - "type": "string" - } - }, - "updatedWorkerProperties": { - "type": "array", - "description": "Router Worker Properties Updated", - "items": { - "$ref": "#/definitions/AcsRouterUpdatedWorkerProperty" - } - } - }, - "required": [ - "queueAssignments", - "channelConfigurations", - "labels", - "tags", - "updatedWorkerProperties" - ] - }, - "AcsSmsDeliveryAttemptProperties": { - "type": "object", - "description": "Schema for details of a delivery attempt", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "TimeStamp when delivery was attempted" - }, - "segmentsSucceeded": { - "type": "integer", - "format": "int32", - "description": "Number of segments that were successfully delivered" - }, - "segmentsFailed": { - "type": "integer", - "format": "int32", - "description": "Number of segments whose delivery failed" - } - }, - "required": [ - "timestamp" - ] - }, - "AcsSmsDeliveryReportReceivedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.SMSDeliveryReportReceived event.", - "properties": { - "deliveryStatus": { - "type": "string", - "description": "Status of Delivery" - }, - "deliveryStatusDetails": { - "type": "string", - "description": "Details about Delivery Status" - }, - "deliveryAttempts": { - "type": "array", - "description": "List of details of delivery attempts made", - "items": { - "$ref": "#/definitions/AcsSmsDeliveryAttemptProperties" - }, - "x-ms-identifiers": [] - }, - "receivedTimestamp": { - "type": "string", - "format": "date-time", - "description": "The time at which the SMS delivery report was received" - }, - "tag": { - "type": "string", - "description": "Customer Content" - } - }, - "required": [ - "deliveryAttempts", - "receivedTimestamp" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsSmsEventBaseProperties" - } - ] - }, - "AcsSmsEventBaseProperties": { - "type": "object", - "description": "Schema of common properties of all SMS events", - "properties": { - "messageId": { - "type": "string", - "description": "The identity of the SMS message" - }, - "from": { - "type": "string", - "description": "The identity of SMS message sender" - }, - "to": { - "type": "string", - "description": "The identity of SMS message receiver" - } - } - }, - "AcsSmsReceivedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.SMSReceived event.", - "properties": { - "message": { - "type": "string", - "description": "The SMS content" - }, - "receivedTimestamp": { - "type": "string", - "format": "date-time", - "description": "The time at which the SMS was received" - } - }, - "required": [ - "receivedTimestamp" - ], - "allOf": [ - { - "$ref": "#/definitions/AcsSmsEventBaseProperties" - } - ] - }, - "AcsUserDisconnectedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.UserDisconnected event.", - "properties": { - "userCommunicationIdentifier": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "The communication identifier of the user who was disconnected" - } - }, - "required": [ - "userCommunicationIdentifier" - ] - }, - "AcsUserEngagement": { - "type": "string", - "description": "The type of engagement user have with email.", - "enum": [ - "view", - "click" - ], - "x-ms-enum": { - "name": "AcsUserEngagement", - "modelAsString": true, - "values": [ - { - "name": "view", - "value": "view", - "description": "View" - }, - { - "name": "click", - "value": "click", - "description": "Click" - } - ] - } - }, - "ApiCenterApiDefinitionAddedEventData": { - "type": "object", - "description": "Schema of the data property of an EventGridEvent for a Microsoft.ApiCenter.ApiDefinitionAdded event.", - "properties": { - "title": { - "type": "string", - "description": "API definition title." - }, - "description": { - "type": "string", - "description": "API definition description." - }, - "specification": { - "$ref": "#/definitions/ApiCenterApiSpecification", - "description": "API definition specification." - } - }, - "required": [ - "specification" - ] - }, - "ApiCenterApiDefinitionUpdatedEventData": { - "type": "object", - "description": "Schema of the data property of an EventGridEvent for a Microsoft.ApiCenter.ApiDefinitionUpdated event.", - "properties": { - "title": { - "type": "string", - "description": "API definition title." - }, - "description": { - "type": "string", - "description": "API definition description." - }, - "specification": { - "$ref": "#/definitions/ApiCenterApiSpecification", - "description": "API definition specification." - } - }, - "required": [ - "specification" - ] - }, - "ApiCenterApiSpecification": { - "type": "object", - "description": "API specification details.", - "properties": { - "name": { - "type": "string", - "description": "Specification name." - }, - "version": { - "type": "string", - "description": "Specification version." - } - } - }, - "ApiManagementApiCreatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APICreated event.", - "properties": { - "resourceUri": { - "type": "string", - "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" - } - } - }, - "ApiManagementApiDeletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIDeleted event.", - "properties": { - "resourceUri": { - "type": "string", - "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" - } - } - }, - "ApiManagementApiReleaseCreatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIReleaseCreated event.", - "properties": { - "resourceUri": { - "type": "string", - "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" - } - } - }, - "ApiManagementApiReleaseDeletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIReleaseDeleted event.", - "properties": { - "resourceUri": { - "type": "string", - "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" - } - } - }, - "ApiManagementApiReleaseUpdatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIReleaseUpdated event.", - "properties": { - "resourceUri": { - "type": "string", - "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" - } - } - }, - "ApiManagementApiUpdatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIUpdated event.", - "properties": { - "resourceUri": { - "type": "string", - "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" - } - } - }, - "ApiManagementGatewayApiAddedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayAPIAdded event.", - "properties": { - "resourceUri": { - "type": "string", - "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways//apis/`" - } - } - }, - "ApiManagementGatewayApiRemovedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayAPIRemoved event.", - "properties": { - "resourceUri": { - "type": "string", - "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways//apis/`" - } - } - }, - "ApiManagementGatewayCertificateAuthorityCreatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayCertificateAuthorityCreated event.", - "properties": { - "resourceUri": { - "type": "string", - "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways//certificateAuthorities/`" - } - } - }, - "ApiManagementGatewayCertificateAuthorityDeletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted event.", - "properties": { - "resourceUri": { - "type": "string", - "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways//certificateAuthorities/`" - } - } - }, - "ApiManagementGatewayCertificateAuthorityUpdatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayCertificateAuthorityUpdated event.", - "properties": { - "resourceUri": { - "type": "string", - "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways//certificateAuthorities/`" - } - } - }, - "ApiManagementGatewayCreatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayCreated event.", - "properties": { - "resourceUri": { - "type": "string", - "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways/`" - } - } - }, - "ApiManagementGatewayDeletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayDeleted event.", - "properties": { - "resourceUri": { - "type": "string", - "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways/`" - } - } - }, - "ApiManagementGatewayHostnameConfigurationCreatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayHostnameConfigurationCreated event.", - "properties": { - "resourceUri": { - "type": "string", - "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways//hostnameConfigurations/`" - } - } - }, - "ApiManagementGatewayHostnameConfigurationDeletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted event.", - "properties": { - "resourceUri": { - "type": "string", - "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways//hostnameConfigurations/`" - } - } - }, - "ApiManagementGatewayHostnameConfigurationUpdatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated event.", - "properties": { - "resourceUri": { - "type": "string", - "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways//hostnameConfigurations/`" - } - } - }, - "ApiManagementGatewayUpdatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayUpdated event.", - "properties": { - "resourceUri": { - "type": "string", - "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateways/`" - } - } - }, - "ApiManagementProductCreatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.ProductCreated event.", - "properties": { - "resourceUri": { - "type": "string", - "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" - } - } - }, - "ApiManagementProductDeletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.ProductDeleted event.", - "properties": { - "resourceUri": { - "type": "string", - "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" - } - } - }, - "ApiManagementProductUpdatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.ProductUpdated event.", - "properties": { - "resourceUri": { - "type": "string", - "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" - } - } - }, - "ApiManagementSubscriptionCreatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.SubscriptionCreated event.", - "properties": { - "resourceUri": { - "type": "string", - "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" - } - } - }, - "ApiManagementSubscriptionDeletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.SubscriptionDeleted event.", - "properties": { - "resourceUri": { - "type": "string", - "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" - } - } - }, - "ApiManagementSubscriptionUpdatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.SubscriptionUpdated event.", - "properties": { - "resourceUri": { - "type": "string", - "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" - } - } - }, - "ApiManagementUserCreatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.UserCreated event.", - "properties": { - "resourceUri": { - "type": "string", - "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" - } - } - }, - "ApiManagementUserDeletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.UserDeleted event.", - "properties": { - "resourceUri": { - "type": "string", - "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" - } - } - }, - "ApiManagementUserUpdatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.UserUpdated event.", - "properties": { - "resourceUri": { - "type": "string", - "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///`" - } - } - }, - "AppAction": { - "type": "string", - "description": "Type of action of the operation", - "enum": [ - "Restarted", - "Stopped", - "ChangedAppSettings", - "Started", - "Completed", - "Failed" - ], - "x-ms-enum": { - "name": "AppAction", - "modelAsString": true, - "values": [ - { - "name": "Restarted", - "value": "Restarted", - "description": "Web app was restarted." - }, - { - "name": "Stopped", - "value": "Stopped", - "description": "Web app was stopped." - }, - { - "name": "ChangedAppSettings", - "value": "ChangedAppSettings", - "description": "There was an operation to change app setting on the web app." - }, - { - "name": "Started", - "value": "Started", - "description": "The job has started." - }, - { - "name": "Completed", - "value": "Completed", - "description": "The job has completed." - }, - { - "name": "Failed", - "value": "Failed", - "description": "The job has failed to complete." - } - ] - } - }, - "AppConfigurationKeyValueDeletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AppConfiguration.KeyValueDeleted event.", - "properties": { - "key": { - "type": "string", - "description": "The key used to identify the key-value that was deleted." - }, - "label": { - "type": "string", - "description": "The label, if any, used to identify the key-value that was deleted." - }, - "etag": { - "type": "string", - "description": "The etag representing the key-value that was deleted." - }, - "syncToken": { - "type": "string", - "description": "The sync token representing the server state after the event." - } - } - }, - "AppConfigurationKeyValueModifiedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AppConfiguration.KeyValueModified event.", - "properties": { - "key": { - "type": "string", - "description": "The key used to identify the key-value that was modified." - }, - "label": { - "type": "string", - "description": "The label, if any, used to identify the key-value that was modified." - }, - "etag": { - "type": "string", - "description": "The etag representing the new state of the key-value." - }, - "syncToken": { - "type": "string", - "description": "The sync token representing the server state after the event." - } - } - }, - "AppConfigurationSnapshotCreatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AppConfiguration.SnapshotCreated event.", - "allOf": [ - { - "$ref": "#/definitions/AppConfigurationSnapshotEventData" - } - ] - }, - "AppConfigurationSnapshotEventData": { - "type": "object", - "description": "Schema of common properties of snapshot events", - "properties": { - "name": { - "type": "string", - "description": "The name of the snapshot." - }, - "etag": { - "type": "string", - "description": "The etag representing the new state of the snapshot." - }, - "syncToken": { - "type": "string", - "description": "The sync token representing the server state after the event." - } - } - }, - "AppConfigurationSnapshotModifiedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AppConfiguration.SnapshotModified event.", - "allOf": [ - { - "$ref": "#/definitions/AppConfigurationSnapshotEventData" - } - ] - }, - "AppEventTypeDetail": { - "type": "object", - "description": "Detail of action on the app.", - "properties": { - "action": { - "$ref": "#/definitions/AppAction", - "description": "Type of action of the operation." - } - }, - "required": [ - "action" - ] - }, - "AppServicePlanAction": { - "type": "string", - "description": "Type of action on the app service plan.", - "enum": [ - "Updated" - ], - "x-ms-enum": { - "name": "AppServicePlanAction", - "modelAsString": true, - "values": [ - { - "name": "Updated", - "value": "Updated", - "description": "App Service plan is being updated." - } - ] - } - }, - "AppServicePlanEventTypeDetail": { - "type": "object", - "description": "Detail of action on the app service plan.", - "properties": { - "stampKind": { - "$ref": "#/definitions/StampKind", - "description": "Kind of environment where app service plan is." - }, - "action": { - "$ref": "#/definitions/AppServicePlanAction", - "description": "Type of action on the app service plan." - }, - "status": { - "$ref": "#/definitions/AsyncStatus", - "description": "Asynchronous operation status of the operation on the app service plan." - } - }, - "required": [ - "stampKind", - "action", - "status" - ] - }, - "AsyncStatus": { - "type": "string", - "description": "Asynchronous operation status of the operation on the app service plan.", - "enum": [ - "Started", - "Completed", - "Failed" - ], - "x-ms-enum": { - "name": "AsyncStatus", - "modelAsString": true, - "values": [ - { - "name": "Started", - "value": "Started", - "description": "Async operation has started." - }, - { - "name": "Completed", - "value": "Completed", - "description": "Async operation has completed." - }, - { - "name": "Failed", - "value": "Failed", - "description": "Async operation failed to complete." - } - ] - } - }, - "AvsClusterCreatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterCreated event.", - "allOf": [ - { - "$ref": "#/definitions/AvsClusterEventData" - } - ] - }, - "AvsClusterDeletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterDeleted event.", - "allOf": [ - { - "$ref": "#/definitions/AvsClusterEventData" - } - ] - }, - "AvsClusterEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for Microsoft.AVS/clusters events.", - "properties": { - "operationId": { - "type": "string", - "description": "Id of the operation that caused this event." - }, - "addedHostNames": { - "type": "array", - "description": "Hosts added to the cluster in this event, if any.", - "items": { - "type": "string" - } - }, - "removedHostNames": { - "type": "array", - "description": "Hosts removed from the cluster in this event, if any.", - "items": { - "type": "string" - } - }, - "inMaintenanceHostNames": { - "type": "array", - "description": "Hosts in Maintenance mode in the cluster, if any.", - "items": { - "type": "string" - } - } - } - }, - "AvsClusterFailedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterFailed event.", - "properties": { - "failureMessage": { - "type": "string", - "description": "Failure reason of an event." - } - }, - "allOf": [ - { - "$ref": "#/definitions/AvsClusterEventData" - } - ] - }, - "AvsClusterUpdatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterUpdated event.", - "allOf": [ - { - "$ref": "#/definitions/AvsClusterEventData" - } - ] - }, - "AvsClusterUpdatingEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterUpdating event.", - "allOf": [ - { - "$ref": "#/definitions/AvsClusterEventData" - } - ] - }, - "AvsPrivateCloudEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for Microsoft.AVS/privateClouds events.", - "properties": { - "operationId": { - "type": "string", - "description": "Id of the operation that caused this event." - } - } - }, - "AvsPrivateCloudFailedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.PrivateCloudFailed event.", - "properties": { - "failureMessage": { - "type": "string", - "description": "Failure reason of an event." - } - }, - "allOf": [ - { - "$ref": "#/definitions/AvsPrivateCloudEventData" - } - ] - }, - "AvsPrivateCloudUpdatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.PrivateCloudUpdated event.", - "allOf": [ - { - "$ref": "#/definitions/AvsPrivateCloudEventData" - } - ] - }, - "AvsPrivateCloudUpdatingEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.PrivateCloudUpdating event.", - "allOf": [ - { - "$ref": "#/definitions/AvsPrivateCloudEventData" - } - ] - }, - "AvsScriptExecutionCancelledEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionCancelled event.", - "allOf": [ - { - "$ref": "#/definitions/AvsScriptExecutionEventData" - } - ] - }, - "AvsScriptExecutionEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for Microsoft.AVS/scriptExecutions events.", - "properties": { - "operationId": { - "type": "string", - "description": "Id of the operation that caused this event." - }, - "cmdletId": { - "type": "string", - "description": "Cmdlet referenced in the execution that caused this event." - }, - "output": { - "type": "array", - "description": "Stdout outputs from the execution, if any.", - "items": { - "type": "string" - } - } - } - }, - "AvsScriptExecutionFailedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionFailed event.", - "properties": { - "failureMessage": { - "type": "string", - "description": "Failure reason of an event." - } - }, - "allOf": [ - { - "$ref": "#/definitions/AvsScriptExecutionEventData" - } - ] - }, - "AvsScriptExecutionFinishedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionFinished event.", - "properties": { - "namedOutputs": { - "type": "object", - "description": "Named outputs of completed execution, if any.", - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "namedOutputs" - ], - "allOf": [ - { - "$ref": "#/definitions/AvsScriptExecutionEventData" - } - ] - }, - "AvsScriptExecutionStartedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionStarted event.", - "allOf": [ - { - "$ref": "#/definitions/AvsScriptExecutionEventData" - } - ] - }, - "CommunicationCloudEnvironmentModel": { - "type": "string", - "description": "Communication cloud environment model.", - "enum": [ - "public", - "dod", - "gcch" - ], - "x-ms-enum": { - "name": "CommunicationCloudEnvironmentModel", - "modelAsString": true, - "values": [ - { - "name": "public", - "value": "public", - "description": "Public" - }, - { - "name": "dod", - "value": "dod", - "description": "Dod" - }, - { - "name": "gcch", - "value": "gcch", - "description": "Gcch" - } - ] - } - }, - "CommunicationIdentifierModel": { - "type": "object", - "description": "Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model must be interpreted as a union: Apart from rawId, at most one further property may be set.", - "properties": { - "kind": { - "$ref": "#/definitions/CommunicationIdentifierModelKind", - "description": "The identifier kind. Only required in responses." - }, - "rawId": { - "type": "string", - "description": "Raw Id of the identifier. Optional in requests, required in responses." - }, - "communicationUser": { - "$ref": "#/definitions/CommunicationUserIdentifierModel", - "description": "The communication user." - }, - "phoneNumber": { - "$ref": "#/definitions/PhoneNumberIdentifierModel", - "description": "The phone number." - }, - "microsoftTeamsUser": { - "$ref": "#/definitions/MicrosoftTeamsUserIdentifierModel", - "description": "The Microsoft Teams user." - }, - "microsoftTeamsApp": { - "$ref": "#/definitions/MicrosoftTeamsAppIdentifierModel", - "description": "The Microsoft Teams application." - } - }, - "required": [ - "kind", - "communicationUser", - "phoneNumber", - "microsoftTeamsUser", - "microsoftTeamsApp" - ] - }, - "CommunicationIdentifierModelKind": { - "type": "string", - "description": "Communication model identifier kind", - "enum": [ - "unknown", - "communicationUser", - "phoneNumber", - "microsoftTeamsUser" - ], - "x-ms-enum": { - "name": "CommunicationIdentifierModelKind", - "modelAsString": true, - "values": [ - { - "name": "unknown", - "value": "unknown", - "description": "Unknown" - }, - { - "name": "communicationUser", - "value": "communicationUser", - "description": "Communication User" - }, - { - "name": "phoneNumber", - "value": "phoneNumber", - "description": "Phone Number" - }, - { - "name": "microsoftTeamsUser", - "value": "microsoftTeamsUser", - "description": "Microsoft Teams User" - } - ] - } - }, - "CommunicationUserIdentifierModel": { - "type": "object", - "description": "A user that got created with an Azure Communication Services resource.", - "properties": { - "id": { - "type": "string", - "description": "The Id of the communication user." - } - }, - "required": [ - "id" - ] - }, - "ContainerRegistryArtifactEventData": { - "type": "object", - "description": "The content of the event request message.", - "properties": { - "id": { - "type": "string", - "description": "The event ID." - }, - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The time at which the event occurred." - }, - "action": { - "type": "string", - "description": "The action that encompasses the provided event." - }, - "location": { - "type": "string", - "description": "The location of the event." - }, - "target": { - "$ref": "#/definitions/ContainerRegistryArtifactEventTarget", - "description": "The target of the event." - }, - "connectedRegistry": { - "$ref": "#/definitions/ContainerRegistryEventConnectedRegistry", - "description": "The connected registry information if the event is generated by a connected registry." - } - }, - "required": [ - "timestamp", - "target", - "connectedRegistry" - ] - }, - "ContainerRegistryArtifactEventTarget": { - "type": "object", - "description": "The target of the event.", - "properties": { - "mediaType": { - "type": "string", - "description": "The MIME type of the artifact." - }, - "size": { - "type": "integer", - "format": "int64", - "description": "The size in bytes of the artifact." - }, - "digest": { - "type": "string", - "description": "The digest of the artifact." - }, - "repository": { - "type": "string", - "description": "The repository name of the artifact." - }, - "tag": { - "type": "string", - "description": "The tag of the artifact." - }, - "name": { - "type": "string", - "description": "The name of the artifact." - }, - "version": { - "type": "string", - "description": "The version of the artifact." - } - } - }, - "ContainerRegistryChartDeletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ChartDeleted event.", - "allOf": [ - { - "$ref": "#/definitions/ContainerRegistryArtifactEventData" - } - ] - }, - "ContainerRegistryChartPushedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ChartPushed event.", - "allOf": [ - { - "$ref": "#/definitions/ContainerRegistryArtifactEventData" - } - ] - }, - "ContainerRegistryEventActor": { - "type": "object", - "description": "The agent that initiated the event. For most situations, this could be from the authorization context of the request.", - "properties": { - "name": { - "type": "string", - "description": "The subject or username associated with the request context that generated the event." - } - } - }, - "ContainerRegistryEventConnectedRegistry": { - "type": "object", - "description": "The connected registry information if the event is generated by a connected registry.", - "properties": { - "name": { - "type": "string", - "description": "The name of the connected registry that generated this event." - } - } - }, - "ContainerRegistryEventData": { - "type": "object", - "description": "The content of the event request message.", - "properties": { - "id": { - "type": "string", - "description": "The event ID." - }, - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The time at which the event occurred." - }, - "action": { - "type": "string", - "description": "The action that encompasses the provided event." - }, - "location": { - "type": "string", - "description": "The location of the event." - }, - "target": { - "$ref": "#/definitions/ContainerRegistryEventTarget", - "description": "The target of the event." - }, - "request": { - "$ref": "#/definitions/ContainerRegistryEventRequest", - "description": "The request that generated the event." - }, - "actor": { - "$ref": "#/definitions/ContainerRegistryEventActor", - "description": "The agent that initiated the event. For most situations, this could be from the authorization context of the request." - }, - "source": { - "$ref": "#/definitions/ContainerRegistryEventSource", - "description": "The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it." - }, - "connectedRegistry": { - "$ref": "#/definitions/ContainerRegistryEventConnectedRegistry", - "description": "The connected registry information if the event is generated by a connected registry." - } - }, - "required": [ - "timestamp", - "target", - "request", - "actor", - "source", - "connectedRegistry" - ] - }, - "ContainerRegistryEventRequest": { - "type": "object", - "description": "The request that generated the event.", - "properties": { - "id": { - "type": "string", - "description": "The ID of the request that initiated the event." - }, - "addr": { - "type": "string", - "description": "The IP or hostname and possibly port of the client connection that initiated the event. This is the RemoteAddr from the standard http request." - }, - "host": { - "type": "string", - "description": "The externally accessible hostname of the registry instance, as specified by the http host header on incoming requests." - }, - "method": { - "type": "string", - "description": "The request method that generated the event." - }, - "useragent": { - "type": "string", - "description": "The user agent header of the request." - } - } - }, - "ContainerRegistryEventSource": { - "type": "object", - "description": "The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.", - "properties": { - "addr": { - "type": "string", - "description": "The IP or hostname and the port of the registry node that generated the event. Generally, this will be resolved by os.Hostname() along with the running port." - }, - "instanceID": { - "type": "string", - "description": "The running instance of an application. Changes after each restart." - } - } - }, - "ContainerRegistryEventTarget": { - "type": "object", - "description": "The target of the event.", - "properties": { - "mediaType": { - "type": "string", - "description": "The MIME type of the referenced object." - }, - "size": { - "type": "integer", - "format": "int64", - "description": "The number of bytes of the content. Same as Length field." - }, - "digest": { - "type": "string", - "description": "The digest of the content, as defined by the Registry V2 HTTP API Specification." - }, - "length": { - "type": "integer", - "format": "int64", - "description": "The number of bytes of the content. Same as Size field." - }, - "repository": { - "type": "string", - "description": "The repository name." - }, - "url": { - "type": "string", - "description": "The direct URL to the content." - }, - "tag": { - "type": "string", - "description": "The tag name." - } - } - }, - "ContainerRegistryImageDeletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ImageDeleted event.", - "allOf": [ - { - "$ref": "#/definitions/ContainerRegistryEventData" - } - ] - }, - "ContainerRegistryImagePushedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ImagePushed event.", - "allOf": [ - { - "$ref": "#/definitions/ContainerRegistryEventData" - } - ] - }, - "ContainerServiceClusterSupportEndedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.ClusterSupportEnded event", - "allOf": [ - { - "$ref": "#/definitions/ContainerServiceClusterSupportEventData" - } - ] - }, - "ContainerServiceClusterSupportEndingEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.ClusterSupportEnding event", - "allOf": [ - { - "$ref": "#/definitions/ContainerServiceClusterSupportEventData" - } - ] - }, - "ContainerServiceClusterSupportEventData": { - "type": "object", - "description": "Schema of common properties of cluster support events", - "properties": { - "kubernetesVersion": { - "type": "string", - "description": "The Kubernetes version of the ManagedCluster resource" - } - } - }, - "ContainerServiceNewKubernetesVersionAvailableEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.NewKubernetesVersionAvailable event", - "properties": { - "latestSupportedKubernetesVersion": { - "type": "string", - "description": "The highest PATCH Kubernetes version for the highest MINOR version supported by ManagedCluster resource" - }, - "latestStableKubernetesVersion": { - "type": "string", - "description": "The highest PATCH Kubernetes version for the MINOR version considered stable for the ManagedCluster resource" - }, - "lowestMinorKubernetesVersion": { - "type": "string", - "description": "The highest PATCH Kubernetes version for the lowest applicable MINOR version available for the ManagedCluster resource" - }, - "latestPreviewKubernetesVersion": { - "type": "string", - "description": "The highest PATCH Kubernetes version considered preview for the ManagedCluster resource. There might not be any version in preview at the time of publishing the event" - } - } - }, - "ContainerServiceNodePoolRollingEventData": { - "type": "object", - "description": "Schema of common properties of node pool rolling events", - "properties": { - "nodePoolName": { - "type": "string", - "description": "The name of the node pool in the ManagedCluster resource" - } - } - }, - "ContainerServiceNodePoolRollingFailedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.NodePoolRollingFailed event", - "allOf": [ - { - "$ref": "#/definitions/ContainerServiceNodePoolRollingEventData" - } - ] - }, - "ContainerServiceNodePoolRollingStartedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.NodePoolRollingStarted event", - "allOf": [ - { - "$ref": "#/definitions/ContainerServiceNodePoolRollingEventData" - } - ] - }, - "ContainerServiceNodePoolRollingSucceededEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.NodePoolRollingSucceeded event", - "allOf": [ - { - "$ref": "#/definitions/ContainerServiceNodePoolRollingEventData" - } - ] - }, - "DataBoxCopyCompletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.DataBox.CopyCompleted event.", - "properties": { - "serialNumber": { - "type": "string", - "description": "Serial Number of the device associated with the event. The list is comma separated if more than one serial number is associated." - }, - "stageName": { - "$ref": "#/definitions/DataBoxStageName", - "description": "Name of the current Stage" - }, - "stageTime": { - "type": "string", - "format": "date-time", - "description": "The time at which the stage happened." - } - }, - "required": [ - "stageName", - "stageTime" - ] - }, - "DataBoxCopyStartedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.DataBox.CopyStarted event.", - "properties": { - "serialNumber": { - "type": "string", - "description": "Serial Number of the device associated with the event. The list is comma separated if more than one serial number is associated." - }, - "stageName": { - "$ref": "#/definitions/DataBoxStageName", - "description": "Name of the current Stage" - }, - "stageTime": { - "type": "string", - "format": "date-time", - "description": "The time at which the stage happened." - } - }, - "required": [ - "stageName", - "stageTime" - ] - }, - "DataBoxOrderCompletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.DataBox.OrderCompleted event.", - "properties": { - "serialNumber": { - "type": "string", - "description": "Serial Number of the device associated with the event. The list is comma separated if more than one serial number is associated." - }, - "stageName": { - "$ref": "#/definitions/DataBoxStageName", - "description": "Name of the current Stage" - }, - "stageTime": { - "type": "string", - "format": "date-time", - "description": "The time at which the stage happened." - } - }, - "required": [ - "stageName", - "stageTime" - ] - }, - "DataBoxStageName": { - "type": "string", - "description": "Schema of DataBox Stage Name enumeration.", - "enum": [ - "CopyStarted", - "CopyCompleted", - "OrderCompleted" - ], - "x-ms-enum": { - "name": "DataBoxStageName", - "modelAsString": true, - "values": [ - { - "name": "CopyStarted", - "value": "CopyStarted", - "description": "Copy has started" - }, - { - "name": "CopyCompleted", - "value": "CopyCompleted", - "description": "Copy has completed" - }, - { - "name": "OrderCompleted", - "value": "OrderCompleted", - "description": "Order has been completed" - } - ] - } - }, - "DeviceConnectionStateEventInfo": { - "type": "object", - "description": "Information about the device connection state event.", - "properties": { - "sequenceNumber": { - "type": "string", - "description": "Sequence number is string representation of a hexadecimal number. string compare can be used to identify the larger number because both in ASCII and HEX numbers come after alphabets. If you are converting the string to hex, then the number is a 256 bit number." - } - } - }, - "DeviceConnectionStateEventProperties": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a device connection state event (DeviceConnected, DeviceDisconnected).", - "properties": { - "deviceId": { - "type": "string", - "description": "The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = `@` ; $ '." - }, - "moduleId": { - "type": "string", - "description": "The unique identifier of the module. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = `@` ; $ '." - }, - "hubName": { - "type": "string", - "description": "Name of the IoT Hub where the device was created or deleted." - }, - "deviceConnectionStateEventInfo": { - "$ref": "#/definitions/DeviceConnectionStateEventInfo", - "description": "Information about the device connection state event." - } - }, - "required": [ - "deviceConnectionStateEventInfo" - ] - }, - "DeviceLifeCycleEventProperties": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a device life cycle event (DeviceCreated, DeviceDeleted).", - "properties": { - "deviceId": { - "type": "string", - "description": "The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = `@` ; $ '." - }, - "hubName": { - "type": "string", - "description": "Name of the IoT Hub where the device was created or deleted." - }, - "twin": { - "$ref": "#/definitions/DeviceTwinInfo", - "description": "Information about the device twin, which is the cloud representation of application device metadata." - } - }, - "required": [ - "twin" - ] - }, - "DeviceTelemetryEventProperties": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a device telemetry event (DeviceTelemetry).", - "properties": { - "body": { - "type": "object", - "description": "The content of the message from the device.", - "additionalProperties": {} - }, - "properties": { - "type": "object", - "description": "Application properties are user-defined strings that can be added to the message. These fields are optional.", - "additionalProperties": { - "type": "string" - } - }, - "systemProperties": { - "type": "object", - "description": "System properties help identify contents and source of the messages.", - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "body", - "properties", - "systemProperties" - ] - }, - "DeviceTwinInfo": { - "type": "object", - "description": "Information about the device twin, which is the cloud representation of application device metadata.", - "properties": { - "authenticationType": { - "type": "string", - "description": "Authentication type used for this device: either SAS, SelfSigned, or CertificateAuthority." - }, - "cloudToDeviceMessageCount": { - "type": "number", - "format": "float", - "description": "Count of cloud to device messages sent to this device." - }, - "connectionState": { - "type": "string", - "description": "Whether the device is connected or disconnected." - }, - "deviceId": { - "type": "string", - "description": "The unique identifier of the device twin." - }, - "etag": { - "type": "string", - "description": "A piece of information that describes the content of the device twin. Each etag is guaranteed to be unique per device twin." - }, - "lastActivityTime": { - "type": "string", - "description": "The ISO8601 timestamp of the last activity." - }, - "properties": { - "$ref": "#/definitions/DeviceTwinInfoProperties", - "description": "Properties JSON element." - }, - "status": { - "type": "string", - "description": "Whether the device twin is enabled or disabled." - }, - "statusUpdateTime": { - "type": "string", - "description": "The ISO8601 timestamp of the last device twin status update." - }, - "version": { - "type": "number", - "format": "float", - "description": "An integer that is incremented by one each time the device twin is updated." - }, - "x509Thumbprint": { - "$ref": "#/definitions/DeviceTwinInfoX509Thumbprint", - "description": "The thumbprint is a unique value for the x509 certificate, commonly used to find a particular certificate in a certificate store. The thumbprint is dynamically generated using the SHA1 algorithm, and does not physically exist in the certificate." - } - }, - "required": [ - "properties", - "x509Thumbprint" - ] - }, - "DeviceTwinInfoProperties": { - "type": "object", - "description": "Properties JSON element.", - "properties": { - "desired": { - "$ref": "#/definitions/DeviceTwinProperties", - "description": "A portion of the properties that can be written only by the application back-end, and read by the device." - }, - "reported": { - "$ref": "#/definitions/DeviceTwinProperties", - "description": "A portion of the properties that can be written only by the device, and read by the application back-end." - } - }, - "required": [ - "desired", - "reported" - ] - }, - "DeviceTwinInfoX509Thumbprint": { - "type": "object", - "description": "The thumbprint is a unique value for the x509 certificate, commonly used to find a particular certificate in a certificate store. The thumbprint is dynamically generated using the SHA1 algorithm, and does not physically exist in the certificate.", - "properties": { - "primaryThumbprint": { - "type": "string", - "description": "Primary thumbprint for the x509 certificate." - }, - "secondaryThumbprint": { - "type": "string", - "description": "Secondary thumbprint for the x509 certificate." - } - } - }, - "DeviceTwinMetadata": { - "type": "object", - "description": "Metadata information for the properties JSON document.", - "properties": { - "lastUpdated": { - "type": "string", - "description": "The ISO8601 timestamp of the last time the properties were updated.", - "x-ms-client-name": "$lastUpdated" - } - } - }, - "DeviceTwinProperties": { - "type": "object", - "description": "A portion of the properties that can be written only by the application back-end, and read by the device.", - "properties": { - "metadata": { - "$ref": "#/definitions/DeviceTwinMetadata", - "description": "Metadata information for the properties JSON document.", - "x-ms-client-name": "$metadata" - }, - "version": { - "type": "number", - "format": "float", - "description": "Version of device twin properties.", - "x-ms-client-name": "$version" - } - }, - "required": [ - "metadata" - ] - }, - "EventGridMQTTClientCreatedOrUpdatedEventData": { - "type": "object", - "description": "Event data for Microsoft.EventGrid.MQTTClientCreatedOrUpdated event.", - "properties": { - "state": { - "$ref": "#/definitions/EventGridMQTTClientState", - "description": "Configured state of the client. The value could be Enabled or Disabled" - }, - "createdOn": { - "type": "string", - "format": "date-time", - "description": "Time the client resource is created based on the provider's UTC time." - }, - "updatedOn": { - "type": "string", - "format": "date-time", - "description": "Time the client resource is last updated based on the provider's UTC time. If\nthe client resource was never updated, this value is identical to the value of\nthe 'createdOn' property." - }, - "attributes": { - "type": "object", - "description": "The key-value attributes that are assigned to the client resource.", - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "state", - "createdOn", - "updatedOn", - "attributes" - ], - "allOf": [ - { - "$ref": "#/definitions/EventGridMQTTClientEventData" - } - ] - }, - "EventGridMQTTClientDeletedEventData": { - "type": "object", - "description": "Event data for Microsoft.EventGrid.MQTTClientDeleted event.", - "allOf": [ - { - "$ref": "#/definitions/EventGridMQTTClientEventData" - } - ] - }, - "EventGridMQTTClientDisconnectionReason": { - "type": "string", - "description": "EventGrid MQTT Client Disconnection Reason", - "enum": [ - "ClientAuthenticationError", - "ClientAuthorizationError", - "ClientError", - "ClientInitiatedDisconnect", - "ConnectionLost", - "IpForbidden", - "QuotaExceeded", - "ServerError", - "ServerInitiatedDisconnect", - "SessionOverflow", - "SessionTakenOver" - ], - "x-ms-enum": { - "name": "EventGridMQTTClientDisconnectionReason", - "modelAsString": true, - "values": [ - { - "name": "ClientAuthenticationError", - "value": "ClientAuthenticationError", - "description": "The client got disconnected for any authentication reasons (for example, certificate expired, client got disabled, or client configuration changed)." - }, - { - "name": "ClientAuthorizationError", - "value": "ClientAuthorizationError", - "description": "The client got disconnected for any authorization reasons (for example, because of a change in the configuration of topic spaces, permission bindings, or client groups)." - }, - { - "name": "ClientError", - "value": "ClientError", - "description": "The client sent a bad request or used one of the unsupported features that resulted in a connection termination by the service." - }, - { - "name": "ClientInitiatedDisconnect", - "value": "ClientInitiatedDisconnect", - "description": "The client initiated a graceful disconnect through a DISCONNECT packet for MQTT or a close frame for MQTT over WebSocket." - }, - { - "name": "ConnectionLost", - "value": "ConnectionLost", - "description": "The client-server connection is lost. (EXCHANGE ONLINE PROTECTION)." - }, - { - "name": "IpForbidden", - "value": "IpForbidden", - "description": "The client's IP address is blocked by IP filter or Private links configuration." - }, - { - "name": "QuotaExceeded", - "value": "QuotaExceeded", - "description": "The client exceeded one or more of the throttling limits that resulted in a connection termination by the service." - }, - { - "name": "ServerError", - "value": "ServerError", - "description": "The connection got terminated due to an unexpected server error." - }, - { - "name": "ServerInitiatedDisconnect", - "value": "ServerInitiatedDisconnect", - "description": "The server initiates a graceful disconnect for any operational reason." - }, - { - "name": "SessionOverflow", - "value": "SessionOverflow", - "description": "The client's queue for unacknowledged QoS1 messages reached its limit, which resulted in a connection termination by the server." - }, - { - "name": "SessionTakenOver", - "value": "SessionTakenOver", - "description": "The client reconnected with the same authentication name, which resulted in the termination of the previous connection." - } - ] - } - }, - "EventGridMQTTClientEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for MQTT Client state changes.", - "properties": { - "clientAuthenticationName": { - "type": "string", - "description": "Unique identifier for the MQTT client that the client presents to the service\nfor authentication. This case-sensitive string can be up to 128 characters\nlong, and supports UTF-8 characters." - }, - "clientName": { - "type": "string", - "description": "Name of the client resource in the Event Grid namespace." - }, - "namespaceName": { - "type": "string", - "description": "Name of the Event Grid namespace where the MQTT client was created or updated." - } - } - }, - "EventGridMQTTClientSessionConnectedEventData": { - "type": "object", - "description": "Event data for Microsoft.EventGrid.MQTTClientSessionConnected event.", - "properties": { - "clientSessionName": { - "type": "string", - "description": "Unique identifier for the MQTT client's session. This case-sensitive string can\nbe up to 128 characters long, and supports UTF-8 characters." - }, - "sequenceNumber": { - "type": "integer", - "format": "int64", - "description": "A number that helps indicate order of MQTT client session connected or\ndisconnected events. Latest event will have a sequence number that is higher\nthan the previous event." - } - }, - "allOf": [ - { - "$ref": "#/definitions/EventGridMQTTClientEventData" - } - ] - }, - "EventGridMQTTClientSessionDisconnectedEventData": { - "type": "object", - "description": "Event data for Microsoft.EventGrid.MQTTClientSessionDisconnected event.", - "properties": { - "clientSessionName": { - "type": "string", - "description": "Unique identifier for the MQTT client's session. This case-sensitive string can\nbe up to 128 characters long, and supports UTF-8 characters." - }, - "sequenceNumber": { - "type": "integer", - "format": "int64", - "description": "A number that helps indicate order of MQTT client session connected or\ndisconnected events. Latest event will have a sequence number that is higher\nthan the previous event." - }, - "disconnectionReason": { - "$ref": "#/definitions/EventGridMQTTClientDisconnectionReason", - "description": "Reason for the disconnection of the MQTT client's session. The value could be\none of the values in the disconnection reasons table." - } - }, - "required": [ - "disconnectionReason" - ], - "allOf": [ - { - "$ref": "#/definitions/EventGridMQTTClientEventData" - } - ] - }, - "EventGridMQTTClientState": { - "type": "string", - "description": "EventGrid MQTT Client State", - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "name": "EventGridMQTTClientState", - "modelAsString": true, - "values": [ - { - "name": "Enabled", - "value": "Enabled", - "description": "Enabled" - }, - { - "name": "Disabled", - "value": "Disabled", - "description": "Disabled" - } - ] - } - }, - "EventHubCaptureFileCreatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.EventHub.CaptureFileCreated event.", - "properties": { - "fileUrl": { - "type": "string", - "description": "The path to the capture file.", - "x-ms-client-name": "fileurl" - }, - "fileType": { - "type": "string", - "description": "The file type of the capture file." - }, - "partitionId": { - "type": "string", - "description": "The shard ID." - }, - "sizeInBytes": { - "type": "integer", - "format": "int32", - "description": "The file size." - }, - "eventCount": { - "type": "integer", - "format": "int32", - "description": "The number of events in the file." - }, - "firstSequenceNumber": { - "type": "integer", - "format": "int32", - "description": "The smallest sequence number from the queue." - }, - "lastSequenceNumber": { - "type": "integer", - "format": "int32", - "description": "The last sequence number from the queue." - }, - "firstEnqueueTime": { - "type": "string", - "format": "date-time", - "description": "The first time from the queue." - }, - "lastEnqueueTime": { - "type": "string", - "format": "date-time", - "description": "The last time from the queue." - } - }, - "required": [ - "firstEnqueueTime", - "lastEnqueueTime" - ] - }, - "HealthcareDicomImageCreatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.DicomImageCreated event.", - "properties": { - "partitionName": { - "type": "string", - "description": "Data partition name" - }, - "imageStudyInstanceUid": { - "type": "string", - "description": "Unique identifier for the Study" - }, - "imageSeriesInstanceUid": { - "type": "string", - "description": "Unique identifier for the Series" - }, - "imageSopInstanceUid": { - "type": "string", - "description": "Unique identifier for the DICOM Image" - }, - "serviceHostName": { - "type": "string", - "description": "Domain name of the DICOM account for this image." - }, - "sequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of the DICOM Service within Azure Health Data Services. It is unique for every image creation and deletion within the service." - } - } - }, - "HealthcareDicomImageDeletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.DicomImageDeleted event.", - "properties": { - "partitionName": { - "type": "string", - "description": "Data partition name" - }, - "imageStudyInstanceUid": { - "type": "string", - "description": "Unique identifier for the Study" - }, - "imageSeriesInstanceUid": { - "type": "string", - "description": "Unique identifier for the Series" - }, - "imageSopInstanceUid": { - "type": "string", - "description": "Unique identifier for the DICOM Image" - }, - "serviceHostName": { - "type": "string", - "description": "Host name of the DICOM account for this image." - }, - "sequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of the DICOM Service within Azure Health Data Services. It is unique for every image creation and deletion within the service." - } - } - }, - "HealthcareDicomImageUpdatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.DicomImageUpdated event.", - "properties": { - "partitionName": { - "type": "string", - "description": "Data partition name" - }, - "imageStudyInstanceUid": { - "type": "string", - "description": "Unique identifier for the Study" - }, - "imageSeriesInstanceUid": { - "type": "string", - "description": "Unique identifier for the Series" - }, - "imageSopInstanceUid": { - "type": "string", - "description": "Unique identifier for the DICOM Image" - }, - "serviceHostName": { - "type": "string", - "description": "Domain name of the DICOM account for this image." - }, - "sequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of the DICOM Service within Azure Health Data Services. It is unique for every image creation, updation and deletion within the service." - } - } - }, - "HealthcareFhirResourceCreatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.FhirResourceCreated event.", - "properties": { - "resourceType": { - "$ref": "#/definitions/HealthcareFhirResourceType", - "description": "Type of HL7 FHIR resource.", - "x-ms-client-name": "FhirResourceType" - }, - "resourceFhirAccount": { - "type": "string", - "description": "Domain name of FHIR account for this resource.", - "x-ms-client-name": "FhirServiceHostName" - }, - "resourceFhirId": { - "type": "string", - "description": "Id of HL7 FHIR resource.", - "x-ms-client-name": "FhirResourceId" - }, - "resourceVersionId": { - "type": "integer", - "format": "int64", - "description": "VersionId of HL7 FHIR resource. It changes when the resource is created, updated, or deleted(soft-deletion).", - "x-ms-client-name": "FhirResourceVersionId" - } - }, - "required": [ - "resourceType" - ] - }, - "HealthcareFhirResourceDeletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.FhirResourceDeleted event.", - "properties": { - "resourceType": { - "$ref": "#/definitions/HealthcareFhirResourceType", - "description": "Type of HL7 FHIR resource.", - "x-ms-client-name": "FhirResourceType" - }, - "resourceFhirAccount": { - "type": "string", - "description": "Domain name of FHIR account for this resource.", - "x-ms-client-name": "FhirServiceHostName" - }, - "resourceFhirId": { - "type": "string", - "description": "Id of HL7 FHIR resource.", - "x-ms-client-name": "FhirResourceId" - }, - "resourceVersionId": { - "type": "integer", - "format": "int64", - "description": "VersionId of HL7 FHIR resource. It changes when the resource is created, updated, or deleted(soft-deletion).", - "x-ms-client-name": "FhirResourceVersionId" - } - }, - "required": [ - "resourceType" - ] - }, - "HealthcareFhirResourceType": { - "type": "string", - "description": "Schema of FHIR resource type enumeration.", - "enum": [ - "Account", - "ActivityDefinition", - "AdverseEvent", - "AllergyIntolerance", - "Appointment", - "AppointmentResponse", - "AuditEvent", - "Basic", - "Binary", - "BiologicallyDerivedProduct", - "BodySite", - "BodyStructure", - "Bundle", - "CapabilityStatement", - "CarePlan", - "CareTeam", - "CatalogEntry", - "ChargeItem", - "ChargeItemDefinition", - "Claim", - "ClaimResponse", - "ClinicalImpression", - "CodeSystem", - "Communication", - "CommunicationRequest", - "CompartmentDefinition", - "Composition", - "ConceptMap", - "Condition", - "Consent", - "Contract", - "Coverage", - "CoverageEligibilityRequest", - "CoverageEligibilityResponse", - "DataElement", - "DetectedIssue", - "Device", - "DeviceComponent", - "DeviceDefinition", - "DeviceMetric", - "DeviceRequest", - "DeviceUseStatement", - "DiagnosticReport", - "DocumentManifest", - "DocumentReference", - "DomainResource", - "EffectEvidenceSynthesis", - "EligibilityRequest", - "EligibilityResponse", - "Encounter", - "Endpoint", - "EnrollmentRequest", - "EnrollmentResponse", - "EpisodeOfCare", - "EventDefinition", - "Evidence", - "EvidenceVariable", - "ExampleScenario", - "ExpansionProfile", - "ExplanationOfBenefit", - "FamilyMemberHistory", - "Flag", - "Goal", - "GraphDefinition", - "Group", - "GuidanceResponse", - "HealthcareService", - "ImagingManifest", - "ImagingStudy", - "Immunization", - "ImmunizationEvaluation", - "ImmunizationRecommendation", - "ImplementationGuide", - "InsurancePlan", - "Invoice", - "Library", - "Linkage", - "List", - "Location", - "Measure", - "MeasureReport", - "Media", - "Medication", - "MedicationAdministration", - "MedicationDispense", - "MedicationKnowledge", - "MedicationRequest", - "MedicationStatement", - "MedicinalProduct", - "MedicinalProductAuthorization", - "MedicinalProductContraindication", - "MedicinalProductIndication", - "MedicinalProductIngredient", - "MedicinalProductInteraction", - "MedicinalProductManufactured", - "MedicinalProductPackaged", - "MedicinalProductPharmaceutical", - "MedicinalProductUndesirableEffect", - "MessageDefinition", - "MessageHeader", - "MolecularSequence", - "NamingSystem", - "NutritionOrder", - "Observation", - "ObservationDefinition", - "OperationDefinition", - "OperationOutcome", - "Organization", - "OrganizationAffiliation", - "Parameters", - "Patient", - "PaymentNotice", - "PaymentReconciliation", - "Person", - "PlanDefinition", - "Practitioner", - "PractitionerRole", - "Procedure", - "ProcedureRequest", - "ProcessRequest", - "ProcessResponse", - "Provenance", - "Questionnaire", - "QuestionnaireResponse", - "ReferralRequest", - "RelatedPerson", - "RequestGroup", - "ResearchDefinition", - "ResearchElementDefinition", - "ResearchStudy", - "ResearchSubject", - "Resource", - "RiskAssessment", - "RiskEvidenceSynthesis", - "Schedule", - "SearchParameter", - "Sequence", - "ServiceDefinition", - "ServiceRequest", - "Slot", - "Specimen", - "SpecimenDefinition", - "StructureDefinition", - "StructureMap", - "Subscription", - "Substance", - "SubstanceNucleicAcid", - "SubstancePolymer", - "SubstanceProtein", - "SubstanceReferenceInformation", - "SubstanceSourceMaterial", - "SubstanceSpecification", - "SupplyDelivery", - "SupplyRequest", - "Task", - "TerminologyCapabilities", - "TestReport", - "TestScript", - "ValueSet", - "VerificationResult", - "VisionPrescription" - ], - "x-ms-enum": { - "name": "HealthcareFhirResourceType", - "modelAsString": true, - "values": [ - { - "name": "Account", - "value": "Account", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "ActivityDefinition", - "value": "ActivityDefinition", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "AdverseEvent", - "value": "AdverseEvent", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "AllergyIntolerance", - "value": "AllergyIntolerance", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Appointment", - "value": "Appointment", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "AppointmentResponse", - "value": "AppointmentResponse", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "AuditEvent", - "value": "AuditEvent", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Basic", - "value": "Basic", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Binary", - "value": "Binary", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "BiologicallyDerivedProduct", - "value": "BiologicallyDerivedProduct", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "BodySite", - "value": "BodySite", - "description": "The FHIR resource type defined in STU3." - }, - { - "name": "BodyStructure", - "value": "BodyStructure", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "Bundle", - "value": "Bundle", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "CapabilityStatement", - "value": "CapabilityStatement", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "CarePlan", - "value": "CarePlan", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "CareTeam", - "value": "CareTeam", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "CatalogEntry", - "value": "CatalogEntry", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "ChargeItem", - "value": "ChargeItem", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "ChargeItemDefinition", - "value": "ChargeItemDefinition", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "Claim", - "value": "Claim", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "ClaimResponse", - "value": "ClaimResponse", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "ClinicalImpression", - "value": "ClinicalImpression", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "CodeSystem", - "value": "CodeSystem", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Communication", - "value": "Communication", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "CommunicationRequest", - "value": "CommunicationRequest", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "CompartmentDefinition", - "value": "CompartmentDefinition", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Composition", - "value": "Composition", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "ConceptMap", - "value": "ConceptMap", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Condition", - "value": "Condition", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Consent", - "value": "Consent", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Contract", - "value": "Contract", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Coverage", - "value": "Coverage", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "CoverageEligibilityRequest", - "value": "CoverageEligibilityRequest", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "CoverageEligibilityResponse", - "value": "CoverageEligibilityResponse", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "DataElement", - "value": "DataElement", - "description": "The FHIR resource type defined in STU3." - }, - { - "name": "DetectedIssue", - "value": "DetectedIssue", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Device", - "value": "Device", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "DeviceComponent", - "value": "DeviceComponent", - "description": "The FHIR resource type defined in STU3." - }, - { - "name": "DeviceDefinition", - "value": "DeviceDefinition", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "DeviceMetric", - "value": "DeviceMetric", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "DeviceRequest", - "value": "DeviceRequest", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "DeviceUseStatement", - "value": "DeviceUseStatement", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "DiagnosticReport", - "value": "DiagnosticReport", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "DocumentManifest", - "value": "DocumentManifest", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "DocumentReference", - "value": "DocumentReference", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "DomainResource", - "value": "DomainResource", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "EffectEvidenceSynthesis", - "value": "EffectEvidenceSynthesis", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "EligibilityRequest", - "value": "EligibilityRequest", - "description": "The FHIR resource type defined in STU3." - }, - { - "name": "EligibilityResponse", - "value": "EligibilityResponse", - "description": "The FHIR resource type defined in STU3." - }, - { - "name": "Encounter", - "value": "Encounter", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Endpoint", - "value": "Endpoint", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "EnrollmentRequest", - "value": "EnrollmentRequest", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "EnrollmentResponse", - "value": "EnrollmentResponse", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "EpisodeOfCare", - "value": "EpisodeOfCare", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "EventDefinition", - "value": "EventDefinition", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "Evidence", - "value": "Evidence", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "EvidenceVariable", - "value": "EvidenceVariable", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "ExampleScenario", - "value": "ExampleScenario", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "ExpansionProfile", - "value": "ExpansionProfile", - "description": "The FHIR resource type defined in STU3." - }, - { - "name": "ExplanationOfBenefit", - "value": "ExplanationOfBenefit", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "FamilyMemberHistory", - "value": "FamilyMemberHistory", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Flag", - "value": "Flag", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Goal", - "value": "Goal", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "GraphDefinition", - "value": "GraphDefinition", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Group", - "value": "Group", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "GuidanceResponse", - "value": "GuidanceResponse", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "HealthcareService", - "value": "HealthcareService", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "ImagingManifest", - "value": "ImagingManifest", - "description": "The FHIR resource type defined in STU3." - }, - { - "name": "ImagingStudy", - "value": "ImagingStudy", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Immunization", - "value": "Immunization", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "ImmunizationEvaluation", - "value": "ImmunizationEvaluation", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "ImmunizationRecommendation", - "value": "ImmunizationRecommendation", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "ImplementationGuide", - "value": "ImplementationGuide", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "InsurancePlan", - "value": "InsurancePlan", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "Invoice", - "value": "Invoice", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "Library", - "value": "Library", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Linkage", - "value": "Linkage", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "List", - "value": "List", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Location", - "value": "Location", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Measure", - "value": "Measure", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "MeasureReport", - "value": "MeasureReport", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Media", - "value": "Media", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Medication", - "value": "Medication", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "MedicationAdministration", - "value": "MedicationAdministration", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "MedicationDispense", - "value": "MedicationDispense", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "MedicationKnowledge", - "value": "MedicationKnowledge", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "MedicationRequest", - "value": "MedicationRequest", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "MedicationStatement", - "value": "MedicationStatement", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "MedicinalProduct", - "value": "MedicinalProduct", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "MedicinalProductAuthorization", - "value": "MedicinalProductAuthorization", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "MedicinalProductContraindication", - "value": "MedicinalProductContraindication", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "MedicinalProductIndication", - "value": "MedicinalProductIndication", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "MedicinalProductIngredient", - "value": "MedicinalProductIngredient", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "MedicinalProductInteraction", - "value": "MedicinalProductInteraction", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "MedicinalProductManufactured", - "value": "MedicinalProductManufactured", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "MedicinalProductPackaged", - "value": "MedicinalProductPackaged", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "MedicinalProductPharmaceutical", - "value": "MedicinalProductPharmaceutical", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "MedicinalProductUndesirableEffect", - "value": "MedicinalProductUndesirableEffect", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "MessageDefinition", - "value": "MessageDefinition", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "MessageHeader", - "value": "MessageHeader", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "MolecularSequence", - "value": "MolecularSequence", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "NamingSystem", - "value": "NamingSystem", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "NutritionOrder", - "value": "NutritionOrder", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Observation", - "value": "Observation", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "ObservationDefinition", - "value": "ObservationDefinition", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "OperationDefinition", - "value": "OperationDefinition", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "OperationOutcome", - "value": "OperationOutcome", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Organization", - "value": "Organization", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "OrganizationAffiliation", - "value": "OrganizationAffiliation", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "Parameters", - "value": "Parameters", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Patient", - "value": "Patient", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "PaymentNotice", - "value": "PaymentNotice", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "PaymentReconciliation", - "value": "PaymentReconciliation", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Person", - "value": "Person", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "PlanDefinition", - "value": "PlanDefinition", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Practitioner", - "value": "Practitioner", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "PractitionerRole", - "value": "PractitionerRole", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Procedure", - "value": "Procedure", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "ProcedureRequest", - "value": "ProcedureRequest", - "description": "The FHIR resource type defined in STU3." - }, - { - "name": "ProcessRequest", - "value": "ProcessRequest", - "description": "The FHIR resource type defined in STU3." - }, - { - "name": "ProcessResponse", - "value": "ProcessResponse", - "description": "The FHIR resource type defined in STU3." - }, - { - "name": "Provenance", - "value": "Provenance", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Questionnaire", - "value": "Questionnaire", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "QuestionnaireResponse", - "value": "QuestionnaireResponse", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "ReferralRequest", - "value": "ReferralRequest", - "description": "The FHIR resource type defined in STU3." - }, - { - "name": "RelatedPerson", - "value": "RelatedPerson", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "RequestGroup", - "value": "RequestGroup", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "ResearchDefinition", - "value": "ResearchDefinition", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "ResearchElementDefinition", - "value": "ResearchElementDefinition", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "ResearchStudy", - "value": "ResearchStudy", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "ResearchSubject", - "value": "ResearchSubject", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Resource", - "value": "Resource", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "RiskAssessment", - "value": "RiskAssessment", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "RiskEvidenceSynthesis", - "value": "RiskEvidenceSynthesis", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "Schedule", - "value": "Schedule", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "SearchParameter", - "value": "SearchParameter", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Sequence", - "value": "Sequence", - "description": "The FHIR resource type defined in STU3." - }, - { - "name": "ServiceDefinition", - "value": "ServiceDefinition", - "description": "The FHIR resource type defined in STU3." - }, - { - "name": "ServiceRequest", - "value": "ServiceRequest", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "Slot", - "value": "Slot", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Specimen", - "value": "Specimen", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "SpecimenDefinition", - "value": "SpecimenDefinition", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "StructureDefinition", - "value": "StructureDefinition", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "StructureMap", - "value": "StructureMap", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Subscription", - "value": "Subscription", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Substance", - "value": "Substance", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "SubstanceNucleicAcid", - "value": "SubstanceNucleicAcid", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "SubstancePolymer", - "value": "SubstancePolymer", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "SubstanceProtein", - "value": "SubstanceProtein", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "SubstanceReferenceInformation", - "value": "SubstanceReferenceInformation", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "SubstanceSourceMaterial", - "value": "SubstanceSourceMaterial", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "SubstanceSpecification", - "value": "SubstanceSpecification", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "SupplyDelivery", - "value": "SupplyDelivery", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "SupplyRequest", - "value": "SupplyRequest", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "Task", - "value": "Task", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "TerminologyCapabilities", - "value": "TerminologyCapabilities", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "TestReport", - "value": "TestReport", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "TestScript", - "value": "TestScript", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "ValueSet", - "value": "ValueSet", - "description": "The FHIR resource type defined in STU3 and R4." - }, - { - "name": "VerificationResult", - "value": "VerificationResult", - "description": "The FHIR resource type defined in R4." - }, - { - "name": "VisionPrescription", - "value": "VisionPrescription", - "description": "The FHIR resource type defined in STU3 and R4." - } - ] - } - }, - "HealthcareFhirResourceUpdatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.FhirResourceUpdated event.", - "properties": { - "resourceType": { - "$ref": "#/definitions/HealthcareFhirResourceType", - "description": "Type of HL7 FHIR resource.", - "x-ms-client-name": "FhirResourceType" - }, - "resourceFhirAccount": { - "type": "string", - "description": "Domain name of FHIR account for this resource.", - "x-ms-client-name": "FhirServiceHostName" - }, - "resourceFhirId": { - "type": "string", - "description": "Id of HL7 FHIR resource.", - "x-ms-client-name": "FhirResourceId" - }, - "resourceVersionId": { - "type": "integer", - "format": "int64", - "description": "VersionId of HL7 FHIR resource. It changes when the resource is created, updated, or deleted(soft-deletion).", - "x-ms-client-name": "FhirResourceVersionId" - } - }, - "required": [ - "resourceType" - ] - }, - "IotHubDeviceConnectedEventData": { - "type": "object", - "description": "Event data for Microsoft.Devices.DeviceConnected event.", - "allOf": [ - { - "$ref": "#/definitions/DeviceConnectionStateEventProperties" - } - ] - }, - "IotHubDeviceCreatedEventData": { - "type": "object", - "description": "Event data for Microsoft.Devices.DeviceCreated event.", - "allOf": [ - { - "$ref": "#/definitions/DeviceLifeCycleEventProperties" - } - ] - }, - "IotHubDeviceDeletedEventData": { - "type": "object", - "description": "Event data for Microsoft.Devices.DeviceDeleted event.", - "allOf": [ - { - "$ref": "#/definitions/DeviceLifeCycleEventProperties" - } - ] - }, - "IotHubDeviceDisconnectedEventData": { - "type": "object", - "description": "Event data for Microsoft.Devices.DeviceDisconnected event.", - "allOf": [ - { - "$ref": "#/definitions/DeviceConnectionStateEventProperties" - } - ] - }, - "IotHubDeviceTelemetryEventData": { - "type": "object", - "description": "Event data for Microsoft.Devices.DeviceTelemetry event.", - "allOf": [ - { - "$ref": "#/definitions/DeviceTelemetryEventProperties" - } - ] - }, - "KeyVaultAccessPolicyChangedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.VaultAccessPolicyChanged event.", - "properties": { - "Id": { - "type": "string", - "description": "The id of the object that triggered this event." - }, - "VaultName": { - "type": "string", - "description": "Key vault name of the object that triggered this event." - }, - "ObjectType": { - "type": "string", - "description": "The type of the object that triggered this event" - }, - "ObjectName": { - "type": "string", - "description": "The name of the object that triggered this event" - }, - "Version": { - "type": "string", - "description": "The version of the object that triggered this event" - }, - "NBF": { - "type": "number", - "format": "float", - "description": "Not before date of the object that triggered this event" - }, - "EXP": { - "type": "number", - "format": "float", - "description": "The expiration date of the object that triggered this event" - } - } - }, - "KeyVaultCertificateExpiredEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.CertificateExpired event.", - "properties": { - "Id": { - "type": "string", - "description": "The id of the object that triggered this event." - }, - "VaultName": { - "type": "string", - "description": "Key vault name of the object that triggered this event." - }, - "ObjectType": { - "type": "string", - "description": "The type of the object that triggered this event" - }, - "ObjectName": { - "type": "string", - "description": "The name of the object that triggered this event" - }, - "Version": { - "type": "string", - "description": "The version of the object that triggered this event" - }, - "NBF": { - "type": "number", - "format": "float", - "description": "Not before date of the object that triggered this event" - }, - "EXP": { - "type": "number", - "format": "float", - "description": "The expiration date of the object that triggered this event" - } - } - }, - "KeyVaultCertificateNearExpiryEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.CertificateNearExpiry event.", - "properties": { - "Id": { - "type": "string", - "description": "The id of the object that triggered this event." - }, - "VaultName": { - "type": "string", - "description": "Key vault name of the object that triggered this event." - }, - "ObjectType": { - "type": "string", - "description": "The type of the object that triggered this event" - }, - "ObjectName": { - "type": "string", - "description": "The name of the object that triggered this event" - }, - "Version": { - "type": "string", - "description": "The version of the object that triggered this event" - }, - "NBF": { - "type": "number", - "format": "float", - "description": "Not before date of the object that triggered this event" - }, - "EXP": { - "type": "number", - "format": "float", - "description": "The expiration date of the object that triggered this event" - } - } - }, - "KeyVaultCertificateNewVersionCreatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.CertificateNewVersionCreated event.", - "properties": { - "Id": { - "type": "string", - "description": "The id of the object that triggered this event." - }, - "VaultName": { - "type": "string", - "description": "Key vault name of the object that triggered this event." - }, - "ObjectType": { - "type": "string", - "description": "The type of the object that triggered this event" - }, - "ObjectName": { - "type": "string", - "description": "The name of the object that triggered this event" - }, - "Version": { - "type": "string", - "description": "The version of the object that triggered this event" - }, - "NBF": { - "type": "number", - "format": "float", - "description": "Not before date of the object that triggered this event" - }, - "EXP": { - "type": "number", - "format": "float", - "description": "The expiration date of the object that triggered this event" - } - } - }, - "KeyVaultKeyExpiredEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.KeyExpired event.", - "properties": { - "Id": { - "type": "string", - "description": "The id of the object that triggered this event." - }, - "VaultName": { - "type": "string", - "description": "Key vault name of the object that triggered this event." - }, - "ObjectType": { - "type": "string", - "description": "The type of the object that triggered this event" - }, - "ObjectName": { - "type": "string", - "description": "The name of the object that triggered this event" - }, - "Version": { - "type": "string", - "description": "The version of the object that triggered this event" - }, - "NBF": { - "type": "number", - "format": "float", - "description": "Not before date of the object that triggered this event" - }, - "EXP": { - "type": "number", - "format": "float", - "description": "The expiration date of the object that triggered this event" - } - } - }, - "KeyVaultKeyNearExpiryEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.KeyNearExpiry event.", - "properties": { - "Id": { - "type": "string", - "description": "The id of the object that triggered this event." - }, - "VaultName": { - "type": "string", - "description": "Key vault name of the object that triggered this event." - }, - "ObjectType": { - "type": "string", - "description": "The type of the object that triggered this event" - }, - "ObjectName": { - "type": "string", - "description": "The name of the object that triggered this event" - }, - "Version": { - "type": "string", - "description": "The version of the object that triggered this event" - }, - "NBF": { - "type": "number", - "format": "float", - "description": "Not before date of the object that triggered this event" - }, - "EXP": { - "type": "number", - "format": "float", - "description": "The expiration date of the object that triggered this event" - } - } - }, - "KeyVaultKeyNewVersionCreatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.KeyNewVersionCreated event.", - "properties": { - "Id": { - "type": "string", - "description": "The id of the object that triggered this event." - }, - "VaultName": { - "type": "string", - "description": "Key vault name of the object that triggered this event." - }, - "ObjectType": { - "type": "string", - "description": "The type of the object that triggered this event" - }, - "ObjectName": { - "type": "string", - "description": "The name of the object that triggered this event" - }, - "Version": { - "type": "string", - "description": "The version of the object that triggered this event" - }, - "NBF": { - "type": "number", - "format": "float", - "description": "Not before date of the object that triggered this event" - }, - "EXP": { - "type": "number", - "format": "float", - "description": "The expiration date of the object that triggered this event" - } - } - }, - "KeyVaultSecretExpiredEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.SecretExpired event.", - "properties": { - "Id": { - "type": "string", - "description": "The id of the object that triggered this event." - }, - "VaultName": { - "type": "string", - "description": "Key vault name of the object that triggered this event." - }, - "ObjectType": { - "type": "string", - "description": "The type of the object that triggered this event" - }, - "ObjectName": { - "type": "string", - "description": "The name of the object that triggered this event" - }, - "Version": { - "type": "string", - "description": "The version of the object that triggered this event" - }, - "NBF": { - "type": "number", - "format": "float", - "description": "Not before date of the object that triggered this event" - }, - "EXP": { - "type": "number", - "format": "float", - "description": "The expiration date of the object that triggered this event" - } - } - }, - "KeyVaultSecretNearExpiryEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.SecretNearExpiry event.", - "properties": { - "Id": { - "type": "string", - "description": "The id of the object that triggered this event." - }, - "VaultName": { - "type": "string", - "description": "Key vault name of the object that triggered this event." - }, - "ObjectType": { - "type": "string", - "description": "The type of the object that triggered this event" - }, - "ObjectName": { - "type": "string", - "description": "The name of the object that triggered this event" - }, - "Version": { - "type": "string", - "description": "The version of the object that triggered this event" - }, - "NBF": { - "type": "number", - "format": "float", - "description": "Not before date of the object that triggered this event" - }, - "EXP": { - "type": "number", - "format": "float", - "description": "The expiration date of the object that triggered this event" - } - } - }, - "KeyVaultSecretNewVersionCreatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.SecretNewVersionCreated event.", - "properties": { - "Id": { - "type": "string", - "description": "The id of the object that triggered this event." - }, - "VaultName": { - "type": "string", - "description": "Key vault name of the object that triggered this event." - }, - "ObjectType": { - "type": "string", - "description": "The type of the object that triggered this event" - }, - "ObjectName": { - "type": "string", - "description": "The name of the object that triggered this event" - }, - "Version": { - "type": "string", - "description": "The version of the object that triggered this event" - }, - "NBF": { - "type": "number", - "format": "float", - "description": "Not before date of the object that triggered this event" - }, - "EXP": { - "type": "number", - "format": "float", - "description": "The expiration date of the object that triggered this event" - } - } - }, - "MachineLearningServicesDatasetDriftDetectedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.DatasetDriftDetected event.", - "properties": { - "dataDriftId": { - "type": "string", - "description": "The ID of the data drift monitor that triggered the event." - }, - "dataDriftName": { - "type": "string", - "description": "The name of the data drift monitor that triggered the event." - }, - "runId": { - "type": "string", - "description": "The ID of the Run that detected data drift." - }, - "baseDatasetId": { - "type": "string", - "description": "The ID of the base Dataset used to detect drift." - }, - "targetDatasetId": { - "type": "string", - "description": "The ID of the target Dataset used to detect drift." - }, - "driftCoefficient": { - "type": "number", - "format": "double", - "description": "The coefficient result that triggered the event." - }, - "startTime": { - "type": "string", - "format": "date-time", - "description": "The start time of the target dataset time series that resulted in drift detection." - }, - "endTime": { - "type": "string", - "format": "date-time", - "description": "The end time of the target dataset time series that resulted in drift detection." - } - }, - "required": [ - "startTime", - "endTime" - ] - }, - "MachineLearningServicesModelDeployedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.ModelDeployed event.", - "properties": { - "serviceName": { - "type": "string", - "description": "The name of the deployed service." - }, - "serviceComputeType": { - "type": "string", - "description": "The compute type (e.g. ACI, AKS) of the deployed service." - }, - "modelIds": { - "type": "string", - "description": "A common separated list of model IDs. The IDs of the models deployed in the service." - }, - "serviceTags": { - "type": "object", - "description": "The tags of the deployed service.", - "additionalProperties": {} - }, - "serviceProperties": { - "type": "object", - "description": "The properties of the deployed service.", - "additionalProperties": {} - } - }, - "required": [ - "serviceTags", - "serviceProperties" - ] - }, - "MachineLearningServicesModelRegisteredEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.ModelRegistered event.", - "properties": { - "modelName": { - "type": "string", - "description": "The name of the model that was registered." - }, - "modelVersion": { - "type": "string", - "description": "The version of the model that was registered." - }, - "modelTags": { - "type": "object", - "description": "The tags of the model that was registered.", - "additionalProperties": {} - }, - "modelProperties": { - "type": "object", - "description": "The properties of the model that was registered.", - "additionalProperties": {} - } - }, - "required": [ - "modelTags", - "modelProperties" - ] - }, - "MachineLearningServicesRunCompletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.RunCompleted event.", - "properties": { - "experimentId": { - "type": "string", - "description": "The ID of the experiment that the run belongs to." - }, - "experimentName": { - "type": "string", - "description": "The name of the experiment that the run belongs to." - }, - "runId": { - "type": "string", - "description": "The ID of the Run that was completed." - }, - "runType": { - "type": "string", - "description": "The Run Type of the completed Run." - }, - "runTags": { - "type": "object", - "description": "The tags of the completed Run.", - "additionalProperties": {} - }, - "runProperties": { - "type": "object", - "description": "The properties of the completed Run.", - "additionalProperties": {} - } - }, - "required": [ - "runTags", - "runProperties" - ] - }, - "MachineLearningServicesRunStatusChangedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.RunStatusChanged event.", - "properties": { - "experimentId": { - "type": "string", - "description": "The ID of the experiment that the Machine Learning Run belongs to." - }, - "experimentName": { - "type": "string", - "description": "The name of the experiment that the Machine Learning Run belongs to." - }, - "runId": { - "type": "string", - "description": "The ID of the Machine Learning Run." - }, - "runType": { - "type": "string", - "description": "The Run Type of the Machine Learning Run." - }, - "runTags": { - "type": "object", - "description": "The tags of the Machine Learning Run.", - "additionalProperties": {} - }, - "runProperties": { - "type": "object", - "description": "The properties of the Machine Learning Run.", - "additionalProperties": {} - }, - "runStatus": { - "type": "string", - "description": "The status of the Machine Learning Run." - } - }, - "required": [ - "runTags", - "runProperties" - ] - }, - "MapsGeofenceEnteredEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceEntered event.", - "allOf": [ - { - "$ref": "#/definitions/MapsGeofenceEventProperties" - } - ] - }, - "MapsGeofenceEventProperties": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Geofence event (GeofenceEntered, GeofenceExited, GeofenceResult).", - "properties": { - "expiredGeofenceGeometryId": { - "type": "array", - "description": "Lists of the geometry ID of the geofence which is expired relative to the user time in the request.", - "items": { - "type": "string" - } - }, - "geometries": { - "type": "array", - "description": "Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.", - "items": { - "$ref": "#/definitions/MapsGeofenceGeometry" - }, - "x-ms-identifiers": [] - }, - "invalidPeriodGeofenceGeometryId": { - "type": "array", - "description": "Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.", - "items": { - "type": "string" - } - }, - "isEventPublished": { - "type": "boolean", - "description": "True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber." - } - }, - "required": [ - "geometries" - ] - }, - "MapsGeofenceExitedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceExited event.", - "allOf": [ - { - "$ref": "#/definitions/MapsGeofenceEventProperties" - } - ] - }, - "MapsGeofenceGeometry": { - "type": "object", - "description": "The geofence geometry.", - "properties": { - "deviceId": { - "type": "string", - "description": "ID of the device." - }, - "distance": { - "type": "number", - "format": "float", - "description": "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." - }, - "geometryId": { - "type": "string", - "description": "The unique ID for the geofence geometry." - }, - "nearestLat": { - "type": "number", - "format": "float", - "description": "Latitude of the nearest point of the geometry." - }, - "nearestLon": { - "type": "number", - "format": "float", - "description": "Longitude of the nearest point of the geometry." - }, - "udId": { - "type": "string", - "description": "The unique id returned from user upload service when uploading a geofence. Will not be included in geofencing post API." - } - } - }, - "MapsGeofenceResultEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceResult event.", - "allOf": [ - { - "$ref": "#/definitions/MapsGeofenceEventProperties" - } - ] - }, - "MediaJobCanceledEventData": { - "type": "object", - "description": "Job canceled event data. Schema of the data property of an EventGridEvent for a\nMicrosoft.Media.JobCanceled event.", - "properties": { - "outputs": { - "type": "array", - "description": "Gets the Job outputs.", - "items": { - "$ref": "#/definitions/MediaJobOutput" - }, - "x-ms-identifiers": [] - } - }, - "required": [ - "outputs" - ], - "allOf": [ - { - "$ref": "#/definitions/MediaJobStateChangeEventData" - } - ] - }, - "MediaJobCancelingEventData": { - "type": "object", - "description": "Job canceling event data. Schema of the data property of an EventGridEvent for\na Microsoft.Media.JobCanceling event.", - "allOf": [ - { - "$ref": "#/definitions/MediaJobStateChangeEventData" - } - ] - }, - "MediaJobError": { - "type": "object", - "description": "Details of JobOutput errors.", - "properties": { - "code": { - "$ref": "#/definitions/MediaJobErrorCode", - "description": "Error code describing the error." - }, - "message": { - "type": "string", - "description": "A human-readable language-dependent representation of the error." - }, - "category": { - "$ref": "#/definitions/MediaJobErrorCategory", - "description": "Helps with categorization of errors." - }, - "retry": { - "$ref": "#/definitions/MediaJobRetry", - "description": "Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal." - }, - "details": { - "type": "array", - "description": "An array of details about specific errors that led to this reported error.", - "items": { - "$ref": "#/definitions/MediaJobErrorDetail" - }, - "x-ms-identifiers": [] - } - }, - "required": [ - "code", - "category", - "retry", - "details" - ] - }, - "MediaJobErrorCategory": { - "type": "string", - "description": "Error categories for Media Job Errors.", - "enum": [ - "Service", - "Download", - "Upload", - "Configuration", - "Content", - "Account" - ], - "x-ms-enum": { - "name": "MediaJobErrorCategory", - "modelAsString": true, - "values": [ - { - "name": "Service", - "value": "Service", - "description": "The error is service related." - }, - { - "name": "Download", - "value": "Download", - "description": "The error is download related." - }, - { - "name": "Upload", - "value": "Upload", - "description": "The error is upload related." - }, - { - "name": "Configuration", - "value": "Configuration", - "description": "The error is configuration related." - }, - { - "name": "Content", - "value": "Content", - "description": "The error is related to data in the input files." - }, - { - "name": "Account", - "value": "Account", - "description": "The error is related to account information." - } - ] - } - }, - "MediaJobErrorCode": { - "type": "string", - "description": "Media Job Error Codes.", - "enum": [ - "ServiceError", - "ServiceTransientError", - "DownloadNotAccessible", - "DownloadTransientError", - "UploadNotAccessible", - "UploadTransientError", - "ConfigurationUnsupported", - "ContentMalformed", - "ContentUnsupported", - "IdentityUnsupported" - ], - "x-ms-enum": { - "name": "MediaJobErrorCode", - "modelAsString": true, - "values": [ - { - "name": "ServiceError", - "value": "ServiceError", - "description": "Fatal service error, please contact support." - }, - { - "name": "ServiceTransientError", - "value": "ServiceTransientError", - "description": "Transient error, please retry, if retry is unsuccessful, please contact support." - }, - { - "name": "DownloadNotAccessible", - "value": "DownloadNotAccessible", - "description": "While trying to download the input files, the files were not accessible, please check the availability of the source." - }, - { - "name": "DownloadTransientError", - "value": "DownloadTransientError", - "description": "While trying to download the input files, there was an issue during transfer (storage service, network errors), see details and check your source." - }, - { - "name": "UploadNotAccessible", - "value": "UploadNotAccessible", - "description": "While trying to upload the output files, the destination was not reachable, please check the availability of the destination." - }, - { - "name": "UploadTransientError", - "value": "UploadTransientError", - "description": "While trying to upload the output files, there was an issue during transfer (storage service, network errors), see details and check your destination." - }, - { - "name": "ConfigurationUnsupported", - "value": "ConfigurationUnsupported", - "description": "There was a problem with the combination of input files and the configuration settings applied, fix the configuration settings and retry with the same input, or change input to match the configuration." - }, - { - "name": "ContentMalformed", - "value": "ContentMalformed", - "description": "There was a problem with the input content (for example: zero byte files, or corrupt/non-decodable files), check the input files." - }, - { - "name": "ContentUnsupported", - "value": "ContentUnsupported", - "description": "There was a problem with the format of the input (not valid media file, or an unsupported file/codec), check the validity of the input files." - }, - { - "name": "IdentityUnsupported", - "value": "IdentityUnsupported", - "description": "There is an error verifying to the account identity. Check and fix the identity configurations and retry. If unsuccessful, please contact support." - } - ] - } - }, - "MediaJobErrorDetail": { - "type": "object", - "description": "Details of JobOutput errors.", - "properties": { - "code": { - "type": "string", - "description": "Code describing the error detail." - }, - "message": { - "type": "string", - "description": "A human-readable representation of the error." - } - } - }, - "MediaJobErroredEventData": { - "type": "object", - "description": "Job error state event data. Schema of the data property of an EventGridEvent\nfor a Microsoft.Media.JobErrored event.", - "properties": { - "outputs": { - "type": "array", - "description": "Gets the Job outputs.", - "items": { - "$ref": "#/definitions/MediaJobOutput" - }, - "x-ms-identifiers": [] - } - }, - "required": [ - "outputs" - ], - "allOf": [ - { - "$ref": "#/definitions/MediaJobStateChangeEventData" - } - ] - }, - "MediaJobFinishedEventData": { - "type": "object", - "description": "Job finished event data. Schema of the data property of an EventGridEvent for a\nMicrosoft.Media.JobFinished event.", - "properties": { - "outputs": { - "type": "array", - "description": "Gets the Job outputs.", - "items": { - "$ref": "#/definitions/MediaJobOutput" - }, - "x-ms-identifiers": [] - } - }, - "required": [ - "outputs" - ], - "allOf": [ - { - "$ref": "#/definitions/MediaJobStateChangeEventData" - } - ] - }, - "MediaJobOutput": { - "type": "object", - "description": "The event data for a Job output.", - "properties": { - "@odata.type": { - "type": "string", - "description": "The discriminator for derived types." - }, - "error": { - "$ref": "#/definitions/MediaJobError", - "description": "Gets the Job output error." - }, - "label": { - "type": "string", - "description": "Gets the Job output label." - }, - "progress": { - "type": "integer", - "format": "int64", - "description": "Gets the Job output progress." - }, - "state": { - "$ref": "#/definitions/MediaJobState", - "description": "Gets the Job output state." - } - }, - "discriminator": "@odata.type", - "required": [ - "@odata.type", - "error", - "progress", - "state" - ] - }, - "MediaJobOutputAsset": { - "type": "object", - "description": "The event data for a Job output asset.", - "properties": { - "assetName": { - "type": "string", - "description": "Gets the Job output asset name." - } - }, - "allOf": [ - { - "$ref": "#/definitions/MediaJobOutput" - } - ], - "x-ms-discriminator-value": "#Microsoft.Media.JobOutputAsset" - }, - "MediaJobOutputCanceledEventData": { - "type": "object", - "description": "Job output canceled event data. Schema of the data property of an\nEventGridEvent for a Microsoft.Media.JobOutputCanceled event.", - "allOf": [ - { - "$ref": "#/definitions/MediaJobOutputStateChangeEventData" - } - ] - }, - "MediaJobOutputCancelingEventData": { - "type": "object", - "description": "Job output canceling event data. Schema of the data property of an\nEventGridEvent for a Microsoft.Media.JobOutputCanceling event.", - "allOf": [ - { - "$ref": "#/definitions/MediaJobOutputStateChangeEventData" - } - ] - }, - "MediaJobOutputErroredEventData": { - "type": "object", - "description": "Job output error event data. Schema of the data property of an EventGridEvent\nfor a Microsoft.Media.JobOutputErrored event.", - "allOf": [ - { - "$ref": "#/definitions/MediaJobOutputStateChangeEventData" - } - ] - }, - "MediaJobOutputFinishedEventData": { - "type": "object", - "description": "Job output finished event data. Schema of the data property of an\nEventGridEvent for a Microsoft.Media.JobOutputFinished event.", - "allOf": [ - { - "$ref": "#/definitions/MediaJobOutputStateChangeEventData" - } - ] - }, - "MediaJobOutputProcessingEventData": { - "type": "object", - "description": "Job output processing event data. Schema of the data property of an\nEventGridEvent for a Microsoft.Media.JobOutputProcessing event.", - "allOf": [ - { - "$ref": "#/definitions/MediaJobOutputStateChangeEventData" - } - ] - }, - "MediaJobOutputProgressEventData": { - "type": "object", - "description": "Job Output Progress Event Data. Schema of the Data property of an\n EventGridEvent for a Microsoft.Media.JobOutputProgress event.", - "properties": { - "label": { - "type": "string", - "description": "Gets the Job output label." - }, - "progress": { - "type": "integer", - "format": "int64", - "description": "Gets the Job output progress." - }, - "jobCorrelationData": { - "type": "object", - "description": "Gets the Job correlation data.", - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "jobCorrelationData" - ] - }, - "MediaJobOutputScheduledEventData": { - "type": "object", - "description": "Job output scheduled event data. Schema of the data property of an\nEventGridEvent for a Microsoft.Media.JobOutputScheduled event.", - "allOf": [ - { - "$ref": "#/definitions/MediaJobOutputStateChangeEventData" - } - ] - }, - "MediaJobOutputStateChangeEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a\n Microsoft.Media.JobOutputStateChange event.", - "properties": { - "previousState": { - "$ref": "#/definitions/MediaJobState", - "description": "The previous state of the Job." - }, - "output": { - "$ref": "#/definitions/MediaJobOutput", - "description": "Gets the output." - }, - "jobCorrelationData": { - "type": "object", - "description": "Gets the Job correlation data.", - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "previousState", - "output", - "jobCorrelationData" - ] - }, - "MediaJobProcessingEventData": { - "type": "object", - "description": "Job processing event data. Schema of the data property of an EventGridEvent for\na Microsoft.Media.JobProcessing event.", - "allOf": [ - { - "$ref": "#/definitions/MediaJobStateChangeEventData" - } - ] - }, - "MediaJobRetry": { - "type": "string", - "description": "Media Job Retry Options.", - "enum": [ - "DoNotRetry", - "MayRetry" - ], - "x-ms-enum": { - "name": "MediaJobRetry", - "modelAsString": true, - "values": [ - { - "name": "DoNotRetry", - "value": "DoNotRetry", - "description": "Issue needs to be investigated and then the job resubmitted with corrections or retried once the underlying issue has been corrected." - }, - { - "name": "MayRetry", - "value": "MayRetry", - "description": "Issue may be resolved after waiting for a period of time and resubmitting the same Job." - } - ] - } - }, - "MediaJobScheduledEventData": { - "type": "object", - "description": "Job scheduled event data. Schema of the data property of an EventGridEvent for\na Microsoft.Media.JobScheduled event.", - "allOf": [ - { - "$ref": "#/definitions/MediaJobStateChangeEventData" - } - ] - }, - "MediaJobState": { - "type": "string", - "description": "State of a Media Job.", - "enum": [ - "Canceled", - "Canceling", - "Error", - "Finished", - "Processing", - "Queued", - "Scheduled" - ], - "x-ms-enum": { - "name": "MediaJobState", - "modelAsString": true, - "values": [ - { - "name": "Canceled", - "value": "Canceled", - "description": "The job was canceled. This is a final state for the job." - }, - { - "name": "Canceling", - "value": "Canceling", - "description": "The job is in the process of being canceled. This is a transient state for the job." - }, - { - "name": "Error", - "value": "Error", - "description": "The job has encountered an error. This is a final state for the job." - }, - { - "name": "Finished", - "value": "Finished", - "description": "The job is finished. This is a final state for the job." - }, - { - "name": "Processing", - "value": "Processing", - "description": "The job is processing. This is a transient state for the job." - }, - { - "name": "Queued", - "value": "Queued", - "description": "The job is in a queued state, waiting for resources to become available. This is a transient state." - }, - { - "name": "Scheduled", - "value": "Scheduled", - "description": "The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states." - } - ] - } - }, - "MediaJobStateChangeEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a\n Microsoft.Media.JobStateChange event.", - "properties": { - "previousState": { - "$ref": "#/definitions/MediaJobState", - "description": "The previous state of the Job." - }, - "state": { - "$ref": "#/definitions/MediaJobState", - "description": "The new state of the Job." - }, - "correlationData": { - "type": "object", - "description": "Gets the Job correlation data.", - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "previousState", - "state", - "correlationData" - ] - }, - "MediaLiveEventChannelArchiveHeartbeatEventData": { - "type": "object", - "description": "Channel Archive heartbeat event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventChannelArchiveHeartbeat event.", - "properties": { - "channelLatencyMs": { - "type": "string", - "description": "Gets the channel latency in ms." - }, - "latencyResultCode": { - "type": "string", - "description": "Gets the latency result code." - } - }, - "required": [ - "channelLatencyMs", - "latencyResultCode" - ] - }, - "MediaLiveEventConnectionRejectedEventData": { - "type": "object", - "description": "Encoder connection rejected event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventConnectionRejected event.", - "properties": { - "ingestUrl": { - "type": "string", - "description": "Gets the ingest URL provided by the live event." - }, - "streamId": { - "type": "string", - "description": "Gets the stream Id." - }, - "encoderIp": { - "type": "string", - "description": "Gets the remote IP." - }, - "encoderPort": { - "type": "string", - "description": "Gets the remote port." - }, - "resultCode": { - "type": "string", - "description": "Gets the result code." - } - } - }, - "MediaLiveEventEncoderConnectedEventData": { - "type": "object", - "description": "Encoder connect event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventEncoderConnected event.", - "properties": { - "ingestUrl": { - "type": "string", - "description": "Gets the ingest URL provided by the live event." - }, - "streamId": { - "type": "string", - "description": "Gets the stream Id." - }, - "encoderIp": { - "type": "string", - "description": "Gets the remote IP." - }, - "encoderPort": { - "type": "string", - "description": "Gets the remote port." - } - } - }, - "MediaLiveEventEncoderDisconnectedEventData": { - "type": "object", - "description": "Encoder disconnected event data. Schema of the Data property of an EventGridEvent for a Microsoft.Media.LiveEventEncoderDisconnected event.", - "properties": { - "ingestUrl": { - "type": "string", - "description": "Gets the ingest URL provided by the live event." - }, - "streamId": { - "type": "string", - "description": "Gets the stream Id." - }, - "encoderIp": { - "type": "string", - "description": "Gets the remote IP." - }, - "encoderPort": { - "type": "string", - "description": "Gets the remote port." - }, - "resultCode": { - "type": "string", - "description": "Gets the result code." - } - } - }, - "MediaLiveEventIncomingDataChunkDroppedEventData": { - "type": "object", - "description": "Ingest fragment dropped event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIncomingDataChunkDropped event.", - "properties": { - "timestamp": { - "type": "string", - "description": "Gets the timestamp of the data chunk dropped." - }, - "trackType": { - "type": "string", - "description": "Gets the type of the track (Audio / Video)." - }, - "bitrate": { - "type": "integer", - "format": "int64", - "description": "Gets the bitrate of the track." - }, - "timescale": { - "type": "string", - "description": "Gets the timescale of the Timestamp." - }, - "resultCode": { - "type": "string", - "description": "Gets the result code for fragment drop operation." - }, - "trackName": { - "type": "string", - "description": "Gets the name of the track for which fragment is dropped." - } - } - }, - "MediaLiveEventIncomingStreamReceivedEventData": { - "type": "object", - "description": "Encoder connect event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIncomingStreamReceived event.", - "properties": { - "ingestUrl": { - "type": "string", - "description": "Gets the ingest URL provided by the live event." - }, - "trackType": { - "type": "string", - "description": "Gets the type of the track (Audio / Video)." - }, - "trackName": { - "type": "string", - "description": "Gets the track name." - }, - "bitrate": { - "type": "integer", - "format": "int64", - "description": "Gets the bitrate of the track." - }, - "encoderIp": { - "type": "string", - "description": "Gets the remote IP." - }, - "encoderPort": { - "type": "string", - "description": "Gets the remote port." - }, - "timestamp": { - "type": "string", - "description": "Gets the first timestamp of the data chunk received." - }, - "duration": { - "type": "string", - "description": "Gets the duration of the first data chunk." - }, - "timescale": { - "type": "string", - "description": "Gets the timescale in which timestamp is represented." - } - } - }, - "MediaLiveEventIncomingStreamsOutOfSyncEventData": { - "type": "object", - "description": "Incoming streams out of sync event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIncomingStreamsOutOfSync event.", - "properties": { - "minLastTimestamp": { - "type": "string", - "description": "Gets the minimum last timestamp received." - }, - "typeOfStreamWithMinLastTimestamp": { - "type": "string", - "description": "Gets the type of stream with minimum last timestamp." - }, - "maxLastTimestamp": { - "type": "string", - "description": "Gets the maximum timestamp among all the tracks (audio or video)." - }, - "typeOfStreamWithMaxLastTimestamp": { - "type": "string", - "description": "Gets the type of stream with maximum last timestamp." - }, - "timescaleOfMinLastTimestamp": { - "type": "string", - "description": "Gets the timescale in which \\\"MinLastTimestamp\\\" is represented." - }, - "timescaleOfMaxLastTimestamp": { - "type": "string", - "description": "Gets the timescale in which \\\"MaxLastTimestamp\\\" is represented." - } - } - }, - "MediaLiveEventIncomingVideoStreamsOutOfSyncEventData": { - "type": "object", - "description": "Incoming video stream out of sync event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIncomingVideoStreamsOutOfSync event.", - "properties": { - "firstTimestamp": { - "type": "string", - "description": "Gets the first timestamp received for one of the quality levels." - }, - "firstDuration": { - "type": "string", - "description": "Gets the duration of the data chunk with first timestamp." - }, - "secondTimestamp": { - "type": "string", - "description": "Gets the timestamp received for some other quality levels." - }, - "secondDuration": { - "type": "string", - "description": "Gets the duration of the data chunk with second timestamp." - }, - "timescale": { - "type": "string", - "description": "Gets the timescale in which both the timestamps and durations are represented." - } - } - }, - "MediaLiveEventIngestHeartbeatEventData": { - "type": "object", - "description": "Ingest heartbeat event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIngestHeartbeat event.", - "properties": { - "trackType": { - "type": "string", - "description": "Gets the type of the track (Audio / Video)." - }, - "trackName": { - "type": "string", - "description": "Gets the track name." - }, - "transcriptionLanguage": { - "type": "string", - "description": "Gets the Live Transcription language." - }, - "transcriptionState": { - "type": "string", - "description": "Gets the Live Transcription state." - }, - "bitrate": { - "type": "integer", - "format": "int64", - "description": "Gets the bitrate of the track." - }, - "incomingBitrate": { - "type": "integer", - "format": "int64", - "description": "Gets the incoming bitrate." - }, - "ingestDriftValue": { - "type": "string", - "description": "Gets the track ingest drift value." - }, - "lastFragmentArrivalTime": { - "type": "string", - "description": "Gets the arrival UTC time of the last fragment." - }, - "lastTimestamp": { - "type": "string", - "description": "Gets the last timestamp." - }, - "timescale": { - "type": "string", - "description": "Gets the timescale of the last timestamp." - }, - "overlapCount": { - "type": "integer", - "format": "int64", - "description": "Gets the fragment Overlap count." - }, - "discontinuityCount": { - "type": "integer", - "format": "int64", - "description": "Gets the fragment Discontinuity count." - }, - "nonincreasingCount": { - "type": "integer", - "format": "int64", - "description": "Gets Non increasing count." - }, - "unexpectedBitrate": { - "type": "boolean", - "description": "Gets a value indicating whether unexpected bitrate is present or not." - }, - "state": { - "type": "string", - "description": "Gets the state of the live event." - }, - "healthy": { - "type": "boolean", - "description": "Gets a value indicating whether preview is healthy or not." - } - } - }, - "MediaLiveEventTrackDiscontinuityDetectedEventData": { - "type": "object", - "description": "Ingest track discontinuity detected event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventTrackDiscontinuityDetected event.", - "properties": { - "trackType": { - "type": "string", - "description": "Gets the type of the track (Audio / Video)." - }, - "trackName": { - "type": "string", - "description": "Gets the track name." - }, - "bitrate": { - "type": "integer", - "format": "int64", - "description": "Gets the bitrate." - }, - "previousTimestamp": { - "type": "string", - "description": "Gets the timestamp of the previous fragment." - }, - "newTimestamp": { - "type": "string", - "description": "Gets the timestamp of the current fragment." - }, - "timescale": { - "type": "string", - "description": "Gets the timescale in which both timestamps and discontinuity gap are represented." - }, - "discontinuityGap": { - "type": "string", - "description": "Gets the discontinuity gap between PreviousTimestamp and NewTimestamp." - } - } - }, - "MicrosoftTeamsAppIdentifierModel": { - "type": "object", - "description": "A Microsoft Teams application.", - "properties": { - "appId": { - "type": "string", - "description": "The Id of the Microsoft Teams application" - }, - "cloud": { - "$ref": "#/definitions/CommunicationCloudEnvironmentModel", - "description": "The cloud that the Microsoft Teams application belongs to. By default 'public' if missing." - } - }, - "required": [ - "appId", - "cloud" - ] - }, - "MicrosoftTeamsUserIdentifierModel": { - "type": "object", - "description": "A Microsoft Teams user.", - "properties": { - "userId": { - "type": "string", - "description": "The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user." - }, - "isAnonymous": { - "type": "boolean", - "description": "True if the Microsoft Teams user is anonymous. By default false if missing." - }, - "cloud": { - "$ref": "#/definitions/CommunicationCloudEnvironmentModel", - "description": "The cloud that the Microsoft Teams user belongs to. By default 'public' if missing." - } - }, - "required": [ - "userId", - "cloud" - ] - }, - "PhoneNumberIdentifierModel": { - "type": "object", - "description": "A phone number.", - "properties": { - "value": { - "type": "string", - "description": "The phone number in E.164 format." - } - }, - "required": [ - "value" - ] - }, - "PolicyInsightsPolicyStateChangedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.PolicyInsights.PolicyStateChanged event.", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The time that the resource was scanned by Azure Policy in the Universal ISO 8601 DateTime format yyyy-MM-ddTHH:mm:ss.fffffffZ." - }, - "policyAssignmentId": { - "type": "string", - "description": "The resource ID of the policy assignment." - }, - "policyDefinitionId": { - "type": "string", - "description": "The resource ID of the policy definition." - }, - "policyDefinitionReferenceId": { - "type": "string", - "description": "The reference ID for the policy definition inside the initiative definition, if the policy assignment is for an initiative. May be empty." - }, - "complianceState": { - "type": "string", - "description": "The compliance state of the resource with respect to the policy assignment." - }, - "subscriptionId": { - "type": "string", - "description": "The subscription ID of the resource." - }, - "complianceReasonCode": { - "type": "string", - "description": "The compliance reason code. May be empty." - } - }, - "required": [ - "timestamp" - ] - }, - "PolicyInsightsPolicyStateCreatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.PolicyInsights.PolicyStateCreated event.", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The time that the resource was scanned by Azure Policy in the Universal ISO 8601 DateTime format yyyy-MM-ddTHH:mm:ss.fffffffZ." - }, - "policyAssignmentId": { - "type": "string", - "description": "The resource ID of the policy assignment." - }, - "policyDefinitionId": { - "type": "string", - "description": "The resource ID of the policy definition." - }, - "policyDefinitionReferenceId": { - "type": "string", - "description": "The reference ID for the policy definition inside the initiative definition, if the policy assignment is for an initiative. May be empty." - }, - "complianceState": { - "type": "string", - "description": "The compliance state of the resource with respect to the policy assignment." - }, - "subscriptionId": { - "type": "string", - "description": "The subscription ID of the resource." - }, - "complianceReasonCode": { - "type": "string", - "description": "The compliance reason code. May be empty." - } - }, - "required": [ - "timestamp" - ] - }, - "PolicyInsightsPolicyStateDeletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.PolicyInsights.PolicyStateDeleted event.", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The time that the resource was scanned by Azure Policy in the Universal ISO 8601 DateTime format yyyy-MM-ddTHH:mm:ss.fffffffZ." - }, - "policyAssignmentId": { - "type": "string", - "description": "The resource ID of the policy assignment." - }, - "policyDefinitionId": { - "type": "string", - "description": "The resource ID of the policy definition." - }, - "policyDefinitionReferenceId": { - "type": "string", - "description": "The reference ID for the policy definition inside the initiative definition, if the policy assignment is for an initiative. May be empty." - }, - "complianceState": { - "type": "string", - "description": "The compliance state of the resource with respect to the policy assignment." - }, - "subscriptionId": { - "type": "string", - "description": "The subscription ID of the resource." - }, - "complianceReasonCode": { - "type": "string", - "description": "The compliance reason code. May be empty." - } - }, - "required": [ - "timestamp" - ] - }, - "RedisExportRDBCompletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Cache.ExportRDBCompleted event.", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The time at which the event occurred." - }, - "name": { - "type": "string", - "description": "The name of this event." - }, - "status": { - "type": "string", - "description": "The status of this event. Failed or succeeded" - } - }, - "required": [ - "timestamp" - ] - }, - "RedisImportRDBCompletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Cache.ImportRDBCompleted event.", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The time at which the event occurred." - }, - "name": { - "type": "string", - "description": "The name of this event." - }, - "status": { - "type": "string", - "description": "The status of this event. Failed or succeeded" - } - }, - "required": [ - "timestamp" - ] - }, - "RedisPatchingCompletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Cache.PatchingCompleted event.", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The time at which the event occurred." - }, - "name": { - "type": "string", - "description": "The name of this event." - }, - "status": { - "type": "string", - "description": "The status of this event. Failed or succeeded" - } - }, - "required": [ - "timestamp" - ] - }, - "RedisScalingCompletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Cache.ScalingCompleted event.", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The time at which the event occurred." - }, - "name": { - "type": "string", - "description": "The name of this event." - }, - "status": { - "type": "string", - "description": "The status of this event. Failed or succeeded" - } - }, - "required": [ - "timestamp" - ] - }, - "ResourceActionCancelEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionCancel event. This is raised when a resource action operation is canceled.", - "properties": { - "tenantId": { - "type": "string", - "description": "The tenant ID of the resource." - }, - "subscriptionId": { - "type": "string", - "description": "The subscription ID of the resource." - }, - "resourceGroup": { - "type": "string", - "description": "The resource group of the resource." - }, - "resourceProvider": { - "type": "string", - "description": "The resource provider performing the operation." - }, - "resourceUri": { - "type": "string", - "description": "The URI of the resource in the operation." - }, - "operationName": { - "type": "string", - "description": "The operation that was performed." - }, - "status": { - "type": "string", - "description": "The status of the operation." - }, - "authorization": { - "$ref": "#/definitions/ResourceAuthorization", - "description": "The requested authorization for the operation." - }, - "claims": { - "type": "object", - "description": "The properties of the claims.", - "additionalProperties": { - "type": "string" - } - }, - "correlationId": { - "type": "string", - "description": "An operation ID used for troubleshooting." - }, - "httpRequest": { - "$ref": "#/definitions/ResourceHttpRequest", - "description": "The details of the operation." - } - }, - "required": [ - "authorization", - "claims", - "httpRequest" - ] - }, - "ResourceActionFailureEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionFailure event. This is raised when a resource action operation fails.", - "properties": { - "tenantId": { - "type": "string", - "description": "The tenant ID of the resource." - }, - "subscriptionId": { - "type": "string", - "description": "The subscription ID of the resource." - }, - "resourceGroup": { - "type": "string", - "description": "The resource group of the resource." - }, - "resourceProvider": { - "type": "string", - "description": "The resource provider performing the operation." - }, - "resourceUri": { - "type": "string", - "description": "The URI of the resource in the operation." - }, - "operationName": { - "type": "string", - "description": "The operation that was performed." - }, - "status": { - "type": "string", - "description": "The status of the operation." - }, - "authorization": { - "$ref": "#/definitions/ResourceAuthorization", - "description": "The requested authorization for the operation." - }, - "claims": { - "type": "object", - "description": "The properties of the claims.", - "additionalProperties": { - "type": "string" - } - }, - "correlationId": { - "type": "string", - "description": "An operation ID used for troubleshooting." - }, - "httpRequest": { - "$ref": "#/definitions/ResourceHttpRequest", - "description": "The details of the operation." - } - }, - "required": [ - "authorization", - "claims", - "httpRequest" - ] - }, - "ResourceActionSuccessEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionSuccess event. This is raised when a resource action operation succeeds.", - "properties": { - "tenantId": { - "type": "string", - "description": "The tenant ID of the resource." - }, - "subscriptionId": { - "type": "string", - "description": "The subscription ID of the resource." - }, - "resourceGroup": { - "type": "string", - "description": "The resource group of the resource." - }, - "resourceProvider": { - "type": "string", - "description": "The resource provider performing the operation." - }, - "resourceUri": { - "type": "string", - "description": "The URI of the resource in the operation." - }, - "operationName": { - "type": "string", - "description": "The operation that was performed." - }, - "status": { - "type": "string", - "description": "The status of the operation." - }, - "authorization": { - "$ref": "#/definitions/ResourceAuthorization", - "description": "The requested authorization for the operation." - }, - "claims": { - "type": "object", - "description": "The properties of the claims.", - "additionalProperties": { - "type": "string" - } - }, - "correlationId": { - "type": "string", - "description": "An operation ID used for troubleshooting." - }, - "httpRequest": { - "$ref": "#/definitions/ResourceHttpRequest", - "description": "The details of the operation." - } - }, - "required": [ - "authorization", - "claims", - "httpRequest" - ] - }, - "ResourceAuthorization": { - "type": "object", - "description": "The details of the authorization for the resource.", - "properties": { - "scope": { - "type": "string", - "description": "The scope of the authorization." - }, - "action": { - "type": "string", - "description": "The action being requested." - }, - "evidence": { - "type": "object", - "description": "The evidence for the authorization.", - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "evidence" - ] - }, - "ResourceDeleteCancelEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteCancel event. This is raised when a resource delete operation is canceled.", - "properties": { - "tenantId": { - "type": "string", - "description": "The tenant ID of the resource." - }, - "subscriptionId": { - "type": "string", - "description": "The subscription ID of the resource." - }, - "resourceGroup": { - "type": "string", - "description": "The resource group of the resource." - }, - "resourceProvider": { - "type": "string", - "description": "The resource provider performing the operation." - }, - "resourceUri": { - "type": "string", - "description": "The URI of the resource in the operation." - }, - "operationName": { - "type": "string", - "description": "The operation that was performed." - }, - "status": { - "type": "string", - "description": "The status of the operation." - }, - "authorization": { - "$ref": "#/definitions/ResourceAuthorization", - "description": "The requested authorization for the operation." - }, - "claims": { - "type": "object", - "description": "The properties of the claims.", - "additionalProperties": { - "type": "string" - } - }, - "correlationId": { - "type": "string", - "description": "An operation ID used for troubleshooting." - }, - "httpRequest": { - "$ref": "#/definitions/ResourceHttpRequest", - "description": "The details of the operation." - } - }, - "required": [ - "authorization", - "claims", - "httpRequest" - ] - }, - "ResourceDeleteFailureEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteFailure event. This is raised when a resource delete operation fails.", - "properties": { - "tenantId": { - "type": "string", - "description": "The tenant ID of the resource." - }, - "subscriptionId": { - "type": "string", - "description": "The subscription ID of the resource." - }, - "resourceGroup": { - "type": "string", - "description": "The resource group of the resource." - }, - "resourceProvider": { - "type": "string", - "description": "The resource provider performing the operation." - }, - "resourceUri": { - "type": "string", - "description": "The URI of the resource in the operation." - }, - "operationName": { - "type": "string", - "description": "The operation that was performed." - }, - "status": { - "type": "string", - "description": "The status of the operation." - }, - "authorization": { - "$ref": "#/definitions/ResourceAuthorization", - "description": "The requested authorization for the operation." - }, - "claims": { - "type": "object", - "description": "The properties of the claims.", - "additionalProperties": { - "type": "string" - } - }, - "correlationId": { - "type": "string", - "description": "An operation ID used for troubleshooting." - }, - "httpRequest": { - "$ref": "#/definitions/ResourceHttpRequest", - "description": "The details of the operation." - } - }, - "required": [ - "authorization", - "claims", - "httpRequest" - ] - }, - "ResourceDeleteSuccessEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteSuccess event. This is raised when a resource delete operation succeeds.", - "properties": { - "tenantId": { - "type": "string", - "description": "The tenant ID of the resource." - }, - "subscriptionId": { - "type": "string", - "description": "The subscription ID of the resource." - }, - "resourceGroup": { - "type": "string", - "description": "The resource group of the resource." - }, - "resourceProvider": { - "type": "string", - "description": "The resource provider performing the operation." - }, - "resourceUri": { - "type": "string", - "description": "The URI of the resource in the operation." - }, - "operationName": { - "type": "string", - "description": "The operation that was performed." - }, - "status": { - "type": "string", - "description": "The status of the operation." - }, - "authorization": { - "$ref": "#/definitions/ResourceAuthorization", - "description": "The requested authorization for the operation." - }, - "claims": { - "type": "object", - "description": "The properties of the claims.", - "additionalProperties": { - "type": "string" - } - }, - "correlationId": { - "type": "string", - "description": "An operation ID used for troubleshooting." - }, - "httpRequest": { - "$ref": "#/definitions/ResourceHttpRequest", - "description": "The details of the operation." - } - }, - "required": [ - "authorization", - "claims", - "httpRequest" - ] - }, - "ResourceHttpRequest": { - "type": "object", - "description": "The details of the HTTP request.", - "properties": { - "clientRequestId": { - "type": "string", - "description": "The client request ID." - }, - "clientIpAddress": { - "type": "string", - "description": "The client IP address." - }, - "method": { - "type": "string", - "description": "The request method." - }, - "url": { - "type": "string", - "description": "The url used in the request." - } - } - }, - "ResourceNotificationsHealthResourcesAnnotatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a\nMicrosoft.ResourceNotifications.HealthResources.ResourceAnnotated event.", - "allOf": [ - { - "$ref": "#/definitions/ResourceNotificationsResourceUpdatedEventData" - } - ] - }, - "ResourceNotificationsHealthResourcesAvailabilityStatusChangedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a\nMicrosoft.ResourceNotifications.HealthResources.AvailabilityStatusChanged\nevent.", - "allOf": [ - { - "$ref": "#/definitions/ResourceNotificationsResourceUpdatedEventData" - } - ] - }, - "ResourceNotificationsOperationalDetails": { - "type": "object", - "description": "details of operational info", - "properties": { - "resourceEventTime": { - "type": "string", - "format": "date-time", - "description": "Date and Time when resource was updated" - } - }, - "required": [ - "resourceEventTime" - ] - }, - "ResourceNotificationsResourceDeletedDetails": { - "type": "object", - "description": "Describes the schema of the properties under resource info which are common\nacross all ARN system topic delete events", - "properties": { - "id": { - "type": "string", - "description": "id of the resource for which the event is being emitted" - }, - "name": { - "type": "string", - "description": "name of the resource for which the event is being emitted" - }, - "type": { - "type": "string", - "description": "the type of the resource for which the event is being emitted" - } - } - }, - "ResourceNotificationsResourceDeletedEventData": { - "type": "object", - "description": "Describes the schema of the common properties across all ARN system topic\ndelete events", - "properties": { - "resourceInfo": { - "$ref": "#/definitions/ResourceNotificationsResourceDeletedDetails", - "description": "resourceInfo details for delete event", - "x-ms-client-name": "resourceDetails" - }, - "operationalInfo": { - "$ref": "#/definitions/ResourceNotificationsOperationalDetails", - "description": "details about operational info", - "x-ms-client-name": "operationalDetails" - } - }, - "required": [ - "resourceInfo", - "operationalInfo" - ] - }, - "ResourceNotificationsResourceManagementCreatedOrUpdatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a\nMicrosoft.ResourceNotifications.Resources.CreatedOrUpdated event.", - "allOf": [ - { - "$ref": "#/definitions/ResourceNotificationsResourceUpdatedEventData" - } - ] - }, - "ResourceNotificationsResourceManagementDeletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a\nMicrosoft.ResourceNotifications.Resources.Deleted event.", - "allOf": [ - { - "$ref": "#/definitions/ResourceNotificationsResourceDeletedEventData" - } - ] - }, - "ResourceNotificationsResourceUpdatedDetails": { - "type": "object", - "description": "Describes the schema of the properties under resource info which are common\nacross all ARN system topic events", - "properties": { - "id": { - "type": "string", - "description": "id of the resource for which the event is being emitted" - }, - "name": { - "type": "string", - "description": "name of the resource for which the event is being emitted" - }, - "type": { - "type": "string", - "description": "the type of the resource for which the event is being emitted" - }, - "location": { - "type": "string", - "description": "the location of the resource for which the event is being emitted" - }, - "tags": { - "type": "object", - "description": "the tags on the resource for which the event is being emitted", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "type": "object", - "description": "properties in the payload of the resource for which the event is being emitted", - "additionalProperties": {} - } - }, - "required": [ - "tags", - "properties" - ] - }, - "ResourceNotificationsResourceUpdatedEventData": { - "type": "object", - "description": "Describes the schema of the common properties across all ARN system topic events", - "properties": { - "resourceInfo": { - "$ref": "#/definitions/ResourceNotificationsResourceUpdatedDetails", - "description": "resourceInfo details for update event", - "x-ms-client-name": "resourceDetails" - }, - "operationalInfo": { - "$ref": "#/definitions/ResourceNotificationsOperationalDetails", - "description": "details about operational info", - "x-ms-client-name": "operationalDetails" - }, - "apiVersion": { - "type": "string", - "description": "api version of the resource properties bag" - } - }, - "required": [ - "resourceInfo", - "operationalInfo" - ] - }, - "ResourceWriteCancelEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteCancel event. This is raised when a resource create or update operation is canceled.", - "properties": { - "tenantId": { - "type": "string", - "description": "The tenant ID of the resource." - }, - "subscriptionId": { - "type": "string", - "description": "The subscription ID of the resource." - }, - "resourceGroup": { - "type": "string", - "description": "The resource group of the resource." - }, - "resourceProvider": { - "type": "string", - "description": "The resource provider performing the operation." - }, - "resourceUri": { - "type": "string", - "description": "The URI of the resource in the operation." - }, - "operationName": { - "type": "string", - "description": "The operation that was performed." - }, - "status": { - "type": "string", - "description": "The status of the operation." - }, - "authorization": { - "$ref": "#/definitions/ResourceAuthorization", - "description": "The requested authorization for the operation." - }, - "claims": { - "type": "object", - "description": "The properties of the claims.", - "additionalProperties": { - "type": "string" - } - }, - "correlationId": { - "type": "string", - "description": "An operation ID used for troubleshooting." - }, - "httpRequest": { - "$ref": "#/definitions/ResourceHttpRequest", - "description": "The details of the operation." - } - }, - "required": [ - "authorization", - "claims", - "httpRequest" - ] - }, - "ResourceWriteFailureEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteFailure event. This is raised when a resource create or update operation fails.", - "properties": { - "tenantId": { - "type": "string", - "description": "The tenant ID of the resource." - }, - "subscriptionId": { - "type": "string", - "description": "The subscription ID of the resource." - }, - "resourceGroup": { - "type": "string", - "description": "The resource group of the resource." - }, - "resourceProvider": { - "type": "string", - "description": "The resource provider performing the operation." - }, - "resourceUri": { - "type": "string", - "description": "The URI of the resource in the operation." - }, - "operationName": { - "type": "string", - "description": "The operation that was performed." - }, - "status": { - "type": "string", - "description": "The status of the operation." - }, - "authorization": { - "$ref": "#/definitions/ResourceAuthorization", - "description": "The requested authorization for the operation." - }, - "claims": { - "type": "object", - "description": "The properties of the claims.", - "additionalProperties": { - "type": "string" - } - }, - "correlationId": { - "type": "string", - "description": "An operation ID used for troubleshooting." - }, - "httpRequest": { - "$ref": "#/definitions/ResourceHttpRequest", - "description": "The details of the operation." - } - }, - "required": [ - "authorization", - "claims", - "httpRequest" - ] - }, - "ResourceWriteSuccessEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteSuccess event. This is raised when a resource create or update operation succeeds.", - "properties": { - "tenantId": { - "type": "string", - "description": "The tenant ID of the resource." - }, - "subscriptionId": { - "type": "string", - "description": "The subscription ID of the resource." - }, - "resourceGroup": { - "type": "string", - "description": "The resource group of the resource." - }, - "resourceProvider": { - "type": "string", - "description": "The resource provider performing the operation." - }, - "resourceUri": { - "type": "string", - "description": "The URI of the resource in the operation." - }, - "operationName": { - "type": "string", - "description": "The operation that was performed." - }, - "status": { - "type": "string", - "description": "The status of the operation." - }, - "authorization": { - "$ref": "#/definitions/ResourceAuthorization", - "description": "The requested authorization for the operation." - }, - "claims": { - "type": "object", - "description": "The properties of the claims.", - "additionalProperties": { - "type": "string" - } - }, - "correlationId": { - "type": "string", - "description": "An operation ID used for troubleshooting." - }, - "httpRequest": { - "$ref": "#/definitions/ResourceHttpRequest", - "description": "The details of the operation." - } - }, - "required": [ - "authorization", - "claims", - "httpRequest" - ] - }, - "ServiceBusActiveMessagesAvailablePeriodicNotificationsEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.ActiveMessagesAvailablePeriodicNotifications event.", - "properties": { - "namespaceName": { - "type": "string", - "description": "The namespace name of the Microsoft.ServiceBus resource." - }, - "requestUri": { - "type": "string", - "description": "The endpoint of the Microsoft.ServiceBus resource." - }, - "entityType": { - "type": "string", - "description": "The entity type of the Microsoft.ServiceBus resource. Could be one of 'queue' or 'subscriber'." - }, - "queueName": { - "type": "string", - "description": "The name of the Microsoft.ServiceBus queue. If the entity type is of type 'subscriber', then this value will be null." - }, - "topicName": { - "type": "string", - "description": "The name of the Microsoft.ServiceBus topic. If the entity type is of type 'queue', then this value will be null." - }, - "subscriptionName": { - "type": "string", - "description": "The name of the Microsoft.ServiceBus topic's subscription. If the entity type is of type 'queue', then this value will be null." - } - } - }, - "ServiceBusActiveMessagesAvailableWithNoListenersEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.ActiveMessagesAvailableWithNoListeners event.", - "properties": { - "namespaceName": { - "type": "string", - "description": "The namespace name of the Microsoft.ServiceBus resource." - }, - "requestUri": { - "type": "string", - "description": "The endpoint of the Microsoft.ServiceBus resource." - }, - "entityType": { - "type": "string", - "description": "The entity type of the Microsoft.ServiceBus resource. Could be one of 'queue' or 'subscriber'." - }, - "queueName": { - "type": "string", - "description": "The name of the Microsoft.ServiceBus queue. If the entity type is of type 'subscriber', then this value will be null." - }, - "topicName": { - "type": "string", - "description": "The name of the Microsoft.ServiceBus topic. If the entity type is of type 'queue', then this value will be null." - }, - "subscriptionName": { - "type": "string", - "description": "The name of the Microsoft.ServiceBus topic's subscription. If the entity type is of type 'queue', then this value will be null." - } - } - }, - "ServiceBusDeadletterMessagesAvailablePeriodicNotificationsEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.DeadletterMessagesAvailablePeriodicNotifications event.", - "properties": { - "namespaceName": { - "type": "string", - "description": "The namespace name of the Microsoft.ServiceBus resource." - }, - "requestUri": { - "type": "string", - "description": "The endpoint of the Microsoft.ServiceBus resource." - }, - "entityType": { - "type": "string", - "description": "The entity type of the Microsoft.ServiceBus resource. Could be one of 'queue' or 'subscriber'." - }, - "queueName": { - "type": "string", - "description": "The name of the Microsoft.ServiceBus queue. If the entity type is of type 'subscriber', then this value will be null." - }, - "topicName": { - "type": "string", - "description": "The name of the Microsoft.ServiceBus topic. If the entity type is of type 'queue', then this value will be null." - }, - "subscriptionName": { - "type": "string", - "description": "The name of the Microsoft.ServiceBus topic's subscription. If the entity type is of type 'queue', then this value will be null." - } - } - }, - "ServiceBusDeadletterMessagesAvailableWithNoListenersEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.DeadletterMessagesAvailableWithNoListeners event.", - "properties": { - "namespaceName": { - "type": "string", - "description": "The namespace name of the Microsoft.ServiceBus resource." - }, - "requestUri": { - "type": "string", - "description": "The endpoint of the Microsoft.ServiceBus resource." - }, - "entityType": { - "type": "string", - "description": "The entity type of the Microsoft.ServiceBus resource. Could be one of 'queue' or 'subscriber'." - }, - "queueName": { - "type": "string", - "description": "The name of the Microsoft.ServiceBus queue. If the entity type is of type 'subscriber', then this value will be null." - }, - "topicName": { - "type": "string", - "description": "The name of the Microsoft.ServiceBus topic. If the entity type is of type 'queue', then this value will be null." - }, - "subscriptionName": { - "type": "string", - "description": "The name of the Microsoft.ServiceBus topic's subscription. If the entity type is of type 'queue', then this value will be null." - } - } - }, - "SignalRServiceClientConnectionConnectedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.SignalRService.ClientConnectionConnected event.", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The time at which the event occurred." - }, - "hubName": { - "type": "string", - "description": "The hub of connected client connection." - }, - "connectionId": { - "type": "string", - "description": "The connection Id of connected client connection." - }, - "userId": { - "type": "string", - "description": "The user Id of connected client connection." - } - }, - "required": [ - "timestamp" - ] - }, - "SignalRServiceClientConnectionDisconnectedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.SignalRService.ClientConnectionDisconnected event.", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The time at which the event occurred." - }, - "hubName": { - "type": "string", - "description": "The hub of connected client connection." - }, - "connectionId": { - "type": "string", - "description": "The connection Id of connected client connection." - }, - "userId": { - "type": "string", - "description": "The user Id of connected client connection." - }, - "errorMessage": { - "type": "string", - "description": "The message of error that cause the client connection disconnected." - } - }, - "required": [ - "timestamp" - ] - }, - "StampKind": { - "type": "string", - "description": "Kind of environment where app service plan is.", - "enum": [ - "Public", - "AseV1", - "AseV2" - ], - "x-ms-enum": { - "name": "StampKind", - "modelAsString": true, - "values": [ - { - "name": "Public", - "value": "Public", - "description": "App Service Plan is running on a public stamp." - }, - { - "name": "AseV1", - "value": "AseV1", - "description": "App Service Plan is running on an App Service Environment V1." - }, - { - "name": "AseV2", - "value": "AseV2", - "description": "App Service Plan is running on an App Service Environment V2." - } - ] - } - }, - "StorageAsyncOperationInitiatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.AsyncOperationInitiated event.", - "properties": { - "api": { - "type": "string", - "description": "The name of the API/operation that triggered this event." - }, - "clientRequestId": { - "type": "string", - "description": "A request id provided by the client of the storage API operation that triggered this event." - }, - "requestId": { - "type": "string", - "description": "The request id generated by the storage service for the storage API operation that triggered this event." - }, - "contentType": { - "type": "string", - "description": "The content type of the blob. This is the same as what would be returned in the Content-Type header from the blob." - }, - "contentLength": { - "type": "integer", - "format": "int64", - "description": "The size of the blob in bytes. This is the same as what would be returned in the Content-Length header from the blob." - }, - "blobType": { - "type": "string", - "description": "The type of blob." - }, - "url": { - "type": "string", - "description": "The path to the blob." - }, - "sequencer": { - "type": "string", - "description": "An opaque string value representing the logical sequence of events for any particular blob name. Users can use standard string comparison to understand the relative sequence of two events on the same blob name." - }, - "identity": { - "type": "string", - "description": "The identity of the requester that triggered this event." - }, - "storageDiagnostics": { - "type": "object", - "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", - "additionalProperties": {} - } - }, - "required": [ - "storageDiagnostics" - ] - }, - "StorageBlobCreatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.BlobCreated event.", - "properties": { - "api": { - "type": "string", - "description": "The name of the API/operation that triggered this event." - }, - "clientRequestId": { - "type": "string", - "description": "A request id provided by the client of the storage API operation that triggered this event." - }, - "requestId": { - "type": "string", - "description": "The request id generated by the storage service for the storage API operation that triggered this event." - }, - "eTag": { - "type": "string", - "description": "The etag of the blob at the time this event was triggered." - }, - "contentType": { - "type": "string", - "description": "The content type of the blob. This is the same as what would be returned in the Content-Type header from the blob." - }, - "contentLength": { - "type": "integer", - "format": "int64", - "description": "The size of the blob in bytes. This is the same as what would be returned in the Content-Length header from the blob." - }, - "contentOffset": { - "type": "integer", - "format": "int64", - "description": "The offset of the blob in bytes." - }, - "blobType": { - "type": "string", - "description": "The type of blob." - }, - "url": { - "type": "string", - "description": "The path to the blob." - }, - "sequencer": { - "type": "string", - "description": "An opaque string value representing the logical sequence of events for any particular blob name. Users can use standard string comparison to understand the relative sequence of two events on the same blob name." - }, - "identity": { - "type": "string", - "description": "The identity of the requester that triggered this event." - }, - "storageDiagnostics": { - "type": "object", - "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", - "additionalProperties": {} - } - }, - "required": [ - "storageDiagnostics" - ] - }, - "StorageBlobDeletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.BlobDeleted event.", - "properties": { - "api": { - "type": "string", - "description": "The name of the API/operation that triggered this event." - }, - "clientRequestId": { - "type": "string", - "description": "A request id provided by the client of the storage API operation that triggered this event." - }, - "requestId": { - "type": "string", - "description": "The request id generated by the storage service for the storage API operation that triggered this event." - }, - "contentType": { - "type": "string", - "description": "The content type of the blob. This is the same as what would be returned in the Content-Type header from the blob." - }, - "blobType": { - "type": "string", - "description": "The type of blob." - }, - "url": { - "type": "string", - "description": "The path to the blob." - }, - "sequencer": { - "type": "string", - "description": "An opaque string value representing the logical sequence of events for any particular blob name. Users can use standard string comparison to understand the relative sequence of two events on the same blob name." - }, - "identity": { - "type": "string", - "description": "The identity of the requester that triggered this event." - }, - "storageDiagnostics": { - "type": "object", - "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", - "additionalProperties": {} - } - }, - "required": [ - "storageDiagnostics" - ] - }, - "StorageBlobInventoryPolicyCompletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Storage.BlobInventoryPolicyCompleted event.", - "properties": { - "scheduleDateTime": { - "type": "string", - "format": "date-time", - "description": "The time at which inventory policy was scheduled." - }, - "accountName": { - "type": "string", - "description": "The account name for which inventory policy is registered." - }, - "ruleName": { - "type": "string", - "description": "The rule name for inventory policy." - }, - "policyRunStatus": { - "type": "string", - "description": "The status of inventory run, it can be Succeeded/PartiallySucceeded/Failed." - }, - "policyRunStatusMessage": { - "type": "string", - "description": "The status message for inventory run." - }, - "policyRunId": { - "type": "string", - "description": "The policy run id for inventory run." - }, - "manifestBlobUrl": { - "type": "string", - "description": "The blob URL for manifest file for inventory run." - } - }, - "required": [ - "scheduleDateTime" - ] - }, - "StorageBlobRenamedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.BlobRenamed event.", - "properties": { - "api": { - "type": "string", - "description": "The name of the API/operation that triggered this event." - }, - "clientRequestId": { - "type": "string", - "description": "A request id provided by the client of the storage API operation that triggered this event." - }, - "requestId": { - "type": "string", - "description": "The request id generated by the storage service for the storage API operation that triggered this event." - }, - "sourceUrl": { - "type": "string", - "description": "The path to the blob that was renamed." - }, - "destinationUrl": { - "type": "string", - "description": "The new path to the blob after the rename operation." - }, - "sequencer": { - "type": "string", - "description": "An opaque string value representing the logical sequence of events for any particular blob name. Users can use standard string comparison to understand the relative sequence of two events on the same blob name." - }, - "identity": { - "type": "string", - "description": "The identity of the requester that triggered this event." - }, - "storageDiagnostics": { - "type": "object", - "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", - "additionalProperties": {} - } - }, - "required": [ - "storageDiagnostics" - ] - }, - "StorageBlobTierChangedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.BlobTierChanged event.", - "properties": { - "api": { - "type": "string", - "description": "The name of the API/operation that triggered this event." - }, - "clientRequestId": { - "type": "string", - "description": "A request id provided by the client of the storage API operation that triggered this event." - }, - "requestId": { - "type": "string", - "description": "The request id generated by the storage service for the storage API operation that triggered this event." - }, - "contentType": { - "type": "string", - "description": "The content type of the blob. This is the same as what would be returned in the Content-Type header from the blob." - }, - "contentLength": { - "type": "integer", - "format": "int64", - "description": "The size of the blob in bytes. This is the same as what would be returned in the Content-Length header from the blob." - }, - "blobType": { - "type": "string", - "description": "The type of blob." - }, - "url": { - "type": "string", - "description": "The path to the blob." - }, - "sequencer": { - "type": "string", - "description": "An opaque string value representing the logical sequence of events for any particular blob name. Users can use standard string comparison to understand the relative sequence of two events on the same blob name." - }, - "identity": { - "type": "string", - "description": "The identity of the requester that triggered this event." - }, - "storageDiagnostics": { - "type": "object", - "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", - "additionalProperties": {} - } - }, - "required": [ - "storageDiagnostics" - ] - }, - "StorageDirectoryCreatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.DirectoryCreated event.", - "properties": { - "api": { - "type": "string", - "description": "The name of the API/operation that triggered this event." - }, - "clientRequestId": { - "type": "string", - "description": "A request id provided by the client of the storage API operation that triggered this event." - }, - "requestId": { - "type": "string", - "description": "The request id generated by the storage service for the storage API operation that triggered this event." - }, - "eTag": { - "type": "string", - "description": "The etag of the directory at the time this event was triggered." - }, - "url": { - "type": "string", - "description": "The path to the directory." - }, - "sequencer": { - "type": "string", - "description": "An opaque string value representing the logical sequence of events for any particular directory name. Users can use standard string comparison to understand the relative sequence of two events on the same directory name." - }, - "identity": { - "type": "string", - "description": "The identity of the requester that triggered this event." - }, - "storageDiagnostics": { - "type": "object", - "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", - "additionalProperties": {} - } - }, - "required": [ - "storageDiagnostics" - ] - }, - "StorageDirectoryDeletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.DirectoryDeleted event.", - "properties": { - "api": { - "type": "string", - "description": "The name of the API/operation that triggered this event." - }, - "clientRequestId": { - "type": "string", - "description": "A request id provided by the client of the storage API operation that triggered this event." - }, - "requestId": { - "type": "string", - "description": "The request id generated by the storage service for the storage API operation that triggered this event." - }, - "url": { - "type": "string", - "description": "The path to the deleted directory." - }, - "recursive": { - "type": "string", - "description": "Is this event for a recursive delete operation." - }, - "sequencer": { - "type": "string", - "description": "An opaque string value representing the logical sequence of events for any particular directory name. Users can use standard string comparison to understand the relative sequence of two events on the same directory name." - }, - "identity": { - "type": "string", - "description": "The identity of the requester that triggered this event." - }, - "storageDiagnostics": { - "type": "object", - "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", - "additionalProperties": {} - } - }, - "required": [ - "storageDiagnostics" - ] - }, - "StorageDirectoryRenamedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.DirectoryRenamed event.", - "properties": { - "api": { - "type": "string", - "description": "The name of the API/operation that triggered this event." - }, - "clientRequestId": { - "type": "string", - "description": "A request id provided by the client of the storage API operation that triggered this event." - }, - "requestId": { - "type": "string", - "description": "The request id generated by the storage service for the storage API operation that triggered this event." - }, - "sourceUrl": { - "type": "string", - "description": "The path to the directory that was renamed." - }, - "destinationUrl": { - "type": "string", - "description": "The new path to the directory after the rename operation." - }, - "sequencer": { - "type": "string", - "description": "An opaque string value representing the logical sequence of events for any particular directory name. Users can use standard string comparison to understand the relative sequence of two events on the same directory name." - }, - "identity": { - "type": "string", - "description": "The identity of the requester that triggered this event." - }, - "storageDiagnostics": { - "type": "object", - "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", - "additionalProperties": {} - } - }, - "required": [ - "storageDiagnostics" - ] - }, - "StorageLifecyclePolicyActionSummaryDetail": { - "type": "object", - "description": "Execution statistics of a specific policy action in a Blob Management cycle.", - "properties": { - "totalObjectsCount": { - "type": "integer", - "format": "int64", - "description": "Total number of objects to be acted on by this action." - }, - "successCount": { - "type": "integer", - "format": "int64", - "description": "Number of success operations of this action." - }, - "errorList": { - "type": "string", - "description": "Error messages of this action if any." - } - } - }, - "StorageLifecyclePolicyCompletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.LifecyclePolicyCompleted event.", - "properties": { - "scheduleTime": { - "type": "string", - "description": "The time the policy task was scheduled." - }, - "deleteSummary": { - "$ref": "#/definitions/StorageLifecyclePolicyActionSummaryDetail", - "description": "Execution statistics of a specific policy action in a Blob Management cycle." - }, - "tierToCoolSummary": { - "$ref": "#/definitions/StorageLifecyclePolicyActionSummaryDetail", - "description": "Execution statistics of a specific policy action in a Blob Management cycle." - }, - "tierToArchiveSummary": { - "$ref": "#/definitions/StorageLifecyclePolicyActionSummaryDetail", - "description": "Execution statistics of a specific policy action in a Blob Management cycle." - } - }, - "required": [ - "deleteSummary", - "tierToCoolSummary", - "tierToArchiveSummary" - ] - }, - "StorageTaskAssignmentCompletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskAssignmentCompleted event.", - "properties": { - "status": { - "$ref": "#/definitions/StorageTaskAssignmentCompletedStatus", - "description": "The status for a storage task." - }, - "completedDateTime": { - "type": "string", - "format": "date-time", - "description": "The time at which a storage task was completed.", - "x-ms-client-name": "completedOn" - }, - "taskExecutionId": { - "type": "string", - "description": "The execution id for a storage task." - }, - "taskName": { - "type": "string", - "description": "The task name for a storage task." - }, - "summaryReportBlobUrl": { - "type": "string", - "format": "uri", - "description": "The summary report blob url for a storage task", - "x-ms-client-name": "summaryReportBlobUri" - } - }, - "required": [ - "status", - "completedDateTime", - "summaryReportBlobUrl" - ] - }, - "StorageTaskAssignmentCompletedStatus": { - "type": "string", - "description": "The status for a storage task.", - "enum": [ - "Succeeded", - "Failed" - ], - "x-ms-enum": { - "name": "StorageTaskAssignmentCompletedStatus", - "modelAsString": true, - "values": [ - { - "name": "Succeeded", - "value": "Succeeded", - "description": "Succeeded" - }, - { - "name": "Failed", - "value": "Failed", - "description": "Failed" - } - ] - } - }, - "StorageTaskAssignmentQueuedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskAssignmentQueued event.", - "properties": { - "queuedDateTime": { - "type": "string", - "format": "date-time", - "description": "The time at which a storage task was queued.", - "x-ms-client-name": "queuedOn" - }, - "taskExecutionId": { - "type": "string", - "description": "The execution id for a storage task." - } - }, - "required": [ - "queuedDateTime" - ] - }, - "StorageTaskCompletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskCompleted event.", - "properties": { - "status": { - "$ref": "#/definitions/StorageTaskCompletedStatus", - "description": "The status for a storage task." - }, - "completedDateTime": { - "type": "string", - "format": "date-time", - "description": "The time at which a storage task was completed." - }, - "taskExecutionId": { - "type": "string", - "description": "The execution id for a storage task." - }, - "taskName": { - "type": "string", - "description": "The task name for a storage task." - }, - "summaryReportBlobUrl": { - "type": "string", - "format": "uri", - "description": "The summary report blob url for a storage task" - } - }, - "required": [ - "status", - "completedDateTime", - "summaryReportBlobUrl" - ] - }, - "StorageTaskCompletedStatus": { - "type": "string", - "description": "The status for a storage task.", - "enum": [ - "Succeeded", - "Failed" - ], - "x-ms-enum": { - "name": "StorageTaskCompletedStatus", - "modelAsString": true, - "values": [ - { - "name": "Succeeded", - "value": "Succeeded", - "description": "Succeeded" - }, - { - "name": "Failed", - "value": "Failed", - "description": "Failed" - } - ] - } - }, - "StorageTaskQueuedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskQueued event.", - "properties": { - "queuedDateTime": { - "type": "string", - "format": "date-time", - "description": "The time at which a storage task was queued." - }, - "taskExecutionId": { - "type": "string", - "description": "The execution id for a storage task." - } - }, - "required": [ - "queuedDateTime" - ] - }, - "SubscriptionDeletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a\nMicrosoft.EventGrid.SubscriptionDeletedEvent event.", - "properties": { - "eventSubscriptionId": { - "type": "string", - "description": "The Azure resource ID of the deleted event subscription." - } - } - }, - "SubscriptionValidationEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.EventGrid.SubscriptionValidationEvent event.", - "properties": { - "validationCode": { - "type": "string", - "description": "The validation code sent by Azure Event Grid to validate an event subscription.\nTo complete the validation handshake, the subscriber must either respond with this validation code as part of the validation response,\nor perform a GET request on the validationUrl (available starting version 2018-05-01-preview)." - }, - "validationUrl": { - "type": "string", - "description": "The validation URL sent by Azure Event Grid (available starting version 2018-05-01-preview).\nTo complete the validation handshake, the subscriber must either respond with the validationCode as part of the validation response,\nor perform a GET request on the validationUrl (available starting version 2018-05-01-preview)." - } - } - }, - "SubscriptionValidationResponse": { - "type": "object", - "description": "To complete an event subscription validation handshake, a subscriber can use\neither the validationCode or the validationUrl received in a\nSubscriptionValidationEvent. When the validationCode is used, the\nSubscriptionValidationResponse can be used to build the response.", - "properties": { - "validationResponse": { - "type": "string", - "description": "The validation response sent by the subscriber to Azure Event Grid to complete the validation of an event subscription." - } - } - }, - "WebAppServicePlanUpdatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.AppServicePlanUpdated event.", - "properties": { - "appServicePlanEventTypeDetail": { - "$ref": "#/definitions/AppServicePlanEventTypeDetail", - "description": "Detail of action on the app service plan." - }, - "sku": { - "$ref": "#/definitions/WebAppServicePlanUpdatedEventDataSku", - "description": "sku of app service plan." - }, - "name": { - "type": "string", - "description": "name of the app service plan that had this event." - }, - "clientRequestId": { - "type": "string", - "description": "The client request id generated by the app service for the app service plan API operation that triggered this event." - }, - "correlationRequestId": { - "type": "string", - "description": "The correlation request id generated by the app service for the app service plan API operation that triggered this event." - }, - "requestId": { - "type": "string", - "description": "The request id generated by the app service for the app service plan API operation that triggered this event." - }, - "address": { - "type": "string", - "description": "HTTP request URL of this operation." - }, - "verb": { - "type": "string", - "description": "HTTP verb of this operation." - } - }, - "required": [ - "appServicePlanEventTypeDetail", - "sku" - ] - }, - "WebAppServicePlanUpdatedEventDataSku": { - "type": "object", - "description": "sku of app service plan.", - "properties": { - "name": { - "type": "string", - "description": "name of app service plan sku." - }, - "Tier": { - "type": "string", - "description": "tier of app service plan sku." - }, - "Size": { - "type": "string", - "description": "size of app service plan sku." - }, - "Family": { - "type": "string", - "description": "family of app service plan sku." - }, - "Capacity": { - "type": "string", - "description": "capacity of app service plan sku." - } - } - }, - "WebAppUpdatedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.AppUpdated event.", - "properties": { - "appEventTypeDetail": { - "$ref": "#/definitions/AppEventTypeDetail", - "description": "Detail of action on the app." - }, - "name": { - "type": "string", - "description": "name of the web site that had this event." - }, - "clientRequestId": { - "type": "string", - "description": "The client request id generated by the app service for the site API operation that triggered this event." - }, - "correlationRequestId": { - "type": "string", - "description": "The correlation request id generated by the app service for the site API operation that triggered this event." - }, - "requestId": { - "type": "string", - "description": "The request id generated by the app service for the site API operation that triggered this event." - }, - "address": { - "type": "string", - "description": "HTTP request URL of this operation." - }, - "verb": { - "type": "string", - "description": "HTTP verb of this operation." - } - }, - "required": [ - "appEventTypeDetail" - ] - }, - "WebBackupOperationCompletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.BackupOperationCompleted event.", - "properties": { - "appEventTypeDetail": { - "$ref": "#/definitions/AppEventTypeDetail", - "description": "Detail of action on the app." - }, - "name": { - "type": "string", - "description": "name of the web site that had this event." - }, - "clientRequestId": { - "type": "string", - "description": "The client request id generated by the app service for the site API operation that triggered this event." - }, - "correlationRequestId": { - "type": "string", - "description": "The correlation request id generated by the app service for the site API operation that triggered this event." - }, - "requestId": { - "type": "string", - "description": "The request id generated by the app service for the site API operation that triggered this event." - }, - "address": { - "type": "string", - "description": "HTTP request URL of this operation." - }, - "verb": { - "type": "string", - "description": "HTTP verb of this operation." - } - }, - "required": [ - "appEventTypeDetail" - ] - }, - "WebBackupOperationFailedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.BackupOperationFailed event.", - "properties": { - "appEventTypeDetail": { - "$ref": "#/definitions/AppEventTypeDetail", - "description": "Detail of action on the app." - }, - "name": { - "type": "string", - "description": "name of the web site that had this event." - }, - "clientRequestId": { - "type": "string", - "description": "The client request id generated by the app service for the site API operation that triggered this event." - }, - "correlationRequestId": { - "type": "string", - "description": "The correlation request id generated by the app service for the site API operation that triggered this event." - }, - "requestId": { - "type": "string", - "description": "The request id generated by the app service for the site API operation that triggered this event." - }, - "address": { - "type": "string", - "description": "HTTP request URL of this operation." - }, - "verb": { - "type": "string", - "description": "HTTP verb of this operation." - } - }, - "required": [ - "appEventTypeDetail" - ] - }, - "WebBackupOperationStartedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.BackupOperationStarted event.", - "properties": { - "appEventTypeDetail": { - "$ref": "#/definitions/AppEventTypeDetail", - "description": "Detail of action on the app." - }, - "name": { - "type": "string", - "description": "name of the web site that had this event." - }, - "clientRequestId": { - "type": "string", - "description": "The client request id generated by the app service for the site API operation that triggered this event." - }, - "correlationRequestId": { - "type": "string", - "description": "The correlation request id generated by the app service for the site API operation that triggered this event." - }, - "requestId": { - "type": "string", - "description": "The request id generated by the app service for the site API operation that triggered this event." - }, - "address": { - "type": "string", - "description": "HTTP request URL of this operation." - }, - "verb": { - "type": "string", - "description": "HTTP verb of this operation." - } - }, - "required": [ - "appEventTypeDetail" - ] - }, - "WebRestoreOperationCompletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.RestoreOperationCompleted event.", - "properties": { - "appEventTypeDetail": { - "$ref": "#/definitions/AppEventTypeDetail", - "description": "Detail of action on the app." - }, - "name": { - "type": "string", - "description": "name of the web site that had this event." - }, - "clientRequestId": { - "type": "string", - "description": "The client request id generated by the app service for the site API operation that triggered this event." - }, - "correlationRequestId": { - "type": "string", - "description": "The correlation request id generated by the app service for the site API operation that triggered this event." - }, - "requestId": { - "type": "string", - "description": "The request id generated by the app service for the site API operation that triggered this event." - }, - "address": { - "type": "string", - "description": "HTTP request URL of this operation." - }, - "verb": { - "type": "string", - "description": "HTTP verb of this operation." - } - }, - "required": [ - "appEventTypeDetail" - ] - }, - "WebRestoreOperationFailedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.RestoreOperationFailed event.", - "properties": { - "appEventTypeDetail": { - "$ref": "#/definitions/AppEventTypeDetail", - "description": "Detail of action on the app." - }, - "name": { - "type": "string", - "description": "name of the web site that had this event." - }, - "clientRequestId": { - "type": "string", - "description": "The client request id generated by the app service for the site API operation that triggered this event." - }, - "correlationRequestId": { - "type": "string", - "description": "The correlation request id generated by the app service for the site API operation that triggered this event." - }, - "requestId": { - "type": "string", - "description": "The request id generated by the app service for the site API operation that triggered this event." - }, - "address": { - "type": "string", - "description": "HTTP request URL of this operation." - }, - "verb": { - "type": "string", - "description": "HTTP verb of this operation." - } - }, - "required": [ - "appEventTypeDetail" - ] - }, - "WebRestoreOperationStartedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.RestoreOperationStarted event.", - "properties": { - "appEventTypeDetail": { - "$ref": "#/definitions/AppEventTypeDetail", - "description": "Detail of action on the app." - }, - "name": { - "type": "string", - "description": "name of the web site that had this event." - }, - "clientRequestId": { - "type": "string", - "description": "The client request id generated by the app service for the site API operation that triggered this event." - }, - "correlationRequestId": { - "type": "string", - "description": "The correlation request id generated by the app service for the site API operation that triggered this event." - }, - "requestId": { - "type": "string", - "description": "The request id generated by the app service for the site API operation that triggered this event." - }, - "address": { - "type": "string", - "description": "HTTP request URL of this operation." - }, - "verb": { - "type": "string", - "description": "HTTP verb of this operation." - } - }, - "required": [ - "appEventTypeDetail" - ] - }, - "WebSlotSwapCompletedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.SlotSwapCompleted event.", - "properties": { - "appEventTypeDetail": { - "$ref": "#/definitions/AppEventTypeDetail", - "description": "Detail of action on the app." - }, - "name": { - "type": "string", - "description": "name of the web site that had this event." - }, - "clientRequestId": { - "type": "string", - "description": "The client request id generated by the app service for the site API operation that triggered this event." - }, - "correlationRequestId": { - "type": "string", - "description": "The correlation request id generated by the app service for the site API operation that triggered this event." - }, - "requestId": { - "type": "string", - "description": "The request id generated by the app service for the site API operation that triggered this event." - }, - "address": { - "type": "string", - "description": "HTTP request URL of this operation." - }, - "verb": { - "type": "string", - "description": "HTTP verb of this operation." - } - }, - "required": [ - "appEventTypeDetail" - ] - }, - "WebSlotSwapFailedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.SlotSwapFailed event.", - "properties": { - "appEventTypeDetail": { - "$ref": "#/definitions/AppEventTypeDetail", - "description": "Detail of action on the app." - }, - "name": { - "type": "string", - "description": "name of the web site that had this event." - }, - "clientRequestId": { - "type": "string", - "description": "The client request id generated by the app service for the site API operation that triggered this event." - }, - "correlationRequestId": { - "type": "string", - "description": "The correlation request id generated by the app service for the site API operation that triggered this event." - }, - "requestId": { - "type": "string", - "description": "The request id generated by the app service for the site API operation that triggered this event." - }, - "address": { - "type": "string", - "description": "HTTP request URL of this operation." - }, - "verb": { - "type": "string", - "description": "HTTP verb of this operation." - } - }, - "required": [ - "appEventTypeDetail" - ] - }, - "WebSlotSwapStartedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.SlotSwapStarted event.", - "properties": { - "appEventTypeDetail": { - "$ref": "#/definitions/AppEventTypeDetail", - "description": "Detail of action on the app." - }, - "name": { - "type": "string", - "description": "name of the web site that had this event." - }, - "clientRequestId": { - "type": "string", - "description": "The client request id generated by the app service for the site API operation that triggered this event." - }, - "correlationRequestId": { - "type": "string", - "description": "The correlation request id generated by the app service for the site API operation that triggered this event." - }, - "requestId": { - "type": "string", - "description": "The request id generated by the app service for the site API operation that triggered this event." - }, - "address": { - "type": "string", - "description": "HTTP request URL of this operation." - }, - "verb": { - "type": "string", - "description": "HTTP verb of this operation." - } - }, - "required": [ - "appEventTypeDetail" - ] - }, - "WebSlotSwapWithPreviewCancelledEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.SlotSwapWithPreviewCancelled event.", - "properties": { - "appEventTypeDetail": { - "$ref": "#/definitions/AppEventTypeDetail", - "description": "Detail of action on the app." - }, - "name": { - "type": "string", - "description": "name of the web site that had this event." - }, - "clientRequestId": { - "type": "string", - "description": "The client request id generated by the app service for the site API operation that triggered this event." - }, - "correlationRequestId": { - "type": "string", - "description": "The correlation request id generated by the app service for the site API operation that triggered this event." - }, - "requestId": { - "type": "string", - "description": "The request id generated by the app service for the site API operation that triggered this event." - }, - "address": { - "type": "string", - "description": "HTTP request URL of this operation." - }, - "verb": { - "type": "string", - "description": "HTTP verb of this operation." - } - }, - "required": [ - "appEventTypeDetail" - ] - }, - "WebSlotSwapWithPreviewStartedEventData": { - "type": "object", - "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.SlotSwapWithPreviewStarted event.", - "properties": { - "appEventTypeDetail": { - "$ref": "#/definitions/AppEventTypeDetail", - "description": "Detail of action on the app." - }, - "name": { - "type": "string", - "description": "name of the web site that had this event." - }, - "clientRequestId": { - "type": "string", - "description": "The client request id generated by the app service for the site API operation that triggered this event." - }, - "correlationRequestId": { - "type": "string", - "description": "The correlation request id generated by the app service for the site API operation that triggered this event." - }, - "requestId": { - "type": "string", - "description": "The request id generated by the app service for the site API operation that triggered this event." - }, - "address": { - "type": "string", - "description": "HTTP request URL of this operation." - }, - "verb": { - "type": "string", - "description": "HTTP verb of this operation." - } - }, - "required": [ - "appEventTypeDetail" - ] - }, - "recordingChannelType": { - "type": "string", - "description": "Recording channel type", - "enum": [ - "Mixed", - "Unmixed" - ], - "x-ms-enum": { - "name": "recordingChannelType", - "modelAsString": true, - "values": [ - { - "name": "Mixed", - "value": "Mixed", - "description": "Mixed channel type" - }, - { - "name": "Unmixed", - "value": "Unmixed", - "description": "Unmixed channel type" - } - ] - } - }, - "recordingContentType": { - "type": "string", - "description": "Recording content type", - "enum": [ - "AudioVideo", - "Audio" - ], - "x-ms-enum": { - "name": "recordingContentType", - "modelAsString": true, - "values": [ - { - "name": "AudioVideo", - "value": "AudioVideo", - "description": "AudioVideo content type" - }, - { - "name": "Audio", - "value": "Audio", - "description": "Audio content type" - } - ] - } - }, - "recordingFormatType": { - "type": "string", - "description": "Recording format type", - "enum": [ - "Wav", - "Mp3", - "Mp4" - ], - "x-ms-enum": { - "name": "recordingFormatType", - "modelAsString": true, - "values": [ - { - "name": "Wav", - "value": "Wav", - "description": "WAV format" - }, - { - "name": "Mp3", - "value": "Mp3", - "description": "MP3 format" - }, - { - "name": "Mp4", - "value": "Mp4", - "description": "MP4 format" - } - ] - } - } - }, - "parameters": {} -} diff --git a/specification/eventgrid/data-plane/readme.md b/specification/eventgrid/data-plane/readme.md index a7786a2ee4b8..1cf80d695d1b 100644 --- a/specification/eventgrid/data-plane/readme.md +++ b/specification/eventgrid/data-plane/readme.md @@ -253,7 +253,15 @@ These settings apply only when `--tag=package-2024-01-01` is specified on the co ``` yaml $(tag) == 'package-2024-01-01' input-file: - Microsoft.EventGrid/stable/2018-01-01/EventGrid.json -- Microsoft.EventGrid/stable/2024-01-01/SystemEvents.json +- Microsoft.EventGrid/stable/2024-01-01/GeneratedSystemEvents.json +``` + +### Tag: package-2018-01-01-generated +These settings apply only when `--tag=package-2018-01-01-generated` is specified on the command line. Will generate EventGrid SystemEvents from TypeSpec, with backcompat from what Swagger was doing for optional extensible enums. +``` yaml $(tag) == '2018-01-01-generated' +input-file: +- Microsoft.EventGrid/stable/2018-01-01/EventGrid.json +- Microsoft.EventGrid/stable/2018-01-01/GeneratedSystemEvents.json ``` ### Suppression diff --git a/specification/eventhub/resource-manager/readme.md b/specification/eventhub/resource-manager/readme.md index 7d84d0ea255f..64e355def5aa 100644 --- a/specification/eventhub/resource-manager/readme.md +++ b/specification/eventhub/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the EventHub API. ``` yaml openapi-type: arm -tag: package-2024-05-preview +tag: package-2024-01 ``` ### Tag: package-2017-04 diff --git a/specification/eventhub/resource-manager/readme.python.md b/specification/eventhub/resource-manager/readme.python.md index 6a64248f0d98..de0f73ed2f9a 100644 --- a/specification/eventhub/resource-manager/readme.python.md +++ b/specification/eventhub/resource-manager/readme.python.md @@ -19,9 +19,10 @@ Generate all API versions currently shipped for this package ```yaml $(python) multiapi: true -default-api-version: "2021-11-01" +default-api-version: "2024-01-01" clear-output-folder: true batch: + - tag: package-2024-01 - tag: package-2021-11 - tag: package-2022-01-preview - tag: package-2022-10-preview @@ -36,6 +37,17 @@ batch: ``` yaml $(multiapiscript) output-folder: $(python-sdks-folder)/eventhub/azure-mgmt-eventhub/azure/mgmt/eventhub/ perform-load: false +clear-output-folder: false +``` + +### Tag: package-2024-01 and python + +These settings apply only when `--tag=package-2024-01 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2024-01' +namespace: azure.mgmt.eventhub.v2024_01_01 +output-folder: $(python-sdks-folder)/eventhub/azure-mgmt-eventhub/azure/mgmt/eventhub/v2024_01_01 ``` ### Tag: package-2021-11 and python @@ -46,9 +58,6 @@ Please also specify `--python-sdks-folder= { interface FabricCapacities { get is ArmResourceRead; createOrUpdate is ArmResourceCreateOrReplaceAsync; - update is ArmResourcePatchSync; - delete is ArmResourceDeleteSync; + update is ArmCustomPatchAsync< + FabricCapacity, + Azure.ResourceManager.Foundations.ResourceUpdateModel< + FabricCapacity, + FabricCapacityProperties + > + >; + delete is ArmResourceDeleteWithoutOkAsync; listByResourceGroup is ArmResourceListByParent; listBySubscription is ArmListBySubscription; diff --git a/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Delete.json b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Delete.json index decf9a4809f8..90c9acbf1ebb 100644 --- a/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Delete.json +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Delete.json @@ -8,7 +8,12 @@ "capacityName": "azsdktest" }, "responses": { - "200": {}, + "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/2023-11-01/FabricCapacities_Update.json b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Update.json index 0dbbee872b7c..7bcc4e1649ab 100644 --- a/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Update.json +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Update.json @@ -27,8 +27,8 @@ "200": { "body": { "properties": { - "provisioningState": "Provisioning", - "state": "Provisioning", + "provisioningState": "Updating", + "state": "Preparing", "administration": { "members": [ "azsdktest2@microsoft.com" @@ -47,6 +47,12 @@ "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/tspconfig.yaml b/specification/fabric/Microsoft.Fabric.Management/tspconfig.yaml index b5074dd778f1..b0a0da99704d 100644 --- a/specification/fabric/Microsoft.Fabric.Management/tspconfig.yaml +++ b/specification/fabric/Microsoft.Fabric.Management/tspconfig.yaml @@ -5,6 +5,9 @@ options: use-read-only-status-schema: true emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/fabric.json" examples-directory: "{project-root}/examples" linter: diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Delete.json b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Delete.json index decf9a4809f8..90c9acbf1ebb 100644 --- a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Delete.json +++ b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Delete.json @@ -8,7 +8,12 @@ "capacityName": "azsdktest" }, "responses": { - "200": {}, + "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/stable/2023-11-01/examples/FabricCapacities_Update.json b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Update.json index 0dbbee872b7c..7bcc4e1649ab 100644 --- a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Update.json +++ b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/examples/FabricCapacities_Update.json @@ -27,8 +27,8 @@ "200": { "body": { "properties": { - "provisioningState": "Provisioning", - "state": "Provisioning", + "provisioningState": "Updating", + "state": "Preparing", "administration": { "members": [ "azsdktest2@microsoft.com" @@ -47,6 +47,12 @@ "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/stable/2023-11-01/fabric.json b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/fabric.json index eb8d87cc9837..2db25ad25d71 100644 --- a/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/fabric.json +++ b/specification/fabric/resource-manager/Microsoft.Fabric/stable/2023-11-01/fabric.json @@ -419,6 +419,20 @@ "$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": { @@ -430,7 +444,11 @@ "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", @@ -460,8 +478,19 @@ } ], "responses": { - "200": { - "description": "Resource deleted successfully." + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } }, "204": { "description": "Resource does not exist." @@ -477,7 +506,11 @@ "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": { @@ -767,6 +800,7 @@ }, "properties": { "$ref": "#/definitions/FabricCapacityUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/createOrUpdateGuestConfigurationAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/createOrUpdateGuestConfigurationAssignment.json new file mode 100644 index 000000000000..7ea14f73f050 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/createOrUpdateGuestConfigurationAssignment.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "guestConfigurationAssignmentName": "NotInstalledApplicationForWindows", + "api-version": "2024-04-05", + "parameters": { + "location": "westcentralus", + "name": "NotInstalledApplicationForWindows", + "properties": { + "context": "Azure policy", + "guestConfiguration": { + "name": "NotInstalledApplicationForWindows", + "version": "1.0.0.3", + "contentUri": "https://thisisfake/pacakge", + "contentHash": "123contenthash", + "assignmentType": "ApplyAndAutoCorrect", + "contentManagedIdentity": "test_identity", + "configurationParameter": [ + { + "name": "[InstalledApplication]NotInstalledApplicationResource1;Name", + "value": "NotePad,sql" + } + ] + } + } + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "location": "westcentralus", + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows", + "name": "NotInstalledApplicationForWindows", + "properties": { + "complianceStatus": "Pending", + "assignmentHash": null, + "latestReportId": null, + "lastComplianceStatusChecked": null, + "context": "Azure policy", + "resourceType": null, + "vmssVMList": null, + "guestConfiguration": { + "kind": null, + "name": "NotInstalledApplicationForWindows", + "version": "1.0.0.3", + "contentUri": null, + "contentHash": null, + "contentType": null, + "contentManagedIdentity": null, + "assignmentSource": "AzurePolicy", + "configurationParameter": [ + { + "name": "[InstalledApplication]NotInstalledApplicationResource1;Name", + "value": "NotePad,sql" + } + ] + }, + "provisioningState": "Succeeded" + } + } + }, + "200": { + "headers": {}, + "body": { + "location": "westcentralus", + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows", + "name": "NotInstalledApplicationForWindows", + "properties": { + "complianceStatus": "Pending", + "assignmentHash": null, + "latestReportId": null, + "lastComplianceStatusChecked": null, + "context": "Azure policy", + "resourceType": null, + "vmssVMList": null, + "guestConfiguration": { + "kind": null, + "name": "NotInstalledApplicationForWindows", + "version": "1.0.0.3", + "contentUri": null, + "contentHash": null, + "contentType": null, + "contentManagedIdentity": null, + "assignmentSource": "AzurePolicy", + "configurationParameter": [ + { + "name": "[InstalledApplication]NotInstalledApplicationResource1;Name", + "value": "NotePad,sql" + } + ] + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/createOrUpdateGuestConfigurationConnectedVMwarevSphereAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/createOrUpdateGuestConfigurationConnectedVMwarevSphereAssignment.json new file mode 100644 index 000000000000..8d700c48feb2 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/createOrUpdateGuestConfigurationConnectedVMwarevSphereAssignment.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "guestConfigurationAssignmentName": "NotInstalledApplicationForWindows", + "api-version": "2024-04-05", + "parameters": { + "location": "westcentralus", + "name": "NotInstalledApplicationForWindows", + "properties": { + "context": "Azure policy", + "guestConfiguration": { + "name": "NotInstalledApplicationForWindows", + "version": "1.0.0.0", + "contentUri": "https://thisisfake/pacakge", + "contentHash": "123contenthash", + "assignmentType": "ApplyAndAutoCorrect", + "configurationParameter": [ + { + "name": "[InstalledApplication]NotInstalledApplicationResource1;Name", + "value": "NotePad,sql" + } + ] + } + } + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "location": "westcentralus", + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.ConnectedVMwarevSphere/virtualmachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows", + "name": "NotInstalledApplicationForWindows", + "properties": { + "complianceStatus": "Pending", + "assignmentHash": null, + "latestReportId": null, + "lastComplianceStatusChecked": null, + "context": "Azure policy", + "resourceType": null, + "vmssVMList": null, + "guestConfiguration": { + "kind": null, + "name": "NotInstalledApplicationForWindows", + "version": "1.0.0.3", + "contentUri": null, + "contentHash": null, + "contentType": null, + "assignmentSource": "AzurePolicy", + "configurationParameter": [ + { + "name": "[InstalledApplication]NotInstalledApplicationResource1;Name", + "value": "NotePad,sql" + } + ] + }, + "provisioningState": "Succeeded" + } + } + }, + "200": { + "headers": {}, + "body": { + "location": "westcentralus", + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/microsoft.ConnectedVMwarevSphere/virtualmachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows", + "name": "NotInstalledApplicationForWindows", + "properties": { + "complianceStatus": "Pending", + "assignmentHash": null, + "latestReportId": null, + "lastComplianceStatusChecked": null, + "context": "Azure policy", + "resourceType": null, + "vmssVMList": null, + "guestConfiguration": { + "kind": null, + "name": "NotInstalledApplicationForWindows", + "version": "1.0.0.3", + "contentUri": null, + "contentHash": null, + "contentType": null, + "assignmentSource": "AzurePolicy", + "configurationParameter": [ + { + "name": "[InstalledApplication]NotInstalledApplicationResource1;Name", + "value": "NotePad,sql" + } + ] + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/createOrUpdateGuestConfigurationHCRPAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/createOrUpdateGuestConfigurationHCRPAssignment.json new file mode 100644 index 000000000000..dc035f23d335 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/createOrUpdateGuestConfigurationHCRPAssignment.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "machineName": "myMachineName", + "guestConfigurationAssignmentName": "NotInstalledApplicationForWindows", + "api-version": "2024-04-05", + "parameters": { + "location": "westcentralus", + "name": "NotInstalledApplicationForWindows", + "properties": { + "context": "Azure policy", + "guestConfiguration": { + "name": "NotInstalledApplicationForWindows", + "version": "1.0.0.3", + "contentUri": "https://thisisfake/pacakge", + "contentHash": "123contenthash", + "assignmentType": "ApplyAndAutoCorrect", + "configurationParameter": [ + { + "name": "[InstalledApplication]NotInstalledApplicationResource1;Name", + "value": "NotePad,sql" + } + ] + } + } + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "location": "westcentralus", + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/HybridRP.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows", + "name": "NotInstalledApplicationForWindows", + "properties": { + "complianceStatus": "Pending", + "assignmentHash": "abcdr453g", + "latestReportId": "a2a64e5d-a1a9-4344-a866-fb9e1541f723", + "lastComplianceStatusChecked": null, + "context": "Azure policy", + "guestConfiguration": { + "kind": null, + "name": "NotInstalledApplicationForWindows", + "version": "1.0.0.3", + "contentUri": null, + "contentHash": null, + "contentType": null, + "configurationParameter": [ + { + "name": "[InstalledApplication]NotInstalledApplicationResource1;Name", + "value": "NotePad,sql" + } + ] + }, + "provisioningState": "Succeeded" + } + } + }, + "200": { + "headers": {}, + "body": { + "location": "westcentralus", + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/HybridRP.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows", + "name": "NotInstalledApplicationForWindows", + "properties": { + "complianceStatus": "Pending", + "assignmentHash": "abcdr453g", + "latestReportId": "a2a64e5d-a1a9-4344-a866-fb9e1541f723", + "lastComplianceStatusChecked": null, + "context": "Azure policy", + "guestConfiguration": { + "kind": null, + "name": "NotInstalledApplicationForWindows", + "version": "1.0.0.3", + "contentUri": null, + "contentHash": null, + "contentType": null, + "configurationParameter": [ + { + "name": "[InstalledApplication]NotInstalledApplicationResource1;Name", + "value": "NotePad,sql" + } + ] + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/createOrUpdateGuestConfigurationVMSSAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/createOrUpdateGuestConfigurationVMSSAssignment.json new file mode 100644 index 000000000000..0ea390962e71 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/createOrUpdateGuestConfigurationVMSSAssignment.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmssName": "myVMSSName", + "name": "NotInstalledApplicationForWindows", + "api-version": "2024-04-05", + "parameters": { + "location": "westcentralus", + "name": "NotInstalledApplicationForWindows", + "properties": { + "context": "Azure policy", + "guestConfiguration": { + "name": "NotInstalledApplicationForWindows", + "version": "1.0.0.3", + "contentUri": "https://thisisfake/pacakge", + "contentHash": "123contenthash", + "assignmentType": "ApplyAndAutoCorrect", + "contentManagedIdentity": "test_identity", + "configurationParameter": [ + { + "name": "[InstalledApplication]NotInstalledApplicationResource1;Name", + "value": "NotePad,sql" + } + ] + } + } + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "location": "westcentralus", + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualmachinescalesets/myvmssname/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows", + "name": "NotInstalledApplicationForWindows", + "properties": { + "complianceStatus": "Pending", + "assignmentHash": null, + "latestReportId": null, + "lastComplianceStatusChecked": null, + "context": "Azure policy", + "resourceType": null, + "vmssVMList": null, + "guestConfiguration": { + "kind": null, + "name": "NotInstalledApplicationForWindows", + "version": "1.0.0.3", + "contentUri": null, + "contentHash": null, + "contentType": null, + "assignmentSource": "AzurePolicy", + "contentManagedIdentity": "test_identity", + "configurationParameter": [ + { + "name": "[InstalledApplication]NotInstalledApplicationResource1;Name", + "value": "NotePad,sql" + } + ] + }, + "provisioningState": "Succeeded" + } + } + }, + "200": { + "headers": {}, + "body": { + "location": "westcentralus", + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualmachinescalesets/myvmssname/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/NotInstalledApplicationForWindows", + "name": "NotInstalledApplicationForWindows", + "properties": { + "complianceStatus": "Pending", + "assignmentHash": null, + "latestReportId": null, + "lastComplianceStatusChecked": null, + "context": "Azure policy", + "resourceType": null, + "vmssVMList": null, + "guestConfiguration": { + "kind": null, + "name": "NotInstalledApplicationForWindows", + "version": "1.0.0.3", + "contentUri": null, + "contentHash": null, + "contentType": null, + "assignmentSource": "AzurePolicy", + "contentManagedIdentity": "test_identity", + "configurationParameter": [ + { + "name": "[InstalledApplication]NotInstalledApplicationResource1;Name", + "value": "NotePad,sql" + } + ] + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/deleteGuestConfigurationAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/deleteGuestConfigurationAssignment.json new file mode 100644 index 000000000000..535ce8939e05 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/deleteGuestConfigurationAssignment.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "guestConfigurationAssignmentName": "SecureProtocol", + "api-version": "2024-04-05" + }, + "responses": { + "200": {} + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/deleteGuestConfigurationConnectedVMwarevSphereAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/deleteGuestConfigurationConnectedVMwarevSphereAssignment.json new file mode 100644 index 000000000000..5fde70225dd5 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/deleteGuestConfigurationConnectedVMwarevSphereAssignment.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "guestConfigurationAssignmentName": "SecureProtocol", + "api-version": "2024-04-05" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/deleteGuestConfigurationHCRPAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/deleteGuestConfigurationHCRPAssignment.json new file mode 100644 index 000000000000..42e041eff7b1 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/deleteGuestConfigurationHCRPAssignment.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "machineName": "myMachineName", + "guestConfigurationAssignmentName": "SecureProtocol", + "api-version": "2024-04-05" + }, + "responses": { + "200": {} + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/deleteGuestConfigurationVMSSAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/deleteGuestConfigurationVMSSAssignment.json new file mode 100644 index 000000000000..720a041b6442 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/deleteGuestConfigurationVMSSAssignment.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmssName": "myVMSSName", + "name": "SecureProtocol", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/myVMSSName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol", + "name": "AuditSecureProtocol", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "E0D8941DD713F284284561648C00C18FA76C8602943C7CD38AFD73B56AE4C35F.E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855", + "latestReportId": null, + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol/AuditSecureProtocol_1.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": "Succeeded", + "resourceType": "VMSS", + "vmssVMList": null + } + } + }, + "204": {} + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationAssignment.json new file mode 100644 index 000000000000..ec7608f277ca --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationAssignment.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "guestConfigurationAssignmentName": "SecureProtocol", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol", + "name": "AuditSecureProtocol", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "E0D8941DD713F284284561648C00C18FA76C8602943C7CD38AFD73B56AE4C35F.E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol/AuditSecureProtocol_1.0.0.3.zip", + "contentHash": "content hash", + "contentManagedIdentity": "test_identity", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationAssignmentReportById.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationAssignmentReportById.json new file mode 100644 index 000000000000..8e53acc78012 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationAssignmentReportById.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionid", + "resourceGroupName": "myResourceGroupName", + "vmName": "myvm", + "guestConfigurationAssignmentName": "AuditSecureProtocol", + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "name": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol", + "version": "1.0.0.0" + } + }, + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm", + "uuid": "vmuuid" + }, + "details": { + "complianceStatus": "Compliant", + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z", + "jobId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "resources": [ + { + "complianceStatus": "Compliant", + "reasons": [ + { + "phrase": "Operation successful.", + "code": "DSC::RESOURCE::SUCCESS" + } + ], + "properties": { + "ConfigurationName": "IsWebServerSecure", + "DependsOn": null, + "IsSingleInstance": "Yes", + "ModuleName": "SecureProtocolWebServer", + "ModuleVersion": "1.0.0.3", + "Protocols": [ + { + "Ensure": "Absent", + "Protocol": "SSL 2.0" + }, + { + "Ensure": "Absent", + "Protocol": "SSL 3.0" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.0" + }, + { + "Ensure": "Absent", + "Protocol": "PCT 1.0" + }, + { + "Ensure": "Absent", + "Protocol": "Multi-Protocol Unified Hello" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.1" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.2" + } + ], + "PsDscRunAsCredential": null, + "Reasons": null, + "ResourceId": "[SecureWebServer]s1", + "SourceInfo": null + } + } + ], + "operationType": "Consistency" + }, + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationConnectedVMwarevSphereAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationConnectedVMwarevSphereAssignment.json new file mode 100644 index 000000000000..744167af77bd --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationConnectedVMwarevSphereAssignment.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "guestConfigurationAssignmentName": "SecureProtocol", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/microsoft.ConnectedVMwarevSphere/virtualmachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol", + "name": "AuditSecureProtocol", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "E0D8941DD713F284284561648C00C18FA76C8602943C7CD38AFD73B56AE4C35F.E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/microsoft.ConnectedVMwarevSphere/virtualmachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol/AuditSecureProtocol_1.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationConnectedVMwarevSphereAssignmentReportById.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationConnectedVMwarevSphereAssignmentReportById.json new file mode 100644 index 000000000000..46065c571a78 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationConnectedVMwarevSphereAssignmentReportById.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionid", + "resourceGroupName": "myResourceGroupName", + "vmName": "myvm", + "guestConfigurationAssignmentName": "AuditSecureProtocol", + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Connectedvmwarevsphere/virtualmachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "name": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol", + "version": "1.0.0.0" + } + }, + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Connectedvmwarevsphere/virtualmachines/myvm", + "uuid": "vmuuid" + }, + "details": { + "complianceStatus": "Compliant", + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z", + "jobId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "resources": [ + { + "complianceStatus": "Compliant", + "reasons": [ + { + "phrase": "Operation successful.", + "code": "DSC::RESOURCE::SUCCESS" + } + ], + "properties": { + "ConfigurationName": "IsWebServerSecure", + "DependsOn": null, + "IsSingleInstance": "Yes", + "ModuleName": "SecureProtocolWebServer", + "ModuleVersion": "1.0.0.3", + "Protocols": [ + { + "Ensure": "Absent", + "Protocol": "SSL 2.0" + }, + { + "Ensure": "Absent", + "Protocol": "SSL 3.0" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.0" + }, + { + "Ensure": "Absent", + "Protocol": "PCT 1.0" + }, + { + "Ensure": "Absent", + "Protocol": "Multi-Protocol Unified Hello" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.1" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.2" + } + ], + "PsDscRunAsCredential": null, + "Reasons": null, + "ResourceId": "[SecureWebServer]s1", + "SourceInfo": null + } + } + ], + "operationType": "Consistency" + }, + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationHCRPAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationHCRPAssignment.json new file mode 100644 index 000000000000..81218c40b230 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationHCRPAssignment.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "machineName": "myMachineName", + "guestConfigurationAssignmentName": "SecureProtocol", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol", + "name": "AuditSecureProtocol", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "E0D8941DD713F284284561648C00C18FA76C8602943C7CD38AFD73B56AE4C35F.E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol/AuditSecureProtocol_1.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationHCRPAssignmentReportById.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationHCRPAssignmentReportById.json new file mode 100644 index 000000000000..45e30574a026 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getGuestConfigurationHCRPAssignmentReportById.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionid", + "resourceGroupName": "myResourceGroupName", + "machineName": "myMachineName", + "guestConfigurationAssignmentName": "AuditSecureProtocol", + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "name": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol", + "version": "1.0.0.0" + } + }, + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName", + "uuid": "vmuuid" + }, + "details": { + "complianceStatus": "Compliant", + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z", + "jobId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "resources": [ + { + "complianceStatus": "Compliant", + "reasons": [ + { + "phrase": "Operation successful.", + "code": "DSC::RESOURCE::SUCCESS" + } + ], + "properties": { + "ConfigurationName": "IsWebServerSecure", + "DependsOn": null, + "IsSingleInstance": "Yes", + "ModuleName": "SecureProtocolWebServer", + "ModuleVersion": "1.0.0.3", + "Protocols": [ + { + "Ensure": "Absent", + "Protocol": "SSL 2.0" + }, + { + "Ensure": "Absent", + "Protocol": "SSL 3.0" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.0" + }, + { + "Ensure": "Absent", + "Protocol": "PCT 1.0" + }, + { + "Ensure": "Absent", + "Protocol": "Multi-Protocol Unified Hello" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.1" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.2" + } + ], + "PsDscRunAsCredential": null, + "Reasons": null, + "ResourceId": "[SecureWebServer]s1", + "SourceInfo": null + } + } + ], + "operationType": "Consistency" + }, + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getVMSSGuestConfigurationAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getVMSSGuestConfigurationAssignment.json new file mode 100644 index 000000000000..73d79d20dc07 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getVMSSGuestConfigurationAssignment.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmssName": "myVMSSName", + "name": "SecureProtocol", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/myVMSSName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol", + "name": "AuditSecureProtocol", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "E0D8941DD713F284284561648C00C18FA76C8602943C7CD38AFD73B56AE4C35F.E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855", + "latestReportId": null, + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol/AuditSecureProtocol_1.0.0.3.zip", + "contentHash": "content hash", + "contentManagedIdentity": "test_identity", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": "Succeeded", + "resourceType": "VMSS", + "vmssVMList": null + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getVMSSGuestConfigurationAssignmentReportById.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getVMSSGuestConfigurationAssignmentReportById.json new file mode 100644 index 000000000000..3c460fa57e38 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/getVMSSGuestConfigurationAssignmentReportById.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionid", + "resourceGroupName": "myResourceGroupName", + "vmssName": "myvmss", + "name": "AuditSecureProtocol", + "id": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/myvmss/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "name": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol", + "version": "1.0.0.0" + } + }, + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "vm": { + "id": "/subscriptions/mySubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/myvmss/virtualMachines/1", + "uuid": "vmuuid" + }, + "details": { + "complianceStatus": "Compliant", + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z", + "jobId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "resources": [ + { + "complianceStatus": "Compliant", + "reasons": [ + { + "phrase": "Operation successful.", + "code": "DSC::RESOURCE::SUCCESS" + } + ], + "properties": { + "ConfigurationName": "IsWebServerSecure", + "DependsOn": null, + "IsSingleInstance": "Yes", + "ModuleName": "SecureProtocolWebServer", + "ModuleVersion": "1.0.0.3", + "Protocols": [ + { + "Ensure": "Absent", + "Protocol": "SSL 2.0" + }, + { + "Ensure": "Absent", + "Protocol": "SSL 3.0" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.0" + }, + { + "Ensure": "Absent", + "Protocol": "PCT 1.0" + }, + { + "Ensure": "Absent", + "Protocol": "Multi-Protocol Unified Hello" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.1" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.2" + } + ], + "PsDscRunAsCredential": null, + "Reasons": null, + "ResourceId": "[SecureWebServer]s1", + "SourceInfo": null + } + } + ], + "operationType": "Consistency" + }, + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listAllGuestConfigurationAssignmentReports.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listAllGuestConfigurationAssignmentReports.json new file mode 100644 index 000000000000..2270acb515ae --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listAllGuestConfigurationAssignmentReports.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionid", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "guestConfigurationAssignmentName": "AuditSecureProtocol", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "name": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol" + } + }, + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm", + "uuid": "vmuuid" + }, + "details": null, + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z" + } + }, + { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "name": "41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol" + } + }, + "reportId": "41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm", + "uuid": "vmuuid" + }, + "details": null, + "startTime": "2018-08-29T20:13:53Z", + "endTime": "2018-08-29T20:14:13Z" + } + } + ] + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listAllGuestConfigurationConnectedVMwarevSphereAssignmentsReports.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listAllGuestConfigurationConnectedVMwarevSphereAssignmentsReports.json new file mode 100644 index 000000000000..b9e7322d4de0 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listAllGuestConfigurationConnectedVMwarevSphereAssignmentsReports.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionid", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "guestConfigurationAssignmentName": "AuditSecureProtocol", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Connectedvmwarevsphere/virtualmachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "name": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol" + } + }, + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Connectedvmwarevsphere/virtualmachines/myvm", + "uuid": "vmuuid" + }, + "details": null, + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z" + } + }, + { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Connectedvmwarevsphere/virtualmachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "name": "41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol" + } + }, + "reportId": "41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Connectedvmwarevsphere/virtualmachines/myvm", + "uuid": "vmuuid" + }, + "details": null, + "startTime": "2018-08-29T20:13:53Z", + "endTime": "2018-08-29T20:14:13Z" + } + } + ] + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listAllGuestConfigurationHCRPAssignmentReports.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listAllGuestConfigurationHCRPAssignmentReports.json new file mode 100644 index 000000000000..264bbf86767e --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listAllGuestConfigurationHCRPAssignmentReports.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionid", + "resourceGroupName": "myResourceGroupName", + "machineName": "myMachineName", + "guestConfigurationAssignmentName": "AuditSecureProtocol", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "name": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol" + } + }, + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName", + "uuid": "vmuuid" + }, + "details": null, + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z" + } + }, + { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "name": "41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol" + } + }, + "reportId": "41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName", + "uuid": "vmuuid" + }, + "details": null, + "startTime": "2018-08-29T20:13:53Z", + "endTime": "2018-08-29T20:14:13Z" + } + } + ] + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listAllVMSSGuestConfigurationAssignmentReports.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listAllVMSSGuestConfigurationAssignmentReports.json new file mode 100644 index 000000000000..2cf8428beb05 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listAllVMSSGuestConfigurationAssignmentReports.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionid", + "resourceGroupName": "myResourceGroupName", + "vmssName": "myVMSSName", + "name": "AuditSecureProtocol", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/myVMSSName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "name": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol" + } + }, + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/myVMSSName/virtualMachines/1", + "uuid": "vmuuid" + }, + "details": null, + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z" + } + }, + { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/myVMSSName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "name": "41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol" + } + }, + "reportId": "41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/myVMSSName/virtualMachines/1", + "uuid": "vmuuid" + }, + "details": null, + "startTime": "2018-08-29T20:13:53Z", + "endTime": "2018-08-29T20:14:13Z" + } + } + ] + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listGuestConfigurationAssignments.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listGuestConfigurationAssignments.json new file mode 100644 index 000000000000..4a5143634915 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listGuestConfigurationAssignments.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2", + "name": "AuditSecureProtocol2", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol2", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol2/AuditSecureProtocol2_1.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + }, + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment", + "name": "myAssignment", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "myAssignment", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/myAssignment/myAssignment.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + } + ] + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listGuestConfigurationConnectedVMwarevSphereAssignments.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listGuestConfigurationConnectedVMwarevSphereAssignments.json new file mode 100644 index 000000000000..c46cce0791ab --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listGuestConfigurationConnectedVMwarevSphereAssignments.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.ConnectedVMwarevSphere/virtualmachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2", + "name": "AuditSecureProtocol2", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.ConnectedVMwarevSphere/virtualmachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol2", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol2/AuditSecureProtocol2_1.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + }, + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.ConnectedVMwarevSphere/virtualmachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment", + "name": "myAssignment", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.ConnectedVMwarevSphere/virtualmachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "myAssignment", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/myAssignment/myAssignment.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + } + ] + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listGuestConfigurationHCRPAssignments.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listGuestConfigurationHCRPAssignments.json new file mode 100644 index 000000000000..159e0721c276 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listGuestConfigurationHCRPAssignments.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "machineName": "myMachineName", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2", + "name": "AuditSecureProtocol2", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol2", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol2/AuditSecureProtocol2_1.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + }, + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment", + "name": "myAssignment", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "myAssignment", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/myAssignment/myAssignment.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + } + ] + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listOperations.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listOperations.json new file mode 100644 index 000000000000..6361eb97dade --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listOperations.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "Microsoft.GuestConfiguration/guestConfigurationAssignments/write", + "display": { + "provider": "Microsoft Guest Configuration", + "resource": "Microsoft.GuestConfiguration/guestConfigurationAssignments", + "operation": "Microsoft.GuestConfiguration/guestConfigurationAssignments/write", + "description": "Create new guest configuration assignment." + }, + "properties": null + }, + { + "name": "Microsoft.GuestConfiguration/register/action", + "display": { + "provider": "Microsoft Guest Configuration", + "resource": "Register", + "operation": "Registers the feature for Microsoft.GuestConfiguration.", + "description": "Registers the subscription for the Microsoft.GuestConfiguration resource provider." + }, + "properties": null + }, + { + "name": "Microsoft.GuestConfiguration/guestConfigurationAssignments/read", + "display": { + "provider": "Microsoft Guest Configuration", + "resource": "Microsoft.GuestConfiguration/guestConfigurationAssignments", + "operation": "Microsoft.GuestConfiguration/guestConfigurationAssignments/read", + "description": "Get guest configuration assignment." + }, + "properties": null + }, + { + "name": "Microsoft.GuestConfiguration/guestConfigurationAssignments/reports/read", + "display": { + "provider": "Microsoft Guest Configuration", + "resource": "Microsoft.GuestConfiguration/guestConfigurationAssignments", + "operation": "Microsoft.GuestConfiguration/guestConfigurationAssignments/reports/read", + "description": "Get guest configuration assignment report." + }, + "properties": null + } + ] + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listRGGuestConfigurationAssignments.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listRGGuestConfigurationAssignments.json new file mode 100644 index 000000000000..34128e287758 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listRGGuestConfigurationAssignments.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2", + "name": "AuditSecureProtocol2", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol2", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol2/AuditSecureProtocol2_1.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + }, + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment", + "name": "myAssignment", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "myAssignment", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/myAssignment/myAssignment.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + } + ] + }, + "204": {} + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listSubGuestConfigurationAssignments.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listSubGuestConfigurationAssignments.json new file mode 100644 index 000000000000..1c510b030d04 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listSubGuestConfigurationAssignments.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2", + "name": "AuditSecureProtocol2", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol2", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol2/AuditSecureProtocol2_1.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + }, + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment", + "name": "myAssignment", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "myAssignment", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/myAssignment/myAssignment.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + } + ] + }, + "204": {} + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listVMSSGuestConfigurationAssignments.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listVMSSGuestConfigurationAssignments.json new file mode 100644 index 000000000000..64bf536bd16b --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/examples/listVMSSGuestConfigurationAssignments.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmssName": "myVMSSName", + "api-version": "2024-04-05" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/myVMSSName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2", + "name": "AuditSecureProtocol2", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/myVMSSName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol2", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol2/AuditSecureProtocol2_1.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + }, + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/myVMSSName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment", + "name": "myAssignment", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/myVMSSName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "myAssignment", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/myAssignment/myAssignment.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + } + ] + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/guestconfiguration.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/guestconfiguration.json new file mode 100644 index 000000000000..43ec0f14e009 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/guestconfiguration.json @@ -0,0 +1,2191 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-05", + "title": "GuestConfiguration" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}": { + "put": { + "tags": [ + "GuestConfigurationAssignments" + ], + "operationId": "GuestConfigurationAssignments_CreateOrUpdate", + "description": "Creates an association between a VM and guest configuration", + "x-ms-examples": { + "Create or update guest configuration assignment": { + "$ref": "./examples/createOrUpdateGuestConfigurationAssignment.json" + } + }, + "parameters": [ + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the guest configuration assignment." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + }, + "description": "Parameters supplied to the create or update guest configuration assignment." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created. The guest configuration assignment for the VM was created successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "200": { + "description": "OK. The guest configuration assignment for the VM was updated successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "get": { + "tags": [ + "GuestConfigurationAssignments" + ], + "operationId": "GuestConfigurationAssignments_Get", + "description": "Get information about a guest configuration assignment", + "x-ms-examples": { + "Get a guest configuration assignment": { + "$ref": "./examples/getGuestConfigurationAssignment.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assignment name." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The guest configuration assignment was returned successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "tags": [ + "GuestConfigurationAssignments" + ], + "operationId": "GuestConfigurationAssignments_Delete", + "description": "Delete a guest configuration assignment", + "x-ms-examples": { + "Delete an guest configuration assignment": { + "$ref": "./examples/deleteGuestConfigurationAssignment.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the guest configuration assignment" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments": { + "get": { + "tags": [ + "GuestConfigurationAssignments" + ], + "operationId": "GuestConfigurationAssignments_SubscriptionList", + "description": "List all guest configuration assignments for a subscription.", + "x-ms-examples": { + "List all guest configuration assignments for a subscription": { + "$ref": "./examples/listSubGuestConfigurationAssignments.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentList" + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments": { + "get": { + "tags": [ + "GuestConfigurationAssignments" + ], + "operationId": "GuestConfigurationAssignments_RGList", + "description": "List all guest configuration assignments for a resource group.", + "x-ms-examples": { + "List all guest configuration assignments for a resource group": { + "$ref": "./examples/listRGGuestConfigurationAssignments.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentList" + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments": { + "get": { + "tags": [ + "GuestConfigurationAssignments" + ], + "operationId": "GuestConfigurationAssignments_List", + "description": "List all guest configuration assignments for a virtual machine.", + "x-ms-examples": { + "List all guest configuration assignments for a virtual machine": { + "$ref": "./examples/listGuestConfigurationAssignments.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}/reports": { + "get": { + "tags": [ + "GuestConfigurationAssignmentReports" + ], + "operationId": "GuestConfigurationAssignmentReports_List", + "description": "List all reports for the guest configuration assignment, latest report first.", + "x-ms-examples": { + "List all guest configuration assignments for a virtual machine": { + "$ref": "./examples/listAllGuestConfigurationAssignmentReports.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assignment name." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. This response is due one of these two reasons: 1. Reports were returned successfully 2. Guest configuration assignment was found, but VM is not registered yet, hence no reports returned.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentReportList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}/reports/{reportId}": { + "get": { + "tags": [ + "GuestConfigurationAssignmentReports" + ], + "operationId": "GuestConfigurationAssignmentReports_Get", + "description": "Get a report for the guest configuration assignment, by reportId.", + "x-ms-examples": { + "Get a guest configuration assignment report by Id for a virtual machine": { + "$ref": "./examples/getGuestConfigurationAssignmentReportById.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assignment name." + }, + { + "name": "reportId", + "in": "path", + "required": true, + "type": "string", + "description": "The GUID for the guest configuration assignment report." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. This response is due one of these two reasons: 1. Report was returned successfully 2. Guest configuration assignment was found, but VM is not registered yet, hence no report was returned.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentReport" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}": { + "put": { + "tags": [ + "GuestConfigurationHCRPAssignments" + ], + "operationId": "GuestConfigurationHCRPAssignments_CreateOrUpdate", + "description": "Creates an association between a ARC machine and guest configuration", + "x-ms-examples": { + "Create or update guest configuration assignment": { + "$ref": "./examples/createOrUpdateGuestConfigurationHCRPAssignment.json" + } + }, + "parameters": [ + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the guest configuration assignment." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + }, + "description": "Parameters supplied to the create or update guest configuration assignment." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/MachineNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created. The guest configuration assignment for the ARC machine was created successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "200": { + "description": "OK. The guest configuration assignment for the ARC machine was updated successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "get": { + "tags": [ + "GuestConfigurationHCRPAssignments" + ], + "operationId": "GuestConfigurationHCRPAssignments_Get", + "description": "Get information about a guest configuration assignment", + "x-ms-examples": { + "Get a guest configuration assignment": { + "$ref": "./examples/getGuestConfigurationHCRPAssignment.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assignment name." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/MachineNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The guest configuration assignment was returned successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "tags": [ + "GuestConfigurationHCRPAssignments" + ], + "operationId": "GuestConfigurationHCRPAssignments_Delete", + "description": "Delete a guest configuration assignment", + "x-ms-examples": { + "Delete an guest configuration assignment": { + "$ref": "./examples/deleteGuestConfigurationHCRPAssignment.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the guest configuration assignment" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/MachineNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments": { + "get": { + "tags": [ + "GuestConfigurationHCRPAssignments" + ], + "operationId": "GuestConfigurationHCRPAssignments_List", + "description": "List all guest configuration assignments for an ARC machine.", + "x-ms-examples": { + "List all guest configuration assignments for a virtual machine": { + "$ref": "./examples/listGuestConfigurationHCRPAssignments.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/MachineNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}/reports": { + "get": { + "tags": [ + "GuestConfigurationAssignmentHCRPReports" + ], + "operationId": "GuestConfigurationHCRPAssignmentReports_List", + "description": "List all reports for the guest configuration assignment, latest report first.", + "x-ms-examples": { + "List all guest configuration assignments for a virtual machine": { + "$ref": "./examples/listAllGuestConfigurationHCRPAssignmentReports.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assignment name." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/MachineNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. This response is due one of these two reasons: 1. Reports were returned successfully 2. Guest configuration assignment was found, but machine is not registered yet, hence no reports returned.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentReportList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}/reports/{reportId}": { + "get": { + "tags": [ + "GuestConfigurationAssignmentHCRPReports" + ], + "operationId": "GuestConfigurationHCRPAssignmentReports_Get", + "description": "Get a report for the guest configuration assignment, by reportId.", + "x-ms-examples": { + "Get a guest configuration assignment report by Id for a virtual machine": { + "$ref": "./examples/getGuestConfigurationHCRPAssignmentReportById.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assignment name." + }, + { + "name": "reportId", + "in": "path", + "required": true, + "type": "string", + "description": "The GUID for the guest configuration assignment report." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/MachineNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. This response is due one of these two reasons: 1. Report was returned successfully 2. Guest configuration assignment was found, but machine is not registered yet, hence no report was returned.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentReport" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{name}": { + "put": { + "tags": [ + "GuestConfigurationAssignments" + ], + "operationId": "GuestConfigurationAssignmentsVMSS_CreateOrUpdate", + "description": "Creates an association between a VMSS and guest configuration", + "x-ms-examples": { + "Create or update guest configuration assignment": { + "$ref": "./examples/createOrUpdateGuestConfigurationVMSSAssignment.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VMSSNameParameter" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the guest configuration assignment." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + }, + "description": "Parameters supplied to the create or update guest configuration assignment." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created. The guest configuration assignment for the VMSS was created successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "200": { + "description": "OK. The guest configuration assignment for the VMSS was updated successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "get": { + "tags": [ + "GuestConfigurationAssignments" + ], + "operationId": "GuestConfigurationAssignmentsVMSS_Get", + "description": "Get information about a guest configuration assignment for VMSS", + "x-ms-examples": { + "Get a VMSS guest configuration assignment": { + "$ref": "./examples/getVMSSGuestConfigurationAssignment.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VMSSNameParameter" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assignment name." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The guest configuration assignment was returned successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "tags": [ + "GuestConfigurationAssignments" + ], + "operationId": "GuestConfigurationAssignmentsVMSS_Delete", + "description": "Delete a guest configuration assignment for VMSS", + "x-ms-examples": { + "Delete an guest configuration assignment for VMSS": { + "$ref": "./examples/deleteGuestConfigurationVMSSAssignment.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VMSSNameParameter" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assignment name." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "204": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments": { + "get": { + "tags": [ + "GuestConfigurationAssignments" + ], + "operationId": "GuestConfigurationAssignmentsVMSS_List", + "description": "List all guest configuration assignments for VMSS.", + "x-ms-examples": { + "List all guest configuration assignments for VMSS": { + "$ref": "./examples/listVMSSGuestConfigurationAssignments.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VMSSNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{name}/reports": { + "get": { + "tags": [ + "GuestConfigurationAssignmentReports" + ], + "operationId": "GuestConfigurationAssignmentReportsVMSS_List", + "description": "List all reports for the VMSS guest configuration assignment, latest report first.", + "x-ms-examples": { + "List all reports for the VMSS guest configuration assignment with latest report first": { + "$ref": "./examples/listAllVMSSGuestConfigurationAssignmentReports.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VMSSNameParameter" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assignment name." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. This response is due one of these two reasons: 1. Reports were returned successfully 2. Guest configuration assignment was found, but VM is not registered yet, hence no reports returned.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentReportList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{name}/reports/{id}": { + "get": { + "tags": [ + "GuestConfigurationAssignmentReports" + ], + "operationId": "GuestConfigurationAssignmentReportsVMSS_Get", + "description": "Get a report for the VMSS guest configuration assignment, by reportId.", + "x-ms-examples": { + "Get a guest configuration assignment report by Id for a virtual machine scale set": { + "$ref": "./examples/getVMSSGuestConfigurationAssignmentReportById.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VMSSNameParameter" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assignment name." + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string", + "description": "The GUID for the guest configuration assignment report." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. This response is due one of these two reasons: 1. Report was returned successfully 2. Guest configuration assignment was found, but VM is not registered yet, hence no report was returned.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentReport" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualmachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}": { + "put": { + "tags": [ + "GuestConfigurationConnectedVMwarevSphereAssignments" + ], + "operationId": "GuestConfigurationConnectedVMwarevSphereAssignments_CreateOrUpdate", + "description": "Creates an association between a Connected VM Sphere machine and guest configuration", + "x-ms-examples": { + "Create or update guest configuration assignment": { + "$ref": "./examples/createOrUpdateGuestConfigurationConnectedVMwarevSphereAssignment.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[^<>%&:\\\\?/#]*$", + "description": "Name of the guest configuration assignment." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + }, + "description": "Parameters supplied to the create or update guest configuration assignment." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created. The guest configuration assignment for the Connected VM Sphere machine was created successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "200": { + "description": "OK. The guest configuration assignment for the Connected VM Sphere machine was updated successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "get": { + "tags": [ + "GuestConfigurationConnectedVMwarevSphereAssignments" + ], + "operationId": "GuestConfigurationConnectedVMwarevSphereAssignments_Get", + "description": "Get information about a guest configuration assignment", + "x-ms-examples": { + "Get a guest configuration assignment": { + "$ref": "./examples/getGuestConfigurationConnectedVMwarevSphereAssignment.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[^<>%&:\\\\?/#]*$", + "description": "The guest configuration assignment name." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The guest configuration assignment was returned successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "tags": [ + "GuestConfigurationConnectedVMwarevSphereAssignments" + ], + "operationId": "GuestConfigurationConnectedVMwarevSphereAssignments_Delete", + "description": "Delete a guest configuration assignment", + "x-ms-examples": { + "Delete an guest configuration assignment": { + "$ref": "./examples/deleteGuestConfigurationConnectedVMwarevSphereAssignment.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[^<>%&:\\\\?/#]*$", + "description": "Name of the guest configuration assignment" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualmachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments": { + "get": { + "tags": [ + "GuestConfigurationConnectedVMwarevSphereAssignments" + ], + "operationId": "GuestConfigurationConnectedVMwarevSphereAssignments_List", + "description": "List all guest configuration assignments for an ARC machine.", + "x-ms-examples": { + "List all guest configuration assignments for a virtual machine": { + "$ref": "./examples/listGuestConfigurationConnectedVMwarevSphereAssignments.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualmachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}/reports": { + "get": { + "tags": [ + "GuestConfigurationConnectedVMwarevSphereAssignmentsReports" + ], + "operationId": "GuestConfigurationConnectedVMwarevSphereAssignmentsReports_List", + "description": "List all reports for the guest configuration assignment, latest report first.", + "x-ms-examples": { + "List all guest configuration assignments for a virtual machine": { + "$ref": "./examples/listAllGuestConfigurationConnectedVMwarevSphereAssignmentsReports.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[^<>%&:\\\\?/#]*$", + "description": "The guest configuration assignment name." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. This response is due one of these two reasons: 1. Reports were returned successfully 2. Guest configuration assignment was found, but machine is not registered yet, hence no reports returned.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentReportList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualmachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}/reports/{reportId}": { + "get": { + "tags": [ + "GuestConfigurationConnectedVMwarevSphereAssignmentsReports" + ], + "operationId": "GuestConfigurationConnectedVMwarevSphereAssignmentsReports_Get", + "description": "Get a report for the guest configuration assignment, by reportId.", + "x-ms-examples": { + "Get a guest configuration assignment report by Id for a virtual machine": { + "$ref": "./examples/getGuestConfigurationConnectedVMwarevSphereAssignmentReportById.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[^<>%&:\\\\?/#]*$", + "description": "The guest configuration assignment name." + }, + { + "name": "reportId", + "in": "path", + "required": true, + "type": "string", + "description": "The GUID for the guest configuration assignment report." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. This response is due one of these two reasons: 1. Report was returned successfully 2. Guest configuration assignment was found, but machine is not registered yet, hence no report was returned.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentReport" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/providers/Microsoft.GuestConfiguration/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available GuestConfiguration REST API operations.", + "x-ms-examples": { + "Lists all of the available GuestConfiguration REST API operations": { + "$ref": "./examples/listOperations.json" + } + }, + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/OperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + } + }, + "definitions": { + "GuestConfigurationAssignmentList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GuestConfigurationAssignment" + }, + "description": "Result of the list guest configuration assignment operation." + } + }, + "description": "The response of the list guest configuration assignment operation." + }, + "GuestConfigurationAssignment": { + "properties": { + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/GuestConfigurationAssignmentProperties", + "description": "Properties of the Guest configuration assignment." + }, + "systemData": { + "readOnly": true, + "type": "object", + "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/ProxyResource" + } + ], + "description": "Guest configuration assignment is an association between a machine and guest configuration." + }, + "GuestConfigurationNavigation": { + "description": "Guest configuration is an artifact that encapsulates DSC configuration and its dependencies. The artifact is a zip file containing DSC configuration (as MOF) and dependent resources and other dependencies like modules.", + "properties": { + "kind": { + "type": "string", + "description": "Kind of the guest configuration. For example:DSC", + "x-ms-enum": { + "name": "kind", + "modelAsString": true + }, + "enum": [ + "DSC" + ] + }, + "name": { + "type": "string", + "description": "Name of the guest configuration." + }, + "version": { + "type": "string", + "description": "Version of the guest configuration." + }, + "contentUri": { + "type": "string", + "description": "Uri of the storage where guest configuration package is uploaded." + }, + "contentHash": { + "type": "string", + "description": "Combined hash of the guest configuration package and configuration parameters." + }, + "contentManagedIdentity": { + "type": "string", + "description": "Managed identity with storage access of the guest configuration package and configuration parameters." + }, + "assignmentType": { + "type": "string", + "description": "Specifies the assignment type and execution of the configuration. Possible values are Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect and ApplyAndMonitor.", + "x-ms-enum": { + "name": "assignmentType", + "modelAsString": true + }, + "enum": [ + "Audit", + "DeployAndAutoCorrect", + "ApplyAndAutoCorrect", + "ApplyAndMonitor" + ] + }, + "assignmentSource": { + "type": "string", + "readOnly": true, + "description": "Specifies the origin of the configuration.", + "x-nullable": true + }, + "contentType": { + "type": "string", + "readOnly": true, + "description": "Specifies the content type of the configuration. Possible values could be Builtin or Custom.", + "x-nullable": true + }, + "configurationParameter": { + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationParameter" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The configuration parameters for the guest configuration." + }, + "configurationProtectedParameter": { + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationParameter" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The protected configuration parameters for the guest configuration." + }, + "configurationSetting": { + "$ref": "#/definitions/ConfigurationSetting", + "readOnly": true, + "description": "The configuration setting for the guest configuration." + } + } + }, + "ConfigurationParameter": { + "properties": { + "name": { + "type": "string", + "readOnly": false, + "description": "Name of the configuration parameter." + }, + "value": { + "type": "string", + "readOnly": false, + "description": "Value of the configuration parameter." + } + }, + "description": "Represents a configuration parameter." + }, + "ConfigurationSetting": { + "properties": { + "configurationMode": { + "type": "string", + "readOnly": true, + "description": "Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect.", + "x-ms-enum": { + "name": "configurationMode", + "modelAsString": true + }, + "enum": [ + "ApplyOnly", + "ApplyAndMonitor", + "ApplyAndAutoCorrect" + ] + }, + "allowModuleOverwrite": { + "type": "boolean", + "readOnly": true, + "description": "If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false" + }, + "actionAfterReboot": { + "type": "string", + "readOnly": true, + "description": "Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration", + "x-ms-enum": { + "name": "actionAfterReboot", + "modelAsString": true + }, + "enum": [ + "ContinueConfiguration", + "StopConfiguration" + ] + }, + "refreshFrequencyMins": { + "type": "number", + "readOnly": true, + "default": 30, + "description": "The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30." + }, + "rebootIfNeeded": { + "type": "boolean", + "readOnly": true, + "description": "Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module." + }, + "configurationModeFrequencyMins": { + "type": "number", + "readOnly": true, + "default": 15, + "description": "How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15." + } + }, + "description": "Configuration setting of LCM (Local Configuration Manager)." + }, + "AssignmentReport": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "ARM resource id of the report for the guest configuration assignment." + }, + "reportId": { + "type": "string", + "readOnly": true, + "description": "GUID that identifies the guest configuration assignment report under a subscription, resource group." + }, + "assignment": { + "$ref": "#/definitions/AssignmentInfo", + "description": "Configuration details of the guest configuration assignment." + }, + "vm": { + "$ref": "#/definitions/VMInfo", + "description": "Information about the VM." + }, + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Start date and time of the guest configuration assignment compliance status check." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "End date and time of the guest configuration assignment compliance status check." + }, + "complianceStatus": { + "type": "string", + "readOnly": true, + "description": "A value indicating compliance status of the machine for the assigned guest configuration.", + "x-ms-enum": { + "name": "complianceStatus", + "modelAsString": true + }, + "enum": [ + "Compliant", + "NonCompliant", + "Pending" + ] + }, + "operationType": { + "type": "string", + "readOnly": true, + "description": "Type of report, Consistency or Initial", + "x-ms-enum": { + "name": "type", + "modelAsString": true + }, + "enum": [ + "Consistency", + "Initial" + ] + }, + "resources": { + "type": "array", + "items": { + "$ref": "#/definitions/AssignmentReportResource" + }, + "x-ms-identifiers": [], + "description": "The list of resources for which guest configuration assignment compliance is checked." + } + } + }, + "GuestConfigurationAssignmentProperties": { + "properties": { + "targetResourceId": { + "type": "string", + "readOnly": true, + "description": "VM resource Id.", + "x-nullable": true + }, + "guestConfiguration": { + "$ref": "#/definitions/GuestConfigurationNavigation", + "description": "The guest configuration to assign." + }, + "complianceStatus": { + "type": "string", + "readOnly": true, + "description": "A value indicating compliance status of the machine for the assigned guest configuration.", + "x-ms-enum": { + "name": "complianceStatus", + "modelAsString": true + }, + "enum": [ + "Compliant", + "NonCompliant", + "Pending" + ] + }, + "lastComplianceStatusChecked": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Date and time when last compliance status was checked.", + "x-nullable": true + }, + "latestReportId": { + "type": "string", + "readOnly": true, + "description": "Id of the latest report for the guest configuration assignment. ", + "x-nullable": true + }, + "parameterHash": { + "type": "string", + "readOnly": true, + "description": "parameter hash for the guest configuration assignment. ", + "x-nullable": true + }, + "latestAssignmentReport": { + "$ref": "#/definitions/AssignmentReport", + "description": "Last reported guest configuration assignment report." + }, + "context": { + "type": "string", + "description": "The source which initiated the guest configuration assignment. Ex: Azure Policy" + }, + "assignmentHash": { + "type": "string", + "readOnly": true, + "description": "Combined hash of the configuration package and parameters.", + "x-nullable": true + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response.", + "x-nullable": true, + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + }, + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Created" + ] + }, + "resourceType": { + "type": "string", + "readOnly": true, + "description": "Type of the resource - VMSS / VM", + "x-nullable": true + }, + "vmssVMList": { + "type": "array", + "items": { + "$ref": "#/definitions/VMSSVMInfo" + }, + "x-ms-identifiers": [ + "vmId" + ], + "description": "The list of VM Compliance data for VMSS" + } + }, + "description": "Guest configuration assignment properties." + }, + "GuestConfigurationAssignmentReportList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GuestConfigurationAssignmentReport" + }, + "description": "List of reports for the guest configuration. Report contains information such as compliance status, reason and more." + } + }, + "description": "List of guest configuration assignment reports." + }, + "GuestConfigurationAssignmentReport": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "ARM resource id of the report for the guest configuration assignment." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "GUID that identifies the guest configuration assignment report under a subscription, resource group." + }, + "properties": { + "$ref": "#/definitions/GuestConfigurationAssignmentReportProperties", + "description": "Properties of the guest configuration report." + } + }, + "description": "Report for the guest configuration assignment. Report contains information such as compliance status, reason, and more." + }, + "GuestConfigurationAssignmentReportProperties": { + "properties": { + "complianceStatus": { + "type": "string", + "readOnly": true, + "description": "A value indicating compliance status of the machine for the assigned guest configuration.", + "x-ms-enum": { + "name": "complianceStatus", + "modelAsString": true + }, + "enum": [ + "Compliant", + "NonCompliant", + "Pending" + ] + }, + "reportId": { + "type": "string", + "readOnly": true, + "description": "GUID that identifies the guest configuration assignment report under a subscription, resource group." + }, + "assignment": { + "$ref": "#/definitions/AssignmentInfo", + "description": "Configuration details of the guest configuration assignment." + }, + "vm": { + "$ref": "#/definitions/VMInfo", + "description": "Information about the VM." + }, + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Start date and time of the guest configuration assignment compliance status check." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "End date and time of the guest configuration assignment compliance status check." + }, + "details": { + "$ref": "#/definitions/AssignmentReportDetails", + "description": "Details of the assignment report.", + "x-nullable": true + }, + "vmssResourceId": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id of the VMSS." + } + }, + "description": "Report for the guest configuration assignment. Report contains information such as compliance status, reason, and more." + }, + "AssignmentInfo": { + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "Name of the guest configuration assignment." + }, + "configuration": { + "$ref": "#/definitions/ConfigurationInfo", + "description": "Information about the configuration." + } + }, + "description": "Information about the guest configuration assignment." + }, + "VMInfo": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id of the VM." + }, + "uuid": { + "type": "string", + "readOnly": true, + "description": "UUID(Universally Unique Identifier) of the VM." + } + }, + "description": "Information about the VM." + }, + "ConfigurationInfo": { + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "Name of the configuration." + }, + "version": { + "type": "string", + "readOnly": true, + "description": "Version of the configuration." + } + }, + "description": "Information about the configuration." + }, + "AssignmentReportDetails": { + "properties": { + "complianceStatus": { + "type": "string", + "readOnly": true, + "description": "A value indicating compliance status of the machine for the assigned guest configuration.", + "x-ms-enum": { + "name": "complianceStatus", + "modelAsString": true + }, + "enum": [ + "Compliant", + "NonCompliant", + "Pending" + ] + }, + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Start date and time of the guest configuration assignment compliance status check." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "End date and time of the guest configuration assignment compliance status check." + }, + "jobId": { + "type": "string", + "readOnly": true, + "description": "GUID of the report." + }, + "operationType": { + "type": "string", + "readOnly": true, + "description": "Type of report, Consistency or Initial", + "x-ms-enum": { + "name": "type", + "modelAsString": true + }, + "enum": [ + "Consistency", + "Initial" + ] + }, + "resources": { + "type": "array", + "items": { + "$ref": "#/definitions/AssignmentReportResource" + }, + "x-ms-identifiers": [], + "description": "The list of resources for which guest configuration assignment compliance is checked." + } + }, + "description": "Details of the guest configuration assignment report." + }, + "AssignmentReportResource": { + "properties": { + "complianceStatus": { + "type": "string", + "readOnly": true, + "description": "A value indicating compliance status of the machine for the assigned guest configuration.", + "x-ms-enum": { + "name": "complianceStatus", + "modelAsString": true + }, + "enum": [ + "Compliant", + "NonCompliant", + "Pending" + ] + }, + "resourceId": { + "type": "string", + "readOnly": true, + "description": "Name of the guest configuration assignment resource setting." + }, + "reasons": { + "type": "array", + "items": { + "$ref": "#/definitions/AssignmentReportResourceComplianceReason" + }, + "x-ms-identifiers": [ + "phrase", + "code" + ], + "description": "Compliance reason and reason code for a resource." + }, + "properties": { + "type": "object", + "readOnly": true, + "description": "Properties of a guest configuration assignment resource." + } + }, + "description": "The guest configuration assignment resource." + }, + "AssignmentReportResourceComplianceReason": { + "properties": { + "phrase": { + "type": "string", + "readOnly": true, + "description": "Reason for the compliance of the guest configuration assignment resource." + }, + "code": { + "type": "string", + "readOnly": true, + "description": "Code for the compliance of the guest configuration assignment resource." + } + }, + "description": "Reason and code for the compliance of the guest configuration assignment resource." + }, + "VMSSVMInfo": { + "properties": { + "vmId": { + "type": "string", + "readOnly": true, + "description": "UUID of the VM." + }, + "vmResourceId": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id of the VM." + }, + "complianceStatus": { + "type": "string", + "readOnly": true, + "description": "A value indicating compliance status of the machine for the assigned guest configuration.", + "x-ms-enum": { + "name": "complianceStatus", + "modelAsString": true + }, + "enum": [ + "Compliant", + "NonCompliant", + "Pending" + ] + }, + "latestReportId": { + "type": "string", + "readOnly": true, + "description": "Id of the latest report for the guest configuration assignment. ", + "x-nullable": true + }, + "lastComplianceChecked": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Date and time when last compliance status was checked.", + "x-nullable": true + } + }, + "description": "Information about VMSS VM" + } + }, + "parameters": {} +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/scenarios/GuestAssignmentTests.yaml b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/scenarios/GuestAssignmentTests.yaml new file mode 100644 index 000000000000..391b823de7c7 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2024-04-05/scenarios/GuestAssignmentTests.yaml @@ -0,0 +1,188 @@ +# yaml-language-server: $schema=https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/documentation/api-scenario/references/v1.2/schema.json +scope: ResourceGroup +variables: + guestConfigurationAssignmentName: + type: string + prefix: guestcon + vmName: + type: string + prefix: vmname + vmssName: + type: string + prefix: vmssname + name: + type: string + prefix: name + adminPassword: + type: secureString + prefix: Admin@1 + +prepareSteps: + - step: createVirtualNetwork + operationId: VirtualNetworks_CreateOrUpdate + readmeTag: ../../../../../../network/resource-manager/readme.md#package-2021-05 + parameters: + virtualNetworkName: $(vmName)-VNET + parameters: + location: $(location) + properties: + addressSpace: + addressPrefixes: + - 10.0.0.0/16 + subnets: + - name: $(vmName)-Subnet + properties: + addressPrefix: 10.0.0.0/24 + outputVariables: + subnetId: + type: string + fromResponse: /properties/subnets/0/id + - step: createNSG + operationId: NetworkSecurityGroups_CreateOrUpdate + readmeTag: ../../../../../../network/resource-manager/readme.md#package-2021-05 + parameters: + networkSecurityGroupName: $(vmName)-NSG + parameters: + location: $(location) + properties: + securityRules: + - name: rdp + properties: + protocol: Tcp + sourcePortRange: "*" + destinationPortRange: "3389" + sourceAddressPrefix: "*" + destinationAddressPrefix: "*" + access: Allow + priority: 1000 + direction: Inbound + outputVariables: + networkSecurityGroupId: + type: string + fromResponse: /id + - step: createPublicIP + operationId: PublicIPAddresses_CreateOrUpdate + readmeTag: ../../../../../../network/resource-manager/readme.md#package-2021-05 + parameters: + publicIpAddressName: $(vmName)-PublicIP + parameters: + location: $(location) + sku: + name: Standard + properties: + publicIPAllocationMethod: Static + outputVariables: + publicIPAddressId: + type: string + fromResponse: /id + - step: createNIC + operationId: NetworkInterfaces_CreateOrUpdate + readmeTag: ../../../../../../network/resource-manager/readme.md#package-2021-05 + parameters: + networkInterfaceName: $(vmName)-VMNic + parameters: + location: $(location) + properties: + ipConfigurations: + - name: ipconfig-$(vmName) + properties: + privateIPAllocationMethod: Dynamic + subnet: + id: $(subnetId) + publicIpAddress: + id: $(publicIPAddressId) + networkSecurityGroup: + id: $(networkSecurityGroupId) + outputVariables: + vmNicId: + type: string + fromResponse: /id + - step: createVirtualMachine + operationId: VirtualMachines_CreateOrUpdate + readmeTag: ../../../../../../compute/resource-manager/readme.md#package-2022-11-01 + parameters: + vmName: $(vmName) + parameters: + location: $(location) + properties: + hardwareProfile: + vmSize: Standard_A2_v2 + networkProfile: + networkInterfaces: + - id: $(vmNicId) + storageProfile: + osDisk: + createOption: fromImage + caching: ReadWrite + imageReference: + publisher: MicrosoftWindowsServer + offer: WindowsServer + sku: 2019-Datacenter + version: latest + osProfile: + computerName: $(vmName) + adminUsername: azureuser + adminPassword: $(adminPassword) + additionalCapabilities: {} + - step: createVirtualMachineScaleSets + operationId: VirtualMachineScaleSets_CreateOrUpdate + readmeTag: ../../../../../../compute/resource-manager/readme.md#package-2022-11-01 + parameters: + vmScaleSetName: $(vmssName) + parameters: + location: $(location) + properties: + overprovision: false + upgradePolicy: + mode: Automatic + automaticOSUpgradePolicy: + enableAutomaticOSUpgrade: false + virtualMachineProfile: + storageProfile: + osDisk: + createOption: fromImage + imageReference: + publisher: MicrosoftWindowsServer + offer: WindowsServer + sku: 2019-Datacenter + version: latest + osProfile: + computerNamePrefix: vmss + adminUsername: $(vmssName) + adminPassword: $(adminPassword) + networkProfile: + networkInterfaceConfigurations: + - name: $(vmssName) + properties: + primary: true + ipConfigurations: + - name: ipconfig-$(vmssName) + properties: + subnet: + id: $(subnetId) + sku: + name: Standard_A1_v2 + capacity: 1 + tier: Standard +scenarios: + - scenario: GeneratedScenario + steps: + - operationId: GuestConfigurationAssignments_CreateOrUpdate + exampleFile: ../../2024-04-05/examples/createOrUpdateGuestConfigurationAssignment.json + - operationId: GuestConfigurationAssignments_SubscriptionList + exampleFile: ../../2024-04-05/examples/listSubGuestConfigurationAssignments.json + - operationId: GuestConfigurationAssignments_RGList + exampleFile: ../../2024-04-05/examples/listRGGuestConfigurationAssignments.json + - operationId: Operations_List + exampleFile: ../../2024-04-05/examples/listOperations.json + - operationId: GuestConfigurationAssignments_Get + exampleFile: ../../2024-04-05/examples/getGuestConfigurationAssignment.json + - operationId: GuestConfigurationAssignments_List + exampleFile: ../../2024-04-05/examples/listGuestConfigurationAssignments.json + - operationId: GuestConfigurationAssignments_Delete + exampleFile: ../../2024-04-05/examples/deleteGuestConfigurationAssignment.json + - operationId: GuestConfigurationAssignmentsVMSS_CreateOrUpdate + exampleFile: ../../2024-04-05/examples/createOrUpdateGuestConfigurationVMSSAssignment.json + - operationId: GuestConfigurationAssignmentsVMSS_Get + exampleFile: ../../2024-04-05/examples/getVMSSGuestConfigurationAssignment.json + diff --git a/specification/guestconfiguration/resource-manager/readme.go.md b/specification/guestconfiguration/resource-manager/readme.go.md index a1abf43d714a..5172389f1de4 100644 --- a/specification/guestconfiguration/resource-manager/readme.go.md +++ b/specification/guestconfiguration/resource-manager/readme.go.md @@ -28,7 +28,17 @@ batch: - tag: package-2020-06-25 - tag: package-2021-01-25 - tag: package-2022-01-25 + - tag: package-2024-04-05 ``` +### Tag: package-2024-04-05 and go + +These settings apply only when `--tag=package-2024-04-05 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2024-04-05' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2024-04-05/$(namespace) +``` + ### Tag: package-2022-01-25 and go These settings apply only when `--tag=package-2022-01-25 --go` is specified on the command line. diff --git a/specification/guestconfiguration/resource-manager/readme.md b/specification/guestconfiguration/resource-manager/readme.md index 8c0424e7ef10..be2a587ff043 100644 --- a/specification/guestconfiguration/resource-manager/readme.md +++ b/specification/guestconfiguration/resource-manager/readme.md @@ -28,7 +28,7 @@ These are the global settings for the Guest Configuration API. title: GuestConfigurationClient description: Guest Configuration Client openapi-type: arm -tag: package-2022-01-25 +tag: package-2024-04-05 ``` ``` yaml !$(csharp) @@ -36,6 +36,15 @@ modelerfour: flatten-models: false ``` +### Tag: package-2024-04-05 + +These settings apply only when `--tag=package-2024-04-05` is specified on the command line. + +```yaml $(tag) == 'package-2024-04-05' +input-file: + - Microsoft.GuestConfiguration/stable/2024-04-05/guestconfiguration.json +``` + ### Tag: package-2022-01-25 These settings apply only when `--tag=package-2022-01-25` is specified on the command line. diff --git a/specification/healthdataaiservices/HealthDataAIServices.DeidServices/client.tsp b/specification/healthdataaiservices/HealthDataAIServices.DeidServices/client.tsp new file mode 100644 index 000000000000..046424f54abc --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.DeidServices/client.tsp @@ -0,0 +1,4 @@ +import "./main.tsp"; +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; diff --git a/specification/healthdataaiservices/HealthDataAIServices.DeidServices/examples/2024-07-12-preview/CancelJob.json b/specification/healthdataaiservices/HealthDataAIServices.DeidServices/examples/2024-07-12-preview/CancelJob.json new file mode 100644 index 000000000000..c70063471c24 --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.DeidServices/examples/2024-07-12-preview/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/HealthDataAIServices.DeidServices/examples/2024-07-12-preview/CreateJob.json b/specification/healthdataaiservices/HealthDataAIServices.DeidServices/examples/2024-07-12-preview/CreateJob.json new file mode 100644 index 000000000000..87689147cfcf --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.DeidServices/examples/2024-07-12-preview/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/HealthDataAIServices.DeidServices/examples/2024-07-12-preview/Deidentify.json b/specification/healthdataaiservices/HealthDataAIServices.DeidServices/examples/2024-07-12-preview/Deidentify.json new file mode 100644 index 000000000000..e2021314bf20 --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.DeidServices/examples/2024-07-12-preview/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/HealthDataAIServices.DeidServices/examples/2024-07-12-preview/DeleteJob.json b/specification/healthdataaiservices/HealthDataAIServices.DeidServices/examples/2024-07-12-preview/DeleteJob.json new file mode 100644 index 000000000000..9b49028db92a --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.DeidServices/examples/2024-07-12-preview/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/HealthDataAIServices.DeidServices/examples/2024-07-12-preview/GetJob.json b/specification/healthdataaiservices/HealthDataAIServices.DeidServices/examples/2024-07-12-preview/GetJob.json new file mode 100644 index 000000000000..41496ff69046 --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.DeidServices/examples/2024-07-12-preview/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/HealthDataAIServices.DeidServices/examples/2024-07-12-preview/ListJobDocuments.json b/specification/healthdataaiservices/HealthDataAIServices.DeidServices/examples/2024-07-12-preview/ListJobDocuments.json new file mode 100644 index 000000000000..372911afab67 --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.DeidServices/examples/2024-07-12-preview/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/HealthDataAIServices.DeidServices/examples/2024-07-12-preview/ListJobs.json b/specification/healthdataaiservices/HealthDataAIServices.DeidServices/examples/2024-07-12-preview/ListJobs.json new file mode 100644 index 000000000000..43061dc58040 --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.DeidServices/examples/2024-07-12-preview/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/HealthDataAIServices.DeidServices/main.tsp b/specification/healthdataaiservices/HealthDataAIServices.DeidServices/main.tsp new file mode 100644 index 000000000000..8a77f88ed379 --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.DeidServices/main.tsp @@ -0,0 +1,44 @@ +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "./routes.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.Core.Traits; + +// Official Name: Azure Health Data Services de-identification service +@useAuth(AadToken) +@service({ + title: "Azure Health Data Services de-identification service", +}) +@server( + "https://{endpoint}", + "De-identification Service service endpoint", + { + @doc("Url of your De-identification Service.") + endpoint: string, + } +) +@versioned(HealthDataAIServices.DeidServices.Versions) +namespace HealthDataAIServices.DeidServices; + +@doc("The Azure Active Directory OAuth2 Flow") +model AadToken + is OAuth2Auth<[ + { + type: OAuth2FlowType.authorizationCode; + authorizationUrl: "https://login.microsoftonline.com/common/oauth2/v2.0/authorize"; + tokenUrl: "https://login.microsoftonline.com/common/oauth2/token"; + scopes: ["https://deid.azure.com/.default"]; + } + ]>; + +@doc("Azure Health Data Services de-identification service versions.") +enum Versions { + @doc("Public preview release version.") + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + v2024_07_12_preview: "2024-07-12-preview", +} diff --git a/specification/healthdataaiservices/HealthDataAIServices.DeidServices/models.tsp b/specification/healthdataaiservices/HealthDataAIServices.DeidServices/models.tsp new file mode 100644 index 000000000000..0073a3813fdf --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.DeidServices/models.tsp @@ -0,0 +1,377 @@ +import "@typespec/http"; +import "@typespec/rest"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using Azure.Core; + +#suppress "@azure-tools/typespec-azure-core/casing-style" "AI Casing style to match OpenAI" +namespace HealthDataAIServices.DeidServices; + +@doc("A job containing a batch of documents to de-identify.") +@resource("jobs") +model DeidentificationJob { + @key + @doc("The name of a job.") + @visibility("read") + @maxLength(36) + @minLength(3) // Must be 3 to match regex + @pattern("^[a-zA-Z0-9][a-zA-Z0-9-_]+[a-zA-Z0-9]$") + name: string; + + @doc("Storage location to perform the operation on.") + sourceLocation: SourceStorageLocation; + + @doc("Target location to store output of operation.") + targetLocation: TargetStorageLocation; + + @doc("Operation to perform on the input documents.") + operation?: OperationType = OperationType.Surrogate; + + @doc("Data type of the input documents.") + dataType?: DocumentDataType = DocumentDataType.Plaintext; + + @maxLength(16) + @minLength(1) + @doc("Format of the redacted output. Only valid when Operation is Redact.") + redactionFormat?: string; + + // Readonly Properties + + @doc("Current status of a job.") + @visibility("read") + @pollingOperationParameter + status: JobStatus; + + @doc("Error when job fails in it's entirety.") + @visibility("read") + error?: Azure.Core.Foundations.Error; + + @doc(""" + Date and time when the job was completed. + + If the job is canceled, this is the time when the job was canceled. + + If the job failed, this is the time when the job failed. + """) + @visibility("read") + lastUpdatedAt: utcDateTime; + + @doc("Date and time when the job was created.") + @visibility("read") + createdAt: utcDateTime; + + @doc("Date and time when the job was started.") + @visibility("read") + startedAt?: utcDateTime; + + @doc("Summary of a job. Exists only when the job is completed.") + @visibility("read") + summary?: JobSummary; +} + +@doc("Summary metrics of a job.") +model JobSummary { + @doc("Number of documents that have completed.") + successful: int32; + + @doc("Number of documents that have failed.") + failed: int32; + + @doc("Number of documents that have been canceled.") + canceled: int32; + + @doc("Number of documents total.") + total: int32; + + @doc("Number of bytes processed.") + bytesProcessed: int64; +} + +@doc("List of statuses a job can have.") +@lroStatus +union JobStatus { + // Cannot use Azure.Core.Foundations.OperationState. because it is not a union type. + @doc("Job has been submitted and is waiting to be processed.") + NotStarted: "NotStarted", + + @doc("Job has been started.") + Running: "Running", + + @lroSucceeded + @doc("Job has completed successfully. All documents have succeeded.") + Succeeded: "Succeeded", + + @lroFailed + @doc("Job has completed with at least a single document failing.") + PartialFailed: "PartialFailed", + + @lroFailed + @doc("Job has completed with all documents failing, or a validation failure.") + Failed: "Failed", + + @lroCanceled + @doc("Job has been canceled after user request.") + Canceled: "Canceled", + + string, +} + +@doc("Storage location.") +model SourceStorageLocation { + @doc("URL to storage location.") + location: url; + + @doc("Prefix to filter path by.") + @minLength(1) + @maxLength(1024) + prefix: string; + + @doc("List of extensions to filter path by.") + @minItems(1) + extensions?: Array = #["*"]; +} + +@doc("Storage location.") +model TargetStorageLocation { + @doc("URL to storage location.") + location: url; + + @doc("Prefix to filter path by.") + @minLength(1) + @maxLength(1024) + prefix: string; +} + +@doc("Details of a single document in a job.") +@resource("documents") +@parentResource(DeidentificationJob) +model DocumentDetails { + @key + @doc("Id of the document details.") + @visibility("read") + id: string; + + @doc("Location for the input.") + input: DocumentLocation; + + @doc("Location for the output.") + output?: DocumentLocation; + + @doc("Status of the document.") + status: Azure.Core.Foundations.OperationState; + + @doc("Error when document fails.") + error?: Azure.Core.Foundations.Error; +} + +@doc("Location of a document.") +model DocumentLocation { + @doc("Path of document in storage.") + @maxLength(1024) + path: string; + + ...EtagProperty; +} + +@doc("Enum of supported Data Types.") +union DocumentDataType { + @doc("Plain text data type.") + Plaintext: "Plaintext", + + string, +} + +@doc("Enum of supported Operation Types.") +union OperationType { + @doc("Redact Operation will remove all entities of PHI and replace them with a placeholder value.") + Redact: "Redact", + + @doc("Surrogation Operation will replace all entities of PHI with a surrogate value.") + Surrogate: "Surrogate", + + @doc("Tag Operation will detect all entities of PHI, their type, and return their locations in the document.") + Tag: "Tag", + + string, +} + +@doc("Request body for de-identification operation.") +model DeidentificationContent { + @doc("Input text to de-identify.") + @maxLength(100000) // 100KB + inputText: string; + + @doc("Operation to perform on the input.") + operation?: OperationType = OperationType.Surrogate; + + @doc("Data type of the input.") + dataType?: DocumentDataType = DocumentDataType.Plaintext; + + @maxLength(16) + @doc("Format of the redacted output. Only valid when OperationType is \"Redact\".") + redactionFormat?: string; +} + +@doc("Response body for de-identification operation.") +model DeidentificationResult { + @doc("Output text after de-identification. Not available for \"Tag\" operation.") + outputText?: string; + + @doc("Result of the \"Tag\" operation. Only available for \"Tag\" Operation.") + taggerResult?: PhiTaggerResult; +} + +@doc("Result of the \"Tag\" operation.") +model PhiTaggerResult { + @doc("List of entities detected in the input.") + entities: Array; + + @doc("Path to the document in storage.") + @maxLength(1024) // Max length for path Name + path?: string; + + // Source: ...EtagProperty; + // Needs to be optional + @doc("The entity tag for this resource.") + etag?: eTag; +} + +@doc("List of PHI Entities.") +union PhiCategory { + @doc("Unknown PHI Type.") + Unknown: "Unknown", + + @doc("Account Number.") + Account: "Account", + + @doc("Age.") + Age: "Age", + + @doc("Biological Identifier, such as a fingerprint or retinal scan.") + BioID: "BioID", + + @doc("City.") + City: "City", + + @doc("Country or Region.") + CountryOrRegion: "CountryOrRegion", + + @doc("Date.") + Date: "Date", + + @doc("Device ID or serial numbers.") + Device: "Device", + + @doc("Doctor's Name.") + Doctor: "Doctor", + + @doc("Email Addresses.") + Email: "Email", + + @doc("Fax Number.") + Fax: "Fax", + + @doc("Health Plan ID Numbers.") + HealthPlan: "HealthPlan", + + @doc("Hospital Name.") + Hospital: "Hospital", + + @doc("Id Number, eg. passport number.") + IDNum: "IDNum", + + @doc("IP Address.") + IPAddress: "IPAddress", + + @doc("License, eg. Driver's license or medical license.") + License: "License", + + @doc("Location Other, eg. Golden Gate Park.") + LocationOther: "LocationOther", + + @doc("Medical Record Number.") + MedicalRecord: "MedicalRecord", + + @doc("Organization, eg. Microsoft.") + Organization: "Organization", + + @doc("Patient Name.") + Patient: "Patient", + + @doc("Phone Number.") + Phone: "Phone", + + @doc("Profession.") + Profession: "Profession", + + @doc("Social Security Number.") + SocialSecurity: "SocialSecurity", + + @doc("State.") + State: "State", + + @doc("Street.") + Street: "Street", + + @doc("Web URL.") + Url: "Url", + + @doc("Usernames, eg. a social media handle.") + Username: "Username", + + @doc("Vehicle IDs, eg. license plate or VIN number.") + Vehicle: "Vehicle", + + @doc("Zip Code.") + Zip: "Zip", + + string, +} + +@doc("PHI Entity tag in the input.") +model PhiEntity { + @doc("PHI Category of the entity.") + category: PhiCategory; + + @doc("Starting index of the location from within the input text.") + offset: StringIndex; + + @doc("Length of the input text.") + length: StringIndex; + + @doc("Text of the entity.") + text?: string; + + @doc("Confidence score of the category match.") + confidenceScore?: float64; +} + +@doc("Query parameters for list operation.") +model PaginationByTokenQueryParameters { + ...MaxPageSizeQueryParameter; + + @query + @doc("Token to continue a previous query.") + continuationToken?: string; +} + +@doc("String index encoding model.") +model StringIndex { + @doc("The offset or length of the substring in UTF-8 encoding") + utf8: int32; + + @doc(""" + The offset or length of the substring in UTF-16 encoding. + + Primary encoding used by .NET, Java, and JavaScript. + """) + utf16: int32; + + @doc(""" + The offset or length of the substring in CodePoint encoding. + + Primary encoding used by Python. + """) + codePoint: int32; +} diff --git a/specification/healthdataaiservices/HealthDataAIServices.DeidServices/routes.tsp b/specification/healthdataaiservices/HealthDataAIServices.DeidServices/routes.tsp new file mode 100644 index 000000000000..8413e3191d33 --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.DeidServices/routes.tsp @@ -0,0 +1,80 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/http"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.Core.Traits; +using Azure.ClientGenerator.Core; + +#suppress "@azure-tools/typespec-azure-core/casing-style" "AI Casing style to match OpenAI" +@client({ + name: "DeidentificationClient", +}) +namespace HealthDataAIServices.DeidServices; + +alias ServiceTraits = NoRepeatableRequests & + NoConditionalRequests & + SupportsClientRequestId; + +alias DeidentifyOperations = ResourceOperations< + ServiceTraits, + Azure.Core.Foundations.ErrorResponse +>; + +// Text-Deidentification Operations + +@summary("Create a de-identification job.") +@pollingOperation(getJob) +op createJob is DeidentifyOperations.LongRunningResourceCreateOrReplace; + +@summary("Get a de-identification job.") +op getJob is DeidentifyOperations.ResourceRead; + +@summary("List de-identification jobs.") +op listJobs is DeidentifyOperations.ResourceList< + DeidentificationJob, + ListQueryParametersTrait +>; + +@summary("List processed documents within a job.") +op listJobDocuments is DeidentifyOperations.ResourceList< + DocumentDetails, + ListQueryParametersTrait +>; + +#suppress "@azure-tools/typespec-azure-core/no-explicit-routes-resource-ops" "" +@summary("Cancel a de-identification job.") +@doc(""" + Cancels a job that is in progress. + + The 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. + + If the job is already complete, this will have no effect. + """) +@action("cancel") +op cancelJob is DeidentifyOperations.ResourceAction< + DeidentificationJob, + {}, + DeidentificationJob +>; + +@summary("Delete a de-identification job.") +@doc("Removes the record of the job from the service. Does not delete any documents.") +op deleteJob is DeidentifyOperations.ResourceDelete; + +@summary("De-identify text.") +@route("/deid") +@post +op deidentify is Azure.Core.RpcOperation< + { + @doc("Request body for de-identification operation.") + @body + body: DeidentificationContent; + }, + DeidentificationResult +>; diff --git a/specification/healthdataaiservices/HealthDataAIServices.DeidServices/tspconfig.yaml b/specification/healthdataaiservices/HealthDataAIServices.DeidServices/tspconfig.yaml new file mode 100644 index 000000000000..5fb238bd3322 --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.DeidServices/tspconfig.yaml @@ -0,0 +1,43 @@ +parameters: + "service-dir": + default: "sdk/healthdataaiservices" + "dependencies": + "additionalDirectories": [] + default: "" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "data-plane" + emitter-output-dir: "{project-root}/.." + examples-directory: "{project-root}/examples/" + output-file: "{project-root}/../data-plane/{service-name}/{version-status}/{version}/{service-name}.json" + omit-unreachable-types: true + "@azure-tools/typespec-python": + package-dir: "azure-health-deidentification" + package-name: "{package-dir}" + package-mode: dataplane + flavor: azure + "@azure-tools/typespec-csharp": + package-dir: "Azure.Health.Deidentification" + namespace: "{package-dir}" + clear-output-folder: true + model-namespace: false + flavor: azure + "@azure-tools/typespec-ts": + package-dir: "azure-health-deidentification" + generateMetadata: true + generateTest: true + packageDetails: + name: "@azure-rest/health-deidentification" + description: "Health Deidentification Service" + flavor: azure + "@azure-tools/typespec-java": + package-dir: "azure-health-deidentification" + namespace: "com.azure.health.deidentification" + flavor: azure +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/data-plane" + disable: + "@azure-tools/typespec-azure-core/casing-style": "Disabling as #suppress not working for namespace" diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/DeidServices_Create_MaximumSet_Gen.json b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/DeidServices_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..6f9b65161981 --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/DeidServices_Create_MaximumSet_Gen.json @@ -0,0 +1,140 @@ +{ + "title": "DeidServices_Create - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "DeidServices_Create", + "parameters": { + "api-version": "2024-02-28-preview", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest", + "resource": { + "properties": { + "publicNetworkAccess": "Enabled" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "location": "qwyhvdwcsjulggagdqxlmazcl" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "ddxuoved" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih/privateEndpointConnections/mdwvqjtwcjcvrh", + "name": "mdwvqjtwcjcvrh", + "type": "bzxabjlpbwreez", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "serviceUrl": "woponotsxaippkvhwmibffywnqcfru" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "a82361f4-5320-4a26-8d1b-45832d2164dd", + "tenantId": "53a6a686-ae15-4a1d-badf-3e7947918893" + }, + "tags": {}, + "location": "qwyhvdwcsjulggagdqxlmazcl", + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih", + "name": "nlrthrxaukih", + "type": "slyfiibvwlhfdpzjynsywhbfauexk", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "ddxuoved" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih/privateEndpointConnections/mdwvqjtwcjcvrh", + "name": "mdwvqjtwcjcvrh", + "type": "bzxabjlpbwreez", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "serviceUrl": "woponotsxaippkvhwmibffywnqcfru" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "a82361f4-5320-4a26-8d1b-45832d2164dd", + "tenantId": "53a6a686-ae15-4a1d-badf-3e7947918893" + }, + "tags": {}, + "location": "qwyhvdwcsjulggagdqxlmazcl", + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih", + "name": "nlrthrxaukih", + "type": "slyfiibvwlhfdpzjynsywhbfauexk", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + } + } +} diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/DeidServices_Delete_MaximumSet_Gen.json b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/DeidServices_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..e09f3b2e23d7 --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/DeidServices_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "DeidServices_Delete - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "DeidServices_Delete", + "parameters": { + "api-version": "2024-02-28-preview", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/DeidServices_Get_MaximumSet_Gen.json b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/DeidServices_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..fde44c2591da --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/DeidServices_Get_MaximumSet_Gen.json @@ -0,0 +1,69 @@ +{ + "title": "DeidServices_Get - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "DeidServices_Get", + "parameters": { + "api-version": "2024-02-28-preview", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "ddxuoved" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih/privateEndpointConnections/mdwvqjtwcjcvrh", + "name": "mdwvqjtwcjcvrh", + "type": "bzxabjlpbwreez", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "serviceUrl": "woponotsxaippkvhwmibffywnqcfru" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "a82361f4-5320-4a26-8d1b-45832d2164dd", + "tenantId": "53a6a686-ae15-4a1d-badf-3e7947918893" + }, + "tags": {}, + "location": "qwyhvdwcsjulggagdqxlmazcl", + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih", + "name": "nlrthrxaukih", + "type": "slyfiibvwlhfdpzjynsywhbfauexk", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + } + } +} diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/DeidServices_ListByResourceGroup_MaximumSet_Gen.json b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/DeidServices_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..bf70865c022b --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/DeidServices_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,73 @@ +{ + "title": "DeidServices_ListByResourceGroup - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "DeidServices_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-28-preview", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "serviceUrl": "woponotsxaippkvhwmibffywnqcfru", + "privateEndpointConnections": [ + { + "properties": { + "groupIds": [ + "xbdyjqg" + ], + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "ro" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih/privateEndpointConnections/mdwvqjtwcjcvrh", + "name": "mdwvqjtwcjcvrh", + "type": "bzxabjlpbwreez", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "publicNetworkAccess": "Enabled" + }, + "identity": { + "principalId": "a82361f4-5320-4a26-8d1b-45832d2164dd", + "tenantId": "53a6a686-ae15-4a1d-badf-3e7947918893", + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "location": "qwyhvdwcsjulggagdqxlmazcl", + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih", + "name": "nlrthrxaukih", + "type": "slyfiibvwlhfdpzjynsywhbfauexk", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/DeidServices_ListBySubscription_MaximumSet_Gen.json b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/DeidServices_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..edd631d62174 --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/DeidServices_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,72 @@ +{ + "title": "DeidServices_ListBySubscription - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "DeidServices_ListBySubscription", + "parameters": { + "api-version": "2024-02-28-preview", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "serviceUrl": "woponotsxaippkvhwmibffywnqcfru", + "privateEndpointConnections": [ + { + "properties": { + "groupIds": [ + "xbdyjqg" + ], + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "ro" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih/privateEndpointConnections/mdwvqjtwcjcvrh", + "name": "mdwvqjtwcjcvrh", + "type": "bzxabjlpbwreez", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "publicNetworkAccess": "Enabled" + }, + "identity": { + "principalId": "a82361f4-5320-4a26-8d1b-45832d2164dd", + "tenantId": "53a6a686-ae15-4a1d-badf-3e7947918893", + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "location": "qwyhvdwcsjulggagdqxlmazcl", + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih", + "name": "nlrthrxaukih", + "type": "slyfiibvwlhfdpzjynsywhbfauexk", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/DeidServices_Update_MaximumSet_Gen.json b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/DeidServices_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..7022bae26785 --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/DeidServices_Update_MaximumSet_Gen.json @@ -0,0 +1,84 @@ +{ + "title": "DeidServices_Update - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "DeidServices_Update", + "parameters": { + "api-version": "2024-02-28-preview", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest", + "properties": { + "identity": { + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "properties": { + "publicNetworkAccess": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "ddxuoved" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih/privateEndpointConnections/mdwvqjtwcjcvrh", + "name": "mdwvqjtwcjcvrh", + "type": "bzxabjlpbwreez", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "serviceUrl": "woponotsxaippkvhwmibffywnqcfru" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "a82361f4-5320-4a26-8d1b-45832d2164dd", + "tenantId": "53a6a686-ae15-4a1d-badf-3e7947918893" + }, + "tags": {}, + "location": "qwyhvdwcsjulggagdqxlmazcl", + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih", + "name": "nlrthrxaukih", + "type": "slyfiibvwlhfdpzjynsywhbfauexk", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/Operations_List_MaximumSet_Gen.json b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..e873a4cfa417 --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-02-28-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "vlozcqymdxttexvmhouwzob", + "isDataAction": true, + "display": { + "provider": "hwy", + "resource": "yxabgnzjshmqldqthxonpam", + "operation": "quwaawjasjgpqhskxoxzx", + "description": "ayqiodducsbwvzcgno" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/Operations_List_MinimumSet_Gen.json b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/Operations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..1bb639d8379d --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/Operations_List_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Operations_List_MaximumSet - generated by [MaximumSet] rule - generated by [MinimumSet] rule", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-02-28-preview" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/PrivateEndpointConnections_Create_MaximumSet_Gen.json b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/PrivateEndpointConnections_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..942ecc360302 --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/PrivateEndpointConnections_Create_MaximumSet_Gen.json @@ -0,0 +1,84 @@ +{ + "title": "PrivateEndpointConnections_Create - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "PrivateEndpointConnections_Create", + "parameters": { + "api-version": "2024-02-28-preview", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest", + "privateEndpointConnectionName": "kgwgrrpabvrsrrvpcgcnfmyfgyrl", + "resource": { + "properties": { + "privateEndpoint": {}, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "xr" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "xr" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/deidTest/privateEndpointConnections/aduyb", + "name": "aduyb", + "type": "umjjkodjuhccrngl", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "xr" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/deidTest/privateEndpointConnections/aduyb", + "name": "aduyb", + "type": "umjjkodjuhccrngl", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + } + } +} diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/PrivateEndpointConnections_Delete_MaximumSet_Gen.json b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/PrivateEndpointConnections_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..668885160a84 --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/PrivateEndpointConnections_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "PrivateEndpointConnections_Delete - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "PrivateEndpointConnections_Delete", + "parameters": { + "api-version": "2024-02-28-preview", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest", + "privateEndpointConnectionName": "kgwgrrpabvrsrrvpcgcnfmyfgyrl" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/PrivateEndpointConnections_Get_MaximumSet_Gen.json b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/PrivateEndpointConnections_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..7625f2b4002d --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/PrivateEndpointConnections_Get_MaximumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "PrivateEndpointConnections_Get - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "PrivateEndpointConnections_Get", + "parameters": { + "api-version": "2024-02-28-preview", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest", + "privateEndpointConnectionName": "kgwgrrpabvrsrrvpcgcnfmyfgyrl" + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "xr" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/deidTest/privateEndpointConnections/aduyb", + "name": "aduyb", + "type": "umjjkodjuhccrngl", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + } + } +} diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/PrivateEndpointConnections_ListByDeidService_MaximumSet_Gen.json b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/PrivateEndpointConnections_ListByDeidService_MaximumSet_Gen.json new file mode 100644 index 000000000000..74a9ca213f0b --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/PrivateEndpointConnections_ListByDeidService_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "PrivateEndpointConnections_ListByDeidService - generated by [MaximumSet] rule", + "operationId": "PrivateEndpointConnections_ListByDeidService", + "parameters": { + "api-version": "2024-02-28-preview", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "mmvcleuufspfrojjveuith" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/deidTest/privateEndpointConnections/aduyb", + "name": "aduyb", + "type": "umjjkodjuhccrngl", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/PrivateLinks_ListByDeidService_MaximumSet_Gen.json b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/PrivateLinks_ListByDeidService_MaximumSet_Gen.json new file mode 100644 index 000000000000..95955e8a4900 --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-02-28-preview/PrivateLinks_ListByDeidService_MaximumSet_Gen.json @@ -0,0 +1,41 @@ +{ + "title": "PrivateLinks_ListByDeidService - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "PrivateLinks_ListByDeidService", + "parameters": { + "api-version": "2024-02-28-preview", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "flaloakbdcqjisfhfnkrxmt", + "requiredMembers": [ + "wbraaugftjqa" + ], + "requiredZoneNames": [ + "ndsmc" + ] + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/deidTest/privateLinkResources/rmptbzejhgxhlfpdizsekhsq", + "name": "rmptbzejhgxhlfpdizsekhsq", + "type": "lplbvyjkvsujegzqr", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "nextLink": "https://microsoft.com/arzijt" + } + } + } +} diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/main.tsp b/specification/healthdataaiservices/HealthDataAIServices.Management/main.tsp new file mode 100644 index 000000000000..914a52292a69 --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/main.tsp @@ -0,0 +1,157 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.ResourceManager; + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Using the AI acronym similar to what was done for OpenAI" +@armProviderNamespace("Microsoft.HealthDataAIServices") +@service({ + title: "Microsoft.HealthDataAIServices", +}) +@versioned(Microsoft.HealthDataAIServices.Versions) +namespace Microsoft.HealthDataAIServices; + +@doc("Supported API versions for the Microsoft.HealthDataAIServices resource provider.") +enum Versions { + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) + @doc("The 2024-02-28-preview version.") + v2024_02_28_preview: "2024-02-28-preview", +} + +interface Operations extends Azure.ResourceManager.Operations {} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-path-segment-invalid-chars" "Existing Template" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-key-invalid-chars" "Existing template" +#suppress "@azure-tools/typespec-azure-core/casing-style" "Case-sensitive name" +#suppress "deprecated" "Workaround for Typespec bug https://github.com/Azure/typespec-azure/issues/383" +@doc("A HealthDataAIServicesProviderHub resource") +model DeidService is TrackedResource { + @doc("The name of the deid service") + @pattern("^[a-zA-Z0-9-]{3,24}$") + @key("deidServiceName") + @segment("deidServices") + @path + name: string; + + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "Adding property for versioning" + @doc("The managed service identities assigned to this resource.") + identity?: Azure.ResourceManager.Foundations.ManagedIdentityProperties; +} + +/** Patch request body for DeidService */ +model DeidUpdate { + ...Azure.ResourceManager.Foundations.ArmTagsProperty; + + /** Updatable managed service identity */ + identity?: ManagedServiceIdentityUpdate; + + /** RP-specific properties */ + properties?: DeidPropertiesUpdate; +} + +model DeidPropertiesUpdate + is OptionalProperties>; + +#suppress "deprecated" "Workaround for Typespec bug https://github.com/Azure/typespec-azure/issues/383" +model ManagedServiceIdentityUpdate + is OptionalProperties>; + +#suppress "@azure-tools/typespec-azure-core/no-enum" "Suppress the warning for using enum keyword." +@Azure.Core.lroStatus +@doc("The status of the current operation.") +union ProvisioningState { + ResourceProvisioningState, + + /** The resource is being provisioned. */ + Provisioning: "Provisioning", + + /** The resource is being updated. */ + Updating: "Updating", + + /** The resource is being deleted. */ + Deleting: "Deleting", + + /** The resource provisioning request has been accepted. */ + Accepted: "Accepted", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/no-enum" "Suppress the warning for using enum keyword." +@doc("State of the public network access.") +enum PublicNetworkAccess { + @doc("The public network access is enabled") + Enabled, + + @doc("The public network access is disabled") + Disabled, +} + +@doc("Details of the HealthDataAIServices DeidService.") +model DeidServiceProperties { + @visibility("read") + @doc("The status of the last operation.") + provisioningState?: ProvisioningState; + + @visibility("read") + @doc("Deid service url.") + serviceUrl?: string; + + @doc("List of private endpoint connections.") + @visibility("read") + privateEndpointConnections?: PrivateEndpointConnection[]; + + @doc("Gets or sets allow or disallow public network access to resource") + publicNetworkAccess?: PublicNetworkAccess; +} + +@armResourceOperations +interface DeidServices { + get is ArmResourceRead; + listByResourceGroup is ArmResourceListByParent; + listBySubscription is ArmListBySubscription; + create is ArmResourceCreateOrUpdateAsync; + update is ArmCustomPatchAsync; + delete is ArmResourceDeleteWithoutOkAsync; +} + +/** Holder for private endpoint connections */ +@parentResource(DeidService) +model PrivateEndpointConnectionResource + is ProxyResource { + ...PrivateEndpointConnectionParameter; +} + +/** Private connection operations */ +@armResourceOperations(PrivateEndpointConnectionResource) +interface PrivateEndpointConnections { + /** Get a specific private connection */ + get is ArmResourceRead; + /** Create a Private endpoint connection */ + create is ArmResourceCreateOrReplaceAsync; + /** Delete the private endpoint connection */ + delete is ArmResourceDeleteWithoutOkAsync; + /** List private endpoint connections on the given resource */ + listByDeidService is ArmResourceListByParent; +} + +/** Private Links for DeidService resource */ +#suppress "@azure-tools/typespec-providerhub-controller/no-resource-operations" "Expected for private links" +@parentResource(DeidService) +model PrivateLinkResource is ProxyResource { + ...PrivateLinkResourceParameter; +} + +/** Operations for private links on DeidService resource */ +@armResourceOperations(PrivateLinkResource) +interface PrivateLinks { + /** List private links on the given resource */ + listByDeidService is ArmResourceListByParent; +} diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/tspconfig.yaml b/specification/healthdataaiservices/HealthDataAIServices.Management/tspconfig.yaml new file mode 100644 index 000000000000..e54f6a900bf5 --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/tspconfig.yaml @@ -0,0 +1,32 @@ +parameters: + "service-dir": + default: "sdk/healthdataaiservices" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "resource-manager" + use-read-only-status-schema: true + emitter-output-dir: "{project-root}/.." + examples-directory: "{project-root}/examples" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openapi.json" + new-line: lf + "@azure-tools/typespec-csharp": + package-dir: "Azure.ResourceManager.HealthDataAIServices" + flavor: azure + namespace: "{package-dir}" + service-name: "Health Data AI Services" + examples-directory: "examples" + "@azure-tools/typespec-python": + package-dir: "azure-mgmt-healthdataaiservices" + flavor: "azure" + package-name: "{package-dir}" + "@azure-tools/typespec-java": + package-dir: "azure-resourcemanager-healthdataaiservices" + flavor: "azure" + namespace: "com.azure.resourcemanager.healthdataaiservices" + service-name: "Health Data AI Services" + examples-directory: "examples" +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" 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 new file mode 100644 index 000000000000..d1beef623192 --- /dev/null +++ b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/HealthDataAIServices.DeidServices.json @@ -0,0 +1,1335 @@ +{ + "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 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 new file mode 100644 index 000000000000..61c794b02e7a --- /dev/null +++ b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/readme.md @@ -0,0 +1,78 @@ +# HealthDataAIServices.DeidServices + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for HealthDataAIServices.DeidServices. + +## Getting Started + +To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: + +> `autorest readme.md` + +To see additional help and options, run: + +> `autorest --help` + +For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. + +--- + +## Configuration + +### Basic Information + +These are the global settings for the HealthDataAIServices.DeidServices. + +```yaml +openapi-type: data-plane +tag: package-2024-07-12-preview +title: Azure Health Data Services de-identification service +security: AADToken +security-scopes: + - "https://deid.azure.com/.default" +``` + +### 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 + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-java + - repo: azure-sdk-for-js + - repo: azure-cli-extensions + - repo: azure-powershell +``` + +## Az + +See configuration in [readme.az.md](./readme.az.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) \ No newline at end of file diff --git a/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/DeidServices_Create_MaximumSet_Gen.json b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/DeidServices_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..6f9b65161981 --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/DeidServices_Create_MaximumSet_Gen.json @@ -0,0 +1,140 @@ +{ + "title": "DeidServices_Create - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "DeidServices_Create", + "parameters": { + "api-version": "2024-02-28-preview", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest", + "resource": { + "properties": { + "publicNetworkAccess": "Enabled" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "location": "qwyhvdwcsjulggagdqxlmazcl" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "ddxuoved" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih/privateEndpointConnections/mdwvqjtwcjcvrh", + "name": "mdwvqjtwcjcvrh", + "type": "bzxabjlpbwreez", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "serviceUrl": "woponotsxaippkvhwmibffywnqcfru" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "a82361f4-5320-4a26-8d1b-45832d2164dd", + "tenantId": "53a6a686-ae15-4a1d-badf-3e7947918893" + }, + "tags": {}, + "location": "qwyhvdwcsjulggagdqxlmazcl", + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih", + "name": "nlrthrxaukih", + "type": "slyfiibvwlhfdpzjynsywhbfauexk", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "ddxuoved" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih/privateEndpointConnections/mdwvqjtwcjcvrh", + "name": "mdwvqjtwcjcvrh", + "type": "bzxabjlpbwreez", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "serviceUrl": "woponotsxaippkvhwmibffywnqcfru" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "a82361f4-5320-4a26-8d1b-45832d2164dd", + "tenantId": "53a6a686-ae15-4a1d-badf-3e7947918893" + }, + "tags": {}, + "location": "qwyhvdwcsjulggagdqxlmazcl", + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih", + "name": "nlrthrxaukih", + "type": "slyfiibvwlhfdpzjynsywhbfauexk", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + } + } +} diff --git a/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/DeidServices_Delete_MaximumSet_Gen.json b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/DeidServices_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..e09f3b2e23d7 --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/DeidServices_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "DeidServices_Delete - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "DeidServices_Delete", + "parameters": { + "api-version": "2024-02-28-preview", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/DeidServices_Get_MaximumSet_Gen.json b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/DeidServices_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..fde44c2591da --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/DeidServices_Get_MaximumSet_Gen.json @@ -0,0 +1,69 @@ +{ + "title": "DeidServices_Get - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "DeidServices_Get", + "parameters": { + "api-version": "2024-02-28-preview", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "ddxuoved" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih/privateEndpointConnections/mdwvqjtwcjcvrh", + "name": "mdwvqjtwcjcvrh", + "type": "bzxabjlpbwreez", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "serviceUrl": "woponotsxaippkvhwmibffywnqcfru" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "a82361f4-5320-4a26-8d1b-45832d2164dd", + "tenantId": "53a6a686-ae15-4a1d-badf-3e7947918893" + }, + "tags": {}, + "location": "qwyhvdwcsjulggagdqxlmazcl", + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih", + "name": "nlrthrxaukih", + "type": "slyfiibvwlhfdpzjynsywhbfauexk", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + } + } +} diff --git a/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/DeidServices_ListByResourceGroup_MaximumSet_Gen.json b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/DeidServices_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..bf70865c022b --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/DeidServices_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,73 @@ +{ + "title": "DeidServices_ListByResourceGroup - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "DeidServices_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-28-preview", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "serviceUrl": "woponotsxaippkvhwmibffywnqcfru", + "privateEndpointConnections": [ + { + "properties": { + "groupIds": [ + "xbdyjqg" + ], + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "ro" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih/privateEndpointConnections/mdwvqjtwcjcvrh", + "name": "mdwvqjtwcjcvrh", + "type": "bzxabjlpbwreez", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "publicNetworkAccess": "Enabled" + }, + "identity": { + "principalId": "a82361f4-5320-4a26-8d1b-45832d2164dd", + "tenantId": "53a6a686-ae15-4a1d-badf-3e7947918893", + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "location": "qwyhvdwcsjulggagdqxlmazcl", + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih", + "name": "nlrthrxaukih", + "type": "slyfiibvwlhfdpzjynsywhbfauexk", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/DeidServices_ListBySubscription_MaximumSet_Gen.json b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/DeidServices_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..edd631d62174 --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/DeidServices_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,72 @@ +{ + "title": "DeidServices_ListBySubscription - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "DeidServices_ListBySubscription", + "parameters": { + "api-version": "2024-02-28-preview", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "serviceUrl": "woponotsxaippkvhwmibffywnqcfru", + "privateEndpointConnections": [ + { + "properties": { + "groupIds": [ + "xbdyjqg" + ], + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "ro" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih/privateEndpointConnections/mdwvqjtwcjcvrh", + "name": "mdwvqjtwcjcvrh", + "type": "bzxabjlpbwreez", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "publicNetworkAccess": "Enabled" + }, + "identity": { + "principalId": "a82361f4-5320-4a26-8d1b-45832d2164dd", + "tenantId": "53a6a686-ae15-4a1d-badf-3e7947918893", + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "location": "qwyhvdwcsjulggagdqxlmazcl", + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih", + "name": "nlrthrxaukih", + "type": "slyfiibvwlhfdpzjynsywhbfauexk", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/DeidServices_Update_MaximumSet_Gen.json b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/DeidServices_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..7022bae26785 --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/DeidServices_Update_MaximumSet_Gen.json @@ -0,0 +1,84 @@ +{ + "title": "DeidServices_Update - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "DeidServices_Update", + "parameters": { + "api-version": "2024-02-28-preview", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest", + "properties": { + "identity": { + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "properties": { + "publicNetworkAccess": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "ddxuoved" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih/privateEndpointConnections/mdwvqjtwcjcvrh", + "name": "mdwvqjtwcjcvrh", + "type": "bzxabjlpbwreez", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "serviceUrl": "woponotsxaippkvhwmibffywnqcfru" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "a82361f4-5320-4a26-8d1b-45832d2164dd", + "tenantId": "53a6a686-ae15-4a1d-badf-3e7947918893" + }, + "tags": {}, + "location": "qwyhvdwcsjulggagdqxlmazcl", + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih", + "name": "nlrthrxaukih", + "type": "slyfiibvwlhfdpzjynsywhbfauexk", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/Operations_List_MaximumSet_Gen.json b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..e873a4cfa417 --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-02-28-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "vlozcqymdxttexvmhouwzob", + "isDataAction": true, + "display": { + "provider": "hwy", + "resource": "yxabgnzjshmqldqthxonpam", + "operation": "quwaawjasjgpqhskxoxzx", + "description": "ayqiodducsbwvzcgno" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/Operations_List_MinimumSet_Gen.json b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/Operations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..1bb639d8379d --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/Operations_List_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Operations_List_MaximumSet - generated by [MaximumSet] rule - generated by [MinimumSet] rule", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-02-28-preview" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..942ecc360302 --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json @@ -0,0 +1,84 @@ +{ + "title": "PrivateEndpointConnections_Create - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "PrivateEndpointConnections_Create", + "parameters": { + "api-version": "2024-02-28-preview", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest", + "privateEndpointConnectionName": "kgwgrrpabvrsrrvpcgcnfmyfgyrl", + "resource": { + "properties": { + "privateEndpoint": {}, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "xr" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "xr" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/deidTest/privateEndpointConnections/aduyb", + "name": "aduyb", + "type": "umjjkodjuhccrngl", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "xr" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/deidTest/privateEndpointConnections/aduyb", + "name": "aduyb", + "type": "umjjkodjuhccrngl", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + } + } +} diff --git a/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..668885160a84 --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "PrivateEndpointConnections_Delete - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "PrivateEndpointConnections_Delete", + "parameters": { + "api-version": "2024-02-28-preview", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest", + "privateEndpointConnectionName": "kgwgrrpabvrsrrvpcgcnfmyfgyrl" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..7625f2b4002d --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "PrivateEndpointConnections_Get - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "PrivateEndpointConnections_Get", + "parameters": { + "api-version": "2024-02-28-preview", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest", + "privateEndpointConnectionName": "kgwgrrpabvrsrrvpcgcnfmyfgyrl" + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "xr" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/deidTest/privateEndpointConnections/aduyb", + "name": "aduyb", + "type": "umjjkodjuhccrngl", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + } + } +} diff --git a/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/PrivateEndpointConnections_ListByDeidService_MaximumSet_Gen.json b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/PrivateEndpointConnections_ListByDeidService_MaximumSet_Gen.json new file mode 100644 index 000000000000..74a9ca213f0b --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/PrivateEndpointConnections_ListByDeidService_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "PrivateEndpointConnections_ListByDeidService - generated by [MaximumSet] rule", + "operationId": "PrivateEndpointConnections_ListByDeidService", + "parameters": { + "api-version": "2024-02-28-preview", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "mmvcleuufspfrojjveuith" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/deidTest/privateEndpointConnections/aduyb", + "name": "aduyb", + "type": "umjjkodjuhccrngl", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/PrivateLinks_ListByDeidService_MaximumSet_Gen.json b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/PrivateLinks_ListByDeidService_MaximumSet_Gen.json new file mode 100644 index 000000000000..95955e8a4900 --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/examples/PrivateLinks_ListByDeidService_MaximumSet_Gen.json @@ -0,0 +1,41 @@ +{ + "title": "PrivateLinks_ListByDeidService - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "PrivateLinks_ListByDeidService", + "parameters": { + "api-version": "2024-02-28-preview", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "flaloakbdcqjisfhfnkrxmt", + "requiredMembers": [ + "wbraaugftjqa" + ], + "requiredZoneNames": [ + "ndsmc" + ] + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/deidTest/privateLinkResources/rmptbzejhgxhlfpdizsekhsq", + "name": "rmptbzejhgxhlfpdizsekhsq", + "type": "lplbvyjkvsujegzqr", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "nextLink": "https://microsoft.com/arzijt" + } + } + } +} diff --git a/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/openapi.json b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/openapi.json new file mode 100644 index 000000000000..b8ed648f754a --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/preview/2024-02-28-preview/openapi.json @@ -0,0 +1,997 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.HealthDataAIServices", + "version": "2024-02-28-preview", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "DeidServices" + }, + { + "name": "PrivateEndpointConnections" + }, + { + "name": "PrivateLinks" + } + ], + "paths": { + "/providers/Microsoft.HealthDataAIServices/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/Operations_List_MaximumSet_Gen.json" + }, + "Operations_List_MaximumSet - generated by [MaximumSet] rule - generated by [MinimumSet] rule": { + "$ref": "./examples/Operations_List_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HealthDataAIServices/deidServices": { + "get": { + "operationId": "DeidServices_ListBySubscription", + "tags": [ + "DeidServices" + ], + "description": "List DeidService 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/DeidServiceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeidServices_ListBySubscription - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/DeidServices_ListBySubscription_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthDataAIServices/deidServices": { + "get": { + "operationId": "DeidServices_ListByResourceGroup", + "tags": [ + "DeidServices" + ], + "description": "List DeidService 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/DeidServiceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeidServices_ListByResourceGroup - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/DeidServices_ListByResourceGroup_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthDataAIServices/deidServices/{deidServiceName}": { + "get": { + "operationId": "DeidServices_Get", + "tags": [ + "DeidServices" + ], + "description": "Get a DeidService", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "deidServiceName", + "in": "path", + "description": "The name of the deid service", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeidService" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeidServices_Get - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/DeidServices_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "DeidServices_Create", + "tags": [ + "DeidServices" + ], + "description": "Create a DeidService", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "deidServiceName", + "in": "path", + "description": "The name of the deid service", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DeidService" + } + } + ], + "responses": { + "200": { + "description": "Resource 'DeidService' update operation succeeded", + "schema": { + "$ref": "#/definitions/DeidService" + } + }, + "201": { + "description": "Resource 'DeidService' create operation succeeded", + "schema": { + "$ref": "#/definitions/DeidService" + }, + "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": { + "DeidServices_Create - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/DeidServices_Create_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "DeidServices_Update", + "tags": [ + "DeidServices" + ], + "description": "Update a DeidService", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "deidServiceName", + "in": "path", + "description": "The name of the deid service", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/DeidUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeidService" + } + }, + "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": { + "DeidServices_Update - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/DeidServices_Update_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "DeidServices_Delete", + "tags": [ + "DeidServices" + ], + "description": "Delete a DeidService", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "deidServiceName", + "in": "path", + "description": "The name of the deid service", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "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": { + "DeidServices_Delete - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/DeidServices_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthDataAIServices/deidServices/{deidServiceName}/privateEndpointConnections": { + "get": { + "operationId": "PrivateEndpointConnections_ListByDeidService", + "tags": [ + "PrivateEndpointConnections" + ], + "description": "List private endpoint connections on the given 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": "deidServiceName", + "in": "path", + "description": "The name of the deid service", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_ListByDeidService - generated by [MaximumSet] rule": { + "$ref": "./examples/PrivateEndpointConnections_ListByDeidService_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthDataAIServices/deidServices/{deidServiceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "operationId": "PrivateEndpointConnections_Get", + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Get a specific private connection", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "deidServiceName", + "in": "path", + "description": "The name of the deid service", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_Get - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "PrivateEndpointConnections_Create", + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Create a Private endpoint connection", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "deidServiceName", + "in": "path", + "description": "The name of the deid service", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'PrivateEndpointConnectionResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionResource" + } + }, + "201": { + "description": "Resource 'PrivateEndpointConnectionResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionResource" + }, + "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": { + "PrivateEndpointConnections_Create - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "PrivateEndpointConnections_Delete", + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Delete the private endpoint connection", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "deidServiceName", + "in": "path", + "description": "The name of the deid service", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "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": { + "PrivateEndpointConnections_Delete - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthDataAIServices/deidServices/{deidServiceName}/privateLinkResources": { + "get": { + "operationId": "PrivateLinks_ListByDeidService", + "tags": [ + "PrivateLinks" + ], + "description": "List private links on the given 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": "deidServiceName", + "in": "path", + "description": "The name of the deid service", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Azure 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-examples": { + "PrivateLinks_ListByDeidService - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/PrivateLinks_ListByDeidService_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "DeidPropertiesUpdate": { + "type": "object", + "description": "The template for adding optional properties.", + "properties": { + "publicNetworkAccess": { + "$ref": "#/definitions/PublicNetworkAccess", + "description": "Gets or sets allow or disallow public network access to resource" + } + } + }, + "DeidService": { + "type": "object", + "description": "A HealthDataAIServicesProviderHub resource", + "properties": { + "properties": { + "$ref": "#/definitions/DeidServiceProperties", + "description": "The resource-specific properties for this resource." + }, + "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" + } + ] + }, + "DeidServiceListResult": { + "type": "object", + "description": "The response of a DeidService list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DeidService items on this page", + "items": { + "$ref": "#/definitions/DeidService" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DeidServiceProperties": { + "type": "object", + "description": "Details of the HealthDataAIServices DeidService.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + }, + "serviceUrl": { + "type": "string", + "description": "Deid service url.", + "readOnly": true + }, + "privateEndpointConnections": { + "type": "array", + "description": "List of private endpoint connections.", + "items": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "publicNetworkAccess": { + "$ref": "#/definitions/PublicNetworkAccess", + "description": "Gets or sets allow or disallow public network access to resource" + } + } + }, + "DeidUpdate": { + "type": "object", + "description": "Patch request body for DeidService", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "identity": { + "$ref": "#/definitions/ManagedServiceIdentityUpdate", + "description": "Updatable managed service identity" + }, + "properties": { + "$ref": "#/definitions/DeidPropertiesUpdate", + "description": "RP-specific properties" + } + } + }, + "ManagedServiceIdentityUpdate": { + "type": "object", + "description": "The template for adding optional properties.", + "properties": { + "type": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentityType", + "description": "The type of managed identity assigned to this resource." + }, + "userAssignedIdentities": { + "type": "object", + "description": "The identities assigned to this resource by the user.", + "additionalProperties": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/UserAssignedIdentity" + } + ], + "type": "object", + "x-nullable": true + } + } + } + }, + "PrivateEndpointConnectionResource": { + "type": "object", + "description": "Holder for private endpoint connections", + "properties": { + "properties": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnectionProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PrivateEndpointConnectionResourceListResult": { + "type": "object", + "description": "The response of a PrivateEndpointConnectionResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The PrivateEndpointConnectionResource items on this page", + "items": { + "$ref": "#/definitions/PrivateEndpointConnectionResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PrivateLinkResource": { + "type": "object", + "description": "Private Links for DeidService resource", + "properties": { + "properties": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateLinkResourceProperties", + "description": "The resource-specific properties for this resource." + } + }, + "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" + ] + }, + "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": "The resource is being provisioned." + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is being updated." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource provisioning request has been accepted." + } + ] + }, + "readOnly": true + }, + "PublicNetworkAccess": { + "type": "string", + "description": "State of the public network access.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": false, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "The public network access is enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The public network access is disabled" + } + ] + } + } + }, + "parameters": {} +} diff --git a/specification/healthdataaiservices/resource-manager/readme.az.md b/specification/healthdataaiservices/resource-manager/readme.az.md new file mode 100644 index 000000000000..b76b8b85d767 --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/readme.az.md @@ -0,0 +1,28 @@ +## AZ + +These settings apply only when `--az` is specified on the command line. + +For new Resource Provider. It is highly recommended to onboard Azure CLI extensions. There's no differences in terms of customer usage. + +``` yaml $(az) && $(target-mode) != 'core' +az: + extensions: healthdataaiservices + namespace: azure.mgmt.healthdataaiservices + package-name: azure-mgmt-healthdataaiservices +az-output-folder: $(azure-cli-extension-folder)/src/healthdataaiservices +python-sdk-output-folder: "$(az-output-folder)/azext_healthdataaiservices/vendored_sdks/healthdataaiservices" +# add additional configuration here specific for Azure CLI +# refer to the faq.md for more details +``` + + + +This is for command modules that already in azure cli main repo. +``` yaml $(az) && $(target-mode) == 'core' +az: + extensions: healthdataaiservices + namespace: azure.mgmt.healthdataaiservices + package-name: azure-mgmt-healthdataaiservices +az-output-folder: $(azure-cli-folder)/src/azure-cli/azure/cli/command_modules/healthdataaiservices +python-sdk-output-folder: "$(az-output-folder)/vendored_sdks/healthdataaiservices" +``` \ No newline at end of file diff --git a/specification/healthdataaiservices/resource-manager/readme.cli.md b/specification/healthdataaiservices/resource-manager/readme.cli.md new file mode 100644 index 000000000000..c6cf6ad37ea4 --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/readme.cli.md @@ -0,0 +1 @@ +## CLI Common Settings for all the command line tools \ No newline at end of file diff --git a/specification/healthdataaiservices/resource-manager/readme.csharp.md b/specification/healthdataaiservices/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..4e0742c02300 --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/readme.csharp.md @@ -0,0 +1,15 @@ +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true + client-side-validation: false + namespace: Microsoft.HealthDataAIServices + output-folder: $(csharp-sdks-folder)/healthdataaiservices/management/Microsoft.HealthDataAIServices/GeneratedProtocol +``` diff --git a/specification/healthdataaiservices/resource-manager/readme.go.md b/specification/healthdataaiservices/resource-manager/readme.go.md new file mode 100644 index 000000000000..48c32e82324f --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/readme.go.md @@ -0,0 +1,11 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) && $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/resourcemanager/healthdataaiservices/armhealthdataaiservices +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) +``` diff --git a/specification/healthdataaiservices/resource-manager/readme.java.md b/specification/healthdataaiservices/resource-manager/readme.java.md new file mode 100644 index 000000000000..bb7849d909c6 --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/readme.java.md @@ -0,0 +1,13 @@ +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.azure.resourcemanager.healthdataaiservices +license-header: MICROSOFT_MIT_NO_VERSION +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-healthdataaiservices +``` \ No newline at end of file diff --git a/specification/healthdataaiservices/resource-manager/readme.md b/specification/healthdataaiservices/resource-manager/readme.md new file mode 100644 index 000000000000..5409d8061415 --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/readme.md @@ -0,0 +1,84 @@ +# healthdataaiservices + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for healthdataaiservices. + +## Getting Started + +To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: + +> `autorest readme.md` + +To see additional help and options, run: + +> `autorest --help` + +For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. + +--- + +## Configuration + +### Basic Information + +These are the global settings for the healthdataaiservices. + +```yaml +openapi-type: arm +openapi-subtype: rpaas +tag: package-2024-02-28-preview +``` + +### Tag: package-2024-02-28-preview + +These settings apply only when `--tag=package-2024-02-28-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-02-28-preview' +input-file: + - Microsoft.HealthDataAIServices/preview/2024-02-28-preview/openapi.json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-resource-manager-schemas + - repo: azure-cli-extensions + - repo: azure-powershell +``` +## Az + +See configuration in [readme.az.md](./readme.az.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) + +## Java + +See configuration in [readme.java.md](./readme.java.md) diff --git a/specification/healthdataaiservices/resource-manager/readme.python.md b/specification/healthdataaiservices/resource-manager/readme.python.md new file mode 100644 index 000000000000..a495ce059da5 --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/readme.python.md @@ -0,0 +1,18 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(python) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-healthdataaiservices +namespace: azure.mgmt.healthdataaiservices +package-version: 1.0.0b1 +clear-output-folder: true +``` + +``` yaml $(python) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/healthdataaiservices/azure-mgmt-healthdataaiservices/azure/mgmt/healthdataaiservices +``` diff --git a/specification/healthdataaiservices/resource-manager/readme.typescript.md b/specification/healthdataaiservices/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..923d2cce97da --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/readme.typescript.md @@ -0,0 +1,14 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/arm-healthdataaiservices" + output-folder: "$(typescript-sdks-folder)/sdk/healthdataaiservices/arm-healthdataaiservices" + payload-flattening-threshold: 1 + clear-output-folder: true + generate-metadata: true +``` diff --git a/specification/informatica/Informatica.DataManagement/client.tsp b/specification/informatica/Informatica.DataManagement.Management/client.tsp similarity index 100% rename from specification/informatica/Informatica.DataManagement/client.tsp rename to specification/informatica/Informatica.DataManagement.Management/client.tsp diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Operations_List_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Operations_List_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Operations_List_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Operations_List_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Operations_List_MinimumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Operations_List_MinimumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Operations_List_MinimumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Operations_List_MinimumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_CreateOrUpdate_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_CreateOrUpdate_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_CreateOrUpdate_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_CreateOrUpdate_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_CreateOrUpdate_MinimumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_CreateOrUpdate_MinimumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_CreateOrUpdate_MinimumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_CreateOrUpdate_MinimumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Delete_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_Delete_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Delete_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_Delete_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Delete_MinimumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_Delete_MinimumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Delete_MinimumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_Delete_MinimumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_GetAllServerlessRuntimes_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_GetAllServerlessRuntimes_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_GetAllServerlessRuntimes_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_GetAllServerlessRuntimes_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_GetAllServerlessRuntimes_MinimumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_GetAllServerlessRuntimes_MinimumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_GetAllServerlessRuntimes_MinimumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_GetAllServerlessRuntimes_MinimumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_GetServerlessMetadata_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_GetServerlessMetadata_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_GetServerlessMetadata_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_GetServerlessMetadata_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_GetServerlessMetadata_MinimumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_GetServerlessMetadata_MinimumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_GetServerlessMetadata_MinimumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_GetServerlessMetadata_MinimumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Get_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_Get_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Get_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_Get_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Get_MinimumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_Get_MinimumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Get_MinimumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_Get_MinimumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_ListByResourceGroup_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_ListByResourceGroup_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_ListByResourceGroup_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_ListByResourceGroup_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_ListByResourceGroup_MinimumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_ListByResourceGroup_MinimumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_ListByResourceGroup_MinimumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_ListByResourceGroup_MinimumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_ListBySubscription_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_ListBySubscription_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_ListBySubscription_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_ListBySubscription_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_ListBySubscription_MinimumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_ListBySubscription_MinimumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_ListBySubscription_MinimumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_ListBySubscription_MinimumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Update_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_Update_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Update_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_Update_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Update_MinimumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_Update_MinimumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/Organizations_Update_MinimumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/Organizations_Update_MinimumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_CheckDependencies_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_CheckDependencies_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_CheckDependencies_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_CheckDependencies_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_CheckDependencies_MinimumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_CheckDependencies_MinimumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_CheckDependencies_MinimumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_CheckDependencies_MinimumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_CreateOrUpdate_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_CreateOrUpdate_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_CreateOrUpdate_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_CreateOrUpdate_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_CreateOrUpdate_MinimumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_CreateOrUpdate_MinimumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_CreateOrUpdate_MinimumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_CreateOrUpdate_MinimumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_Delete_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_Delete_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_Delete_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_Delete_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_Get_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_Get_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_Get_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_Get_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_Get_MinimumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_Get_MinimumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_Get_MinimumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_Get_MinimumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_ListByInformaticaOrganizationResource_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_ListByInformaticaOrganizationResource_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_ListByInformaticaOrganizationResource_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_ListByInformaticaOrganizationResource_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_ServerlessResourceById_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_ServerlessResourceById_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_ServerlessResourceById_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_ServerlessResourceById_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_StartFailedServerlessRuntime_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_StartFailedServerlessRuntime_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_StartFailedServerlessRuntime_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_StartFailedServerlessRuntime_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_Update_MaximumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_Update_MaximumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_Update_MaximumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_Update_MaximumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_Update_MinimumSet_Gen.json b/specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_Update_MinimumSet_Gen.json similarity index 100% rename from specification/informatica/Informatica.DataManagement/examples/2024-05-08/ServerlessRuntimes_Update_MinimumSet_Gen.json rename to specification/informatica/Informatica.DataManagement.Management/examples/2024-05-08/ServerlessRuntimes_Update_MinimumSet_Gen.json diff --git a/specification/informatica/Informatica.DataManagement/main.tsp b/specification/informatica/Informatica.DataManagement.Management/main.tsp similarity index 100% rename from specification/informatica/Informatica.DataManagement/main.tsp rename to specification/informatica/Informatica.DataManagement.Management/main.tsp diff --git a/specification/informatica/Informatica.DataManagement.Management/tspconfig.yaml b/specification/informatica/Informatica.DataManagement.Management/tspconfig.yaml new file mode 100644 index 000000000000..21d2ab7f073f --- /dev/null +++ b/specification/informatica/Informatica.DataManagement.Management/tspconfig.yaml @@ -0,0 +1,31 @@ +parameters: + "service-dir": + default: "sdk/informaticadatamanagement" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + emitter-output-dir: "{project-root}/.." + azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openapi.json" + examples-directory: "{project-root}/examples" + # "@azure-tools/typespec-python": + # package-dir: "azure-mgmt-informaticadatamanagement" + # package-name: "{package-dir}" + # flavor: "azure" + # "@azure-tools/typespec-java": + # package-dir: "azure-resourcemanager-informaticadatamanagement" + # flavor: "azure" + # namespace: "com.azure.resourcemanager.informaticadatamanagement" + # service-name: "Informatica DataManagement" + # examples-directory: "examples" + "@azure-tools/typespec-csharp": + flavor: azure + clear-output-folder: true + namespace: "Azure.ResourceManager.InformaticaDataManagement" +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/informatica/Informatica.DataManagement/tspconfig.yaml b/specification/informatica/Informatica.DataManagement/tspconfig.yaml deleted file mode 100644 index b3a0a313df39..000000000000 --- a/specification/informatica/Informatica.DataManagement/tspconfig.yaml +++ /dev/null @@ -1,28 +0,0 @@ -parameters: - "service-dir": - default: "sdk/informaticadatamanagement" -emit: - - "@azure-tools/typespec-autorest" -options: - "@azure-tools/typespec-autorest": - emitter-output-dir: "{project-root}/.." - azure-resource-provider-folder: "resource-manager" - output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openapi.json" - examples-directory: "{project-root}/examples" - "@azure-tools/typespec-python": - package-dir: "azure-mgmt-informaticadatamanagement" - package-name: "{package-dir}" - flavor: "azure" - # "@azure-tools/typespec-java": - # package-dir: "azure-resourcemanager-informaticadatamanagement" - # flavor: "azure" - # namespace: "com.azure.resourcemanager.informaticadatamanagement" - # service-name: "Informatica DataManagement" - # examples-directory: "examples" - "@azure-tools/typespec-csharp": - flavor: azure - clear-output-folder: true - namespace: "Azure.ResourceManager.InformaticaDataManagement" -linter: - extends: - - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/informatica/resource-manager/readme.md b/specification/informatica/resource-manager/readme.md index 1b044bb17cbf..efdc4d0e1e4c 100644 --- a/specification/informatica/resource-manager/readme.md +++ b/specification/informatica/resource-manager/readme.md @@ -30,6 +30,11 @@ openapi-subtype: rpaas tag: package-2024-05-08 ``` +``` yaml +modelerfour: + flatten-models: false +``` + ### Tag: package-2024-05-08 These settings apply only when `--tag=package-2024-05-08` is specified on the command line. diff --git a/specification/informatica/resource-manager/readme.python.md b/specification/informatica/resource-manager/readme.python.md index 43dd631bea18..01f0b3001521 100644 --- a/specification/informatica/resource-manager/readme.python.md +++ b/specification/informatica/resource-manager/readme.python.md @@ -4,6 +4,7 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. ``` yaml $(python) +title: InformaticaDataMgmtClient azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-informaticadatamanagement @@ -14,5 +15,5 @@ clear-output-folder: true ``` yaml $(python) no-namespace-folders: true -output-folder: $(python-sdks-folder)/informatica/azure-mgmt-informaticadatamanagement/azure/mgmt/informaticadatamanagement +output-folder: $(python-sdks-folder)/informaticadatamanagement/azure-mgmt-informaticadatamanagement/azure/mgmt/informaticadatamanagement ``` diff --git a/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/tspconfig.yaml b/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/tspconfig.yaml index e0ea3255299a..7952ec0caa95 100644 --- a/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/tspconfig.yaml +++ b/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/tspconfig.yaml @@ -4,6 +4,9 @@ options: "@azure-tools/typespec-autorest": emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openapi.json" examples-directory: "{project-root}/examples" omit-unreachable-types: true diff --git a/specification/iotoperationsmq/IoTOperationsMQ.Management/main.tsp b/specification/iotoperationsmq/IoTOperationsMQ.Management/main.tsp index e75e801e8293..4b10424701e1 100644 --- a/specification/iotoperationsmq/IoTOperationsMQ.Management/main.tsp +++ b/specification/iotoperationsmq/IoTOperationsMQ.Management/main.tsp @@ -44,7 +44,13 @@ interface Mq { MqResource, LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; - update is ArmResourcePatchSync; + update is ArmCustomPatchSync< + MqResource, + Azure.ResourceManager.Foundations.ResourceUpdateModel< + MqResource, + MqProperties + > + >; delete is ArmResourceDeleteWithoutOkAsync; listByResourceGroup is ArmResourceListByParent; listBySubscription is ArmListBySubscription; @@ -60,9 +66,15 @@ interface Broker { BrokerResource, LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; - update is ArmResourcePatchSync; + update is ArmCustomPatchSync< + BrokerResource, + Azure.ResourceManager.Foundations.ResourceUpdateModel< + BrokerResource, + BrokerProperties + > + >; delete is ArmResourceDeleteWithoutOkAsync; - listByResourceGroup is ArmResourceListByParent; + listByMqResource is ArmResourceListByParent; } // /mq/broker/listener resource Operations @@ -75,12 +87,15 @@ interface BrokerListener { BrokerListenerResource, LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; - update is ArmResourcePatchSync< + update is ArmCustomPatchSync< BrokerListenerResource, - BrokerListenerProperties + Azure.ResourceManager.Foundations.ResourceUpdateModel< + BrokerListenerResource, + BrokerListenerProperties + > >; delete is ArmResourceDeleteWithoutOkAsync; - listByResourceGroup is ArmResourceListByParent; + listByBrokerResource is ArmResourceListByParent; } // /mq/broker/authentication resource Operations @@ -93,12 +108,15 @@ interface BrokerAuthentication { BrokerAuthenticationResource, LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; - update is ArmResourcePatchSync< + update is ArmCustomPatchSync< BrokerAuthenticationResource, - BrokerAuthenticationProperties + Azure.ResourceManager.Foundations.ResourceUpdateModel< + BrokerAuthenticationResource, + BrokerAuthenticationProperties + > >; delete is ArmResourceDeleteWithoutOkAsync; - listByResourceGroup is ArmResourceListByParent; + listByBrokerResource is ArmResourceListByParent; } // /mq/broker/authorization resource Operations @@ -111,12 +129,15 @@ interface BrokerAuthorization { BrokerAuthorizationResource, LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; - update is ArmResourcePatchSync< + update is ArmCustomPatchSync< BrokerAuthorizationResource, - BrokerAuthorizationProperties + Azure.ResourceManager.Foundations.ResourceUpdateModel< + BrokerAuthorizationResource, + BrokerAuthorizationProperties + > >; delete is ArmResourceDeleteWithoutOkAsync; - listByResourceGroup is ArmResourceListByParent; + listByBrokerResource is ArmResourceListByParent; } // /mq/mqttbridgeConnector resource Operations @@ -129,12 +150,15 @@ interface MqttBridgeConnector { MqttBridgeConnectorResource, LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; - update is ArmResourcePatchSync< + update is ArmCustomPatchSync< MqttBridgeConnectorResource, - MqttBridgeConnectorProperties + Azure.ResourceManager.Foundations.ResourceUpdateModel< + MqttBridgeConnectorResource, + MqttBridgeConnectorProperties + > >; delete is ArmResourceDeleteWithoutOkAsync; - listByResourceGroup is ArmResourceListByParent; + listByMqResource is ArmResourceListByParent; } // /mq/mqttbridgeConnector/topicMap resource Operations @@ -147,12 +171,15 @@ interface MqttBridgeTopicMap { MqttBridgeTopicMapResource, LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; - update is ArmResourcePatchSync< + update is ArmCustomPatchSync< MqttBridgeTopicMapResource, - MqttBridgeTopicMapProperties + Azure.ResourceManager.Foundations.ResourceUpdateModel< + MqttBridgeTopicMapResource, + MqttBridgeTopicMapProperties + > >; delete is ArmResourceDeleteWithoutOkAsync; - listByResourceGroup is ArmResourceListByParent; + listByMqttBridgeConnectorResource is ArmResourceListByParent; } // /mq/diagnosticService resource Operations @@ -165,12 +192,15 @@ interface DiagnosticService { DiagnosticServiceResource, LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; - update is ArmResourcePatchSync< + update is ArmCustomPatchSync< DiagnosticServiceResource, - DiagnosticServiceProperties + Azure.ResourceManager.Foundations.ResourceUpdateModel< + DiagnosticServiceResource, + DiagnosticServiceProperties + > >; delete is ArmResourceDeleteWithoutOkAsync; - listByResourceGroup is ArmResourceListByParent; + listByMqResource is ArmResourceListByParent; } // /mq/datalakeConnector resource Operations @@ -183,12 +213,15 @@ interface DataLakeConnector { DataLakeConnectorResource, LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; - update is ArmResourcePatchSync< + update is ArmCustomPatchSync< DataLakeConnectorResource, - DataLakeConnectorProperties + Azure.ResourceManager.Foundations.ResourceUpdateModel< + DataLakeConnectorResource, + DataLakeConnectorProperties + > >; delete is ArmResourceDeleteWithoutOkAsync; - listByResourceGroup is ArmResourceListByParent; + listByMqResource is ArmResourceListByParent; } // /mq/dataLakeconnector/topicMap resource Operations @@ -201,12 +234,15 @@ interface DataLakeConnectorTopicMap { DataLakeTopicMapResource, LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; - update is ArmResourcePatchSync< + update is ArmCustomPatchSync< DataLakeTopicMapResource, - DataLakeConnectorTopicMapProperties + Azure.ResourceManager.Foundations.ResourceUpdateModel< + DataLakeTopicMapResource, + DataLakeConnectorTopicMapProperties + > >; delete is ArmResourceDeleteWithoutOkAsync; - listByResourceGroup is ArmResourceListByParent; + listByDataLakeConnectorResource is ArmResourceListByParent; } // /mq/kafkaConnector resource Operations @@ -219,12 +255,15 @@ interface KafkaConnector { KafkaConnectorResource, LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; - update is ArmResourcePatchSync< + update is ArmCustomPatchSync< KafkaConnectorResource, - KafkaConnectorProperties + Azure.ResourceManager.Foundations.ResourceUpdateModel< + KafkaConnectorResource, + KafkaConnectorProperties + > >; delete is ArmResourceDeleteWithoutOkAsync; - listByResourceGroup is ArmResourceListByParent; + listByMqResource is ArmResourceListByParent; } // /mq/kafkaConnector/topicMap resource Operations @@ -237,10 +276,13 @@ interface KafkaConnectorTopicMap { KafkaTopicMapResource, LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; - update is ArmResourcePatchSync< + update is ArmCustomPatchSync< KafkaTopicMapResource, - KafkaTopicMapProperties + Azure.ResourceManager.Foundations.ResourceUpdateModel< + KafkaTopicMapResource, + KafkaTopicMapProperties + > >; delete is ArmResourceDeleteWithoutOkAsync; - listByResourceGroup is ArmResourceListByParent; + listByKafkaConnectorResource is ArmResourceListByParent; } diff --git a/specification/iotoperationsmq/IoTOperationsMQ.Management/tspconfig.yaml b/specification/iotoperationsmq/IoTOperationsMQ.Management/tspconfig.yaml index 2db459dcd55a..7ccf5b2a7949 100644 --- a/specification/iotoperationsmq/IoTOperationsMQ.Management/tspconfig.yaml +++ b/specification/iotoperationsmq/IoTOperationsMQ.Management/tspconfig.yaml @@ -4,6 +4,9 @@ options: "@azure-tools/typespec-autorest": emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/iotoperationsmq.json" examples-directory: "{project-root}/examples" linter: diff --git a/specification/iotoperationsmq/resource-manager/Microsoft.IoTOperationsMQ/preview/2023-10-04-preview/iotoperationsmq.json b/specification/iotoperationsmq/resource-manager/Microsoft.IoTOperationsMQ/preview/2023-10-04-preview/iotoperationsmq.json index 0d99a964e857..70205ed0f26a 100644 --- a/specification/iotoperationsmq/resource-manager/Microsoft.IoTOperationsMQ/preview/2023-10-04-preview/iotoperationsmq.json +++ b/specification/iotoperationsmq/resource-manager/Microsoft.IoTOperationsMQ/preview/2023-10-04-preview/iotoperationsmq.json @@ -4450,6 +4450,7 @@ }, "properties": { "$ref": "#/definitions/BrokerAuthenticationResourceUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } @@ -4731,6 +4732,7 @@ }, "properties": { "$ref": "#/definitions/BrokerAuthorizationResourceUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } @@ -4989,6 +4991,7 @@ }, "properties": { "$ref": "#/definitions/BrokerListenerResourceUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } @@ -5263,6 +5266,7 @@ }, "properties": { "$ref": "#/definitions/BrokerResourceUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } @@ -5785,6 +5789,7 @@ }, "properties": { "$ref": "#/definitions/DataLakeConnectorResourceUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } @@ -6137,6 +6142,7 @@ }, "properties": { "$ref": "#/definitions/DataLakeTopicMapResourceUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } @@ -6458,6 +6464,7 @@ }, "properties": { "$ref": "#/definitions/DiagnosticServiceResourceUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } @@ -6871,6 +6878,7 @@ }, "properties": { "$ref": "#/definitions/KafkaConnectorResourceUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } @@ -7473,6 +7481,7 @@ }, "properties": { "$ref": "#/definitions/KafkaTopicMapResourceUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } @@ -8100,6 +8109,7 @@ }, "properties": { "$ref": "#/definitions/MqttBridgeConnectorResourceUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } @@ -8518,6 +8528,7 @@ }, "properties": { "$ref": "#/definitions/MqttBridgeTopicMapResourceUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } diff --git a/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/tspconfig.yaml b/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/tspconfig.yaml index e0ea3255299a..7952ec0caa95 100644 --- a/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/tspconfig.yaml +++ b/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/tspconfig.yaml @@ -4,6 +4,9 @@ options: "@azure-tools/typespec-autorest": emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openapi.json" examples-directory: "{project-root}/examples" omit-unreachable-types: true diff --git a/specification/kubernetesruntime/KubernetesRuntime.Management/bgppeer.tsp b/specification/kubernetesruntime/KubernetesRuntime.Management/bgppeer.tsp index 8fbdcec221ff..b712c105ebbb 100644 --- a/specification/kubernetesruntime/KubernetesRuntime.Management/bgppeer.tsp +++ b/specification/kubernetesruntime/KubernetesRuntime.Management/bgppeer.tsp @@ -50,5 +50,5 @@ interface BgpPeers { @renamedFrom(Versions.v2024_03_01, "delete") @removed(Versions.v2024_03_01) oldDelete is ArmResourceDeleteWithoutOkAsync; - listByParent is ArmResourceListByParent; + list is ArmResourceListByParent; } diff --git a/specification/kubernetesruntime/KubernetesRuntime.Management/loadbalancer.tsp b/specification/kubernetesruntime/KubernetesRuntime.Management/loadbalancer.tsp index 2e13742d83cc..3e66d03532e1 100644 --- a/specification/kubernetesruntime/KubernetesRuntime.Management/loadbalancer.tsp +++ b/specification/kubernetesruntime/KubernetesRuntime.Management/loadbalancer.tsp @@ -69,5 +69,5 @@ interface LoadBalancers { @renamedFrom(Versions.v2024_03_01, "delete") @removed(Versions.v2024_03_01) oldDelete is ArmResourceDeleteWithoutOkAsync; - listByParent is ArmResourceListByParent; + list is ArmResourceListByParent; } diff --git a/specification/kubernetesruntime/KubernetesRuntime.Management/service.tsp b/specification/kubernetesruntime/KubernetesRuntime.Management/service.tsp index 59b5ffd5b750..79b1700e0f9c 100644 --- a/specification/kubernetesruntime/KubernetesRuntime.Management/service.tsp +++ b/specification/kubernetesruntime/KubernetesRuntime.Management/service.tsp @@ -33,5 +33,5 @@ interface Services { get is ArmResourceRead; createOrUpdate is ArmResourceCreateOrReplaceSync; delete is ArmResourceDeleteSync; - listByParent is ArmResourceListByParent; + list is ArmResourceListByParent; } diff --git a/specification/kubernetesruntime/KubernetesRuntime.Management/storageclass.tsp b/specification/kubernetesruntime/KubernetesRuntime.Management/storageclass.tsp index c5569c2a21ba..f45b061e8d77 100644 --- a/specification/kubernetesruntime/KubernetesRuntime.Management/storageclass.tsp +++ b/specification/kubernetesruntime/KubernetesRuntime.Management/storageclass.tsp @@ -293,5 +293,5 @@ interface StorageClass { StorageClassResourceUpdate >; delete is ArmResourceDeleteWithoutOkAsync; - listByParent is ArmResourceListByParent; + list is ArmResourceListByParent; } diff --git a/specification/kubernetesruntime/KubernetesRuntime.Management/tspconfig.yaml b/specification/kubernetesruntime/KubernetesRuntime.Management/tspconfig.yaml index 08925b2deba6..2b176a8d0be5 100644 --- a/specification/kubernetesruntime/KubernetesRuntime.Management/tspconfig.yaml +++ b/specification/kubernetesruntime/KubernetesRuntime.Management/tspconfig.yaml @@ -8,6 +8,8 @@ options: "@azure-tools/typespec-autorest": emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: resource-manager + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true examples-directory: "{project-root}/examples" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/kubernetesruntime.json" use-read-only-status-schema: true diff --git a/specification/kubernetesruntime/resource-manager/readme.md b/specification/kubernetesruntime/resource-manager/readme.md index 555b0430de59..17b4c30b42d2 100644 --- a/specification/kubernetesruntime/resource-manager/readme.md +++ b/specification/kubernetesruntime/resource-manager/readme.md @@ -64,7 +64,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js diff --git a/specification/liftrastronomer/Astronomer.Astro.Management/main.tsp b/specification/liftrastronomer/Astronomer.Astro.Management/main.tsp index 3c8e39dadbc4..e3a4bc25cc91 100644 --- a/specification/liftrastronomer/Astronomer.Astro.Management/main.tsp +++ b/specification/liftrastronomer/Astronomer.Astro.Management/main.tsp @@ -59,7 +59,13 @@ interface Organizations { OrganizationResource, LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; - update is ArmResourcePatchAsync; + update is ArmCustomPatchAsync< + OrganizationResource, + Azure.ResourceManager.Foundations.ResourceUpdateModel< + OrganizationResource, + OrganizationProperties + > + >; delete is ArmResourceDeleteWithoutOkAsync; listByResourceGroup is ArmResourceListByParent; listBySubscription is ArmListBySubscription; diff --git a/specification/liftrastronomer/Astronomer.Astro.Management/tspconfig.yaml b/specification/liftrastronomer/Astronomer.Astro.Management/tspconfig.yaml index e014e74cb57b..dc219e3ddd38 100644 --- a/specification/liftrastronomer/Astronomer.Astro.Management/tspconfig.yaml +++ b/specification/liftrastronomer/Astronomer.Astro.Management/tspconfig.yaml @@ -10,5 +10,8 @@ options: "@azure-tools/typespec-autorest": emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/astronomer.json" examples-directory: "{project-root}/examples" diff --git a/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/astronomer.json b/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/astronomer.json index 544b4801dee7..4b41720a43b1 100644 --- a/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/astronomer.json +++ b/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/astronomer.json @@ -827,6 +827,7 @@ }, "properties": { "$ref": "#/definitions/OrganizationResourceUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } diff --git a/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/astronomer.json b/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/astronomer.json index 6aa1f9e141de..dcfc9c84ea45 100644 --- a/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/astronomer.json +++ b/specification/liftrastronomer/resource-manager/Astronomer.Astro/stable/2023-08-01/astronomer.json @@ -827,6 +827,7 @@ }, "properties": { "$ref": "#/definitions/OrganizationResourceUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } diff --git a/specification/liftrqumulo/Qumulo.Storage.Management/tspconfig.yaml b/specification/liftrqumulo/Qumulo.Storage.Management/tspconfig.yaml index 1934664bb598..72b84d4019ad 100644 --- a/specification/liftrqumulo/Qumulo.Storage.Management/tspconfig.yaml +++ b/specification/liftrqumulo/Qumulo.Storage.Management/tspconfig.yaml @@ -6,6 +6,9 @@ options: use-read-only-status-schema: true emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/Qumulo.Storage.json" examples-directory: "{project-root}/examples" linter: diff --git a/specification/liftrqumulo/resource-manager/readme.go.md b/specification/liftrqumulo/resource-manager/readme.go.md index 0a58d895d454..6b8f28b1d784 100644 --- a/specification/liftrqumulo/resource-manager/readme.go.md +++ b/specification/liftrqumulo/resource-manager/readme.go.md @@ -8,29 +8,4 @@ module-name: sdk/resourcemanager/liftrqumulo/armqumulo module: github.com/Azure/azure-sdk-for-go/$(module-name) output-folder: $(go-sdk-folder)/$(module-name) azure-arm: true -directive: - - rename-model: - from: 'LiftrBase.Storage.FileSystemResourceUpdate' - to: FileSystemResourceUpdate - - rename-model: - from: 'LiftrBase.Storage.FileSystemResource' - to: FileSystemResource - - rename-model: - from: 'LiftrBase.Storage.FileSystemResourceUpdateProperties' - to: FileSystemResourceUpdateProperties - - rename-model: - from: 'LiftrBase.Storage.FileSystemResourceProperties' - to: FileSystemResourceProperties - - rename-model: - from: 'LiftrBase.MarketplaceDetails' - to: MarketplaceDetails - - rename-model: - from: 'LiftrBase.MarketplaceSubscriptionStatus' - to: MarketplaceSubscriptionStatus - - rename-model: - from: 'LiftrBase.UserDetails' - to: UserDetails - - rename-model: - from: 'LiftrBase.ProvisioningState' - to: ProvisioningState ``` \ No newline at end of file diff --git a/specification/liftrqumulo/resource-manager/readme.md b/specification/liftrqumulo/resource-manager/readme.md index f7cd7746a285..d6fd1514d04e 100644 --- a/specification/liftrqumulo/resource-manager/readme.md +++ b/specification/liftrqumulo/resource-manager/readme.md @@ -28,6 +28,31 @@ These are the global settings for the Qumulo.Storage. openapi-type: arm openapi-subtype: rpaas tag: package-2024-06-19 +directive: + - rename-model: + from: 'LiftrBase.Storage.FileSystemResourceUpdate' + to: FileSystemResourceUpdate + - rename-model: + from: 'LiftrBase.Storage.FileSystemResource' + to: FileSystemResource + - rename-model: + from: 'LiftrBase.Storage.FileSystemResourceUpdateProperties' + to: FileSystemResourceUpdateProperties + - rename-model: + from: 'LiftrBase.Storage.FileSystemResourceProperties' + to: FileSystemResourceProperties + - rename-model: + from: 'LiftrBase.MarketplaceDetails' + to: MarketplaceDetails + - rename-model: + from: 'LiftrBase.MarketplaceSubscriptionStatus' + to: MarketplaceSubscriptionStatus + - rename-model: + from: 'LiftrBase.UserDetails' + to: UserDetails + - rename-model: + from: 'LiftrBase.ProvisioningState' + to: ProvisioningState ``` diff --git a/specification/liftrqumulo/resource-manager/readme.python.md b/specification/liftrqumulo/resource-manager/readme.python.md index d69356f3247a..92bab489c2e5 100644 --- a/specification/liftrqumulo/resource-manager/readme.python.md +++ b/specification/liftrqumulo/resource-manager/readme.python.md @@ -19,3 +19,10 @@ clear-output-folder: true no-namespace-folders: true output-folder: $(python-sdks-folder)/qumulo/azure-mgmt-qumulo/azure/mgmt/qumulo ``` + +``` yaml $(python) +directive: + - from: swagger-document + where: $["definitions"]["LiftrBase.Storage.FileSystemResourceProperties"] + transform: $["properties"]["privateIPs"]["x-ms-client-name"] = "private_ips" +``` diff --git a/specification/liftrqumulo/resource-manager/readme.typescript.md b/specification/liftrqumulo/resource-manager/readme.typescript.md index d76e0cab6129..3a02e4bea4c1 100644 --- a/specification/liftrqumulo/resource-manager/readme.typescript.md +++ b/specification/liftrqumulo/resource-manager/readme.typescript.md @@ -10,30 +10,4 @@ typescript: output-folder: "$(typescript-sdks-folder)/sdk/liftrqumulo/arm-qumulo" payload-flattening-threshold: 1 generate-metadata: true - -directive: - - rename-model: - from: 'LiftrBase.Storage.FileSystemResourceUpdate' - to: FileSystemResourceUpdate - - rename-model: - from: 'LiftrBase.Storage.FileSystemResource' - to: FileSystemResource - - rename-model: - from: 'LiftrBase.Storage.FileSystemResourceUpdateProperties' - to: FileSystemResourceUpdateProperties - - rename-model: - from: 'LiftrBase.Storage.FileSystemResourceProperties' - to: FileSystemResourceProperties - - rename-model: - from: 'LiftrBase.MarketplaceDetails' - to: MarketplaceDetails - - rename-model: - from: 'LiftrBase.MarketplaceSubscriptionStatus' - to: MarketplaceSubscriptionStatus - - rename-model: - from: 'LiftrBase.UserDetails' - to: UserDetails - - rename-model: - from: 'LiftrBase.ProvisioningState' - to: ProvisioningState ``` diff --git a/specification/liftrqumulo/resource-manager/sdk-suppressions.yaml b/specification/liftrqumulo/resource-manager/sdk-suppressions.yaml index 38ec1fd82d93..fc6ce288b542 100644 --- a/specification/liftrqumulo/resource-manager/sdk-suppressions.yaml +++ b/specification/liftrqumulo/resource-manager/sdk-suppressions.yaml @@ -7,3 +7,10 @@ suppressions: - Field `InitialCapacity` of struct `FileSystemResourceProperties` has been removed - Type of `FileSystemResourceProperties.StorageSKU` has been changed from `*StorageSKU` to `*string` - "`ProvisioningStateNotSpecified` from enum `ProvisioningState` has been removed" + azure-sdk-for-js: + - package: '@azure/arm-qumulo' + breaking-changes: + - Interface FileSystemResource no longer has parameter initialCapacity + - Interface FileSystemResourceUpdateProperties no longer has parameter clusterLoginUrl + - Interface FileSystemResourceUpdateProperties no longer has parameter privateIPs + - Type of parameter storageSku of interface FileSystemResource is changed from StorageSku to string diff --git a/specification/loadtestservice/LoadTestService.Management/models.tsp b/specification/loadtestservice/LoadTestService.Management/models.tsp index 9f6f2d084916..8bdabcbea9de 100644 --- a/specification/loadtestservice/LoadTestService.Management/models.tsp +++ b/specification/loadtestservice/LoadTestService.Management/models.tsp @@ -280,5 +280,5 @@ model QuotaBucketRequestPropertiesDimensions { } @doc("Values returned by the List operation.") -model OutboundEnvironmentEndpointCollection +model PagedOutboundEnvironmentEndpoint is Azure.Core.Page; diff --git a/specification/loadtestservice/LoadTestService.Management/routes.tsp b/specification/loadtestservice/LoadTestService.Management/routes.tsp index c42dca33c8df..3f00bd06eb2c 100644 --- a/specification/loadtestservice/LoadTestService.Management/routes.tsp +++ b/specification/loadtestservice/LoadTestService.Management/routes.tsp @@ -40,9 +40,12 @@ interface LoadTests { >; #suppress "@azure-tools/typespec-azure-resource-manager/lro-location-header" "Existing API" - update is ArmResourcePatchAsync< + update is ArmCustomPatchAsync< LoadTestResource, - LoadTestProperties, + Azure.ResourceManager.Foundations.ResourceUpdateModel< + LoadTestResource, + LoadTestProperties + >, LroHeaders = ArmAsyncOperationHeader & ArmLroLocationHeader & Azure.Core.Foundations.RetryAfterHeader @@ -56,7 +59,7 @@ interface LoadTests { outboundNetworkDependenciesEndpoints is CustomOperations.ArmResourceActionSyncCustomGet< LoadTestResource, void, - OutboundEnvironmentEndpointCollection + PagedOutboundEnvironmentEndpoint >; } @@ -89,13 +92,16 @@ interface LoadTestMappings { #suppress "@azure-tools/typespec-azure-resource-manager/lro-location-header" "Existing API" @added(APIVersions.v2023_12_01_preview) - update is ArmResourcePatchSync< + update is ArmCustomPatchSync< LoadTestMappingResource, - LoadTestMappingProperties + Azure.ResourceManager.Foundations.ResourceUpdateModel< + LoadTestMappingResource, + LoadTestMappingProperties + > >; @added(APIVersions.v2023_12_01_preview) - listByScope is ArmResourceListByParent; + list is ArmResourceListByParent; } @armResourceOperations @@ -111,11 +117,14 @@ interface LoadTestProfileMappings { #suppress "@azure-tools/typespec-azure-resource-manager/lro-location-header" "Existing API" @added(APIVersions.v2023_12_01_preview) - update is ArmResourcePatchSync< + update is ArmCustomPatchSync< LoadTestProfileMappingResource, - LoadTestProfileMappingProperties + Azure.ResourceManager.Foundations.ResourceUpdateModel< + LoadTestProfileMappingResource, + LoadTestProfileMappingProperties + > >; @added(APIVersions.v2023_12_01_preview) - listByScope is ArmResourceListByParent; + list is ArmResourceListByParent; } diff --git a/specification/loadtestservice/LoadTestService.Management/tspconfig.yaml b/specification/loadtestservice/LoadTestService.Management/tspconfig.yaml index 31ebfdc219aa..707efbd8543a 100644 --- a/specification/loadtestservice/LoadTestService.Management/tspconfig.yaml +++ b/specification/loadtestservice/LoadTestService.Management/tspconfig.yaml @@ -10,6 +10,9 @@ parameters: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true emitter-output-dir: "{project-root}/.." examples-directory: ./examples output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/loadtestservice.json" diff --git a/specification/loadtestservice/LoadTestService/models.tsp b/specification/loadtestservice/LoadTestService/models.tsp index 5f1ccb5d57ba..77317b553889 100644 --- a/specification/loadtestservice/LoadTestService/models.tsp +++ b/specification/loadtestservice/LoadTestService/models.tsp @@ -496,9 +496,9 @@ model TestInputArtifacts { @doc("File info") model FileInfo { + #suppress "@azure-tools/typespec-azure-core/key-visibility-required" "model is output only" @doc("Name of the file.") @key - @visibility fileName: string; @doc("File URL.") diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/loadtestservice.json b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/loadtestservice.json index 86864978e6a7..28a044009472 100644 --- a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/loadtestservice.json +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/preview/2023-12-01-preview/loadtestservice.json @@ -1276,6 +1276,7 @@ "properties": { "properties": { "$ref": "#/definitions/LoadTestMappingResourceUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } @@ -1365,6 +1366,7 @@ "properties": { "properties": { "$ref": "#/definitions/LoadTestProfileMappingResourceUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } @@ -1474,6 +1476,7 @@ }, "properties": { "$ref": "#/definitions/LoadTestResourceUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/stable/2022-12-01/loadtestservice.json b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/stable/2022-12-01/loadtestservice.json index deefcea56e76..4fdb26dd2c8d 100644 --- a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/stable/2022-12-01/loadtestservice.json +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/stable/2022-12-01/loadtestservice.json @@ -824,6 +824,7 @@ }, "properties": { "$ref": "#/definitions/LoadTestResourceUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } diff --git a/specification/machinelearningservices/AzureAI.Assets/routes.tsp b/specification/machinelearningservices/AzureAI.Assets/routes.tsp index 5837ecb73a1e..8aac5a8119e1 100644 --- a/specification/machinelearningservices/AzureAI.Assets/routes.tsp +++ b/specification/machinelearningservices/AzureAI.Assets/routes.tsp @@ -125,7 +125,7 @@ interface Indexes { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "Need to define route." @doc("List the latest version of each index. Latest is defined by most recent created by date.") - @route("/indexes/") + @route("/indexes") @get listLatest is Azure.Core.Foundations.Operation< { @@ -240,7 +240,7 @@ interface Prompts { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "Need to define route." @doc("List the latest version of each prompt. Latest is defined by most recent created by date.") - @route("/prompts/") + @route("/prompts") @get listLatest is Azure.Core.Foundations.Operation< { diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/mfe.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/mfe.json index fdab5a2bbdff..6ef3527532aa 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/mfe.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/mfe.json @@ -2613,13 +2613,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/marketplaceSubscriptions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models": { "get": { "tags": [ - "MarketplaceSubscription" + "ModelContainer" ], - "summary": "List containers.", - "operationId": "MarketplaceSubscriptions_List", + "summary": "List model containers.", + "operationId": "RegistryModelContainers_List", "produces": [ "application/json" ], @@ -2631,32 +2631,59 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/MarketplaceSubscriptionResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelContainerResourceArmPaginatedResult" + } } }, "x-ms-examples": { - "List Workspace Marketplace Subscription.": { - "$ref": "./examples/Workspace/MarketplaceSubscription/list.json" + "List Registry Model Container.": { + "$ref": "./examples/Registry/ModelContainer/list.json" } }, "x-ms-pageable": { @@ -2664,13 +2691,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/marketplaceSubscriptions/{name}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}": { "delete": { "tags": [ - "MarketplaceSubscription" + "ModelContainer" ], - "summary": "Delete Marketplace Subscription (asynchronous).", - "operationId": "MarketplaceSubscriptions_Delete", + "summary": "Delete container.", + "operationId": "RegistryModelContainers_Delete", "produces": [ "application/json" ], @@ -2682,12 +2709,12 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", - "name": "name", - "description": "Marketplace Subscription name.", + "name": "modelName", + "description": "Container name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -2697,6 +2724,12 @@ } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "202": { "description": "Accepted", "headers": { @@ -2718,19 +2751,16 @@ } } }, + "200": { + "description": "Success" + }, "204": { "description": "No Content" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { - "Delete Workspace Marketplace Subscription.": { - "$ref": "./examples/Workspace/MarketplaceSubscription/delete.json" + "Delete Registry Model Container.": { + "$ref": "./examples/Registry/ModelContainer/delete.json" } }, "x-ms-long-running-operation": true, @@ -2740,10 +2770,10 @@ }, "get": { "tags": [ - "MarketplaceSubscription" + "ModelContainer" ], "summary": "Get container.", - "operationId": "MarketplaceSubscriptions_Get", + "operationId": "RegistryModelContainers_Get", "produces": [ "application/json" ], @@ -2755,45 +2785,46 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", - "name": "name", - "description": "Container name.", + "name": "modelName", + "description": "Container name. This is case-sensitive.", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/MarketplaceSubscriptionResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelContainerResource" + } } }, "x-ms-examples": { - "Get Workspace Marketplace Subscription.": { - "$ref": "./examples/Workspace/MarketplaceSubscription/get.json" + "Get Registry Model Container.": { + "$ref": "./examples/Registry/ModelContainer/get.json" } } }, "put": { "tags": [ - "MarketplaceSubscription" + "ModelContainer" ], - "summary": "Create or update Marketplace Subscription (asynchronous).", - "operationId": "MarketplaceSubscriptions_CreateOrUpdate", + "summary": "Create or update model container.", + "operationId": "RegistryModelContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -2808,12 +2839,12 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", - "name": "name", - "description": "Marketplace Subscription name.", + "name": "modelName", + "description": "Container name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -2824,24 +2855,30 @@ { "in": "body", "name": "body", - "description": "Marketplace Subscription entity to apply during operation.", + "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/MarketplaceSubscriptionResource" + "$ref": "#/definitions/ModelContainerResource" } } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/MarketplaceSubscriptionResource" + "$ref": "#/definitions/ModelContainerResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/MarketplaceSubscriptionResource" + "$ref": "#/definitions/ModelContainerResource" }, "headers": { "x-ms-async-operation-timeout": { @@ -2854,17 +2891,11 @@ "type": "string" } } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Marketplace Subscription.": { - "$ref": "./examples/Workspace/MarketplaceSubscription/createOrUpdate.json" + "CreateOrUpdate Registry Model Container.": { + "$ref": "./examples/Registry/ModelContainer/createOrUpdate.json" } }, "x-ms-long-running-operation": true, @@ -2873,13 +2904,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions": { "get": { "tags": [ - "ModelContainer" + "ModelVersion" ], - "summary": "List model containers.", - "operationId": "RegistryModelContainers_List", + "summary": "List versions.", + "operationId": "RegistryModelVersions_List", "produces": [ "application/json" ], @@ -2893,12 +2924,57 @@ { "$ref": "registries.json#/parameters/RegistryNameParameter" }, + { + "in": "path", + "name": "modelName", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "version", + "description": "Version identifier.", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "Model description.", + "type": "string" + }, + { + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "properties", + "description": "Comma-separated list of property names (and optionally values). Example: prop1,prop2=value2", + "type": "string" + }, { "in": "query", "name": "listViewType", @@ -2937,13 +3013,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ModelContainerResourceArmPaginatedResult" + "$ref": "#/definitions/ModelVersionResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Registry Model Container.": { - "$ref": "./examples/Registry/ModelContainer/list.json" + "List Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/list.json" } }, "x-ms-pageable": { @@ -2951,13 +3027,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}": { "delete": { "tags": [ - "ModelContainer" + "ModelVersion" ], - "summary": "Delete container.", - "operationId": "RegistryModelContainers_Delete", + "summary": "Delete version.", + "operationId": "RegistryModelVersions_Delete", "produces": [ "application/json" ], @@ -2979,6 +3055,13 @@ "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -3019,8 +3102,8 @@ } }, "x-ms-examples": { - "Delete Registry Model Container.": { - "$ref": "./examples/Registry/ModelContainer/delete.json" + "Delete Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/delete.json" } }, "x-ms-long-running-operation": true, @@ -3030,10 +3113,10 @@ }, "get": { "tags": [ - "ModelContainer" + "ModelVersion" ], - "summary": "Get container.", - "operationId": "RegistryModelContainers_Get", + "summary": "Get version.", + "operationId": "RegistryModelVersions_Get", "produces": [ "application/json" ], @@ -3055,6 +3138,13 @@ "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -3069,22 +3159,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ModelContainerResource" + "$ref": "#/definitions/ModelVersionResource" } } }, "x-ms-examples": { - "Get Registry Model Container.": { - "$ref": "./examples/Registry/ModelContainer/get.json" + "Get Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/get.json" } } }, "put": { "tags": [ - "ModelContainer" + "ModelVersion" ], - "summary": "Create or update model container.", - "operationId": "RegistryModelContainers_CreateOrUpdate", + "summary": "Create or update version.", + "operationId": "RegistryModelVersions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -3110,15 +3200,22 @@ "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "in": "body", "name": "body", - "description": "Container entity to create or update.", + "description": "Version entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/ModelContainerResource" + "$ref": "#/definitions/ModelVersionResource" } } ], @@ -3132,13 +3229,13 @@ "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/ModelContainerResource" + "$ref": "#/definitions/ModelVersionResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/ModelContainerResource" + "$ref": "#/definitions/ModelVersionResource" }, "headers": { "x-ms-async-operation-timeout": { @@ -3154,8 +3251,8 @@ } }, "x-ms-examples": { - "CreateOrUpdate Registry Model Container.": { - "$ref": "./examples/Registry/ModelContainer/createOrUpdate.json" + "CreateOrUpdate Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/createOrUpdate.json" } }, "x-ms-long-running-operation": true, @@ -3164,13 +3261,16 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}/startPendingUpload": { + "post": { "tags": [ "ModelVersion" ], - "summary": "List versions.", - "operationId": "RegistryModelVersions_List", + "summary": "Generate a storage location and credential for the client to upload a model asset to.", + "operationId": "RegistryModelVersions_CreateOrGetStartPendingUpload", + "consumes": [ + "application/json" + ], "produces": [ "application/json" ], @@ -3187,80 +3287,84 @@ { "in": "path", "name": "modelName", - "description": "Container name. This is case-sensitive.", + "description": "Model name. This is case-sensitive.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" }, { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "query", - "name": "$orderBy", - "description": "Ordering of list.", - "type": "string" + "in": "body", + "name": "body", + "description": "Pending upload request object", + "required": true, + "schema": { + "$ref": "#/definitions/PendingUploadRequestDto" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PendingUploadResponseDto" + } + } + }, + "x-ms-examples": { + "CreateOrGetStartPendingUpload Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/createOrGetStartPendingUpload.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints": { + "get": { + "tags": [ + "BatchEndpoint" + ], + "summary": "Lists Batch inference endpoint in the workspace.", + "operationId": "BatchEndpoints_List", + "produces": [ + "application/json" + ], + "parameters": [ { - "in": "query", - "name": "$top", - "description": "Maximum number of records to return.", - "type": "integer", - "format": "int32" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "in": "query", - "name": "version", - "description": "Version identifier.", - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "query", - "name": "description", - "description": "Model description.", - "type": "string" + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "in": "query", - "name": "tags", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "query", - "name": "properties", - "description": "Comma-separated list of property names (and optionally values). Example: prop1,prop2=value2", - "type": "string" + "name": "count", + "description": "Number of endpoints to be retrieved in a page of results.", + "type": "integer", + "format": "int32" }, { - "in": "query", - "name": "listViewType", - "description": "View type for including/excluding (for example) archived entities.", - "type": "string", - "default": "ActiveOnly", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "value": "ActiveOnly" - }, - { - "value": "ArchivedOnly" - }, - { - "value": "All" - } - ] - } + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" } ], "responses": { @@ -3273,13 +3377,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ModelVersionResourceArmPaginatedResult" + "$ref": "#/definitions/BatchEndpointTrackedResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Registry Model Version.": { - "$ref": "./examples/Registry/ModelVersion/list.json" + "List Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/list.json" } }, "x-ms-pageable": { @@ -3287,13 +3391,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}": { "delete": { "tags": [ - "ModelVersion" + "BatchEndpoint" ], - "summary": "Delete version.", - "operationId": "RegistryModelVersions_Delete", + "summary": "Delete Batch Inference Endpoint (asynchronous).", + "operationId": "BatchEndpoints_Delete", "produces": [ "application/json" ], @@ -3305,20 +3409,12 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "registries.json#/parameters/RegistryNameParameter" - }, - { - "in": "path", - "name": "modelName", - "description": "Container name.", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { "in": "path", - "name": "version", - "description": "Version identifier.", + "name": "endpointName", + "description": "Inference Endpoint name.", "required": true, "type": "string" }, @@ -3333,6 +3429,9 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } }, + "200": { + "description": "Success" + }, "202": { "description": "Accepted", "headers": { @@ -3354,16 +3453,13 @@ } } }, - "200": { - "description": "Success" - }, "204": { "description": "No Content" } }, "x-ms-examples": { - "Delete Registry Model Version.": { - "$ref": "./examples/Registry/ModelVersion/delete.json" + "Delete Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/delete.json" } }, "x-ms-long-running-operation": true, @@ -3373,10 +3469,10 @@ }, "get": { "tags": [ - "ModelVersion" + "BatchEndpoint" ], - "summary": "Get version.", - "operationId": "RegistryModelVersions_Get", + "summary": "Gets a batch inference endpoint by name.", + "operationId": "BatchEndpoints_Get", "produces": [ "application/json" ], @@ -3388,20 +3484,12 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "registries.json#/parameters/RegistryNameParameter" - }, - { - "in": "path", - "name": "modelName", - "description": "Container name. This is case-sensitive.", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", + "name": "endpointName", + "description": "Name for the Batch Endpoint.", "required": true, "type": "string" }, @@ -3419,22 +3507,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ModelVersionResource" + "$ref": "#/definitions/BatchEndpointTrackedResource" } } }, "x-ms-examples": { - "Get Registry Model Version.": { - "$ref": "./examples/Registry/ModelVersion/get.json" + "Get Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/get.json" } } }, - "put": { + "patch": { "tags": [ - "ModelVersion" + "BatchEndpoint" ], - "summary": "Create or update version.", - "operationId": "RegistryModelVersions_CreateOrUpdate", + "summary": "Update a batch inference endpoint (asynchronous).", + "operationId": "BatchEndpoints_Update", "consumes": [ "application/json" ], @@ -3449,33 +3537,26 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "registries.json#/parameters/RegistryNameParameter" + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { "in": "path", - "name": "modelName", - "description": "Container name.", + "name": "endpointName", + "description": "Name for the Batch inference endpoint.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, - { - "in": "path", - "name": "version", - "description": "Version identifier.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Version entity to create or update.", + "description": "Mutable batch inference endpoint definition object.", "required": true, "schema": { - "$ref": "#/definitions/ModelVersionResource" + "$ref": "#/definitions/PartialMinimalTrackedResourceWithIdentity" } } ], @@ -3487,47 +3568,46 @@ } }, "200": { - "description": "Create or update request is successful.", + "description": "Success", "schema": { - "$ref": "#/definitions/ModelVersionResource" + "$ref": "#/definitions/BatchEndpointTrackedResource" } }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/ModelVersionResource" - }, + "202": { + "description": "Accepted", "headers": { "x-ms-async-operation-timeout": { "description": "Timeout for the client to use when polling the asynchronous operation.", "type": "string", "format": "duration" }, - "Azure-AsyncOperation": { - "description": "URI to poll for asynchronous operation status.", + "Location": { + "description": "URI to poll for asynchronous operation result.", "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 } } } }, "x-ms-examples": { - "CreateOrUpdate Registry Model Version.": { - "$ref": "./examples/Registry/ModelVersion/createOrUpdate.json" + "Update Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/update.json" } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}/startPendingUpload": { - "post": { + "x-ms-long-running-operation": true + }, + "put": { "tags": [ - "ModelVersion" + "BatchEndpoint" ], - "summary": "Generate a storage location and credential for the client to upload a model asset to.", - "operationId": "RegistryModelVersions_CreateOrGetStartPendingUpload", + "summary": "Creates a batch inference endpoint (asynchronous).", + "operationId": "BatchEndpoints_CreateOrUpdate", "consumes": [ "application/json" ], @@ -3542,33 +3622,26 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "registries.json#/parameters/RegistryNameParameter" + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { "in": "path", - "name": "modelName", - "description": "Model name. This is case-sensitive.", + "name": "endpointName", + "description": "Name for the Batch inference endpoint.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Pending upload request object", + "description": "Batch inference endpoint definition object.", "required": true, "schema": { - "$ref": "#/definitions/PendingUploadRequestDto" + "$ref": "#/definitions/BatchEndpointTrackedResource" } } ], @@ -3580,26 +3653,47 @@ } }, "200": { - "description": "Success", + "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/PendingUploadResponseDto" + "$ref": "#/definitions/BatchEndpointTrackedResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/BatchEndpointTrackedResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } } } }, "x-ms-examples": { - "CreateOrGetStartPendingUpload Registry Model Version.": { - "$ref": "./examples/Registry/ModelVersion/createOrGetStartPendingUpload.json" + "CreateOrUpdate Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/createOrUpdate.json" } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments": { "get": { "tags": [ - "BatchEndpoint" + "BatchDeployment" ], - "summary": "Lists Batch inference endpoint in the workspace.", - "operationId": "BatchEndpoints_List", + "summary": "Lists Batch inference deployments in the workspace.", + "operationId": "BatchDeployments_List", "produces": [ "application/json" ], @@ -3613,13 +3707,26 @@ { "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, + { + "in": "path", + "name": "endpointName", + "description": "Endpoint name", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "query", - "name": "count", - "description": "Number of endpoints to be retrieved in a page of results.", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Top of list.", "type": "integer", "format": "int32" }, @@ -3637,13 +3744,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/BatchEndpointTrackedResourceArmPaginatedResult" + "$ref": "#/definitions/BatchDeploymentTrackedResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Workspace Batch Endpoint.": { - "$ref": "./examples/Workspace/BatchEndpoint/list.json" + "List Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/list.json" } }, "x-ms-pageable": { @@ -3651,13 +3758,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments/{deploymentName}": { "delete": { "tags": [ - "BatchEndpoint" + "BatchDeployment" ], - "summary": "Delete Batch Inference Endpoint (asynchronous).", - "operationId": "BatchEndpoints_Delete", + "summary": "Delete Batch Inference deployment (asynchronous).", + "operationId": "BatchDeployments_Delete", "produces": [ "application/json" ], @@ -3674,7 +3781,14 @@ { "in": "path", "name": "endpointName", - "description": "Inference Endpoint name.", + "description": "Endpoint name", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference deployment identifier.", "required": true, "type": "string" }, @@ -3689,9 +3803,6 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } }, - "200": { - "description": "Success" - }, "202": { "description": "Accepted", "headers": { @@ -3713,13 +3824,16 @@ } } }, + "200": { + "description": "Success" + }, "204": { "description": "No Content" } }, "x-ms-examples": { - "Delete Workspace Batch Endpoint.": { - "$ref": "./examples/Workspace/BatchEndpoint/delete.json" + "Delete Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/delete.json" } }, "x-ms-long-running-operation": true, @@ -3729,10 +3843,10 @@ }, "get": { "tags": [ - "BatchEndpoint" + "BatchDeployment" ], - "summary": "Gets a batch inference endpoint by name.", - "operationId": "BatchEndpoints_Get", + "summary": "Gets a batch inference deployment by id.", + "operationId": "BatchDeployments_Get", "produces": [ "application/json" ], @@ -3749,7 +3863,14 @@ { "in": "path", "name": "endpointName", - "description": "Name for the Batch Endpoint.", + "description": "Endpoint name", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "The identifier for the Batch deployments.", "required": true, "type": "string" }, @@ -3767,22 +3888,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/BatchEndpointTrackedResource" + "$ref": "#/definitions/BatchDeploymentTrackedResource" } } }, "x-ms-examples": { - "Get Workspace Batch Endpoint.": { - "$ref": "./examples/Workspace/BatchEndpoint/get.json" + "Get Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/get.json" } } }, "patch": { "tags": [ - "BatchEndpoint" + "BatchDeployment" ], - "summary": "Update a batch inference endpoint (asynchronous).", - "operationId": "BatchEndpoints_Update", + "summary": "Update a batch inference deployment (asynchronous).", + "operationId": "BatchDeployments_Update", "consumes": [ "application/json" ], @@ -3802,7 +3923,15 @@ { "in": "path", "name": "endpointName", - "description": "Name for the Batch inference endpoint.", + "description": "Inference endpoint name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "deploymentName", + "description": "The identifier for the Batch inference deployment.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -3813,10 +3942,10 @@ { "in": "body", "name": "body", - "description": "Mutable batch inference endpoint definition object.", + "description": "Batch inference deployment definition object.", "required": true, "schema": { - "$ref": "#/definitions/PartialMinimalTrackedResourceWithIdentity" + "$ref": "#/definitions/PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties" } } ], @@ -3830,7 +3959,7 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/BatchEndpointTrackedResource" + "$ref": "#/definitions/BatchDeploymentTrackedResource" } }, "202": { @@ -3856,18 +3985,18 @@ } }, "x-ms-examples": { - "Update Workspace Batch Endpoint.": { - "$ref": "./examples/Workspace/BatchEndpoint/update.json" + "Update Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/update.json" } }, "x-ms-long-running-operation": true }, "put": { "tags": [ - "BatchEndpoint" + "BatchDeployment" ], - "summary": "Creates a batch inference endpoint (asynchronous).", - "operationId": "BatchEndpoints_CreateOrUpdate", + "summary": "Creates/updates a batch inference deployment (asynchronous).", + "operationId": "BatchDeployments_CreateOrUpdate", "consumes": [ "application/json" ], @@ -3887,7 +4016,15 @@ { "in": "path", "name": "endpointName", - "description": "Name for the Batch inference endpoint.", + "description": "Inference endpoint name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "deploymentName", + "description": "The identifier for the Batch inference deployment.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -3898,10 +4035,10 @@ { "in": "body", "name": "body", - "description": "Batch inference endpoint definition object.", + "description": "Batch inference deployment definition object.", "required": true, "schema": { - "$ref": "#/definitions/BatchEndpointTrackedResource" + "$ref": "#/definitions/BatchDeploymentTrackedResource" } } ], @@ -3915,13 +4052,13 @@ "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/BatchEndpointTrackedResource" + "$ref": "#/definitions/BatchDeploymentTrackedResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/BatchEndpointTrackedResource" + "$ref": "#/definitions/BatchDeploymentTrackedResource" }, "headers": { "x-ms-async-operation-timeout": { @@ -3937,8 +4074,8 @@ } }, "x-ms-examples": { - "CreateOrUpdate Workspace Batch Endpoint.": { - "$ref": "./examples/Workspace/BatchEndpoint/createOrUpdate.json" + "CreateOrUpdate Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/createOrUpdate.json" } }, "x-ms-long-running-operation": true, @@ -3947,13 +4084,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/listkeys": { + "post": { "tags": [ - "BatchDeployment" + "BatchEndpoint" ], - "summary": "Lists Batch inference deployments in the workspace.", - "operationId": "BatchDeployments_List", + "summary": "Lists batch Inference Endpoint keys.", + "operationId": "BatchEndpoints_ListKeys", "produces": [ "application/json" ], @@ -3970,28 +4107,12 @@ { "in": "path", "name": "endpointName", - "description": "Endpoint name", + "description": "Inference Endpoint name.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "query", - "name": "$orderBy", - "description": "Ordering of list.", - "type": "string" - }, - { - "in": "query", - "name": "$top", - "description": "Top of list.", - "type": "integer", - "format": "int32" - }, - { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" } ], "responses": { @@ -4004,27 +4125,24 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/BatchDeploymentTrackedResourceArmPaginatedResult" + "$ref": "#/definitions/EndpointAuthKeys" } } }, "x-ms-examples": { - "List Workspace Batch Deployment.": { - "$ref": "./examples/Workspace/BatchDeployment/list.json" + "ListKeys Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/listKeys.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments/{deploymentName}": { - "delete": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes": { + "get": { "tags": [ - "BatchDeployment" + "CodeContainer" ], - "summary": "Delete Batch Inference deployment (asynchronous).", - "operationId": "BatchDeployments_Delete", + "summary": "List containers.", + "operationId": "CodeContainers_List", "produces": [ "application/json" ], @@ -4039,21 +4157,10 @@ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "in": "path", - "name": "endpointName", - "description": "Endpoint name", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "deploymentName", - "description": "Inference deployment identifier.", - "required": true, - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" } ], "responses": { @@ -4063,50 +4170,30 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } }, - "202": { - "description": "Accepted", - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } - } - }, "200": { - "description": "Success" - }, - "204": { - "description": "No Content" + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeContainerResourceArmPaginatedResult" + } } }, "x-ms-examples": { - "Delete Workspace Batch Deployment.": { - "$ref": "./examples/Workspace/BatchDeployment/delete.json" + "List Workspace Code Container.": { + "$ref": "./examples/Workspace/CodeContainer/list.json" } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" + "x-ms-pageable": { + "nextLinkName": "nextLink" } - }, - "get": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}": { + "delete": { "tags": [ - "BatchDeployment" + "CodeContainer" ], - "summary": "Gets a batch inference deployment by id.", - "operationId": "BatchDeployments_Get", + "summary": "Delete container.", + "operationId": "CodeContainers_Delete", "produces": [ "application/json" ], @@ -4122,15 +4209,8 @@ }, { "in": "path", - "name": "endpointName", - "description": "Endpoint name", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "deploymentName", - "description": "The identifier for the Batch deployments.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, @@ -4146,27 +4226,24 @@ } }, "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/BatchDeploymentTrackedResource" - } + "description": "Success" + }, + "204": { + "description": "No Content" } }, "x-ms-examples": { - "Get Workspace Batch Deployment.": { - "$ref": "./examples/Workspace/BatchDeployment/get.json" + "Delete Workspace Code Container.": { + "$ref": "./examples/Workspace/CodeContainer/delete.json" } } }, - "patch": { + "get": { "tags": [ - "BatchDeployment" - ], - "summary": "Update a batch inference deployment (asynchronous).", - "operationId": "BatchDeployments_Update", - "consumes": [ - "application/json" + "CodeContainer" ], + "summary": "Get container.", + "operationId": "CodeContainers_Get", "produces": [ "application/json" ], @@ -4182,31 +4259,13 @@ }, { "in": "path", - "name": "endpointName", - "description": "Inference endpoint name", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" - }, - { - "in": "path", - "name": "deploymentName", - "description": "The identifier for the Batch inference deployment.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "Batch inference deployment definition object.", - "required": true, - "schema": { - "$ref": "#/definitions/PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties" - } } ], "responses": { @@ -4219,44 +4278,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/BatchDeploymentTrackedResource" - } - }, - "202": { - "description": "Accepted", - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } + "$ref": "#/definitions/CodeContainerResource" } } }, "x-ms-examples": { - "Update Workspace Batch Deployment.": { - "$ref": "./examples/Workspace/BatchDeployment/update.json" + "Get Workspace Code Container.": { + "$ref": "./examples/Workspace/CodeContainer/get.json" } - }, - "x-ms-long-running-operation": true + } }, "put": { "tags": [ - "BatchDeployment" + "CodeContainer" ], - "summary": "Creates/updates a batch inference deployment (asynchronous).", - "operationId": "BatchDeployments_CreateOrUpdate", + "summary": "Create or update container.", + "operationId": "CodeContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -4275,16 +4312,8 @@ }, { "in": "path", - "name": "endpointName", - "description": "Inference endpoint name", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" - }, - { - "in": "path", - "name": "deploymentName", - "description": "The identifier for the Batch inference deployment.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -4295,10 +4324,10 @@ { "in": "body", "name": "body", - "description": "Batch inference deployment definition object.", + "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/BatchDeploymentTrackedResource" + "$ref": "#/definitions/CodeContainerResource" } } ], @@ -4312,45 +4341,30 @@ "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/BatchDeploymentTrackedResource" + "$ref": "#/definitions/CodeContainerResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/BatchDeploymentTrackedResource" - }, - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Azure-AsyncOperation": { - "description": "URI to poll for asynchronous operation status.", - "type": "string" - } + "$ref": "#/definitions/CodeContainerResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Batch Deployment.": { - "$ref": "./examples/Workspace/BatchDeployment/createOrUpdate.json" + "CreateOrUpdate Workspace Code Container.": { + "$ref": "./examples/Workspace/CodeContainer/createOrUpdate.json" } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/listkeys": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions": { + "get": { "tags": [ - "BatchEndpoint" + "CodeVersion" ], - "summary": "Lists batch Inference Endpoint keys.", - "operationId": "BatchEndpoints_ListKeys", + "summary": "List versions.", + "operationId": "CodeVersions_List", "produces": [ "application/json" ], @@ -4366,13 +4380,41 @@ }, { "in": "path", - "name": "endpointName", - "description": "Inference Endpoint name.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "hash", + "description": "If specified, return CodeVersion assets with specified content hash value, regardless of name", + "type": "string" + }, + { + "in": "query", + "name": "hashVersion", + "description": "Hash algorithm version when listing by hash", + "type": "string" } ], "responses": { @@ -4385,24 +4427,27 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/EndpointAuthKeys" + "$ref": "#/definitions/CodeVersionResourceArmPaginatedResult" } } }, "x-ms-examples": { - "ListKeys Workspace Batch Endpoint.": { - "$ref": "./examples/Workspace/BatchEndpoint/listKeys.json" + "List Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/list.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}": { + "delete": { "tags": [ - "CodeContainer" + "CodeVersion" ], - "summary": "List containers.", - "operationId": "CodeContainers_List", + "summary": "Delete version.", + "operationId": "CodeVersions_Delete", "produces": [ "application/json" ], @@ -4417,60 +4462,16 @@ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" - } - ], - "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/CodeContainerResourceArmPaginatedResult" - } - } - }, - "x-ms-examples": { - "List Workspace Code Container.": { - "$ref": "./examples/Workspace/CodeContainer/list.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}": { - "delete": { - "tags": [ - "CodeContainer" - ], - "summary": "Delete container.", - "operationId": "CodeContainers_Delete", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" }, { "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", + "name": "version", + "description": "Version identifier. This is case-sensitive.", "required": true, "type": "string" }, @@ -4493,17 +4494,17 @@ } }, "x-ms-examples": { - "Delete Workspace Code Container.": { - "$ref": "./examples/Workspace/CodeContainer/delete.json" + "Delete Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/delete.json" } } }, "get": { "tags": [ - "CodeContainer" + "CodeVersion" ], - "summary": "Get container.", - "operationId": "CodeContainers_Get", + "summary": "Get version.", + "operationId": "CodeVersions_Get", "produces": [ "application/json" ], @@ -4524,6 +4525,13 @@ "required": true, "type": "string" }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -4538,22 +4546,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/CodeContainerResource" + "$ref": "#/definitions/CodeVersionResource" } } }, "x-ms-examples": { - "Get Workspace Code Container.": { - "$ref": "./examples/Workspace/CodeContainer/get.json" + "Get Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/get.json" } } }, "put": { "tags": [ - "CodeContainer" + "CodeVersion" ], - "summary": "Create or update container.", - "operationId": "CodeContainers_CreateOrUpdate", + "summary": "Create or update version.", + "operationId": "CodeVersions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -4578,16 +4586,23 @@ "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Container entity to create or update.", + "description": "Version entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/CodeContainerResource" + "$ref": "#/definitions/CodeVersionResource" } } ], @@ -4601,30 +4616,33 @@ "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/CodeContainerResource" + "$ref": "#/definitions/CodeVersionResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/CodeContainerResource" + "$ref": "#/definitions/CodeVersionResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Code Container.": { - "$ref": "./examples/Workspace/CodeContainer/createOrUpdate.json" + "CreateOrUpdate Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}/publish": { + "post": { "tags": [ "CodeVersion" ], - "summary": "List versions.", - "operationId": "CodeVersions_List", + "summary": "Publish version asset into registry.", + "operationId": "CodeVersions_Publish", + "consumes": [ + "application/json" + ], "produces": [ "application/json" ], @@ -4641,40 +4659,28 @@ { "in": "path", "name": "name", - "description": "Container name. This is case-sensitive.", + "description": "Container name.", "required": true, "type": "string" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "query", - "name": "$orderBy", - "description": "Ordering of list.", + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, "type": "string" }, { - "in": "query", - "name": "$top", - "description": "Maximum number of records to return.", - "type": "integer", - "format": "int32" - }, - { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" - }, - { - "in": "query", - "name": "hash", - "description": "If specified, return CodeVersion assets with specified content hash value, regardless of name", - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "query", - "name": "hashVersion", - "description": "Hash algorithm version when listing by hash", - "type": "string" + "in": "body", + "name": "body", + "description": "Destination registry info", + "required": true, + "schema": { + "$ref": "#/definitions/DestinationAsset" + } } ], "responses": { @@ -4685,29 +4691,46 @@ } }, "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/CodeVersionResourceArmPaginatedResult" + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } } } }, "x-ms-examples": { - "List Workspace Code Version.": { - "$ref": "./examples/Workspace/CodeVersion/list.json" + "Publish Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/publish.json" } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}": { - "delete": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}/startPendingUpload": { + "post": { "tags": [ "CodeVersion" ], - "summary": "Delete version.", - "operationId": "CodeVersions_Delete", + "summary": "Generate a storage location and credential for the client to upload a code asset to.", + "operationId": "CodeVersions_CreateOrGetStartPendingUpload", + "consumes": [ + "application/json" + ], "produces": [ "application/json" ], @@ -4737,6 +4760,15 @@ }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Pending upload request object", + "required": true, + "schema": { + "$ref": "#/definitions/PendingUploadRequestDto" + } } ], "responses": { @@ -4747,24 +4779,26 @@ } }, "200": { - "description": "Success" - }, - "204": { - "description": "No Content" + "description": "Success", + "schema": { + "$ref": "#/definitions/PendingUploadResponseDto" + } } }, "x-ms-examples": { - "Delete Workspace Code Version.": { - "$ref": "./examples/Workspace/CodeVersion/delete.json" + "CreateOrGetStartPendingUpload Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/createOrGetStartPendingUpload.json" } } - }, + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components": { "get": { "tags": [ - "CodeVersion" + "ComponentContainer" ], - "summary": "Get version.", - "operationId": "CodeVersions_Get", + "summary": "List component containers.", + "operationId": "ComponentContainers_List", "produces": [ "application/json" ], @@ -4779,21 +4813,37 @@ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", - "required": true, - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, - "type": "string" + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } } ], "responses": { @@ -4806,25 +4856,27 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/CodeVersionResource" + "$ref": "#/definitions/ComponentContainerResourceArmPaginatedResult" } } }, "x-ms-examples": { - "Get Workspace Code Version.": { - "$ref": "./examples/Workspace/CodeVersion/get.json" + "List Workspace Component Container.": { + "$ref": "./examples/Workspace/ComponentContainer/list.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}": { + "delete": { "tags": [ - "CodeVersion" - ], - "summary": "Create or update version.", - "operationId": "CodeVersions_CreateOrUpdate", - "consumes": [ - "application/json" + "ComponentContainer" ], + "summary": "Delete container.", + "operationId": "ComponentContainers_Delete", "produces": [ "application/json" ], @@ -4841,29 +4893,12 @@ { "in": "path", "name": "name", - "description": "Container name. This is case-sensitive.", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" - }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", + "description": "Container name.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "Version entity to create or update.", - "required": true, - "schema": { - "$ref": "#/definitions/CodeVersionResource" - } } ], "responses": { @@ -4874,35 +4909,24 @@ } }, "200": { - "description": "Create or update request is successful.", - "schema": { - "$ref": "#/definitions/CodeVersionResource" - } + "description": "Success" }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/CodeVersionResource" - } + "204": { + "description": "No Content" } }, "x-ms-examples": { - "CreateOrUpdate Workspace Code Version.": { - "$ref": "./examples/Workspace/CodeVersion/createOrUpdate.json" + "Delete Workspace Component Container.": { + "$ref": "./examples/Workspace/ComponentContainer/delete.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}/publish": { - "post": { + }, + "get": { "tags": [ - "CodeVersion" - ], - "summary": "Publish version asset into registry.", - "operationId": "CodeVersions_Publish", - "consumes": [ - "application/json" + "ComponentContainer" ], + "summary": "Get container.", + "operationId": "ComponentContainers_Get", "produces": [ "application/json" ], @@ -4923,24 +4947,8 @@ "required": true, "type": "string" }, - { - "in": "path", - "name": "version", - "description": "Version identifier.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "Destination registry info", - "required": true, - "schema": { - "$ref": "#/definitions/DestinationAsset" - } } ], "responses": { @@ -4951,43 +4959,24 @@ } }, "200": { - "description": "Success" - }, - "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentContainerResource" } } }, "x-ms-examples": { - "Publish Workspace Code Version.": { - "$ref": "./examples/Workspace/CodeVersion/publish.json" + "Get Workspace Component Container.": { + "$ref": "./examples/Workspace/ComponentContainer/get.json" } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}/startPendingUpload": { - "post": { + }, + "put": { "tags": [ - "CodeVersion" + "ComponentContainer" ], - "summary": "Generate a storage location and credential for the client to upload a code asset to.", - "operationId": "CodeVersions_CreateOrGetStartPendingUpload", + "summary": "Create or update container.", + "operationId": "ComponentContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -5007,16 +4996,10 @@ { "in": "path", "name": "name", - "description": "Container name. This is case-sensitive.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", + "description": "Container name.", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -5024,10 +5007,10 @@ { "in": "body", "name": "body", - "description": "Pending upload request object", + "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/PendingUploadRequestDto" + "$ref": "#/definitions/ComponentContainerResource" } } ], @@ -5039,26 +5022,32 @@ } }, "200": { - "description": "Success", + "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/PendingUploadResponseDto" + "$ref": "#/definitions/ComponentContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ComponentContainerResource" } } }, "x-ms-examples": { - "CreateOrGetStartPendingUpload Workspace Code Version.": { - "$ref": "./examples/Workspace/CodeVersion/createOrGetStartPendingUpload.json" + "CreateOrUpdate Workspace Component Container.": { + "$ref": "./examples/Workspace/ComponentContainer/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions": { "get": { "tags": [ - "ComponentContainer" + "ComponentVersion" ], - "summary": "List component containers.", - "operationId": "ComponentContainers_List", + "summary": "List component versions.", + "operationId": "ComponentVersions_List", "produces": [ "application/json" ], @@ -5072,9 +5061,29 @@ { "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, + { + "in": "path", + "name": "name", + "description": "Component name.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, { "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, @@ -5116,13 +5125,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ComponentContainerResourceArmPaginatedResult" + "$ref": "#/definitions/ComponentVersionResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Workspace Component Container.": { - "$ref": "./examples/Workspace/ComponentContainer/list.json" + "List Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/list.json" } }, "x-ms-pageable": { @@ -5130,13 +5139,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions/{version}": { "delete": { "tags": [ - "ComponentContainer" + "ComponentVersion" ], - "summary": "Delete container.", - "operationId": "ComponentContainers_Delete", + "summary": "Delete version.", + "operationId": "ComponentVersions_Delete", "produces": [ "application/json" ], @@ -5157,6 +5166,13 @@ "required": true, "type": "string" }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -5176,17 +5192,17 @@ } }, "x-ms-examples": { - "Delete Workspace Component Container.": { - "$ref": "./examples/Workspace/ComponentContainer/delete.json" + "Delete Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/delete.json" } } }, "get": { "tags": [ - "ComponentContainer" + "ComponentVersion" ], - "summary": "Get container.", - "operationId": "ComponentContainers_Get", + "summary": "Get version.", + "operationId": "ComponentVersions_Get", "produces": [ "application/json" ], @@ -5207,6 +5223,13 @@ "required": true, "type": "string" }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -5221,22 +5244,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ComponentContainerResource" + "$ref": "#/definitions/ComponentVersionResource" } } }, "x-ms-examples": { - "Get Workspace Component Container.": { - "$ref": "./examples/Workspace/ComponentContainer/get.json" + "Get Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/get.json" } } }, "put": { "tags": [ - "ComponentContainer" + "ComponentVersion" ], - "summary": "Create or update container.", - "operationId": "ComponentContainers_CreateOrUpdate", + "summary": "Create or update version.", + "operationId": "ComponentVersions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -5261,16 +5284,23 @@ "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Container entity to create or update.", + "description": "Version entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/ComponentContainerResource" + "$ref": "#/definitions/ComponentVersionResource" } } ], @@ -5284,30 +5314,33 @@ "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/ComponentContainerResource" + "$ref": "#/definitions/ComponentVersionResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/ComponentContainerResource" + "$ref": "#/definitions/ComponentVersionResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Component Container.": { - "$ref": "./examples/Workspace/ComponentContainer/createOrUpdate.json" + "CreateOrUpdate Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions/{version}/publish": { + "post": { "tags": [ "ComponentVersion" ], - "summary": "List component versions.", - "operationId": "ComponentVersions_List", + "summary": "Publish version asset into registry.", + "operationId": "ComponentVersions_Publish", + "consumes": [ + "application/json" + ], "produces": [ "application/json" ], @@ -5324,7 +5357,14 @@ { "in": "path", "name": "name", - "description": "Component name.", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", "required": true, "type": "string" }, @@ -5332,17 +5372,75 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "query", - "name": "$orderBy", - "description": "Ordering of list.", - "type": "string" + "in": "body", + "name": "body", + "description": "Destination registry info", + "required": true, + "schema": { + "$ref": "#/definitions/DestinationAsset" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + } + }, + "x-ms-examples": { + "Publish Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/publish.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data": { + "get": { + "tags": [ + "DataContainer" + ], + "summary": "List data containers.", + "operationId": "DataContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "in": "query", - "name": "$top", - "description": "Maximum number of records to return.", - "type": "integer", - "format": "int32" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "machineLearningServices.json#/parameters/PaginationParameter" @@ -5385,13 +5483,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ComponentVersionResourceArmPaginatedResult" + "$ref": "#/definitions/DataContainerResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Workspace Component Version.": { - "$ref": "./examples/Workspace/ComponentVersion/list.json" + "List Workspace Data Container.": { + "$ref": "./examples/Workspace/DataContainer/list.json" } }, "x-ms-pageable": { @@ -5399,13 +5497,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions/{version}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}": { "delete": { "tags": [ - "ComponentVersion" + "DataContainer" ], - "summary": "Delete version.", - "operationId": "ComponentVersions_Delete", + "summary": "Delete container.", + "operationId": "DataContainers_Delete", "produces": [ "application/json" ], @@ -5426,13 +5524,6 @@ "required": true, "type": "string" }, - { - "in": "path", - "name": "version", - "description": "Version identifier.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -5452,17 +5543,17 @@ } }, "x-ms-examples": { - "Delete Workspace Component Version.": { - "$ref": "./examples/Workspace/ComponentVersion/delete.json" + "Delete Workspace Data Container.": { + "$ref": "./examples/Workspace/DataContainer/delete.json" } } }, "get": { "tags": [ - "ComponentVersion" + "DataContainer" ], - "summary": "Get version.", - "operationId": "ComponentVersions_Get", + "summary": "Get container.", + "operationId": "DataContainers_Get", "produces": [ "application/json" ], @@ -5483,13 +5574,6 @@ "required": true, "type": "string" }, - { - "in": "path", - "name": "version", - "description": "Version identifier.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -5504,22 +5588,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ComponentVersionResource" + "$ref": "#/definitions/DataContainerResource" } } }, "x-ms-examples": { - "Get Workspace Component Version.": { - "$ref": "./examples/Workspace/ComponentVersion/get.json" + "Get Workspace Data Container.": { + "$ref": "./examples/Workspace/DataContainer/get.json" } } }, "put": { "tags": [ - "ComponentVersion" + "DataContainer" ], - "summary": "Create or update version.", - "operationId": "ComponentVersions_CreateOrUpdate", + "summary": "Create or update container.", + "operationId": "DataContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -5544,23 +5628,16 @@ "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, - { - "in": "path", - "name": "version", - "description": "Version identifier.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Version entity to create or update.", + "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/ComponentVersionResource" + "$ref": "#/definitions/DataContainerResource" } } ], @@ -5574,33 +5651,30 @@ "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/ComponentVersionResource" + "$ref": "#/definitions/DataContainerResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/ComponentVersionResource" + "$ref": "#/definitions/DataContainerResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Component Version.": { - "$ref": "./examples/Workspace/ComponentVersion/createOrUpdate.json" + "CreateOrUpdate Workspace Data Container.": { + "$ref": "./examples/Workspace/DataContainer/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions/{version}/publish": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions": { + "get": { "tags": [ - "ComponentVersion" - ], - "summary": "Publish version asset into registry.", - "operationId": "ComponentVersions_Publish", - "consumes": [ - "application/json" + "DataVersion" ], + "summary": "List data versions in the data container", + "operationId": "DataVersions_List", "produces": [ "application/json" ], @@ -5617,27 +5691,60 @@ { "in": "path", "name": "name", - "description": "Container name.", + "description": "Data container's name", "required": true, "type": "string" }, { - "in": "path", - "name": "version", - "description": "Version identifier.", - "required": true, + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Please choose OrderBy value from ['createdtime', 'modifiedtime']", "type": "string" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "query", + "name": "$top", + "description": "Top count of results, top count cannot be greater than the page size.\r\n If topCount > page size, results with be default page size count will be returned", + "type": "integer", + "format": "int32" }, { - "in": "body", - "name": "body", - "description": "Destination registry info", - "required": true, - "schema": { - "$ref": "#/definitions/DestinationAsset" + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "$tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] } } ], @@ -5649,107 +5756,15 @@ } }, "200": { - "description": "Success" - }, - "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } + "description": "Success", + "schema": { + "$ref": "#/definitions/DataVersionBaseResourceArmPaginatedResult" } } }, "x-ms-examples": { - "Publish Workspace Component Version.": { - "$ref": "./examples/Workspace/ComponentVersion/publish.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data": { - "get": { - "tags": [ - "DataContainer" - ], - "summary": "List data containers.", - "operationId": "DataContainers_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" - }, - { - "in": "query", - "name": "listViewType", - "description": "View type for including/excluding (for example) archived entities.", - "type": "string", - "default": "ActiveOnly", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "value": "ActiveOnly" - }, - { - "value": "ArchivedOnly" - }, - { - "value": "All" - } - ] - } - } - ], - "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DataContainerResourceArmPaginatedResult" - } - } - }, - "x-ms-examples": { - "List Workspace Data Container.": { - "$ref": "./examples/Workspace/DataContainer/list.json" + "List Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/list.json" } }, "x-ms-pageable": { @@ -5757,13 +5772,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions/{version}": { "delete": { "tags": [ - "DataContainer" + "DataVersion" ], - "summary": "Delete container.", - "operationId": "DataContainers_Delete", + "summary": "Delete version.", + "operationId": "DataVersions_Delete", "produces": [ "application/json" ], @@ -5784,6 +5799,13 @@ "required": true, "type": "string" }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -5803,17 +5825,17 @@ } }, "x-ms-examples": { - "Delete Workspace Data Container.": { - "$ref": "./examples/Workspace/DataContainer/delete.json" + "Delete Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/delete.json" } } }, "get": { "tags": [ - "DataContainer" + "DataVersion" ], - "summary": "Get container.", - "operationId": "DataContainers_Get", + "summary": "Get version.", + "operationId": "DataVersions_Get", "produces": [ "application/json" ], @@ -5834,6 +5856,13 @@ "required": true, "type": "string" }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -5848,22 +5877,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DataContainerResource" + "$ref": "#/definitions/DataVersionBaseResource" } } }, "x-ms-examples": { - "Get Workspace Data Container.": { - "$ref": "./examples/Workspace/DataContainer/get.json" + "Get Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/get.json" } } }, "put": { "tags": [ - "DataContainer" + "DataVersion" ], - "summary": "Create or update container.", - "operationId": "DataContainers_CreateOrUpdate", + "summary": "Create or update version.", + "operationId": "DataVersions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -5888,16 +5917,23 @@ "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Container entity to create or update.", + "description": "Version entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/DataContainerResource" + "$ref": "#/definitions/DataVersionBaseResource" } } ], @@ -5911,30 +5947,33 @@ "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/DataContainerResource" + "$ref": "#/definitions/DataVersionBaseResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/DataContainerResource" + "$ref": "#/definitions/DataVersionBaseResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Data Container.": { - "$ref": "./examples/Workspace/DataContainer/createOrUpdate.json" + "CreateOrUpdate Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions/{version}/publish": { + "post": { "tags": [ "DataVersion" ], - "summary": "List data versions in the data container", - "operationId": "DataVersions_List", + "summary": "Publish version asset into registry.", + "operationId": "DataVersions_Publish", + "consumes": [ + "application/json" + ], "produces": [ "application/json" ], @@ -5951,60 +5990,27 @@ { "in": "path", "name": "name", - "description": "Data container's name", + "description": "Container name.", "required": true, "type": "string" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "query", - "name": "$orderBy", - "description": "Please choose OrderBy value from ['createdtime', 'modifiedtime']", + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, "type": "string" }, { - "in": "query", - "name": "$top", - "description": "Top count of results, top count cannot be greater than the page size.\r\n If topCount > page size, results with be default page size count will be returned", - "type": "integer", - "format": "int32" - }, - { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" - }, - { - "in": "query", - "name": "$tags", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "query", - "name": "listViewType", - "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", - "type": "string", - "default": "ActiveOnly", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "value": "ActiveOnly" - }, - { - "value": "ArchivedOnly" - }, - { - "value": "All" - } - ] + "in": "body", + "name": "body", + "description": "Destination registry info", + "required": true, + "schema": { + "$ref": "#/definitions/DestinationAsset" } } ], @@ -6016,29 +6022,43 @@ } }, "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DataVersionBaseResourceArmPaginatedResult" + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } } } }, "x-ms-examples": { - "List Workspace Data Version Base.": { - "$ref": "./examples/Workspace/DataVersionBase/list.json" + "Publish Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/publish.json" } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions/{version}": { - "delete": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores": { + "get": { "tags": [ - "DataVersion" + "Datastore" ], - "summary": "Delete version.", - "operationId": "DataVersions_Delete", + "summary": "List datastores.", + "operationId": "Datastores_List", "produces": [ "application/json" ], @@ -6053,17 +6073,103 @@ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "in": "path", - "name": "name", - "description": "Container name.", - "required": true, - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "path", - "name": "version", - "description": "Version identifier.", - "required": true, + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "count", + "description": "Maximum number of results to return.", + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "in": "query", + "name": "isDefault", + "description": "Filter down to the workspace default datastore.", + "type": "boolean" + }, + { + "in": "query", + "name": "names", + "description": "Names of datastores to return.", + "type": "array", + "items": { + "type": "string" + } + }, + { + "in": "query", + "name": "searchText", + "description": "Text to search for in the datastore names.", + "type": "string" + }, + { + "in": "query", + "name": "orderBy", + "description": "Order by property (createdtime | modifiedtime | name).", + "type": "string" + }, + { + "in": "query", + "name": "orderByAsc", + "description": "Order by property in ascending order.", + "type": "boolean", + "default": false + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatastoreResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List datastores.": { + "$ref": "./examples/Datastore/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}": { + "delete": { + "tags": [ + "Datastore" + ], + "summary": "Delete datastore.", + "operationId": "Datastores_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Datastore name.", + "required": true, "type": "string" }, { @@ -6085,17 +6191,17 @@ } }, "x-ms-examples": { - "Delete Workspace Data Version Base.": { - "$ref": "./examples/Workspace/DataVersionBase/delete.json" + "Delete datastore.": { + "$ref": "./examples/Datastore/delete.json" } } }, "get": { "tags": [ - "DataVersion" + "Datastore" ], - "summary": "Get version.", - "operationId": "DataVersions_Get", + "summary": "Get datastore.", + "operationId": "Datastores_Get", "produces": [ "application/json" ], @@ -6112,14 +6218,7 @@ { "in": "path", "name": "name", - "description": "Container name.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "version", - "description": "Version identifier.", + "description": "Datastore name.", "required": true, "type": "string" }, @@ -6137,22 +6236,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DataVersionBaseResource" + "$ref": "#/definitions/DatastoreResource" } } }, "x-ms-examples": { - "Get Workspace Data Version Base.": { - "$ref": "./examples/Workspace/DataVersionBase/get.json" + "Get datastore.": { + "$ref": "./examples/Datastore/get.json" } } }, "put": { "tags": [ - "DataVersion" + "Datastore" ], - "summary": "Create or update version.", - "operationId": "DataVersions_CreateOrUpdate", + "summary": "Create or update datastore.", + "operationId": "Datastores_CreateOrUpdate", "consumes": [ "application/json" ], @@ -6172,28 +6271,28 @@ { "in": "path", "name": "name", - "description": "Container name.", + "description": "Datastore name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { - "in": "path", - "name": "version", - "description": "Version identifier.", - "required": true, - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "query", + "name": "skipValidation", + "description": "Flag to skip validation.", + "type": "boolean", + "default": false }, { "in": "body", "name": "body", - "description": "Version entity to create or update.", + "description": "Datastore entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/DataVersionBaseResource" + "$ref": "#/definitions/DatastoreResource" } } ], @@ -6207,33 +6306,39 @@ "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/DataVersionBaseResource" + "$ref": "#/definitions/DatastoreResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/DataVersionBaseResource" + "$ref": "#/definitions/DatastoreResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Data Version Base.": { - "$ref": "./examples/Workspace/DataVersionBase/createOrUpdate.json" + "CreateOrUpdate datastore (AzureBlob w/ AccountKey).": { + "$ref": "./examples/Datastore/AzureBlobWAccountKey/createOrUpdate.json" + }, + "CreateOrUpdate datastore (Azure Data Lake Gen1 w/ ServicePrincipal).": { + "$ref": "./examples/Datastore/AzureDataLakeGen1WServicePrincipal/createOrUpdate.json" + }, + "CreateOrUpdate datastore (Azure Data Lake Gen2 w/ Service Principal).": { + "$ref": "./examples/Datastore/AzureDataLakeGen2WServicePrincipal/createOrUpdate.json" + }, + "CreateOrUpdate datastore (Azure File store w/ AccountKey).": { + "$ref": "./examples/Datastore/AzureFileWAccountKey/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions/{version}/publish": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}/listSecrets": { "post": { "tags": [ - "DataVersion" - ], - "summary": "Publish version asset into registry.", - "operationId": "DataVersions_Publish", - "consumes": [ - "application/json" + "Datastore" ], + "summary": "Get datastore secrets.", + "operationId": "Datastores_ListSecrets", "produces": [ "application/json" ], @@ -6250,28 +6355,12 @@ { "in": "path", "name": "name", - "description": "Container name.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "version", - "description": "Version identifier.", + "description": "Datastore name.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "Destination registry info", - "required": true, - "schema": { - "$ref": "#/definitions/DestinationAsset" - } } ], "responses": { @@ -6282,43 +6371,27 @@ } }, "200": { - "description": "Success" - }, - "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } + "description": "Success", + "schema": { + "description": "Base definition for datastore secrets.", + "$ref": "#/definitions/DatastoreSecrets" } } }, "x-ms-examples": { - "Publish Workspace Data Version Base.": { - "$ref": "./examples/Workspace/DataVersionBase/publish.json" + "Get datastore secrets.": { + "$ref": "./examples/Datastore/listSecrets.json" } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments": { "get": { "tags": [ - "Datastore" + "EnvironmentContainer" ], - "summary": "List datastores.", - "operationId": "Datastores_List", + "summary": "List environment containers.", + "operationId": "EnvironmentContainers_List", "produces": [ "application/json" ], @@ -6340,45 +6413,30 @@ }, { "in": "query", - "name": "count", - "description": "Maximum number of results to return.", - "type": "integer", - "format": "int32", - "default": 30 - }, - { - "in": "query", - "name": "isDefault", - "description": "Filter down to the workspace default datastore.", - "type": "boolean" - }, - { - "in": "query", - "name": "names", - "description": "Names of datastores to return.", - "type": "array", - "items": { - "type": "string" - } - }, - { - "in": "query", - "name": "searchText", - "description": "Text to search for in the datastore names.", - "type": "string" - }, - { - "in": "query", - "name": "orderBy", - "description": "Order by property (createdtime | modifiedtime | name).", - "type": "string" - }, - { - "in": "query", - "name": "orderByAsc", - "description": "Order by property in ascending order.", - "type": "boolean", - "default": false + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } } ], "responses": { @@ -6391,13 +6449,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DatastoreResourceArmPaginatedResult" + "$ref": "#/definitions/EnvironmentContainerResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List datastores.": { - "$ref": "./examples/Datastore/list.json" + "List Workspace Environment Container.": { + "$ref": "./examples/Workspace/EnvironmentContainer/list.json" } }, "x-ms-pageable": { @@ -6405,13 +6463,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}": { "delete": { "tags": [ - "Datastore" + "EnvironmentContainer" ], - "summary": "Delete datastore.", - "operationId": "Datastores_Delete", + "summary": "Delete container.", + "operationId": "EnvironmentContainers_Delete", "produces": [ "application/json" ], @@ -6428,7 +6486,7 @@ { "in": "path", "name": "name", - "description": "Datastore name.", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, @@ -6451,17 +6509,17 @@ } }, "x-ms-examples": { - "Delete datastore.": { - "$ref": "./examples/Datastore/delete.json" + "Delete Workspace Environment Container.": { + "$ref": "./examples/Workspace/EnvironmentContainer/delete.json" } } }, "get": { "tags": [ - "Datastore" + "EnvironmentContainer" ], - "summary": "Get datastore.", - "operationId": "Datastores_Get", + "summary": "Get container.", + "operationId": "EnvironmentContainers_Get", "produces": [ "application/json" ], @@ -6478,7 +6536,7 @@ { "in": "path", "name": "name", - "description": "Datastore name.", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, @@ -6496,22 +6554,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DatastoreResource" + "$ref": "#/definitions/EnvironmentContainerResource" } } }, "x-ms-examples": { - "Get datastore.": { - "$ref": "./examples/Datastore/get.json" + "Get Workspace Environment Container.": { + "$ref": "./examples/Workspace/EnvironmentContainer/get.json" } } }, "put": { "tags": [ - "Datastore" + "EnvironmentContainer" ], - "summary": "Create or update datastore.", - "operationId": "Datastores_CreateOrUpdate", + "summary": "Create or update container.", + "operationId": "EnvironmentContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -6531,7 +6589,7 @@ { "in": "path", "name": "name", - "description": "Datastore name.", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -6539,20 +6597,13 @@ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, - { - "in": "query", - "name": "skipValidation", - "description": "Flag to skip validation.", - "type": "boolean", - "default": false - }, { "in": "body", "name": "body", - "description": "Datastore entity to create or update.", + "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/DatastoreResource" + "$ref": "#/definitions/EnvironmentContainerResource" } } ], @@ -6566,39 +6617,30 @@ "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/DatastoreResource" + "$ref": "#/definitions/EnvironmentContainerResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/DatastoreResource" + "$ref": "#/definitions/EnvironmentContainerResource" } } }, "x-ms-examples": { - "CreateOrUpdate datastore (AzureBlob w/ AccountKey).": { - "$ref": "./examples/Datastore/AzureBlobWAccountKey/createOrUpdate.json" - }, - "CreateOrUpdate datastore (Azure Data Lake Gen1 w/ ServicePrincipal).": { - "$ref": "./examples/Datastore/AzureDataLakeGen1WServicePrincipal/createOrUpdate.json" - }, - "CreateOrUpdate datastore (Azure Data Lake Gen2 w/ Service Principal).": { - "$ref": "./examples/Datastore/AzureDataLakeGen2WServicePrincipal/createOrUpdate.json" - }, - "CreateOrUpdate datastore (Azure File store w/ AccountKey).": { - "$ref": "./examples/Datastore/AzureFileWAccountKey/createOrUpdate.json" + "CreateOrUpdate Workspace Environment Container.": { + "$ref": "./examples/Workspace/EnvironmentContainer/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}/listSecrets": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions": { + "get": { "tags": [ - "Datastore" + "EnvironmentVersion" ], - "summary": "Get datastore secrets.", - "operationId": "Datastores_ListSecrets", + "summary": "List versions.", + "operationId": "EnvironmentVersions_List", "produces": [ "application/json" ], @@ -6615,58 +6657,25 @@ { "in": "path", "name": "name", - "description": "Datastore name.", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Success", - "schema": { - "description": "Base definition for datastore secrets.", - "$ref": "#/definitions/DatastoreSecrets" - } - } - }, - "x-ms-examples": { - "Get datastore secrets.": { - "$ref": "./examples/Datastore/listSecrets.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments": { - "get": { - "tags": [ - "EnvironmentContainer" - ], - "summary": "List environment containers.", - "operationId": "EnvironmentContainers_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" }, { "$ref": "machineLearningServices.json#/parameters/PaginationParameter" @@ -6709,13 +6718,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/EnvironmentContainerResourceArmPaginatedResult" + "$ref": "#/definitions/EnvironmentVersionResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Workspace Environment Container.": { - "$ref": "./examples/Workspace/EnvironmentContainer/list.json" + "List Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/list.json" } }, "x-ms-pageable": { @@ -6723,13 +6732,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}": { "delete": { "tags": [ - "EnvironmentContainer" + "EnvironmentVersion" ], - "summary": "Delete container.", - "operationId": "EnvironmentContainers_Delete", + "summary": "Delete version.", + "operationId": "EnvironmentVersions_Delete", "produces": [ "application/json" ], @@ -6750,6 +6759,13 @@ "required": true, "type": "string" }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -6769,17 +6785,17 @@ } }, "x-ms-examples": { - "Delete Workspace Environment Container.": { - "$ref": "./examples/Workspace/EnvironmentContainer/delete.json" + "Delete Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/delete.json" } } }, "get": { "tags": [ - "EnvironmentContainer" + "EnvironmentVersion" ], - "summary": "Get container.", - "operationId": "EnvironmentContainers_Get", + "summary": "Get version.", + "operationId": "EnvironmentVersions_Get", "produces": [ "application/json" ], @@ -6800,6 +6816,13 @@ "required": true, "type": "string" }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -6814,22 +6837,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/EnvironmentContainerResource" + "$ref": "#/definitions/EnvironmentVersionResource" } } }, "x-ms-examples": { - "Get Workspace Environment Container.": { - "$ref": "./examples/Workspace/EnvironmentContainer/get.json" + "Get Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/get.json" } } }, "put": { "tags": [ - "EnvironmentContainer" + "EnvironmentVersion" ], - "summary": "Create or update container.", - "operationId": "EnvironmentContainers_CreateOrUpdate", + "summary": "Creates or updates an EnvironmentVersion.", + "operationId": "EnvironmentVersions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -6849,21 +6872,28 @@ { "in": "path", "name": "name", - "description": "Container name. This is case-sensitive.", + "description": "Name of EnvironmentVersion. This is case-sensitive.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, + { + "in": "path", + "name": "version", + "description": "Version of EnvironmentVersion.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Container entity to create or update.", + "description": "Definition of EnvironmentVersion.", "required": true, "schema": { - "$ref": "#/definitions/EnvironmentContainerResource" + "$ref": "#/definitions/EnvironmentVersionResource" } } ], @@ -6877,30 +6907,33 @@ "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/EnvironmentContainerResource" + "$ref": "#/definitions/EnvironmentVersionResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/EnvironmentContainerResource" + "$ref": "#/definitions/EnvironmentVersionResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Environment Container.": { - "$ref": "./examples/Workspace/EnvironmentContainer/createOrUpdate.json" + "CreateOrUpdate Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}/publish": { + "post": { "tags": [ "EnvironmentVersion" ], - "summary": "List versions.", - "operationId": "EnvironmentVersions_List", + "summary": "Publish version asset into registry.", + "operationId": "EnvironmentVersions_Publish", + "consumes": [ + "application/json" + ], "produces": [ "application/json" ], @@ -6917,7 +6950,14 @@ { "in": "path", "name": "name", - "description": "Container name. This is case-sensitive.", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", "required": true, "type": "string" }, @@ -6925,25 +6965,89 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "query", - "name": "$orderBy", - "description": "Ordering of list.", - "type": "string" + "in": "body", + "name": "body", + "description": "Destination registry info", + "required": true, + "schema": { + "$ref": "#/definitions/DestinationAsset" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } }, + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + } + }, + "x-ms-examples": { + "Publish Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/publish.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets": { + "get": { + "tags": [ + "FeaturesetContainer" + ], + "summary": "List featurestore entity containers.", + "operationId": "FeaturesetContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ { - "in": "query", - "name": "$top", - "description": "Maximum number of records to return.", - "type": "integer", - "format": "int32" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, + { + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, { "in": "query", "name": "listViewType", - "description": "View type for including/excluding (for example) archived entities.", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", "type": "string", "default": "ActiveOnly", "enum": [ @@ -6966,6 +7070,32 @@ } ] } + }, + { + "in": "query", + "name": "pageSize", + "description": "page size", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "in": "query", + "name": "name", + "description": "name for the featureset", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "description for the feature set", + "type": "string" + }, + { + "in": "query", + "name": "createdBy", + "description": "createdBy user name", + "type": "string" } ], "responses": { @@ -6978,13 +7108,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/EnvironmentVersionResourceArmPaginatedResult" + "$ref": "#/definitions/FeaturesetContainerResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Workspace Environment Version.": { - "$ref": "./examples/Workspace/EnvironmentVersion/list.json" + "List Workspace Featureset Container.": { + "$ref": "./examples/Workspace/FeaturesetContainer/list.json" } }, "x-ms-pageable": { @@ -6992,13 +7122,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}": { - "delete": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{featuresetName}/versions/{featuresetVersion}/features": { + "get": { "tags": [ - "EnvironmentVersion" + "Feature" ], - "summary": "Delete version.", - "operationId": "EnvironmentVersions_Delete", + "summary": "List Features.", + "operationId": "Features_List", "produces": [ "application/json" ], @@ -7014,77 +7144,77 @@ }, { "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", + "name": "featuresetName", + "description": "Featureset name. This is case-sensitive.", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", + "name": "featuresetVersion", + "description": "Featureset Version identifier. This is case-sensitive.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Success" }, - "204": { - "description": "No Content" - } - }, - "x-ms-examples": { - "Delete Workspace Environment Version.": { - "$ref": "./examples/Workspace/EnvironmentVersion/delete.json" - } - } - }, - "get": { - "tags": [ - "EnvironmentVersion" - ], - "summary": "Get version.", - "operationId": "EnvironmentVersions_Get", - "produces": [ - "application/json" - ], - "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "in": "query", + "name": "featureName", + "description": "feature name.", + "type": "string" }, { - "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", - "required": true, + "in": "query", + "name": "description", + "description": "Description of the featureset.", "type": "string" }, { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, - "type": "string" + "in": "query", + "name": "listViewType", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "query", + "name": "pageSize", + "description": "Page size.", + "type": "integer", + "format": "int32", + "default": 1000 } ], "responses": { @@ -7097,25 +7227,27 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/EnvironmentVersionResource" + "$ref": "#/definitions/FeatureResourceArmPaginatedResult" } } }, "x-ms-examples": { - "Get Workspace Environment Version.": { - "$ref": "./examples/Workspace/EnvironmentVersion/get.json" + "List Feature.": { + "$ref": "./examples/Feature/list.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{featuresetName}/versions/{featuresetVersion}/features/{featureName}": { + "get": { "tags": [ - "EnvironmentVersion" - ], - "summary": "Creates or updates an EnvironmentVersion.", - "operationId": "EnvironmentVersions_CreateOrUpdate", - "consumes": [ - "application/json" + "Feature" ], + "summary": "Get feature.", + "operationId": "Features_Get", "produces": [ "application/json" ], @@ -7131,30 +7263,29 @@ }, { "in": "path", - "name": "name", - "description": "Name of EnvironmentVersion. This is case-sensitive.", + "name": "featuresetName", + "description": "Feature set name. This is case-sensitive.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "in": "path", - "name": "version", - "description": "Version of EnvironmentVersion.", + "name": "featuresetVersion", + "description": "Feature set version identifier. This is case-sensitive.", "required": true, "type": "string" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "path", + "name": "featureName", + "description": "Feature Name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { - "in": "body", - "name": "body", - "description": "Definition of EnvironmentVersion.", - "required": true, - "schema": { - "$ref": "#/definitions/EnvironmentVersionResource" - } + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -7165,35 +7296,26 @@ } }, "200": { - "description": "Create or update request is successful.", - "schema": { - "$ref": "#/definitions/EnvironmentVersionResource" - } - }, - "201": { - "description": "Created", + "description": "Success", "schema": { - "$ref": "#/definitions/EnvironmentVersionResource" + "$ref": "#/definitions/FeatureResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Environment Version.": { - "$ref": "./examples/Workspace/EnvironmentVersion/createOrUpdate.json" + "Get Feature.": { + "$ref": "./examples/Feature/get.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}/publish": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}": { + "delete": { "tags": [ - "EnvironmentVersion" - ], - "summary": "Publish version asset into registry.", - "operationId": "EnvironmentVersions_Publish", - "consumes": [ - "application/json" + "FeaturesetContainer" ], + "summary": "Delete container.", + "operationId": "FeaturesetContainers_Delete", "produces": [ "application/json" ], @@ -7210,28 +7332,12 @@ { "in": "path", "name": "name", - "description": "Container name.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "version", - "description": "Version identifier.", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "Destination registry info", - "required": true, - "schema": { - "$ref": "#/definitions/DestinationAsset" - } } ], "responses": { @@ -7247,6 +7353,11 @@ "202": { "description": "Accepted", "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, "Location": { "description": "URI to poll for asynchronous operation result.", "type": "string" @@ -7259,26 +7370,27 @@ "minimum": 10 } } + }, + "204": { + "description": "No Content" } }, "x-ms-examples": { - "Publish Workspace Environment Version.": { - "$ref": "./examples/Workspace/EnvironmentVersion/publish.json" + "Delete Workspace Featureset Container.": { + "$ref": "./examples/Workspace/FeaturesetContainer/delete.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets": { + }, "get": { "tags": [ "FeaturesetContainer" ], - "summary": "List featurestore entity containers.", - "operationId": "FeaturesetContainers_List", + "summary": "Get container.", + "operationId": "FeaturesetContainers_GetEntity", "produces": [ "application/json" ], @@ -7293,69 +7405,77 @@ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" }, { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturesetContainerResource" + } + } + }, + "x-ms-examples": { + "GetEntity Workspace Featureset Container.": { + "$ref": "./examples/Workspace/FeaturesetContainer/getEntity.json" + } + } + }, + "put": { + "tags": [ + "FeaturesetContainer" + ], + "summary": "Create or update container.", + "operationId": "FeaturesetContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ { - "in": "query", - "name": "tags", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "in": "query", - "name": "listViewType", - "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", - "type": "string", - "default": "ActiveOnly", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "value": "ActiveOnly" - }, - { - "value": "ArchivedOnly" - }, - { - "value": "All" - } - ] - } + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "query", - "name": "pageSize", - "description": "page size", - "type": "integer", - "format": "int32", - "default": 20 + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "in": "query", + "in": "path", "name": "name", - "description": "name for the featureset", - "type": "string" + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { - "in": "query", - "name": "description", - "description": "description for the feature set", - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "query", - "name": "createdBy", - "description": "createdBy user name", - "type": "string" + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/FeaturesetContainerResource" + } } ], "responses": { @@ -7366,29 +7486,47 @@ } }, "200": { - "description": "Success", + "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/FeaturesetContainerResourceArmPaginatedResult" + "$ref": "#/definitions/FeaturesetContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FeaturesetContainerResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } } } }, "x-ms-examples": { - "List Workspace Featureset Container.": { - "$ref": "./examples/Workspace/FeaturesetContainer/list.json" + "CreateOrUpdate Workspace Featureset Container.": { + "$ref": "./examples/Workspace/FeaturesetContainer/createOrUpdate.json" } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{featuresetName}/versions/{featuresetVersion}/features": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions": { "get": { "tags": [ - "Feature" + "FeaturesetVersion" ], - "summary": "List Features.", - "operationId": "Features_List", + "summary": "List versions.", + "operationId": "FeaturesetVersions_List", "produces": [ "application/json" ], @@ -7404,17 +7542,9 @@ }, { "in": "path", - "name": "featuresetName", + "name": "name", "description": "Featureset name. This is case-sensitive.", "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" - }, - { - "in": "path", - "name": "featuresetVersion", - "description": "Featureset Version identifier. This is case-sensitive.", - "required": true, "type": "string" }, { @@ -7429,18 +7559,6 @@ "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", "type": "string" }, - { - "in": "query", - "name": "featureName", - "description": "feature name.", - "type": "string" - }, - { - "in": "query", - "name": "description", - "description": "Description of the featureset.", - "type": "string" - }, { "in": "query", "name": "listViewType", @@ -7471,10 +7589,40 @@ { "in": "query", "name": "pageSize", - "description": "Page size.", + "description": "page size", "type": "integer", "format": "int32", - "default": 1000 + "default": 20 + }, + { + "in": "query", + "name": "versionName", + "description": "name for the featureset version", + "type": "string" + }, + { + "in": "query", + "name": "version", + "description": "featureset version", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "description for the feature set version", + "type": "string" + }, + { + "in": "query", + "name": "createdBy", + "description": "createdBy user name", + "type": "string" + }, + { + "in": "query", + "name": "stage", + "description": "Specifies the featurestore stage", + "type": "string" } ], "responses": { @@ -7487,13 +7635,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/FeatureResourceArmPaginatedResult" + "$ref": "#/definitions/FeaturesetVersionResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Feature.": { - "$ref": "./examples/Feature/list.json" + "List Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/list.json" } }, "x-ms-pageable": { @@ -7501,13 +7649,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{featuresetName}/versions/{featuresetVersion}/features/{featureName}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}": { + "delete": { "tags": [ - "Feature" + "FeaturesetVersion" ], - "summary": "Get feature.", - "operationId": "Features_Get", + "summary": "Delete version.", + "operationId": "FeaturesetVersions_Delete", "produces": [ "application/json" ], @@ -7523,26 +7671,17 @@ }, { "in": "path", - "name": "featuresetName", - "description": "Feature set name. This is case-sensitive.", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" - }, - { - "in": "path", - "name": "featuresetVersion", - "description": "Feature set version identifier. This is case-sensitive.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, { "in": "path", - "name": "featureName", - "description": "Feature Name. This is case-sensitive.", + "name": "version", + "description": "Version identifier. This is case-sensitive.", "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -7556,26 +7695,49 @@ } }, "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/FeatureResource" + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } } + }, + "204": { + "description": "No Content" } }, "x-ms-examples": { - "Get Feature.": { - "$ref": "./examples/Feature/get.json" + "Delete Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/delete.json" } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}": { - "delete": { + }, + "get": { "tags": [ - "FeaturesetContainer" + "FeaturesetVersion" ], - "summary": "Delete container.", - "operationId": "FeaturesetContainers_Delete", + "summary": "Get version.", + "operationId": "FeaturesetVersions_Get", "produces": [ "application/json" ], @@ -7596,6 +7758,13 @@ "required": true, "type": "string" }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -7608,49 +7777,27 @@ } }, "200": { - "description": "Success" - }, - "202": { - "description": "Accepted", - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturesetVersionResource" } - }, - "204": { - "description": "No Content" } }, "x-ms-examples": { - "Delete Workspace Featureset Container.": { - "$ref": "./examples/Workspace/FeaturesetContainer/delete.json" + "Get Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/get.json" } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" } }, - "get": { + "put": { "tags": [ - "FeaturesetContainer" + "FeaturesetVersion" + ], + "summary": "Create or update version.", + "operationId": "FeaturesetVersions_CreateOrUpdate", + "consumes": [ + "application/json" ], - "summary": "Get container.", - "operationId": "FeaturesetContainers_GetEntity", "produces": [ "application/json" ], @@ -7669,10 +7816,27 @@ "name": "name", "description": "Container name. This is case-sensitive.", "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/FeaturesetVersionResource" + } } ], "responses": { @@ -7683,24 +7847,47 @@ } }, "200": { - "description": "Success", + "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/FeaturesetContainerResource" + "$ref": "#/definitions/FeaturesetVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FeaturesetVersionResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } } } }, "x-ms-examples": { - "GetEntity Workspace Featureset Container.": { - "$ref": "./examples/Workspace/FeaturesetContainer/getEntity.json" + "CreateOrUpdate Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/createOrUpdate.json" } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}/backfill": { + "post": { "tags": [ - "FeaturesetContainer" + "FeaturesetVersion" ], - "summary": "Create or update container.", - "operationId": "FeaturesetContainers_CreateOrUpdate", + "summary": "Backfill.", + "operationId": "FeaturesetVersions_Backfill", "consumes": [ "application/json" ], @@ -7722,8 +7909,14 @@ "name": "name", "description": "Container name. This is case-sensitive.", "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -7731,10 +7924,10 @@ { "in": "body", "name": "body", - "description": "Container entity to create or update.", + "description": "Feature set version backfill request entity.", "required": true, "schema": { - "$ref": "#/definitions/FeaturesetContainerResource" + "$ref": "#/definitions/FeaturesetVersionBackfillRequest" } } ], @@ -7746,47 +7939,46 @@ } }, "200": { - "description": "Create or update request is successful.", + "description": "Success", "schema": { - "$ref": "#/definitions/FeaturesetContainerResource" + "$ref": "#/definitions/FeaturesetVersionBackfillResponse" } }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/FeaturesetContainerResource" - }, + "202": { + "description": "Accepted", "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Azure-AsyncOperation": { - "description": "URI to poll for asynchronous operation status.", + "Location": { + "description": "URI to poll for asynchronous operation result.", "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 } } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Featureset Container.": { - "$ref": "./examples/Workspace/FeaturesetContainer/createOrUpdate.json" + "Backfill Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/backfill.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" + "final-state-via": "location" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities": { "get": { "tags": [ - "FeaturesetVersion" + "FeaturestoreEntityContainer" ], - "summary": "List versions.", - "operationId": "FeaturesetVersions_List", + "summary": "List featurestore entity containers.", + "operationId": "FeaturestoreEntityContainers_List", "produces": [ "application/json" ], @@ -7800,13 +7992,6 @@ { "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, - { - "in": "path", - "name": "name", - "description": "Featureset name. This is case-sensitive.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, @@ -7856,20 +8041,14 @@ }, { "in": "query", - "name": "versionName", - "description": "name for the featureset version", - "type": "string" - }, - { - "in": "query", - "name": "version", - "description": "featureset version", + "name": "name", + "description": "name for the featurestore entity", "type": "string" }, { "in": "query", "name": "description", - "description": "description for the feature set version", + "description": "description for the featurestore entity", "type": "string" }, { @@ -7877,12 +8056,6 @@ "name": "createdBy", "description": "createdBy user name", "type": "string" - }, - { - "in": "query", - "name": "stage", - "description": "Specifies the featurestore stage", - "type": "string" } ], "responses": { @@ -7895,13 +8068,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/FeaturesetVersionResourceArmPaginatedResult" + "$ref": "#/definitions/FeaturestoreEntityContainerResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Workspace Featureset Version.": { - "$ref": "./examples/Workspace/FeaturesetVersion/list.json" + "List Workspace Featurestore Entity Container.": { + "$ref": "./examples/Workspace/FeaturestoreEntityContainer/list.json" } }, "x-ms-pageable": { @@ -7909,13 +8082,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}": { "delete": { "tags": [ - "FeaturesetVersion" + "FeaturestoreEntityContainer" ], - "summary": "Delete version.", - "operationId": "FeaturesetVersions_Delete", + "summary": "Delete container.", + "operationId": "FeaturestoreEntityContainers_Delete", "produces": [ "application/json" ], @@ -7936,13 +8109,6 @@ "required": true, "type": "string" }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -7983,8 +8149,8 @@ } }, "x-ms-examples": { - "Delete Workspace Featureset Version.": { - "$ref": "./examples/Workspace/FeaturesetVersion/delete.json" + "Delete Workspace Featurestore Entity Container.": { + "$ref": "./examples/Workspace/FeaturestoreEntityContainer/delete.json" } }, "x-ms-long-running-operation": true, @@ -7994,70 +8160,10 @@ }, "get": { "tags": [ - "FeaturesetVersion" - ], - "summary": "Get version.", - "operationId": "FeaturesetVersions_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" - }, - { - "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, - "type": "string" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/FeaturesetVersionResource" - } - } - }, - "x-ms-examples": { - "Get Workspace Featureset Version.": { - "$ref": "./examples/Workspace/FeaturesetVersion/get.json" - } - } - }, - "put": { - "tags": [ - "FeaturesetVersion" - ], - "summary": "Create or update version.", - "operationId": "FeaturesetVersions_CreateOrUpdate", - "consumes": [ - "application/json" + "FeaturestoreEntityContainer" ], + "summary": "Get container.", + "operationId": "FeaturestoreEntityContainers_GetEntity", "produces": [ "application/json" ], @@ -8076,27 +8182,10 @@ "name": "name", "description": "Container name. This is case-sensitive.", "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" - }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "Version entity to create or update.", - "required": true, - "schema": { - "$ref": "#/definitions/FeaturesetVersionResource" - } } ], "responses": { @@ -8106,48 +8195,25 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } }, - "200": { - "description": "Create or update request is successful.", - "schema": { - "$ref": "#/definitions/FeaturesetVersionResource" - } - }, - "201": { - "description": "Created", + "200": { + "description": "Success", "schema": { - "$ref": "#/definitions/FeaturesetVersionResource" - }, - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Azure-AsyncOperation": { - "description": "URI to poll for asynchronous operation status.", - "type": "string" - } + "$ref": "#/definitions/FeaturestoreEntityContainerResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Featureset Version.": { - "$ref": "./examples/Workspace/FeaturesetVersion/createOrUpdate.json" + "GetEntity Workspace Featurestore Entity Container.": { + "$ref": "./examples/Workspace/FeaturestoreEntityContainer/getEntity.json" } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}/backfill": { - "post": { + }, + "put": { "tags": [ - "FeaturesetVersion" + "FeaturestoreEntityContainer" ], - "summary": "Backfill.", - "operationId": "FeaturesetVersions_Backfill", + "summary": "Create or update container.", + "operationId": "FeaturestoreEntityContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -8169,14 +8235,8 @@ "name": "name", "description": "Container name. This is case-sensitive.", "required": true, - "type": "string" - }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -8184,10 +8244,10 @@ { "in": "body", "name": "body", - "description": "Feature set version backfill request entity.", + "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/FeaturesetVersionBackfillRequest" + "$ref": "#/definitions/FeaturestoreEntityContainerResource" } } ], @@ -8199,46 +8259,47 @@ } }, "200": { - "description": "Success", + "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/FeaturesetVersionBackfillResponse" + "$ref": "#/definitions/FeaturestoreEntityContainerResource" } }, - "202": { - "description": "Accepted", + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityContainerResource" + }, "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" } } } }, "x-ms-examples": { - "Backfill Workspace Featureset Version.": { - "$ref": "./examples/Workspace/FeaturesetVersion/backfill.json" + "CreateOrUpdate Workspace Featurestore Entity Container.": { + "$ref": "./examples/Workspace/FeaturestoreEntityContainer/createOrUpdate.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "location" + "final-state-via": "original-uri" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}/versions": { "get": { "tags": [ - "FeaturestoreEntityContainer" + "FeaturestoreEntityVersion" ], - "summary": "List featurestore entity containers.", - "operationId": "FeaturestoreEntityContainers_List", + "summary": "List versions.", + "operationId": "FeaturestoreEntityVersions_List", "produces": [ "application/json" ], @@ -8252,6 +8313,13 @@ { "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, + { + "in": "path", + "name": "name", + "description": "Feature entity name. This is case-sensitive.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, @@ -8301,14 +8369,20 @@ }, { "in": "query", - "name": "name", - "description": "name for the featurestore entity", + "name": "versionName", + "description": "name for the featurestore entity version", + "type": "string" + }, + { + "in": "query", + "name": "version", + "description": "featurestore entity version", "type": "string" }, { "in": "query", "name": "description", - "description": "description for the featurestore entity", + "description": "description for the feature entity version", "type": "string" }, { @@ -8316,6 +8390,12 @@ "name": "createdBy", "description": "createdBy user name", "type": "string" + }, + { + "in": "query", + "name": "stage", + "description": "Specifies the featurestore stage", + "type": "string" } ], "responses": { @@ -8328,13 +8408,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/FeaturestoreEntityContainerResourceArmPaginatedResult" + "$ref": "#/definitions/FeaturestoreEntityVersionResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Workspace Featurestore Entity Container.": { - "$ref": "./examples/Workspace/FeaturestoreEntityContainer/list.json" + "List Workspace Featurestore Entity Version.": { + "$ref": "./examples/Workspace/FeaturestoreEntityVersion/list.json" } }, "x-ms-pageable": { @@ -8342,13 +8422,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}/versions/{version}": { "delete": { "tags": [ - "FeaturestoreEntityContainer" + "FeaturestoreEntityVersion" ], - "summary": "Delete container.", - "operationId": "FeaturestoreEntityContainers_Delete", + "summary": "Delete version.", + "operationId": "FeaturestoreEntityVersions_Delete", "produces": [ "application/json" ], @@ -8369,6 +8449,13 @@ "required": true, "type": "string" }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -8409,8 +8496,8 @@ } }, "x-ms-examples": { - "Delete Workspace Featurestore Entity Container.": { - "$ref": "./examples/Workspace/FeaturestoreEntityContainer/delete.json" + "Delete Workspace Featurestore Entity Version.": { + "$ref": "./examples/Workspace/FeaturestoreEntityVersion/delete.json" } }, "x-ms-long-running-operation": true, @@ -8420,10 +8507,10 @@ }, "get": { "tags": [ - "FeaturestoreEntityContainer" + "FeaturestoreEntityVersion" ], - "summary": "Get container.", - "operationId": "FeaturestoreEntityContainers_GetEntity", + "summary": "Get version.", + "operationId": "FeaturestoreEntityVersions_Get", "produces": [ "application/json" ], @@ -8444,6 +8531,13 @@ "required": true, "type": "string" }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -8458,22 +8552,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/FeaturestoreEntityContainerResource" + "$ref": "#/definitions/FeaturestoreEntityVersionResource" } } }, "x-ms-examples": { - "GetEntity Workspace Featurestore Entity Container.": { - "$ref": "./examples/Workspace/FeaturestoreEntityContainer/getEntity.json" + "Get Workspace Featurestore Entity Version.": { + "$ref": "./examples/Workspace/FeaturestoreEntityVersion/get.json" } } }, "put": { "tags": [ - "FeaturestoreEntityContainer" + "FeaturestoreEntityVersion" ], - "summary": "Create or update container.", - "operationId": "FeaturestoreEntityContainers_CreateOrUpdate", + "summary": "Create or update version.", + "operationId": "FeaturestoreEntityVersions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -8498,16 +8592,23 @@ "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Container entity to create or update.", + "description": "Version entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/FeaturestoreEntityContainerResource" + "$ref": "#/definitions/FeaturestoreEntityVersionResource" } } ], @@ -8521,13 +8622,13 @@ "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/FeaturestoreEntityContainerResource" + "$ref": "#/definitions/FeaturestoreEntityVersionResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/FeaturestoreEntityContainerResource" + "$ref": "#/definitions/FeaturestoreEntityVersionResource" }, "headers": { "x-ms-async-operation-timeout": { @@ -8543,8 +8644,8 @@ } }, "x-ms-examples": { - "CreateOrUpdate Workspace Featurestore Entity Container.": { - "$ref": "./examples/Workspace/FeaturestoreEntityContainer/createOrUpdate.json" + "CreateOrUpdate Workspace Featurestore Entity Version.": { + "$ref": "./examples/Workspace/FeaturestoreEntityVersion/createOrUpdate.json" } }, "x-ms-long-running-operation": true, @@ -8553,13 +8654,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}/versions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs": { "get": { "tags": [ - "FeaturestoreEntityVersion" + "Job" ], - "summary": "List versions.", - "operationId": "FeaturestoreEntityVersions_List", + "summary": "Lists Jobs in the workspace.", + "operationId": "Jobs_List", "produces": [ "application/json" ], @@ -8573,13 +8674,6 @@ { "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, - { - "in": "path", - "name": "name", - "description": "Feature entity name. This is case-sensitive.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, @@ -8588,73 +8682,47 @@ }, { "in": "query", - "name": "tags", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "type": "string" - }, - { - "in": "query", - "name": "listViewType", - "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", - "type": "string", - "default": "ActiveOnly", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "value": "ActiveOnly" - }, - { - "value": "ArchivedOnly" - }, - { - "value": "All" - } - ] - } - }, - { - "in": "query", - "name": "pageSize", - "description": "page size", - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "in": "query", - "name": "versionName", - "description": "name for the featurestore entity version", - "type": "string" - }, - { - "in": "query", - "name": "version", - "description": "featurestore entity version", + "name": "jobType", + "description": "Type of job to be returned.", "type": "string" }, { "in": "query", - "name": "description", - "description": "description for the feature entity version", + "name": "tag", + "description": "Jobs returned will have this tag key.", "type": "string" }, { "in": "query", - "name": "createdBy", - "description": "createdBy user name", - "type": "string" + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } }, { "in": "query", - "name": "stage", - "description": "Specifies the featurestore stage", + "name": "properties", + "description": "Comma-separated list of user property names (and optionally values). Example: prop1,prop2=value2", "type": "string" } ], @@ -8668,13 +8736,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/FeaturestoreEntityVersionResourceArmPaginatedResult" + "$ref": "#/definitions/JobBaseResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Workspace Featurestore Entity Version.": { - "$ref": "./examples/Workspace/FeaturestoreEntityVersion/list.json" + "List Command Job.": { + "$ref": "./examples/Job/CommandJob/list.json" + }, + "List AutoML Job.": { + "$ref": "./examples/Job/AutoMLJob/list.json" + }, + "List Sweep Job.": { + "$ref": "./examples/Job/SweepJob/list.json" + }, + "List Pipeline Job.": { + "$ref": "./examples/Job/PipelineJob/list.json" } }, "x-ms-pageable": { @@ -8682,13 +8759,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}/versions/{version}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}": { "delete": { "tags": [ - "FeaturestoreEntityVersion" + "Job" ], - "summary": "Delete version.", - "operationId": "FeaturestoreEntityVersions_Delete", + "summary": "Deletes a Job (asynchronous).", + "operationId": "Jobs_Delete", "produces": [ "application/json" ], @@ -8704,15 +8781,8 @@ }, { "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", + "name": "id", + "description": "The name and identifier for the Job. This is case-sensitive.", "required": true, "type": "string" }, @@ -8756,8 +8826,8 @@ } }, "x-ms-examples": { - "Delete Workspace Featurestore Entity Version.": { - "$ref": "./examples/Workspace/FeaturestoreEntityVersion/delete.json" + "Delete Job.": { + "$ref": "./examples/Job/delete.json" } }, "x-ms-long-running-operation": true, @@ -8767,10 +8837,10 @@ }, "get": { "tags": [ - "FeaturestoreEntityVersion" + "Job" ], - "summary": "Get version.", - "operationId": "FeaturestoreEntityVersions_Get", + "summary": "Gets a Job by name/id.", + "operationId": "Jobs_Get", "produces": [ "application/json" ], @@ -8786,15 +8856,8 @@ }, { "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", + "name": "id", + "description": "The name and identifier for the Job. This is case-sensitive.", "required": true, "type": "string" }, @@ -8812,22 +8875,31 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/FeaturestoreEntityVersionResource" + "$ref": "#/definitions/JobBaseResource" } } }, "x-ms-examples": { - "Get Workspace Featurestore Entity Version.": { - "$ref": "./examples/Workspace/FeaturestoreEntityVersion/get.json" + "Get Command Job.": { + "$ref": "./examples/Job/CommandJob/get.json" + }, + "Get AutoML Job.": { + "$ref": "./examples/Job/AutoMLJob/get.json" + }, + "Get Sweep Job.": { + "$ref": "./examples/Job/SweepJob/get.json" + }, + "Get Pipeline Job.": { + "$ref": "./examples/Job/PipelineJob/get.json" } } }, "put": { "tags": [ - "FeaturestoreEntityVersion" + "Job" ], - "summary": "Create or update version.", - "operationId": "FeaturestoreEntityVersions_CreateOrUpdate", + "summary": "Creates and executes a Job.\r\nFor update case, the Tags in the definition passed in will replace Tags in the existing job.", + "operationId": "Jobs_CreateOrUpdate", "consumes": [ "application/json" ], @@ -8846,29 +8918,22 @@ }, { "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", + "name": "id", + "description": "The name and identifier for the Job. This is case-sensitive.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Version entity to create or update.", + "description": "Job definition object.", "required": true, "schema": { - "$ref": "#/definitions/FeaturestoreEntityVersionResource" + "$ref": "#/definitions/JobBaseResource" } } ], @@ -8882,45 +8947,39 @@ "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/FeaturestoreEntityVersionResource" + "$ref": "#/definitions/JobBaseResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/FeaturestoreEntityVersionResource" - }, - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Azure-AsyncOperation": { - "description": "URI to poll for asynchronous operation status.", - "type": "string" - } + "$ref": "#/definitions/JobBaseResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Featurestore Entity Version.": { - "$ref": "./examples/Workspace/FeaturestoreEntityVersion/createOrUpdate.json" + "CreateOrUpdate Command Job.": { + "$ref": "./examples/Job/CommandJob/createOrUpdate.json" + }, + "CreateOrUpdate AutoML Job.": { + "$ref": "./examples/Job/AutoMLJob/createOrUpdate.json" + }, + "CreateOrUpdate Sweep Job.": { + "$ref": "./examples/Job/SweepJob/createOrUpdate.json" + }, + "CreateOrUpdate Pipeline Job.": { + "$ref": "./examples/Job/PipelineJob/createOrUpdate.json" } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}/cancel": { + "post": { "tags": [ "Job" ], - "summary": "Lists Jobs in the workspace.", - "operationId": "Jobs_List", + "summary": "Cancels a Job (asynchronous).", + "operationId": "Jobs_Cancel", "produces": [ "application/json" ], @@ -8935,55 +8994,79 @@ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "path", + "name": "id", + "description": "The name and identifier for the Job. This is case-sensitive.", + "required": true, + "type": "string" }, { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } }, - { - "in": "query", - "name": "jobType", - "description": "Type of job to be returned.", - "type": "string" + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } }, + "200": { + "description": "Success" + } + }, + "x-ms-examples": { + "Cancel Job.": { + "$ref": "./examples/Job/cancel.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/marketplaceSubscriptions": { + "get": { + "tags": [ + "MarketplaceSubscription" + ], + "summary": "List containers.", + "operationId": "MarketplaceSubscriptions_List", + "produces": [ + "application/json" + ], + "parameters": [ { - "in": "query", - "name": "tag", - "description": "Jobs returned will have this tag key.", - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "in": "query", - "name": "listViewType", - "description": "View type for including/excluding (for example) archived entities.", - "type": "string", - "default": "ActiveOnly", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "value": "ActiveOnly" - }, - { - "value": "ArchivedOnly" - }, - { - "value": "All" - } - ] - } + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "in": "query", - "name": "properties", - "description": "Comma-separated list of user property names (and optionally values). Example: prop1,prop2=value2", - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" } ], "responses": { @@ -8996,22 +9079,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/JobBaseResourceArmPaginatedResult" + "$ref": "#/definitions/MarketplaceSubscriptionResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Command Job.": { - "$ref": "./examples/Job/CommandJob/list.json" - }, - "List AutoML Job.": { - "$ref": "./examples/Job/AutoMLJob/list.json" - }, - "List Sweep Job.": { - "$ref": "./examples/Job/SweepJob/list.json" - }, - "List Pipeline Job.": { - "$ref": "./examples/Job/PipelineJob/list.json" + "List Workspace Marketplace Subscription.": { + "$ref": "./examples/Workspace/MarketplaceSubscription/list.json" } }, "x-ms-pageable": { @@ -9019,13 +9093,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/marketplaceSubscriptions/{name}": { "delete": { "tags": [ - "Job" + "MarketplaceSubscription" ], - "summary": "Deletes a Job (asynchronous).", - "operationId": "Jobs_Delete", + "summary": "Delete Marketplace Subscription (asynchronous).", + "operationId": "MarketplaceSubscriptions_Delete", "produces": [ "application/json" ], @@ -9041,10 +9115,11 @@ }, { "in": "path", - "name": "id", - "description": "The name and identifier for the Job. This is case-sensitive.", + "name": "name", + "description": "Marketplace Subscription name.", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -9057,8 +9132,8 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } }, - "200": { - "description": "Success" + "204": { + "description": "No Content" }, "202": { "description": "Accepted", @@ -9080,14 +9155,11 @@ "minimum": 10 } } - }, - "204": { - "description": "No Content" } }, "x-ms-examples": { - "Delete Job.": { - "$ref": "./examples/Job/delete.json" + "Delete Workspace Marketplace Subscription.": { + "$ref": "./examples/Workspace/MarketplaceSubscription/delete.json" } }, "x-ms-long-running-operation": true, @@ -9097,10 +9169,10 @@ }, "get": { "tags": [ - "Job" + "MarketplaceSubscription" ], - "summary": "Gets a Job by name/id.", - "operationId": "Jobs_Get", + "summary": "Get container.", + "operationId": "MarketplaceSubscriptions_Get", "produces": [ "application/json" ], @@ -9116,8 +9188,8 @@ }, { "in": "path", - "name": "id", - "description": "The name and identifier for the Job. This is case-sensitive.", + "name": "name", + "description": "Container name.", "required": true, "type": "string" }, @@ -9135,31 +9207,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/JobBaseResource" + "$ref": "#/definitions/MarketplaceSubscriptionResource" } } }, "x-ms-examples": { - "Get Command Job.": { - "$ref": "./examples/Job/CommandJob/get.json" - }, - "Get AutoML Job.": { - "$ref": "./examples/Job/AutoMLJob/get.json" - }, - "Get Sweep Job.": { - "$ref": "./examples/Job/SweepJob/get.json" - }, - "Get Pipeline Job.": { - "$ref": "./examples/Job/PipelineJob/get.json" + "Get Workspace Marketplace Subscription.": { + "$ref": "./examples/Workspace/MarketplaceSubscription/get.json" } } }, "put": { "tags": [ - "Job" + "MarketplaceSubscription" ], - "summary": "Creates and executes a Job.\r\nFor update case, the Tags in the definition passed in will replace Tags in the existing job.", - "operationId": "Jobs_CreateOrUpdate", + "summary": "Create or update Marketplace Subscription (asynchronous).", + "operationId": "MarketplaceSubscriptions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -9178,8 +9241,8 @@ }, { "in": "path", - "name": "id", - "description": "The name and identifier for the Job. This is case-sensitive.", + "name": "name", + "description": "Marketplace Subscription name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -9190,10 +9253,10 @@ { "in": "body", "name": "body", - "description": "Job definition object.", + "description": "Marketplace Subscription entity to apply during operation.", "required": true, "schema": { - "$ref": "#/definitions/JobBaseResource" + "$ref": "#/definitions/MarketplaceSubscriptionResource" } } ], @@ -9207,98 +9270,35 @@ "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/JobBaseResource" + "$ref": "#/definitions/MarketplaceSubscriptionResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/JobBaseResource" - } - } - }, - "x-ms-examples": { - "CreateOrUpdate Command Job.": { - "$ref": "./examples/Job/CommandJob/createOrUpdate.json" - }, - "CreateOrUpdate AutoML Job.": { - "$ref": "./examples/Job/AutoMLJob/createOrUpdate.json" - }, - "CreateOrUpdate Sweep Job.": { - "$ref": "./examples/Job/SweepJob/createOrUpdate.json" - }, - "CreateOrUpdate Pipeline Job.": { - "$ref": "./examples/Job/PipelineJob/createOrUpdate.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}/cancel": { - "post": { - "tags": [ - "Job" - ], - "summary": "Cancels a Job (asynchronous).", - "operationId": "Jobs_Cancel", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" - }, - { - "in": "path", - "name": "id", - "description": "The name and identifier for the Job. This is case-sensitive.", - "required": true, - "type": "string" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - }, - "202": { - "description": "Accepted", + "$ref": "#/definitions/MarketplaceSubscriptionResource" + }, "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" } } - }, - "200": { - "description": "Success" } }, "x-ms-examples": { - "Cancel Job.": { - "$ref": "./examples/Job/cancel.json" + "CreateOrUpdate Workspace Marketplace Subscription.": { + "$ref": "./examples/Workspace/MarketplaceSubscription/createOrUpdate.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "location" + "final-state-via": "original-uri" } } }, @@ -11429,17 +11429,17 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ServerlessEndpointTrackedResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ServerlessEndpointTrackedResourceArmPaginatedResult" + } } }, "x-ms-examples": { @@ -11485,6 +11485,15 @@ } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "204": { + "description": "No Content" + }, "202": { "description": "Accepted", "headers": { @@ -11505,15 +11514,6 @@ "minimum": 10 } } - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { @@ -11557,17 +11557,17 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ServerlessEndpointTrackedResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ServerlessEndpointTrackedResource" + } } }, "x-ms-examples": { @@ -11620,6 +11620,12 @@ } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Success", "schema": { @@ -11646,12 +11652,6 @@ "minimum": 10 } } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { @@ -11705,6 +11705,12 @@ } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Create or update request is successful.", "schema": { @@ -11727,12 +11733,6 @@ "type": "string" } } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { @@ -11774,22 +11774,22 @@ "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/EndpointAuthKeys" - } - }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EndpointAuthKeys" + } } }, "x-ms-examples": { @@ -11844,6 +11844,12 @@ } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Success", "schema": { @@ -11865,12 +11871,6 @@ "minimum": 10 } } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { @@ -11994,23 +11994,23 @@ } ], "properties": { - "isAnonymous": { - "description": "If the name version are system generated (anonymous registration).", + "isArchived": { + "description": "Is the asset archived?", "default": false, "type": "boolean", "x-ms-mutability": [ "create", - "read" + "read", + "update" ] }, - "isArchived": { - "description": "Is the asset archived?", + "isAnonymous": { + "description": "If the name version are system generated (anonymous registration).", "default": false, "type": "boolean", "x-ms-mutability": [ "create", - "read", - "update" + "read" ] } }, @@ -12062,6 +12062,12 @@ ], "type": "object", "properties": { + "uri": { + "description": "[Required] Input Asset URI.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + }, "mode": { "description": "Input Asset Delivery Mode.", "default": "ReadOnlyMount", @@ -12070,12 +12076,6 @@ "create", "read" ] - }, - "uri": { - "description": "[Required] Input Asset URI.", - "minLength": 1, - "pattern": "[a-zA-Z0-9_]", - "type": "string" } }, "additionalProperties": false @@ -12084,6 +12084,11 @@ "description": "Asset output type.", "type": "object", "properties": { + "uri": { + "description": "Output Asset URI.", + "type": "string", + "x-nullable": true + }, "mode": { "description": "Output Asset Delivery Mode.", "default": "ReadWriteMount", @@ -12092,11 +12097,6 @@ "create", "read" ] - }, - "uri": { - "description": "Output Asset URI.", - "type": "string", - "x-nullable": true } }, "additionalProperties": false @@ -12175,6 +12175,15 @@ } ], "properties": { + "resources": { + "description": "Compute Resource configuration for the job.", + "default": "{}", + "$ref": "#/definitions/JobResourceConfiguration", + "x-ms-mutability": [ + "create", + "read" + ] + }, "environmentId": { "description": "The ARM resource ID of the Environment specification for the job.\r\nThis is optional value to provide, if not provided, AutoML will default this to Production AutoML curated environment version when running the job.", "type": "string", @@ -12197,6 +12206,10 @@ ], "x-nullable": true }, + "taskDetails": { + "description": "[Required] This represents scenario which can be one of Tables/NLP/Image", + "$ref": "#/definitions/AutoMLVertical" + }, "outputs": { "description": "Mapping of output data bindings used in the job.", "type": "object", @@ -12219,19 +12232,6 @@ "read" ], "x-nullable": true - }, - "resources": { - "description": "Compute Resource configuration for the job.", - "default": "{}", - "$ref": "#/definitions/JobResourceConfiguration", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "taskDetails": { - "description": "[Required] This represents scenario which can be one of Tables/NLP/Image", - "$ref": "#/definitions/AutoMLVertical" } }, "x-ms-discriminator-value": "AutoML", @@ -12245,16 +12245,6 @@ ], "type": "object", "properties": { - "logVerbosity": { - "description": "Log verbosity for the job.", - "default": "Info", - "$ref": "#/definitions/LogVerbosity" - }, - "targetColumnName": { - "description": "Target column name: This is prediction values column.\r\nAlso known as label column name in context of classification tasks.", - "type": "string", - "x-nullable": true - }, "taskType": { "description": "[Required] Task type for AutoMLJob.", "$ref": "#/definitions/TaskType", @@ -12263,9 +12253,19 @@ "read" ] }, + "logVerbosity": { + "description": "Log verbosity for the job.", + "default": "Info", + "$ref": "#/definitions/LogVerbosity" + }, "trainingData": { "description": "[Required] Training data input.", "$ref": "#/definitions/MLTableJobInput" + }, + "targetColumnName": { + "description": "Target column name: This is prediction values column.\r\nAlso known as label column name in context of classification tasks.", + "type": "string", + "x-nullable": true } }, "discriminator": "taskType" @@ -12411,15 +12411,6 @@ } ], "properties": { - "serviceDataAccessAuthIdentity": { - "description": "Indicates which identity to use to authenticate service data access to customer's storage.", - "default": "None", - "$ref": "#/definitions/ServiceDataAccessAuthIdentity", - "x-ms-mutability": [ - "create", - "read" - ] - }, "storeName": { "description": "[Required] Azure Data Lake store name.", "minLength": 1, @@ -12429,6 +12420,15 @@ "create", "read" ] + }, + "serviceDataAccessAuthIdentity": { + "description": "Indicates which identity to use to authenticate service data access to customer's storage.", + "default": "None", + "$ref": "#/definitions/ServiceDataAccessAuthIdentity", + "x-ms-mutability": [ + "create", + "read" + ] } }, "x-ms-discriminator-value": "AzureDataLakeGen1", @@ -12450,6 +12450,16 @@ } ], "properties": { + "filesystem": { + "description": "[Required] The name of the Data Lake Gen2 filesystem.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, "accountName": { "description": "[Required] Storage account name.", "minLength": 1, @@ -12470,16 +12480,6 @@ ], "x-nullable": true }, - "filesystem": { - "description": "[Required] The name of the Data Lake Gen2 filesystem.", - "minLength": 1, - "pattern": "[a-zA-Z0-9_]", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ] - }, "protocol": { "description": "Protocol used to communicate with the storage account.", "type": "string", @@ -12507,13 +12507,13 @@ "description": "Base definition for Azure datastore contents configuration.", "type": "object", "properties": { - "resourceGroup": { - "description": "Azure Resource Group name", + "subscriptionId": { + "description": "Azure Subscription Id", "type": "string", "x-nullable": true }, - "subscriptionId": { - "description": "Azure Subscription Id", + "resourceGroup": { + "description": "Azure Resource Group name", "type": "string", "x-nullable": true } @@ -12557,16 +12557,6 @@ "read" ] }, - "endpoint": { - "description": "Azure cloud endpoint for the storage account.", - "type": "string", - "example": "core.windows.net", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, "fileShareName": { "description": "[Required] The name of the Azure file share that the datastore points to.", "minLength": 1, @@ -12577,6 +12567,16 @@ "read" ] }, + "endpoint": { + "description": "Azure cloud endpoint for the storage account.", + "type": "string", + "example": "core.windows.net", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, "protocol": { "description": "Protocol used to communicate with the storage account.", "type": "string", @@ -12609,15 +12609,15 @@ } ], "properties": { - "slackAmount": { + "slackFactor": { "format": "float", - "description": "Absolute distance allowed from the best performing run.", + "description": "Ratio of the allowed distance from the best performing run.", "default": 0, "type": "number" }, - "slackFactor": { + "slackAmount": { "format": "float", - "description": "Ratio of the allowed distance from the best performing run.", + "description": "Absolute distance allowed from the best performing run.", "default": 0, "type": "number" } @@ -12650,16 +12650,10 @@ "default": -1, "type": "integer" }, - "loggingLevel": { - "description": "Logging level for batch inference operation.", - "default": "Info", - "$ref": "#/definitions/BatchLoggingLevel" - }, - "maxConcurrencyPerInstance": { - "format": "int32", - "description": "Indicates maximum number of parallelism per instance.", - "default": 1, - "type": "integer" + "retrySettings": { + "description": "Retry Settings for the batch inference operation.\r\nIf not provided, will default to the defaults defined in BatchRetrySettings.", + "$ref": "#/definitions/BatchRetrySettings", + "x-nullable": true }, "miniBatchSize": { "format": "int64", @@ -12667,11 +12661,22 @@ "default": 10, "type": "integer" }, + "loggingLevel": { + "description": "Logging level for batch inference operation.", + "default": "Info", + "$ref": "#/definitions/BatchLoggingLevel" + }, "model": { "description": "Reference to the model asset for the endpoint deployment.", "$ref": "#/definitions/AssetReferenceBase", "x-nullable": true }, + "maxConcurrencyPerInstance": { + "format": "int32", + "description": "Indicates maximum number of parallelism per instance.", + "default": 1, + "type": "integer" + }, "outputAction": { "description": "Indicates how the output will be organized.", "default": "AppendRow", @@ -12682,6 +12687,11 @@ "default": "predictions.csv", "type": "string" }, + "resources": { + "description": "Indicates compute configuration for the job.\r\nIf not provided, will default to the defaults defined in ResourceConfiguration.", + "$ref": "#/definitions/DeploymentResourceConfiguration", + "x-nullable": true + }, "provisioningState": { "description": "Provisioning state for the endpoint deployment.", "$ref": "#/definitions/DeploymentProvisioningState", @@ -12689,16 +12699,6 @@ "x-ms-mutability": [ "read" ] - }, - "resources": { - "description": "Indicates compute configuration for the job.\r\nIf not provided, will default to the defaults defined in ResourceConfiguration.", - "$ref": "#/definitions/DeploymentResourceConfiguration", - "x-nullable": true - }, - "retrySettings": { - "description": "Retry Settings for the batch inference operation.\r\nIf not provided, will default to the defaults defined in BatchRetrySettings.", - "$ref": "#/definitions/BatchRetrySettings", - "x-nullable": true } }, "x-ms-client-name": "BatchDeploymentProperties", @@ -12751,17 +12751,17 @@ } ], "properties": { - "identity": { - "description": "Managed service identity (system assigned and/or user assigned identities)", - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/BatchDeployment" }, "kind": { "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", "type": "string" }, - "properties": { - "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/BatchDeployment" + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" }, "sku": { "description": "Sku details required for ARM contract for Autoscaling.", @@ -12775,16 +12775,16 @@ "description": "A paginated list of BatchDeployment entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of BatchDeployment objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type BatchDeployment.", "type": "array", "items": { "$ref": "#/definitions/BatchDeploymentTrackedResource" } + }, + "nextLink": { + "description": "The link to the next page of BatchDeployment objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -12839,17 +12839,17 @@ } ], "properties": { - "identity": { - "description": "Managed service identity (system assigned and/or user assigned identities)", - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/BatchEndpoint" }, "kind": { "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", "type": "string" }, - "properties": { - "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/BatchEndpoint" + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" }, "sku": { "description": "Sku details required for ARM contract for Autoscaling.", @@ -12863,16 +12863,16 @@ "description": "A paginated list of BatchEndpoint entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of BatchEndpoint objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type BatchEndpoint.", "type": "array", "items": { "$ref": "#/definitions/BatchEndpointTrackedResource" } + }, + "nextLink": { + "description": "The link to the next page of BatchEndpoint objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -13003,15 +13003,15 @@ "type": "string", "x-nullable": true }, - "credential": { - "description": "Credential info to access storage account", - "$ref": "#/definitions/PendingUploadCredentialDto", - "x-nullable": true - }, "storageAccountArmId": { "description": "Arm ID of the storage account to use", "type": "string", "x-nullable": true + }, + "credential": { + "description": "Credential info to access storage account", + "$ref": "#/definitions/PendingUploadCredentialDto", + "x-nullable": true } }, "additionalProperties": false @@ -13280,35 +13280,35 @@ "type": "string", "x-nullable": true }, - "clientId": { - "format": "uuid", - "description": "[Required] Service principal client ID.", - "type": "string" - }, "resourceUrl": { "description": "Resource the service principal has access to.", "type": "string", "x-nullable": true }, - "secrets": { - "description": "[Required] Service principal secrets.", - "$ref": "#/definitions/CertificateDatastoreSecrets", - "x-ms-mutability": [ - "create", - "update" - ], - "x-ms-secret": true - }, "tenantId": { "format": "uuid", "description": "[Required] ID of the tenant to which the service principal belongs.", "type": "string" }, + "clientId": { + "format": "uuid", + "description": "[Required] Service principal client ID.", + "type": "string" + }, "thumbprint": { "description": "[Required] Thumbprint of the certificate used for authentication.", "minLength": 1, "pattern": "[a-zA-Z0-9_]", "type": "string" + }, + "secrets": { + "description": "[Required] Service principal secrets.", + "$ref": "#/definitions/CertificateDatastoreSecrets", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true } }, "x-ms-discriminator-value": "Certificate", @@ -13344,11 +13344,6 @@ } ], "properties": { - "positiveLabel": { - "description": "Positive label for binary metrics calculation.", - "type": "string", - "x-nullable": true - }, "primaryMetric": { "description": "Primary metric for the task.", "default": "AUCWeighted", @@ -13358,6 +13353,11 @@ "description": "Inputs for training phase for an AutoML Job.", "$ref": "#/definitions/ClassificationTrainingSettings", "x-nullable": true + }, + "positiveLabel": { + "description": "Positive label for binary metrics calculation.", + "type": "string", + "x-nullable": true } }, "x-ms-discriminator-value": "Classification", @@ -13624,16 +13624,16 @@ "description": "A paginated list of CodeContainer entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of CodeContainer objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type CodeContainer.", "type": "array", "items": { "$ref": "#/definitions/CodeContainerResource" } + }, + "nextLink": { + "description": "The link to the next page of CodeContainer objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -13689,16 +13689,16 @@ "description": "A paginated list of CodeVersion entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of CodeVersion objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type CodeVersion.", "type": "array", "items": { "$ref": "#/definitions/CodeVersionResource" } + }, + "nextLink": { + "description": "The link to the next page of CodeVersion objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -13706,10 +13706,11 @@ "Collection": { "type": "object", "properties": { - "clientId": { - "description": "The msi client id used to collect logging to blob storage. If it's null,backend will pick a registered endpoint identity to auth.", - "type": "string", - "x-nullable": true + "samplingRate": { + "format": "double", + "description": "The sampling rate for collection. Sampling rate 1.0 means we collect 100% of data by default.", + "default": 1, + "type": "number" }, "dataCollectionMode": { "description": "Enable or disable data collection.", @@ -13721,11 +13722,10 @@ "type": "string", "x-nullable": true }, - "samplingRate": { - "format": "double", - "description": "The sampling rate for collection. Sampling rate 1.0 means we collect 100% of data by default.", - "default": 1, - "type": "number" + "clientId": { + "description": "The msi client id used to collect logging to blob storage. If it's null,backend will pick a registered endpoint identity to auth.", + "type": "string", + "x-nullable": true } }, "additionalProperties": false @@ -13763,6 +13763,15 @@ } ], "properties": { + "resources": { + "description": "Compute Resource configuration for the job.", + "default": "{}", + "$ref": "#/definitions/JobResourceConfiguration", + "x-ms-mutability": [ + "create", + "read" + ] + }, "codeId": { "description": "ARM resource ID of the code asset.", "type": "string", @@ -13782,15 +13791,6 @@ "read" ] }, - "distribution": { - "description": "Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.", - "$ref": "#/definitions/DistributionConfiguration", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, "environmentId": { "description": "[Required] The ARM resource ID of the Environment specification for the job.", "minLength": 1, @@ -13801,11 +13801,12 @@ "read" ] }, - "environmentVariables": { - "description": "Environment variables included in the job.", + "inputs": { + "description": "Mapping of input data bindings used in the job.", "type": "object", "additionalProperties": { - "type": "string", + "description": "Command job definition.", + "$ref": "#/definitions/JobInput", "x-nullable": true }, "x-ms-mutability": [ @@ -13814,12 +13815,12 @@ ], "x-nullable": true }, - "inputs": { - "description": "Mapping of input data bindings used in the job.", + "outputs": { + "description": "Mapping of output data bindings used in the job.", "type": "object", "additionalProperties": { - "description": "Command job definition.", - "$ref": "#/definitions/JobInput", + "description": "Job output definition container information on where to find job output/logs.", + "$ref": "#/definitions/JobOutput", "x-nullable": true }, "x-ms-mutability": [ @@ -13828,6 +13829,15 @@ ], "x-nullable": true }, + "distribution": { + "description": "Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.", + "$ref": "#/definitions/DistributionConfiguration", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, "limits": { "description": "Command Job limit.", "$ref": "#/definitions/CommandJobLimits", @@ -13837,12 +13847,11 @@ ], "x-nullable": true }, - "outputs": { - "description": "Mapping of output data bindings used in the job.", + "environmentVariables": { + "description": "Environment variables included in the job.", "type": "object", "additionalProperties": { - "description": "Job output definition container information on where to find job output/logs.", - "$ref": "#/definitions/JobOutput", + "type": "string", "x-nullable": true }, "x-ms-mutability": [ @@ -13868,15 +13877,6 @@ "read" ], "x-nullable": true - }, - "resources": { - "description": "Compute Resource configuration for the job.", - "default": "{}", - "$ref": "#/definitions/JobResourceConfiguration", - "x-ms-mutability": [ - "create", - "read" - ] } }, "x-ms-discriminator-value": "Command", @@ -13938,16 +13938,16 @@ "description": "A paginated list of ComponentContainer entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of ComponentContainer objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type ComponentContainer.", "type": "array", "items": { "$ref": "#/definitions/ComponentContainerResource" } + }, + "nextLink": { + "description": "The link to the next page of ComponentContainer objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -14015,16 +14015,16 @@ "description": "A paginated list of ComponentVersion entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of ComponentVersion objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type ComponentVersion.", "type": "array", "items": { "$ref": "#/definitions/ComponentVersionResource" } + }, + "nextLink": { + "description": "The link to the next page of ComponentVersion objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -14033,13 +14033,13 @@ "description": "Resource requirements for each container instance within an online deployment.", "type": "object", "properties": { - "containerResourceLimits": { - "description": "Container resource limit info:", + "containerResourceRequests": { + "description": "Container resource request info:", "$ref": "#/definitions/ContainerResourceSettings", "x-nullable": true }, - "containerResourceRequests": { - "description": "Container resource request info:", + "containerResourceLimits": { + "description": "Container resource limit info:", "$ref": "#/definitions/ContainerResourceSettings", "x-nullable": true } @@ -14055,17 +14055,17 @@ "example": "1", "x-nullable": true }, - "gpu": { - "description": "Number of Nvidia GPU cards request/limit for container. More info:\r\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", - "type": "string", - "example": "1", - "x-nullable": true - }, "memory": { "description": "Memory size request/limit for container. More info:\r\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", "type": "string", "example": "2Gi", "x-nullable": true + }, + "gpu": { + "description": "Number of Nvidia GPU cards request/limit for container. More info:\r\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", + "type": "string", + "example": "1", + "x-nullable": true } }, "additionalProperties": false @@ -14091,20 +14091,19 @@ "additionalProperties": false }, "ContentSafety": { - "additionalProperties": false, + "required": [ + "contentSafetyStatus" + ], + "type": "object", "properties": { "contentSafetyStatus": { - "$ref": "#/definitions/ContentSafetyStatus", - "description": "[Required] Specifies the status of content safety." + "description": "[Required] Specifies the status of content safety.", + "$ref": "#/definitions/ContentSafetyStatus" } }, - "required": [ - "contentSafetyStatus" - ], - "type": "object" + "additionalProperties": false }, "ContentSafetyStatus": { - "additionalProperties": false, "description": "Specifies the status of content safety.", "enum": [ "Enabled", @@ -14112,8 +14111,8 @@ ], "type": "string", "x-ms-enum": { - "modelAsString": true, "name": "ContentSafetyStatus", + "modelAsString": true, "values": [ { "value": "Enabled" @@ -14122,7 +14121,8 @@ "value": "Disabled" } ] - } + }, + "additionalProperties": false }, "CreateMonitorAction": { "required": [ @@ -14228,6 +14228,15 @@ ], "type": "object", "properties": { + "threshold": { + "description": "The threshold value. If null, a default value will be set depending on the selected metric.", + "$ref": "#/definitions/MonitoringThreshold", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, "metric": { "description": "[Required] The user-defined metric to calculate.", "minLength": 1, @@ -14237,15 +14246,6 @@ "create", "read" ] - }, - "threshold": { - "description": "The threshold value. If null, a default value will be set depending on the selected metric.", - "$ref": "#/definitions/MonitoringThreshold", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true } }, "additionalProperties": false @@ -14288,16 +14288,6 @@ } ], "properties": { - "componentId": { - "description": "[Required] Reference to the component asset used to calculate the custom metrics.", - "minLength": 1, - "pattern": "[a-zA-Z0-9_]", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ] - }, "inputAssets": { "description": "Monitoring assets to take as input. Key is the component input port name, value is the data asset.", "type": "object", @@ -14326,6 +14316,16 @@ ], "x-nullable": true }, + "componentId": { + "description": "[Required] Reference to the component asset used to calculate the custom metrics.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, "metricThresholds": { "description": "[Required] A list of metrics to calculate and their associated thresholds.", "type": "array", @@ -14488,15 +14488,15 @@ "x-nullable": true } }, - "requestLogging": { - "description": "The request logging configuration for mdc, it includes advanced logging settings for all collections. It's optional.", - "$ref": "#/definitions/RequestLogging", - "x-nullable": true - }, "rollingRate": { "description": "When model data is collected to blob storage, we need to roll the data to different path to avoid logging all of them in a single blob file.\r\nIf the rolling rate is hour, all data will be collected in the blob path /yyyy/MM/dd/HH/.\r\nIf it's day, all data will be collected in blob path /yyyy/MM/dd/.\r\nThe other benefit of rolling path is that model monitoring ui is able to select a time range of data very quickly.", "default": "Hour", "$ref": "#/definitions/RollingRateType" + }, + "requestLogging": { + "description": "The request logging configuration for mdc, it includes advanced logging settings for all collections. It's optional.", + "$ref": "#/definitions/RequestLogging", + "x-nullable": true } }, "additionalProperties": false @@ -14549,16 +14549,16 @@ "description": "A paginated list of DataContainer entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of DataContainer objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type DataContainer.", "type": "array", "items": { "$ref": "#/definitions/DataContainerResource" } + }, + "nextLink": { + "description": "The link to the next page of DataContainer objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -14602,12 +14602,9 @@ } ], "properties": { - "featureDataTypeOverride": { - "description": "A dictionary that maps feature names to their respective data types.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/MonitoringFeatureDataType" - }, + "features": { + "description": "The feature filter which identifies which feature to calculate drift over.", + "$ref": "#/definitions/MonitoringFeatureFilterBase", "x-ms-mutability": [ "create", "read" @@ -14623,15 +14620,6 @@ ], "x-nullable": true }, - "features": { - "description": "The feature filter which identifies which feature to calculate drift over.", - "$ref": "#/definitions/MonitoringFeatureFilterBase", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, "metricThresholds": { "description": "[Required] A list of metrics to calculate and their associated thresholds.", "type": "array", @@ -14659,6 +14647,18 @@ "create", "read" ] + }, + "featureDataTypeOverride": { + "description": "A dictionary that maps feature names to their respective data types.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MonitoringFeatureDataType" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true } }, "x-ms-discriminator-value": "DataDrift", @@ -14673,13 +14673,13 @@ } ], "properties": { - "datastoreId": { - "description": "ARM resource ID of the datastore where the asset is located.", + "path": { + "description": "The path of the file/directory in the datastore.", "type": "string", "x-nullable": true }, - "path": { - "description": "The path of the file/directory in the datastore.", + "datastoreId": { + "description": "ARM resource ID of the datastore where the asset is located.", "type": "string", "x-nullable": true } @@ -14726,12 +14726,9 @@ } ], "properties": { - "featureDataTypeOverride": { - "description": "A dictionary that maps feature names to their respective data types.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/MonitoringFeatureDataType" - }, + "features": { + "description": "The features to calculate drift over.", + "$ref": "#/definitions/MonitoringFeatureFilterBase", "x-ms-mutability": [ "create", "read" @@ -14747,15 +14744,6 @@ ], "x-nullable": true }, - "features": { - "description": "The features to calculate drift over.", - "$ref": "#/definitions/MonitoringFeatureFilterBase", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, "metricThresholds": { "description": "[Required] A list of metrics to calculate and their associated thresholds.", "type": "array", @@ -14783,6 +14771,18 @@ "create", "read" ] + }, + "featureDataTypeOverride": { + "description": "A dictionary that maps feature names to their respective data types.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MonitoringFeatureDataType" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true } }, "x-ms-discriminator-value": "DataQuality", @@ -14915,16 +14915,16 @@ "description": "A paginated list of DataVersionBase entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of DataVersionBase objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type DataVersionBase.", "type": "array", "items": { "$ref": "#/definitions/DataVersionBaseResource" } + }, + "nextLink": { + "description": "The link to the next page of DataVersionBase objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -14942,10 +14942,6 @@ } ], "properties": { - "credentials": { - "description": "[Required] Account credentials.", - "$ref": "#/definitions/DatastoreCredentials" - }, "datastoreType": { "description": "[Required] Storage type backing the datastore.", "$ref": "#/definitions/DatastoreType" @@ -14957,6 +14953,10 @@ "x-ms-mutability": [ "read" ] + }, + "credentials": { + "description": "[Required] Account credentials.", + "$ref": "#/definitions/DatastoreCredentials" } }, "discriminator": "datastoreType", @@ -15000,16 +15000,16 @@ "description": "A paginated list of Datastore entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of Datastore objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type Datastore.", "type": "array", "items": { "$ref": "#/definitions/DatastoreResource" } + }, + "nextLink": { + "description": "The link to the next page of Datastore objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -15153,6 +15153,11 @@ "description": "Publishing destination registry asset information", "type": "object", "properties": { + "registryName": { + "description": "Destination registry name", + "type": "string", + "x-nullable": true + }, "destinationName": { "description": "Destination asset name", "type": "string", @@ -15162,11 +15167,6 @@ "description": "Destination asset version", "type": "string", "x-nullable": true - }, - "registryName": { - "description": "Destination registry name", - "type": "string", - "x-nullable": true } }, "additionalProperties": false @@ -15223,13 +15223,13 @@ } ], "properties": { - "password": { - "description": "DockerCredential user password", + "userName": { + "description": "DockerCredential user name", "type": "string", "x-nullable": true }, - "userName": { - "description": "DockerCredential user name", + "password": { + "description": "DockerCredential user password", "type": "string", "x-nullable": true } @@ -15244,11 +15244,9 @@ ], "type": "object", "properties": { - "delayEvaluation": { - "format": "int32", - "description": "Number of intervals by which to delay the first evaluation.", - "default": 0, - "type": "integer" + "policyType": { + "description": "[Required] Name of policy configuration", + "$ref": "#/definitions/EarlyTerminationPolicyType" }, "evaluationInterval": { "format": "int32", @@ -15256,9 +15254,11 @@ "default": 0, "type": "integer" }, - "policyType": { - "description": "[Required] Name of policy configuration", - "$ref": "#/definitions/EarlyTerminationPolicyType" + "delayEvaluation": { + "format": "int32", + "description": "Number of intervals by which to delay the first evaluation.", + "default": 0, + "type": "integer" } }, "discriminator": "policyType" @@ -15392,6 +15392,11 @@ "type": "string", "x-nullable": true }, + "tokenType": { + "description": "Access token type.", + "type": "string", + "x-nullable": true + }, "expiryTimeUtc": { "format": "int64", "description": "Access token expiry time (UTC).", @@ -15403,11 +15408,6 @@ "description": "Refresh access token after time (UTC).", "default": 0, "type": "integer" - }, - "tokenType": { - "description": "Access token type.", - "type": "string", - "x-nullable": true } }, "additionalProperties": false @@ -15441,23 +15441,13 @@ "description": "Base definition for endpoint deployment.", "type": "object", "properties": { - "codeConfiguration": { - "description": "Code configuration for the endpoint deployment.", - "$ref": "#/definitions/CodeConfiguration", - "x-nullable": true - }, "description": { "description": "Description of the endpoint deployment.", "type": "string", "x-nullable": true }, - "environmentId": { - "description": "ARM resource ID or AssetId of the environment specification for the endpoint deployment.", - "type": "string", - "x-nullable": true - }, - "environmentVariables": { - "description": "Environment variables configuration for the deployment.", + "properties": { + "description": "Property dictionary. Properties can be added, but not removed or altered.", "type": "object", "additionalProperties": { "type": "string", @@ -15465,8 +15455,18 @@ }, "x-nullable": true }, - "properties": { - "description": "Property dictionary. Properties can be added, but not removed or altered.", + "codeConfiguration": { + "description": "Code configuration for the endpoint deployment.", + "$ref": "#/definitions/CodeConfiguration", + "x-nullable": true + }, + "environmentId": { + "description": "ARM resource ID or AssetId of the environment specification for the endpoint deployment.", + "type": "string", + "x-nullable": true + }, + "environmentVariables": { + "description": "Environment variables configuration for the deployment.", "type": "object", "additionalProperties": { "type": "string", @@ -15484,24 +15484,11 @@ ], "type": "object", "properties": { - "authMode": { - "description": "[Required] Use 'Key' for key based authentication and 'AMLToken' for Azure Machine Learning token-based authentication. 'Key' doesn't expire but 'AMLToken' does.", - "$ref": "#/definitions/EndpointAuthMode" - }, "description": { "description": "Description of the inference endpoint.", "type": "string", "x-nullable": true }, - "keys": { - "description": "EndpointAuthKeys to set initially on an Endpoint.\r\nThis property will always be returned as null. AuthKey values must be retrieved using the ListKeys API.", - "$ref": "#/definitions/EndpointAuthKeys", - "x-ms-mutability": [ - "create" - ], - "x-ms-secret": true, - "x-nullable": true - }, "properties": { "description": "Property dictionary. Properties can be added, but not removed or altered.", "type": "object", @@ -15530,6 +15517,19 @@ "read" ], "x-nullable": true + }, + "authMode": { + "description": "[Required] Use 'Key' for key based authentication and 'AMLToken' for Azure Machine Learning token-based authentication. 'Key' doesn't expire but 'AMLToken' does.", + "$ref": "#/definitions/EndpointAuthMode" + }, + "keys": { + "description": "EndpointAuthKeys to set initially on an Endpoint.\r\nThis property will always be returned as null. AuthKey values must be retrieved using the ListKeys API.", + "$ref": "#/definitions/EndpointAuthKeys", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true, + "x-nullable": true } }, "additionalProperties": false @@ -15647,16 +15647,16 @@ "description": "A paginated list of EnvironmentContainer entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of EnvironmentContainer objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type EnvironmentContainer.", "type": "array", "items": { "$ref": "#/definitions/EnvironmentContainerResource" } + }, + "nextLink": { + "description": "The link to the next page of EnvironmentContainer objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -15691,18 +15691,18 @@ } ], "properties": { - "autoRebuild": { - "description": "Defines if image needs to be rebuilt based on base image changes.", - "default": "Disabled", - "$ref": "#/definitions/AutoRebuildSetting", + "environmentType": { + "description": "Environment type is either user managed or curated by the Azure ML service\r\n", + "$ref": "#/definitions/EnvironmentType", + "readOnly": true, "x-ms-mutability": [ - "create", "read" ] }, - "build": { - "description": "Configuration settings for Docker build context.", - "$ref": "#/definitions/BuildContext", + "image": { + "description": "Name of the image that will be used for the environment.\r\n", + "type": "string", + "example": "docker.io/tensorflow/serving:latest", "x-ms-mutability": [ "create", "read" @@ -15716,18 +15716,18 @@ "read" ] }, - "environmentType": { - "description": "Environment type is either user managed or curated by the Azure ML service\r\n", - "$ref": "#/definitions/EnvironmentType", - "readOnly": true, + "build": { + "description": "Configuration settings for Docker build context.", + "$ref": "#/definitions/BuildContext", "x-ms-mutability": [ + "create", "read" ] }, - "image": { - "description": "Name of the image that will be used for the environment.\r\n", - "type": "string", - "example": "docker.io/tensorflow/serving:latest", + "osType": { + "description": "The OS type of the environment.", + "default": "Linux", + "$ref": "#/definitions/OperatingSystemType", "x-ms-mutability": [ "create", "read" @@ -15741,10 +15741,10 @@ "read" ] }, - "osType": { - "description": "The OS type of the environment.", - "default": "Linux", - "$ref": "#/definitions/OperatingSystemType", + "autoRebuild": { + "description": "Defines if image needs to be rebuilt based on base image changes.", + "default": "Disabled", + "$ref": "#/definitions/AutoRebuildSetting", "x-ms-mutability": [ "create", "read" @@ -15791,16 +15791,16 @@ "description": "A paginated list of EnvironmentVersion entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of EnvironmentVersion objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type EnvironmentVersion.", "type": "array", "items": { "$ref": "#/definitions/EnvironmentVersionResource" } + }, + "nextLink": { + "description": "The link to the next page of EnvironmentVersion objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -15814,15 +15814,15 @@ } ], "properties": { - "dataType": { - "description": "Specifies type", - "default": "String", - "$ref": "#/definitions/FeatureDataType" - }, "featureName": { "description": "Specifies name", "type": "string", "x-nullable": true + }, + "dataType": { + "description": "Specifies type", + "default": "String", + "$ref": "#/definitions/FeatureDataType" } }, "x-ms-client-name": "FeatureProperties", @@ -15840,19 +15840,15 @@ { "$ref": "#/definitions/MonitoringSignalBase" } - ], - "properties": { - "featureDataTypeOverride": { - "description": "A dictionary that maps feature names to their respective data types.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/MonitoringFeatureDataType" - }, + ], + "properties": { + "metricThreshold": { + "description": "[Required] A list of metrics to calculate and their associated thresholds.", + "$ref": "#/definitions/FeatureAttributionMetricThreshold", "x-ms-mutability": [ "create", "read" - ], - "x-nullable": true + ] }, "featureImportanceSettings": { "description": "[Required] The settings for computing feature importance.", @@ -15862,14 +15858,6 @@ "read" ] }, - "metricThreshold": { - "description": "[Required] A list of metrics to calculate and their associated thresholds.", - "$ref": "#/definitions/FeatureAttributionMetricThreshold", - "x-ms-mutability": [ - "create", - "read" - ] - }, "productionData": { "description": "[Required] The data which drift will be calculated for.", "type": "array", @@ -15890,6 +15878,18 @@ "create", "read" ] + }, + "featureDataTypeOverride": { + "description": "A dictionary that maps feature names to their respective data types.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MonitoringFeatureDataType" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true } }, "x-ms-discriminator-value": "FeatureAttributionDrift", @@ -15918,14 +15918,6 @@ ], "type": "object", "properties": { - "metric": { - "description": "[Required] The feature attribution metric to calculate.", - "$ref": "#/definitions/FeatureAttributionMetric", - "x-ms-mutability": [ - "create", - "read" - ] - }, "threshold": { "description": "The threshold value. If null, a default value will be set depending on the selected metric.", "$ref": "#/definitions/MonitoringThreshold", @@ -15934,6 +15926,14 @@ "read" ], "x-nullable": true + }, + "metric": { + "description": "[Required] The feature attribution metric to calculate.", + "$ref": "#/definitions/FeatureAttributionMetric", + "x-ms-mutability": [ + "create", + "read" + ] } }, "additionalProperties": false @@ -16068,16 +16068,16 @@ "description": "A paginated list of Feature entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of Feature objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type Feature.", "type": "array", "items": { "$ref": "#/definitions/FeatureResource" } + }, + "nextLink": { + "description": "The link to the next page of Feature objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -16113,15 +16113,15 @@ "description": "Specifies the feature window", "type": "object", "properties": { - "featureWindowEnd": { + "featureWindowStart": { "format": "date-time", - "description": "Specifies the feature window end time", + "description": "Specifies the feature window start time", "type": "string", "x-nullable": true }, - "featureWindowStart": { + "featureWindowEnd": { "format": "date-time", - "description": "Specifies the feature window start time", + "description": "Specifies the feature window end time", "type": "string", "x-nullable": true } @@ -16173,16 +16173,16 @@ "description": "A paginated list of FeaturesetContainer entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of FeaturesetContainer objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type FeaturesetContainer.", "type": "array", "items": { "$ref": "#/definitions/FeaturesetContainerResource" } + }, + "nextLink": { + "description": "The link to the next page of FeaturesetContainer objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -16208,6 +16208,21 @@ } ], "properties": { + "specification": { + "description": "Specifies the feature spec details", + "$ref": "#/definitions/FeaturesetSpecification", + "x-nullable": true + }, + "materializationSettings": { + "description": "Specifies the materialization settings", + "$ref": "#/definitions/MaterializationSettings", + "x-nullable": true + }, + "stage": { + "description": "Specifies the asset stage", + "type": "string", + "x-nullable": true + }, "entities": { "description": "Specifies list of entities", "type": "array", @@ -16216,11 +16231,6 @@ }, "x-nullable": true }, - "materializationSettings": { - "description": "Specifies the materialization settings", - "$ref": "#/definitions/MaterializationSettings", - "x-nullable": true - }, "provisioningState": { "description": "Provisioning state for the featureset version container.", "$ref": "#/definitions/AssetProvisioningState", @@ -16228,16 +16238,6 @@ "x-ms-mutability": [ "read" ] - }, - "specification": { - "description": "Specifies the feature spec details", - "$ref": "#/definitions/FeaturesetSpecification", - "x-nullable": true - }, - "stage": { - "description": "Specifies the asset stage", - "type": "string", - "x-nullable": true } }, "x-ms-client-name": "FeaturesetVersionProperties", @@ -16247,18 +16247,11 @@ "description": "Request payload for creating a backfill request for a given feature set version", "type": "object", "properties": { - "dataAvailabilityStatus": { - "description": "Specified the data availability status that you want to backfill", - "type": "array", - "items": { - "$ref": "#/definitions/DataAvailabilityStatus" - } - }, - "description": { + "displayName": { "description": "Specifies description", "type": "string" }, - "displayName": { + "description": { "description": "Specifies description", "type": "string" }, @@ -16267,12 +16260,19 @@ "$ref": "#/definitions/FeatureWindow", "x-nullable": true }, + "dataAvailabilityStatus": { + "description": "Specified the data availability status that you want to backfill", + "type": "array", + "items": { + "$ref": "#/definitions/DataAvailabilityStatus" + } + }, "jobId": { "description": "Specify the jobId to retry the failed materialization", "type": "string" }, - "properties": { - "description": "Specifies the properties", + "tags": { + "description": "Specifies the tags", "type": "object", "additionalProperties": { "type": "string", @@ -16291,8 +16291,8 @@ "x-nullable": true } }, - "tags": { - "description": "Specifies the tags", + "properties": { + "description": "Specifies the properties", "type": "object", "additionalProperties": { "type": "string", @@ -16341,16 +16341,16 @@ "description": "A paginated list of FeaturesetVersion entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of FeaturesetVersion objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type FeaturesetVersion.", "type": "array", "items": { "$ref": "#/definitions/FeaturesetVersionResource" } + }, + "nextLink": { + "description": "The link to the next page of FeaturesetVersion objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -16400,16 +16400,16 @@ "description": "A paginated list of FeaturestoreEntityContainer entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of FeaturestoreEntityContainer objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type FeaturestoreEntityContainer.", "type": "array", "items": { "$ref": "#/definitions/FeaturestoreEntityContainerResource" } + }, + "nextLink": { + "description": "The link to the next page of FeaturestoreEntityContainer objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -16432,6 +16432,11 @@ "x-nullable": true, "x-ms-identifiers": [] }, + "stage": { + "description": "Specifies the asset stage", + "type": "string", + "x-nullable": true + }, "provisioningState": { "description": "Provisioning state for the featurestore entity version.", "$ref": "#/definitions/AssetProvisioningState", @@ -16439,11 +16444,6 @@ "x-ms-mutability": [ "read" ] - }, - "stage": { - "description": "Specifies the asset stage", - "type": "string", - "x-nullable": true } }, "x-ms-client-name": "FeaturestoreEntityVersionProperties", @@ -16473,16 +16473,16 @@ "description": "A paginated list of FeaturestoreEntityVersion entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of FeaturestoreEntityVersion objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type FeaturestoreEntityVersion.", "type": "array", "items": { "$ref": "#/definitions/FeaturestoreEntityVersionResource" } + }, + "nextLink": { + "description": "The link to the next page of FeaturestoreEntityVersion objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -16606,16 +16606,16 @@ } ], "properties": { - "forecastingSettings": { - "description": "Forecasting task specific inputs.", - "$ref": "#/definitions/ForecastingSettings", - "x-nullable": true - }, "primaryMetric": { "description": "Primary metric for forecasting task.", "default": "NormalizedRootMeanSquaredError", "$ref": "#/definitions/ForecastingPrimaryMetrics" }, + "forecastingSettings": { + "description": "Forecasting task specific inputs.", + "$ref": "#/definitions/ForecastingSettings", + "x-nullable": true + }, "trainingSettings": { "description": "Inputs for training phase for an AutoML Job.", "$ref": "#/definitions/ForecastingTrainingSettings", @@ -16775,27 +16775,44 @@ "type": "string", "x-nullable": true }, - "cvStepSize": { - "format": "int32", - "description": "Number of periods between the origin time of one CV fold and the next fold. For\r\nexample, if `CVStepSize` = 3 for daily data, the origin time for each fold will be\r\nthree days apart.", - "type": "integer", + "timeColumnName": { + "description": "The name of the time column. This parameter is required when forecasting to specify the datetime column in the input data used for building the time series and inferring its frequency.", + "type": "string", "x-nullable": true }, - "featureLags": { - "description": "Flag for generating lags for the numeric features with 'auto' or null.", - "default": "None", - "$ref": "#/definitions/FeatureLags" + "targetLags": { + "description": "The number of past periods to lag from the target column.", + "$ref": "#/definitions/TargetLags", + "x-nullable": true + }, + "targetRollingWindowSize": { + "description": "The number of past periods used to create a rolling window average of the target column.", + "$ref": "#/definitions/TargetRollingWindowSize", + "x-nullable": true }, "forecastHorizon": { "description": "The desired maximum forecast horizon in units of time-series frequency.", "default": "{\"Mode\": \"Custom\", \"Value\": 1}", "$ref": "#/definitions/ForecastHorizon" }, + "timeSeriesIdColumnNames": { + "description": "The names of columns used to group a timeseries. It can be used to create multiple series.\r\nIf grain is not defined, the data set is assumed to be one time-series. This parameter is used with task type forecasting.", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, "frequency": { "description": "When forecasting, this parameter represents the period with which the forecast is desired, for example daily, weekly, yearly, etc. The forecast frequency is dataset frequency by default.", "type": "string", "x-nullable": true }, + "featureLags": { + "description": "Flag for generating lags for the numeric features with 'auto' or null.", + "default": "None", + "$ref": "#/definitions/FeatureLags" + }, "seasonality": { "description": "Set time series seasonality as an integer multiple of the series frequency.\r\nIf seasonality is set to 'auto', it will be inferred.", "default": "{\"Mode\": \"Auto\"}", @@ -16806,38 +16823,21 @@ "default": "Auto", "$ref": "#/definitions/ShortSeriesHandlingConfiguration" }, + "useStl": { + "description": "Configure STL Decomposition of the time-series target column.", + "default": "None", + "$ref": "#/definitions/UseStl" + }, "targetAggregateFunction": { "description": "The function to be used to aggregate the time series target column to conform to a user specified frequency.\r\nIf the TargetAggregateFunction is set i.e. not 'None', but the freq parameter is not set, the error is raised. The possible target aggregation functions are: \"sum\", \"max\", \"min\" and \"mean\".", "default": "None", "$ref": "#/definitions/TargetAggregationFunction" }, - "targetLags": { - "description": "The number of past periods to lag from the target column.", - "$ref": "#/definitions/TargetLags", - "x-nullable": true - }, - "targetRollingWindowSize": { - "description": "The number of past periods used to create a rolling window average of the target column.", - "$ref": "#/definitions/TargetRollingWindowSize", - "x-nullable": true - }, - "timeColumnName": { - "description": "The name of the time column. This parameter is required when forecasting to specify the datetime column in the input data used for building the time series and inferring its frequency.", - "type": "string", - "x-nullable": true - }, - "timeSeriesIdColumnNames": { - "description": "The names of columns used to group a timeseries. It can be used to create multiple series.\r\nIf grain is not defined, the data set is assumed to be one time-series. This parameter is used with task type forecasting.", - "type": "array", - "items": { - "type": "string" - }, + "cvStepSize": { + "format": "int32", + "description": "Number of periods between the origin time of one CV fold and the next fold. For\r\nexample, if `CVStepSize` = 3 for daily data, the origin time for each fold will be\r\nthree days apart.", + "type": "integer", "x-nullable": true - }, - "useStl": { - "description": "Configure STL Decomposition of the time-series target column.", - "default": "None", - "$ref": "#/definitions/UseStl" } }, "additionalProperties": false @@ -16879,15 +16879,15 @@ "type": "string", "x-nullable": true }, - "credential": { - "description": "Credential info to access storage account", - "$ref": "#/definitions/DataReferenceCredential", - "x-nullable": true - }, "storageAccountArmId": { "description": "The ARM id of the storage account", "type": "string", "x-nullable": true + }, + "credential": { + "description": "Credential info to access storage account", + "$ref": "#/definitions/DataReferenceCredential", + "x-nullable": true } }, "additionalProperties": false @@ -17107,16 +17107,10 @@ "x-ms-discriminator-value": "ImageInstanceSegmentation", "additionalProperties": false }, - "ImageLimitSettings": { - "description": "Limit settings for the AutoML job.", - "type": "object", - "properties": { - "maxConcurrentTrials": { - "format": "int32", - "description": "Maximum number of concurrent AutoML iterations.", - "default": 1, - "type": "integer" - }, + "ImageLimitSettings": { + "description": "Limit settings for the AutoML job.", + "type": "object", + "properties": { "maxTrials": { "format": "int32", "description": "Maximum number of AutoML iterations.", @@ -17128,6 +17122,12 @@ "description": "AutoML job timeout.", "default": "P7D", "type": "string" + }, + "maxConcurrentTrials": { + "format": "int32", + "description": "Maximum number of concurrent AutoML iterations.", + "default": 1, + "type": "integer" } }, "additionalProperties": false @@ -17184,18 +17184,18 @@ "example": "choice(1, 5)", "x-nullable": true }, - "enableOnnxNormalization": { - "description": "Enable normalization when exporting ONNX model.", - "type": "string", - "example": "choice(true, false)", - "x-nullable": true - }, "evaluationFrequency": { "description": "Frequency to evaluate validation dataset to get metric scores. Must be a positive integer.", "type": "string", "example": "choice(1, 5)", "x-nullable": true }, + "enableOnnxNormalization": { + "description": "Enable normalization when exporting ONNX model.", + "type": "string", + "example": "choice(true, false)", + "x-nullable": true + }, "gradientAccumulationStep": { "description": "Gradient accumulation means running a configured number of \"GradAccumulationStep\" steps without\r\nupdating the model weights while accumulating the gradients of those steps, and then using\r\nthe accumulated gradients to compute the weight updates. Must be a positive integer.", "type": "string", @@ -17437,17 +17437,17 @@ "description": "Settings used for training the model.\r\nFor more information on the available settings please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", "type": "object", "properties": { + "amsGradient": { + "description": "Enable AMSGrad when optimizer is 'adam' or 'adamw'.", + "type": "boolean", + "x-nullable": true + }, "advancedSettings": { "description": "Settings for advanced scenarios.", "type": "string", "example": "key1:val1;key2;key3:val3;key4", "x-nullable": true }, - "amsGradient": { - "description": "Enable AMSGrad when optimizer is 'adam' or 'adamw'.", - "type": "boolean", - "x-nullable": true - }, "augmentations": { "description": "Settings for using Augmentations.", "type": "string", @@ -17472,16 +17472,16 @@ "type": "integer", "x-nullable": true }, - "checkpointModel": { - "description": "The pretrained checkpoint model for incremental training.", - "$ref": "#/definitions/MLFlowModelJobInput", - "x-nullable": true - }, "checkpointRunId": { "description": "The id of a previous run that has a pretrained checkpoint for incremental training.", "type": "string", "x-nullable": true }, + "checkpointModel": { + "description": "The pretrained checkpoint model for incremental training.", + "$ref": "#/definitions/MLFlowModelJobInput", + "x-nullable": true + }, "distributed": { "description": "Whether to use distributed training.", "type": "boolean", @@ -17504,17 +17504,17 @@ "type": "integer", "x-nullable": true }, - "enableOnnxNormalization": { - "description": "Enable normalization when exporting ONNX model.", - "type": "boolean", - "x-nullable": true - }, "evaluationFrequency": { "format": "int32", "description": "Frequency to evaluate validation dataset to get metric scores. Must be a positive integer.", "type": "integer", "x-nullable": true }, + "enableOnnxNormalization": { + "description": "Enable normalization when exporting ONNX model.", + "type": "boolean", + "x-nullable": true + }, "gradientAccumulationStep": { "format": "int32", "description": "Gradient accumulation means running a configured number of \"GradAccumulationStep\" steps without\r\nupdating the model weights while accumulating the gradients of those steps, and then using\r\nthe accumulated gradients to compute the weight updates. Must be a positive integer.", @@ -17798,14 +17798,14 @@ ], "type": "object", "properties": { + "samplingAlgorithm": { + "description": "[Required] Type of the hyperparameter sampling algorithms.", + "$ref": "#/definitions/SamplingAlgorithmType" + }, "earlyTermination": { "description": "Type of early termination policy.", "$ref": "#/definitions/EarlyTerminationPolicy", "x-nullable": true - }, - "samplingAlgorithm": { - "description": "[Required] Type of the hyperparameter sampling algorithms.", - "$ref": "#/definitions/SamplingAlgorithmType" } }, "additionalProperties": false @@ -17844,15 +17844,15 @@ "description": "DTO object representing index column", "type": "object", "properties": { - "columnName": { - "description": "Specifies the column name", - "type": "string", - "x-nullable": true - }, "dataType": { "description": "Specifies the data type", "default": "String", "$ref": "#/definitions/FeatureDataType" + }, + "columnName": { + "description": "Specifies the column name", + "type": "string", + "x-nullable": true } }, "additionalProperties": false @@ -17942,17 +17942,16 @@ } ], "properties": { - "componentId": { - "description": "ARM resource ID of the component resource.", - "type": "string", + "jobType": { + "description": "[Required] Specifies the type of job.", + "$ref": "#/definitions/JobType", "x-ms-mutability": [ "create", "read" - ], - "x-nullable": true + ] }, - "computeId": { - "description": "ARM resource ID of the compute resource.", + "displayName": { + "description": "Display name of job.", "type": "string", "x-ms-mutability": [ "create", @@ -17960,14 +17959,13 @@ ], "x-nullable": true }, - "displayName": { - "description": "Display name of job.", - "type": "string", + "status": { + "description": "Status of the job.", + "$ref": "#/definitions/JobStatus", + "readOnly": true, "x-ms-mutability": [ - "create", "read" - ], - "x-nullable": true + ] }, "experimentName": { "description": "The name of the experiment the job belongs to. If not set, the job is placed in the \"Default\" experiment.", @@ -17978,9 +17976,18 @@ "read" ] }, - "identity": { - "description": "Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null.\r\nDefaults to AmlToken if null.", - "$ref": "#/definitions/IdentityConfiguration", + "services": { + "description": "List of JobEndpoints.\r\nFor local jobs, a job endpoint will have an endpoint value of FileStreamObject.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/JobService", + "x-nullable": true + }, + "x-nullable": true + }, + "computeId": { + "description": "ARM resource ID of the compute resource.", + "type": "string", "x-ms-mutability": [ "create", "read" @@ -17997,13 +18004,23 @@ "update" ] }, - "jobType": { - "description": "[Required] Specifies the type of job.", - "$ref": "#/definitions/JobType", + "identity": { + "description": "Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null.\r\nDefaults to AmlToken if null.", + "$ref": "#/definitions/IdentityConfiguration", "x-ms-mutability": [ "create", "read" - ] + ], + "x-nullable": true + }, + "componentId": { + "description": "ARM resource ID of the component resource.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true }, "notificationSetting": { "description": "Notification setting for the job", @@ -18014,23 +18031,6 @@ "update" ], "x-nullable": true - }, - "services": { - "description": "List of JobEndpoints.\r\nFor local jobs, a job endpoint will have an endpoint value of FileStreamObject.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/JobService", - "x-nullable": true - }, - "x-nullable": true - }, - "status": { - "description": "Status of the job.", - "$ref": "#/definitions/JobStatus", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] } }, "discriminator": "jobType", @@ -18060,16 +18060,16 @@ "description": "A paginated list of JobBase entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of JobBase objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type JobBase.", "type": "array", "items": { "$ref": "#/definitions/JobBaseResource" } + }, + "nextLink": { + "description": "The link to the next page of JobBase objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -18081,6 +18081,14 @@ ], "type": "object", "properties": { + "jobInputType": { + "description": "[Required] Specifies the type of job.", + "$ref": "#/definitions/JobInputType", + "x-ms-mutability": [ + "create", + "read" + ] + }, "description": { "description": "Description for the input.", "type": "string", @@ -18089,14 +18097,6 @@ "read" ], "x-nullable": true - }, - "jobInputType": { - "description": "[Required] Specifies the type of job.", - "$ref": "#/definitions/JobInputType", - "x-ms-mutability": [ - "create", - "read" - ] } }, "discriminator": "jobInputType" @@ -18188,6 +18188,14 @@ ], "type": "object", "properties": { + "jobOutputType": { + "description": "[Required] Specifies the type of job.", + "$ref": "#/definitions/JobOutputType", + "x-ms-mutability": [ + "create", + "read" + ] + }, "description": { "description": "Description for the output.", "type": "string", @@ -18196,14 +18204,6 @@ "read" ], "x-nullable": true - }, - "jobOutputType": { - "description": "[Required] Specifies the type of job.", - "$ref": "#/definitions/JobOutputType", - "x-ms-mutability": [ - "create", - "read" - ] } }, "discriminator": "jobOutputType" @@ -18253,15 +18253,6 @@ } ], "properties": { - "dockerArgs": { - "description": "Extra arguments to pass to the Docker run command. This would override any parameters that have already been set by the system, or in this section. This parameter is only supported for Azure ML compute types.", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, "shmSize": { "description": "Size of the docker container's shared memory block. This should be in the format of (number)(unit) where number as to be greater than 0 and the unit can be one of b(bytes), k(kilobytes), m(megabytes), or g(gigabytes).", "default": "2g", @@ -18271,6 +18262,15 @@ "create", "read" ] + }, + "dockerArgs": { + "description": "Extra arguments to pass to the Docker run command. This would override any parameters that have already been set by the system, or in this section. This parameter is only supported for Azure ML compute types.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true } }, "additionalProperties": false @@ -18304,8 +18304,8 @@ "description": "Job endpoint definition", "type": "object", "properties": { - "endpoint": { - "description": "Url for endpoint.", + "jobServiceType": { + "description": "Endpoint type.", "type": "string", "x-ms-mutability": [ "create", @@ -18313,17 +18313,18 @@ ], "x-nullable": true }, - "errorMessage": { - "description": "Any error in the service.", - "type": "string", - "readOnly": true, + "port": { + "format": "int32", + "description": "Port for endpoint.", + "type": "integer", "x-ms-mutability": [ + "create", "read" ], "x-nullable": true }, - "jobServiceType": { - "description": "Endpoint type.", + "endpoint": { + "description": "Url for endpoint.", "type": "string", "x-ms-mutability": [ "create", @@ -18331,17 +18332,20 @@ ], "x-nullable": true }, - "nodes": { - "description": "Nodes that user would like to start the service on.\r\nIf Nodes is not set or set to null, the service will only be started on leader node.", - "$ref": "#/definitions/Nodes", + "status": { + "description": "Status of endpoint.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], "x-nullable": true }, - "port": { - "format": "int32", - "description": "Port for endpoint.", - "type": "integer", + "errorMessage": { + "description": "Any error in the service.", + "type": "string", + "readOnly": true, "x-ms-mutability": [ - "create", "read" ], "x-nullable": true @@ -18355,13 +18359,9 @@ }, "x-nullable": true }, - "status": { - "description": "Status of endpoint.", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ], + "nodes": { + "description": "Nodes that user would like to start the service on.\r\nIf Nodes is not set or set to null, the service will only be started on leader node.", + "$ref": "#/definitions/Nodes", "x-nullable": true } }, @@ -18832,18 +18832,18 @@ "type": "string", "x-nullable": true }, - "userManagedIdentityClientId": { - "description": "ClientId for the UAMI. For ManagedIdentityType = SystemManaged, this field is null.", + "userManagedIdentityResourceId": { + "description": "Full arm scope for the Id. For ManagedIdentityType = SystemManaged, this field is null.", "type": "string", "x-nullable": true }, - "userManagedIdentityPrincipalId": { - "description": "PrincipalId for the UAMI. For ManagedIdentityType = SystemManaged, this field is null.", + "userManagedIdentityClientId": { + "description": "ClientId for the UAMI. For ManagedIdentityType = SystemManaged, this field is null.", "type": "string", "x-nullable": true }, - "userManagedIdentityResourceId": { - "description": "Full arm scope for the Id. For ManagedIdentityType = SystemManaged, this field is null.", + "userManagedIdentityPrincipalId": { + "description": "PrincipalId for the UAMI. For ManagedIdentityType = SystemManaged, this field is null.", "type": "string", "x-nullable": true }, @@ -18868,44 +18868,53 @@ "additionalProperties": false }, "MarketplacePlan": { - "additionalProperties": false, + "type": "object", "properties": { - "offerId": { - "description": "The identifying name of the Offer of the Marketplace Plan.", - "readOnly": true, + "publisherId": { + "description": "The identifying name of the Publisher of the Marketplace Plan.", "type": "string", + "readOnly": true, "x-ms-mutability": [ "read" ], "x-nullable": true }, - "planId": { - "description": "The identifying name of the Plan of the Marketplace Plan.", - "readOnly": true, + "offerId": { + "description": "The identifying name of the Offer of the Marketplace Plan.", "type": "string", + "readOnly": true, "x-ms-mutability": [ "read" ], "x-nullable": true }, - "publisherId": { - "description": "The identifying name of the Publisher of the Marketplace Plan.", - "readOnly": true, + "planId": { + "description": "The identifying name of the Plan of the Marketplace Plan.", "type": "string", + "readOnly": true, "x-ms-mutability": [ "read" ], "x-nullable": true } }, - "type": "object" + "additionalProperties": false }, "MarketplaceSubscription": { - "additionalProperties": false, + "required": [ + "modelId" + ], + "type": "object", "properties": { + "modelId": { + "description": "[Required] Target Marketplace Model ID to create a Marketplace Subscription for.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + }, "marketplacePlan": { - "$ref": "#/definitions/MarketplacePlan", "description": "Marketplace Plan associated with the Marketplace Subscription.", + "$ref": "#/definitions/MarketplacePlan", "readOnly": true, "x-ms-mutability": [ "read" @@ -18913,36 +18922,26 @@ "x-nullable": true }, "marketplaceSubscriptionStatus": { - "$ref": "#/definitions/MarketplaceSubscriptionStatus", "description": "Current status of the Marketplace Subscription.", + "$ref": "#/definitions/MarketplaceSubscriptionStatus", "readOnly": true, "x-ms-mutability": [ "read" ] }, - "modelId": { - "description": "[Required] Target Marketplace Model ID to create a Marketplace Subscription for.", - "minLength": 1, - "pattern": "[a-zA-Z0-9_]", - "type": "string" - }, "provisioningState": { - "$ref": "#/definitions/MarketplaceSubscriptionProvisioningState", "description": "Provisioning State of the Marketplace Subscription.", + "$ref": "#/definitions/MarketplaceSubscriptionProvisioningState", "readOnly": true, "x-ms-mutability": [ "read" ] } }, - "required": [ - "modelId" - ], - "type": "object", - "x-ms-client-name": "MarketplaceSubscriptionProperties" + "x-ms-client-name": "MarketplaceSubscriptionProperties", + "additionalProperties": false }, "MarketplaceSubscriptionProvisioningState": { - "additionalProperties": false, "enum": [ "Creating", "Deleting", @@ -18951,78 +18950,78 @@ "Updating", "Canceled" ], - "readOnly": true, "type": "string", + "readOnly": true, "x-ms-enum": { - "modelAsString": true, "name": "MarketplaceSubscriptionProvisioningState", + "modelAsString": true, "values": [ { - "description": "MarketplaceSubscription is being created.", - "value": "Creating" + "value": "Creating", + "description": "MarketplaceSubscription is being created." }, { - "description": "MarketplaceSubscription is being deleted.", - "value": "Deleting" + "value": "Deleting", + "description": "MarketplaceSubscription is being deleted." }, { - "description": "MarketplaceSubscription is successfully provisioned.", - "value": "Succeeded" + "value": "Succeeded", + "description": "MarketplaceSubscription is successfully provisioned." }, { - "description": "MarketplaceSubscription provisioning failed.", - "value": "Failed" + "value": "Failed", + "description": "MarketplaceSubscription provisioning failed." }, { - "description": "MarketplaceSubscription is being updated.", - "value": "Updating" + "value": "Updating", + "description": "MarketplaceSubscription is being updated." }, { "value": "Canceled" } ] - } + }, + "additionalProperties": false }, "MarketplaceSubscriptionResource": { - "additionalProperties": false, + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" } ], - "description": "Azure Resource Manager resource envelope.", "properties": { "properties": { - "$ref": "#/definitions/MarketplaceSubscription", - "description": "[Required] Additional attributes of the entity." + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/MarketplaceSubscription" } }, - "required": [ - "properties" - ], - "type": "object", - "x-ms-client-name": "MarketplaceSubscription" + "x-ms-client-name": "MarketplaceSubscription", + "additionalProperties": false }, "MarketplaceSubscriptionResourceArmPaginatedResult": { - "additionalProperties": false, "description": "A paginated list of MarketplaceSubscription entities.", + "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of MarketplaceSubscription objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type MarketplaceSubscription.", + "type": "array", "items": { "$ref": "#/definitions/MarketplaceSubscriptionResource" - }, - "type": "array" + } + }, + "nextLink": { + "description": "The link to the next page of MarketplaceSubscription objects. If null, there are no additional pages.", + "type": "string" } }, - "type": "object" + "additionalProperties": false }, "MarketplaceSubscriptionStatus": { - "additionalProperties": false, "enum": [ "Subscribed", "Suspended", @@ -19030,23 +19029,24 @@ ], "type": "string", "x-ms-enum": { - "modelAsString": true, "name": "MarketplaceSubscriptionStatus", + "modelAsString": true, "values": [ { - "description": "The customer can now use the Marketplace Subscription's\nmodel and will be billed.", - "value": "Subscribed" + "value": "Subscribed", + "description": "The customer can now use the Marketplace Subscription's\nmodel and will be billed." }, { - "description": "The customer could not be billed for the Marketplace Subscription.\nThe customer will not be able to access the model.", - "value": "Suspended" + "value": "Suspended", + "description": "The customer could not be billed for the Marketplace Subscription.\nThe customer will not be able to access the model." }, { - "description": "Marketplace Subscriptions reach this state in response to an explicit customer or CSP action.\nA Marketplace Subscription can also be canceled implicitly, as a result of nonpayment of dues,\nafter being in the Suspended state for some time.", - "value": "Unsubscribed" + "value": "Unsubscribed", + "description": "Marketplace Subscriptions reach this state in response to an explicit customer or CSP action.\nA Marketplace Subscription can also be canceled implicitly, as a result of nonpayment of dues,\nafter being in the Suspended state for some time." } ] - } + }, + "additionalProperties": false }, "MaterializationComputeResource": { "description": "DTO object representing compute resource", @@ -19063,6 +19063,16 @@ "MaterializationSettings": { "type": "object", "properties": { + "storeType": { + "description": "Specifies the stores to which materialization should happen", + "default": "None", + "$ref": "#/definitions/MaterializationStoreType" + }, + "schedule": { + "description": "Specifies the schedule details", + "$ref": "#/definitions/RecurrenceTrigger", + "x-nullable": true + }, "notification": { "description": "Specifies the notification details", "$ref": "#/definitions/NotificationSetting", @@ -19073,11 +19083,6 @@ "$ref": "#/definitions/MaterializationComputeResource", "x-nullable": true }, - "schedule": { - "description": "Specifies the schedule details", - "$ref": "#/definitions/RecurrenceTrigger", - "x-nullable": true - }, "sparkConfiguration": { "description": "Specifies the spark compute settings", "type": "object", @@ -19086,11 +19091,6 @@ "x-nullable": true }, "x-nullable": true - }, - "storeType": { - "description": "Specifies the stores to which materialization should happen", - "default": "None", - "$ref": "#/definitions/MaterializationStoreType" } }, "additionalProperties": false @@ -19178,22 +19178,22 @@ "description": "A paginated list of ModelContainer entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of ModelContainer objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type ModelContainer.", "type": "array", "items": { "$ref": "#/definitions/ModelContainerResource" } + }, + "nextLink": { + "description": "The link to the next page of ModelContainer objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false }, "ModelSettings": { - "additionalProperties": false, + "type": "object", "properties": { "modelId": { "description": "The unique model identifier that this ServerlessEndpoint should provision.", @@ -19201,7 +19201,7 @@ "x-nullable": true } }, - "type": "object" + "additionalProperties": false }, "ModelSize": { "description": "Image model size.", @@ -19280,11 +19280,6 @@ }, "x-nullable": true }, - "jobName": { - "description": "Name of the training job which produced this model", - "type": "string", - "x-nullable": true - }, "modelType": { "description": "The storage format for this entity. Used for NCD.", "type": "string", @@ -19295,6 +19290,11 @@ "type": "string", "x-nullable": true }, + "jobName": { + "description": "Name of the training job which produced this model", + "type": "string", + "x-nullable": true + }, "provisioningState": { "description": "Provisioning state for the model version.", "$ref": "#/definitions/AssetProvisioningState", @@ -19336,16 +19336,16 @@ "description": "A paginated list of ModelVersion entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of ModelVersion objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type ModelVersion.", "type": "array", "items": { "$ref": "#/definitions/ModelVersionResource" } + }, + "nextLink": { + "description": "The link to the next page of ModelVersion objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -19434,23 +19434,6 @@ ], "type": "object", "properties": { - "alertNotificationSettings": { - "description": "The monitor's notification settings.", - "$ref": "#/definitions/MonitorNotificationSettings", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, - "computeConfiguration": { - "description": "[Required] The ARM resource ID of the compute resource to run the monitoring job on.", - "$ref": "#/definitions/MonitorComputeConfigurationBase", - "x-ms-mutability": [ - "create", - "read" - ] - }, "monitoringTarget": { "description": "The entities targeted by the monitor.", "$ref": "#/definitions/MonitoringTarget", @@ -19471,6 +19454,23 @@ "create", "read" ] + }, + "computeConfiguration": { + "description": "[Required] The ARM resource ID of the compute resource to run the monitoring job on.", + "$ref": "#/definitions/MonitorComputeConfigurationBase", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "alertNotificationSettings": { + "description": "The monitor's notification settings.", + "$ref": "#/definitions/MonitorNotificationSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true } }, "additionalProperties": false @@ -19630,18 +19630,13 @@ ], "type": "object", "properties": { - "columns": { - "description": "Mapping of column names to special uses.", - "type": "object", - "additionalProperties": { - "type": "string", - "x-nullable": true - }, + "inputDataType": { + "description": "[Required] Specifies the type of signal to monitor.", + "$ref": "#/definitions/MonitoringInputDataType", "x-ms-mutability": [ "create", "read" - ], - "x-nullable": true + ] }, "dataContext": { "description": "The context metadata of the data source.", @@ -19652,14 +19647,6 @@ ], "x-nullable": true }, - "inputDataType": { - "description": "[Required] Specifies the type of signal to monitor.", - "$ref": "#/definitions/MonitoringInputDataType", - "x-ms-mutability": [ - "create", - "read" - ] - }, "jobInputType": { "description": "[Required] Specifies the type of job.", "$ref": "#/definitions/JobInputType", @@ -19677,6 +19664,19 @@ "create", "read" ] + }, + "columns": { + "description": "Mapping of column names to special uses.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true } }, "discriminator": "inputDataType" @@ -19732,6 +19732,14 @@ ], "type": "object", "properties": { + "signalType": { + "description": "[Required] Specifies the type of signal to monitor.", + "$ref": "#/definitions/MonitoringSignalType", + "x-ms-mutability": [ + "create", + "read" + ] + }, "notificationTypes": { "description": "The current notification mode for this signal.", "type": "array", @@ -19753,14 +19761,6 @@ "x-nullable": true }, "x-nullable": true - }, - "signalType": { - "description": "[Required] Specifies the type of signal to monitor.", - "$ref": "#/definitions/MonitoringSignalType", - "x-ms-mutability": [ - "create", - "read" - ] } }, "discriminator": "signalType" @@ -19809,8 +19809,8 @@ ], "type": "object", "properties": { - "deploymentId": { - "description": "Reference to the deployment asset targeted by this monitor.", + "modelId": { + "description": "Reference to the model asset targeted by this monitor.", "type": "string", "x-ms-mutability": [ "create", @@ -19818,8 +19818,8 @@ ], "x-nullable": true }, - "modelId": { - "description": "Reference to the model asset targeted by this monitor.", + "deploymentId": { + "description": "Reference to the deployment asset targeted by this monitor.", "type": "string", "x-ms-mutability": [ "create", @@ -19922,16 +19922,16 @@ "description": "Abstract class for NLP related AutoML tasks.\r\nNLP - Natural Language Processing.", "type": "object", "properties": { - "featurizationSettings": { - "description": "Featurization inputs needed for AutoML job.", - "$ref": "#/definitions/NlpVerticalFeaturizationSettings", - "x-nullable": true - }, "limitSettings": { "description": "Execution constraints for AutoMLJob.", "$ref": "#/definitions/NlpVerticalLimitSettings", "x-nullable": true }, + "featurizationSettings": { + "description": "Featurization inputs needed for AutoML job.", + "$ref": "#/definitions/NlpVerticalFeaturizationSettings", + "x-nullable": true + }, "validationData": { "description": "Validation data inputs.", "$ref": "#/definitions/MLTableJobInput", @@ -19953,23 +19953,23 @@ "description": "Job execution constraints.", "type": "object", "properties": { - "maxConcurrentTrials": { + "timeout": { + "format": "duration", + "description": "AutoML job timeout.", + "default": "P7D", + "type": "string" + }, + "maxTrials": { "format": "int32", - "description": "Maximum Concurrent AutoML iterations.", + "description": "Number of AutoML iterations.", "default": 1, "type": "integer" }, - "maxTrials": { + "maxConcurrentTrials": { "format": "int32", - "description": "Number of AutoML iterations.", + "description": "Maximum Concurrent AutoML iterations.", "default": 1, "type": "integer" - }, - "timeout": { - "format": "duration", - "description": "AutoML job timeout.", - "default": "P7D", - "type": "string" } }, "additionalProperties": false @@ -20024,11 +20024,11 @@ "description": "Configuration for notification.", "type": "object", "properties": { - "emailOn": { - "description": "Send email notification to user on specified notification type", + "emails": { + "description": "This is the email recipient list which has a limitation of 499 characters in total concat with comma separator", "type": "array", "items": { - "$ref": "#/definitions/EmailNotificationEnableType" + "type": "string" }, "x-ms-mutability": [ "create", @@ -20036,11 +20036,11 @@ ], "x-nullable": true }, - "emails": { - "description": "This is the email recipient list which has a limitation of 499 characters in total concat with comma separator", + "emailOn": { + "description": "Send email notification to user on specified notification type", "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/EmailNotificationEnableType" }, "x-ms-mutability": [ "create", @@ -20248,15 +20248,15 @@ ], "type": "object", "properties": { - "goal": { - "description": "[Required] Defines supported metric goals for hyperparameter tuning", - "$ref": "#/definitions/Goal" - }, "primaryMetric": { "description": "[Required] Name of the metric to optimize.", "minLength": 1, "pattern": "[a-zA-Z0-9_]", "type": "string" + }, + "goal": { + "description": "[Required] Defines supported metric goals for hyperparameter tuning", + "$ref": "#/definitions/Goal" } }, "additionalProperties": false @@ -20269,6 +20269,10 @@ ], "type": "object", "properties": { + "artifactType": { + "description": "[Required] OneLake artifact type", + "$ref": "#/definitions/OneLakeArtifactType" + }, "artifactName": { "description": "[Required] OneLake artifact name", "minLength": 1, @@ -20278,10 +20282,6 @@ "create", "read" ] - }, - "artifactType": { - "description": "[Required] OneLake artifact type", - "$ref": "#/definitions/OneLakeArtifactType" } }, "discriminator": "artifactType" @@ -20324,16 +20324,6 @@ "read" ] }, - "endpoint": { - "description": "OneLake endpoint to use for the datastore.", - "type": "string", - "example": "data.microsoft.com", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, "oneLakeWorkspaceName": { "description": "[Required] OneLake workspace name.", "minLength": 1, @@ -20344,6 +20334,16 @@ "read" ] }, + "endpoint": { + "description": "OneLake endpoint to use for the datastore.", + "type": "string", + "example": "data.microsoft.com", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, "serviceDataAccessAuthIdentity": { "description": "Indicates which identity to use to authenticate service data access to customer's storage.", "default": "None", @@ -20368,47 +20368,38 @@ } ], "properties": { - "appInsightsEnabled": { - "description": "If true, enables Application Insights logging.", - "default": false, - "type": "boolean" - }, - "dataCollector": { - "description": "The mdc configuration, we disable mdc when it's null.", - "$ref": "#/definitions/DataCollector", - "x-nullable": true - }, - "egressPublicNetworkAccess": { - "description": "If Enabled, allow egress public network access. If Disabled, this will create secure egress. Default: Enabled.", - "default": "Enabled", - "$ref": "#/definitions/EgressPublicNetworkAccessType" - }, "endpointComputeType": { "description": "[Required] The compute type of the endpoint.", "$ref": "#/definitions/EndpointComputeType" }, - "instanceType": { - "description": "Compute instance type.", + "scaleSettings": { + "description": "Scale settings for the deployment.\r\nIf it is null or not provided,\r\nit defaults to TargetUtilizationScaleSettings for KubernetesOnlineDeployment\r\nand to DefaultScaleSettings for ManagedOnlineDeployment.", + "$ref": "#/definitions/OnlineScaleSettings", + "x-nullable": true + }, + "requestSettings": { + "description": "Request settings for the deployment.", + "$ref": "#/definitions/OnlineRequestSettings", + "x-nullable": true + }, + "modelMountPath": { + "description": "The path to mount the model in custom container.", "type": "string", - "x-ms-mutability": [ - "create", - "read" - ], "x-nullable": true }, + "appInsightsEnabled": { + "description": "If true, enables Application Insights logging.", + "default": false, + "type": "boolean" + }, "livenessProbe": { "description": "Liveness probe monitors the health of the container regularly.", "$ref": "#/definitions/ProbeSettings", "x-nullable": true }, - "model": { - "description": "The URI path to the model.", - "type": "string", - "x-nullable": true - }, - "modelMountPath": { - "description": "The path to mount the model in custom container.", - "type": "string", + "readinessProbe": { + "description": "Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness probe.", + "$ref": "#/definitions/ProbeSettings", "x-nullable": true }, "provisioningState": { @@ -20419,19 +20410,28 @@ "read" ] }, - "readinessProbe": { - "description": "Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness probe.", - "$ref": "#/definitions/ProbeSettings", + "instanceType": { + "description": "Compute instance type.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], "x-nullable": true }, - "requestSettings": { - "description": "Request settings for the deployment.", - "$ref": "#/definitions/OnlineRequestSettings", + "model": { + "description": "The URI path to the model.", + "type": "string", "x-nullable": true }, - "scaleSettings": { - "description": "Scale settings for the deployment.\r\nIf it is null or not provided,\r\nit defaults to TargetUtilizationScaleSettings for KubernetesOnlineDeployment\r\nand to DefaultScaleSettings for ManagedOnlineDeployment.", - "$ref": "#/definitions/OnlineScaleSettings", + "egressPublicNetworkAccess": { + "description": "If Enabled, allow egress public network access. If Disabled, this will create secure egress. Default: Enabled.", + "default": "Enabled", + "$ref": "#/definitions/EgressPublicNetworkAccessType" + }, + "dataCollector": { + "description": "The mdc configuration, we disable mdc when it's null.", + "$ref": "#/definitions/DataCollector", "x-nullable": true } }, @@ -20450,17 +20450,17 @@ } ], "properties": { - "identity": { - "description": "Managed service identity (system assigned and/or user assigned identities)", - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/OnlineDeployment" }, "kind": { "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", "type": "string" }, - "properties": { - "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/OnlineDeployment" + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" }, "sku": { "description": "Sku details required for ARM contract for Autoscaling.", @@ -20474,16 +20474,16 @@ "description": "A paginated list of OnlineDeployment entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of OnlineDeployment objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type OnlineDeployment.", "type": "array", "items": { "$ref": "#/definitions/OnlineDeploymentTrackedResource" } + }, + "nextLink": { + "description": "The link to the next page of OnlineDeployment objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -20497,20 +20497,6 @@ } ], "properties": { - "compute": { - "description": "ARM resource ID of the compute if it exists.\r\noptional", - "type": "string", - "x-nullable": true - }, - "mirrorTraffic": { - "description": "Percentage of traffic to be mirrored to each deployment without using returned scoring. Traffic values need to sum to utmost 50.", - "type": "object", - "additionalProperties": { - "format": "int32", - "type": "integer" - }, - "x-nullable": true - }, "provisioningState": { "description": "Provisioning state for the endpoint.", "$ref": "#/definitions/EndpointProvisioningState", @@ -20519,6 +20505,11 @@ "read" ] }, + "compute": { + "description": "ARM resource ID of the compute if it exists.\r\noptional", + "type": "string", + "x-nullable": true + }, "publicNetworkAccess": { "description": "Set to \"Enabled\" for endpoints that should allow public access when Private Link is enabled.", "default": "Enabled", @@ -20532,6 +20523,15 @@ "type": "integer" }, "x-nullable": true + }, + "mirrorTraffic": { + "description": "Percentage of traffic to be mirrored to each deployment without using returned scoring. Traffic values need to sum to utmost 50.", + "type": "object", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "x-nullable": true } }, "x-ms-client-name": "OnlineEndpointProperties", @@ -20549,17 +20549,17 @@ } ], "properties": { - "identity": { - "description": "Managed service identity (system assigned and/or user assigned identities)", - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/OnlineEndpoint" }, "kind": { "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", "type": "string" }, - "properties": { - "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/OnlineEndpoint" + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" }, "sku": { "description": "Sku details required for ARM contract for Autoscaling.", @@ -20573,16 +20573,16 @@ "description": "A paginated list of OnlineEndpoint entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of OnlineEndpoint objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type OnlineEndpoint.", "type": "array", "items": { "$ref": "#/definitions/OnlineEndpointTrackedResource" } + }, + "nextLink": { + "description": "The link to the next page of OnlineEndpoint objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -20591,12 +20591,6 @@ "description": "Online deployment scoring requests configuration.", "type": "object", "properties": { - "maxConcurrentRequestsPerInstance": { - "format": "int32", - "description": "The number of maximum concurrent requests per node allowed per deployment. Defaults to 1.", - "default": 1, - "type": "integer" - }, "maxQueueWait": { "format": "duration", "description": "(Deprecated for Managed Online Endpoints) The maximum amount of time a request will stay in the queue in ISO 8601 format.\r\nDefaults to 500ms.\r\n(Now increase `request_timeout_ms` to account for any networking/queue delays)", @@ -20608,6 +20602,12 @@ "description": "The scoring timeout in ISO 8601 format.\r\nDefaults to 5000ms.", "default": "PT5S", "type": "string" + }, + "maxConcurrentRequestsPerInstance": { + "format": "int32", + "description": "The number of maximum concurrent requests per node allowed per deployment. Defaults to 1.", + "default": 1, + "type": "integer" } }, "additionalProperties": false @@ -20709,13 +20709,13 @@ } ], "properties": { - "jobId": { - "description": "ARM resource ID of the job.", + "path": { + "description": "The path of the file/directory in the job output.", "type": "string", "x-nullable": true }, - "path": { - "description": "The path of the file/directory in the job output.", + "jobId": { + "description": "ARM resource ID of the job.", "type": "string", "x-nullable": true } @@ -20820,49 +20820,49 @@ "additionalProperties": false }, "PartialMinimalTrackedResourceWithSkuAndIdentity": { - "additionalProperties": false, + "description": "Strictly used in update requests.", + "type": "object", "allOf": [ { "$ref": "#/definitions/PartialMinimalTrackedResource" } ], - "description": "Strictly used in update requests.", "properties": { - "identity": { - "$ref": "#/definitions/PartialManagedServiceIdentity", - "description": "Managed service identity (system assigned and/or user assigned identities)" - }, "sku": { - "$ref": "#/definitions/PartialSku", - "description": "Sku details required for ARM contract for Autoscaling." + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "#/definitions/PartialSku" + }, + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "#/definitions/PartialManagedServiceIdentity" } }, - "type": "object" + "additionalProperties": false }, "PartialSku": { "description": "Common SKU definition.", "type": "object", "properties": { - "capacity": { - "format": "int32", - "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.", - "type": "integer" - }, - "family": { - "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.", - "type": "string" - }, "name": { "description": "The name of the SKU. Ex - P3. It is typically a letter+number code.", "type": "string" }, + "tier": { + "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/SkuTier" + }, "size": { "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.", "type": "string" }, - "tier": { - "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.", - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/SkuTier" + "family": { + "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.", + "type": "string" + }, + "capacity": { + "format": "int32", + "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.", + "type": "integer" } }, "additionalProperties": false @@ -20968,14 +20968,9 @@ } ], "properties": { - "inputs": { - "description": "Inputs for the pipeline job.", + "settings": { + "description": "Pipeline settings, for things like ContinueRunOnStepFailure etc.", "type": "object", - "additionalProperties": { - "description": "Command job definition.", - "$ref": "#/definitions/JobInput", - "x-nullable": true - }, "x-ms-mutability": [ "create", "read" @@ -20995,12 +20990,12 @@ ], "x-nullable": true }, - "outputs": { - "description": "Outputs for the pipeline job", + "inputs": { + "description": "Inputs for the pipeline job.", "type": "object", "additionalProperties": { - "description": "Job output definition container information on where to find job output/logs.", - "$ref": "#/definitions/JobOutput", + "description": "Command job definition.", + "$ref": "#/definitions/JobInput", "x-nullable": true }, "x-ms-mutability": [ @@ -21009,9 +21004,14 @@ ], "x-nullable": true }, - "settings": { - "description": "Pipeline settings, for things like ContinueRunOnStepFailure etc.", + "outputs": { + "description": "Outputs for the pipeline job", "type": "object", + "additionalProperties": { + "description": "Job output definition container information on where to find job output/logs.", + "$ref": "#/definitions/JobOutput", + "x-nullable": true + }, "x-ms-mutability": [ "create", "read" @@ -21070,18 +21070,6 @@ } ], "properties": { - "featureDataTypeOverride": { - "description": "A dictionary that maps feature names to their respective data types.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/MonitoringFeatureDataType" - }, - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, "metricThresholds": { "description": "[Required] A list of metrics to calculate and their associated thresholds.", "type": "array", @@ -21109,6 +21097,18 @@ "create", "read" ] + }, + "featureDataTypeOverride": { + "description": "A dictionary that maps feature names to their respective data types.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MonitoringFeatureDataType" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true } }, "x-ms-discriminator-value": "PredictionDrift", @@ -21124,18 +21124,6 @@ "default": 30, "type": "integer" }, - "initialDelay": { - "format": "duration", - "description": "The delay before the first probe in ISO 8601 format.", - "type": "string", - "x-nullable": true - }, - "period": { - "format": "duration", - "description": "The length of time between probes in ISO 8601 format.", - "default": "PT10S", - "type": "string" - }, "successThreshold": { "format": "int32", "description": "The number of successful probes before returning a healthy status.", @@ -21147,6 +21135,18 @@ "description": "The probe timeout in ISO 8601 format.", "default": "PT2S", "type": "string" + }, + "period": { + "format": "duration", + "description": "The length of time between probes in ISO 8601 format.", + "default": "PT10S", + "type": "string" + }, + "initialDelay": { + "format": "duration", + "description": "The delay before the first probe in ISO 8601 format.", + "type": "string", + "x-nullable": true } }, "additionalProperties": false @@ -21215,16 +21215,16 @@ } ], "properties": { - "rule": { - "description": "The specific type of random algorithm", - "default": "Random", - "$ref": "#/definitions/RandomSamplingAlgorithmRule" - }, "seed": { "format": "int32", "description": "An optional integer to use as the seed for random number generation", "type": "integer", "x-nullable": true + }, + "rule": { + "description": "The specific type of random algorithm", + "default": "Random", + "$ref": "#/definitions/RandomSamplingAlgorithmRule" } }, "x-ms-discriminator-value": "Random", @@ -21312,20 +21312,20 @@ "type": "integer" } }, - "monthDays": { - "description": "List of month days for the schedule", + "weekDays": { + "description": "List of days for the schedule.", "type": "array", "items": { - "format": "int32", - "type": "integer" + "$ref": "#/definitions/WeekDay" }, "x-nullable": true }, - "weekDays": { - "description": "List of days for the schedule.", + "monthDays": { + "description": "List of month days for the schedule", "type": "array", "items": { - "$ref": "#/definitions/WeekDay" + "format": "int32", + "type": "integer" }, "x-nullable": true } @@ -21578,8 +21578,8 @@ "type": "string", "x-nullable": true }, - "properties": { - "description": "The asset property dictionary.", + "tags": { + "description": "Tag dictionary. Tags can be added, removed, and updated.", "type": "object", "additionalProperties": { "type": "string", @@ -21587,8 +21587,8 @@ }, "x-nullable": true }, - "tags": { - "description": "Tag dictionary. Tags can be added, removed, and updated.", + "properties": { + "description": "The asset property dictionary.", "type": "object", "additionalProperties": { "type": "string", @@ -21650,15 +21650,6 @@ } ], "properties": { - "preprocessingComponentId": { - "description": "Reference to the component asset used to preprocess the data.", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, "windowOffset": { "format": "duration", "description": "[Required] The time offset between the end of the data window and the monitor's current run time.", @@ -21676,6 +21667,15 @@ "create", "read" ] + }, + "preprocessingComponentId": { + "description": "Reference to the component asset used to preprocess the data.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true } }, "x-ms-discriminator-value": "Rolling", @@ -21886,15 +21886,6 @@ } ], "properties": { - "action": { - "description": "[Required] Specifies the action of the schedule", - "$ref": "#/definitions/ScheduleActionBase", - "x-ms-mutability": [ - "create", - "read", - "update" - ] - }, "displayName": { "description": "Display name of schedule.", "type": "string", @@ -21914,14 +21905,6 @@ "update" ] }, - "provisioningState": { - "description": "Provisioning state for the schedule.", - "$ref": "#/definitions/ScheduleProvisioningStatus", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, "trigger": { "description": "[Required] Specifies the trigger details", "$ref": "#/definitions/TriggerBase", @@ -21930,6 +21913,23 @@ "read", "update" ] + }, + "action": { + "description": "[Required] Specifies the action of the schedule", + "$ref": "#/definitions/ScheduleActionBase", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + }, + "provisioningState": { + "description": "Provisioning state for the schedule.", + "$ref": "#/definitions/ScheduleProvisioningStatus", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] } }, "x-ms-client-name": "ScheduleProperties", @@ -22061,16 +22061,16 @@ "description": "A paginated list of Schedule entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of Schedule objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type Schedule.", "type": "array", "items": { "$ref": "#/definitions/ScheduleResource" } + }, + "nextLink": { + "description": "The link to the next page of Schedule objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -22146,65 +22146,64 @@ "additionalProperties": false }, "ServerlessEndpoint": { - "additionalProperties": false, + "required": [ + "authMode" + ], + "type": "object", "properties": { + "modelSettings": { + "description": "The model settings (model id) for the model being serviced on the ServerlessEndpoint.", + "$ref": "#/definitions/ModelSettings", + "x-nullable": true + }, "authMode": { - "$ref": "#/definitions/ServerlessInferenceEndpointAuthMode", - "description": "[Required] Specifies the authentication mode for the Serverless endpoint." + "description": "[Required] Specifies the authentication mode for the Serverless endpoint.", + "$ref": "#/definitions/ServerlessInferenceEndpointAuthMode" }, - "contentSafety": { - "$ref": "#/definitions/ContentSafety", - "description": "Specifies the content safety options. If omitted, the default content safety settings will be configured", + "inferenceEndpoint": { + "description": "The inference uri to target when making requests against the serverless endpoint", + "$ref": "#/definitions/ServerlessInferenceEndpoint", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], "x-nullable": true }, - "endpointState": { - "$ref": "#/definitions/ServerlessEndpointState", - "description": "The current state of the ServerlessEndpoint.", + "provisioningState": { + "description": "Provisioning state for the endpoint.", + "$ref": "#/definitions/EndpointProvisioningState", "readOnly": true, "x-ms-mutability": [ "read" ] }, - "inferenceEndpoint": { - "$ref": "#/definitions/ServerlessInferenceEndpoint", - "description": "The inference uri to target when making requests against the serverless endpoint", + "endpointState": { + "description": "The current state of the ServerlessEndpoint.", + "$ref": "#/definitions/ServerlessEndpointState", "readOnly": true, "x-ms-mutability": [ "read" - ], - "x-nullable": true + ] }, "marketplaceSubscriptionId": { "description": "The MarketplaceSubscription Azure ID associated to this ServerlessEndpoint.", - "readOnly": true, "type": "string", + "readOnly": true, "x-ms-mutability": [ "read" ], "x-nullable": true }, - "modelSettings": { - "$ref": "#/definitions/ModelSettings", - "description": "The model settings (model id) for the model being serviced on the ServerlessEndpoint.", + "contentSafety": { + "description": "Specifies the content safety options. If omitted, the default content safety settings will be configured", + "$ref": "#/definitions/ContentSafety", "x-nullable": true - }, - "provisioningState": { - "$ref": "#/definitions/EndpointProvisioningState", - "description": "Provisioning state for the endpoint.", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] } }, - "required": [ - "authMode" - ], - "type": "object", - "x-ms-client-name": "ServerlessEndpointProperties" + "x-ms-client-name": "ServerlessEndpointProperties", + "additionalProperties": false }, "ServerlessEndpointState": { - "additionalProperties": false, "description": "State of the Serverless Endpoint.", "enum": [ "Unknown", @@ -22219,8 +22218,8 @@ ], "type": "string", "x-ms-enum": { - "modelAsString": true, "name": "ServerlessEndpointState", + "modelAsString": true, "values": [ { "value": "Unknown" @@ -22250,103 +22249,104 @@ "value": "DeletionFailed" } ] - } + }, + "additionalProperties": false }, "ServerlessEndpointTrackedResource": { - "additionalProperties": false, + "required": [ + "location", + "properties" + ], + "type": "object", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" } ], "properties": { - "identity": { - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", - "description": "Managed service identity (system assigned and/or user assigned identities)" + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/ServerlessEndpoint" }, "kind": { "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", "type": "string" }, - "properties": { - "$ref": "#/definitions/ServerlessEndpoint", - "description": "[Required] Additional attributes of the entity." + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" }, "sku": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku", - "description": "Sku details required for ARM contract for Autoscaling." + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" } }, - "required": [ - "location", - "properties" - ], - "type": "object", - "x-ms-client-name": "ServerlessEndpoint" + "x-ms-client-name": "ServerlessEndpoint", + "additionalProperties": false }, "ServerlessEndpointTrackedResourceArmPaginatedResult": { - "additionalProperties": false, "description": "A paginated list of ServerlessEndpoint entities.", + "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of ServerlessEndpoint objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type ServerlessEndpoint.", + "type": "array", "items": { "$ref": "#/definitions/ServerlessEndpointTrackedResource" - }, - "type": "array" + } + }, + "nextLink": { + "description": "The link to the next page of ServerlessEndpoint objects. If null, there are no additional pages.", + "type": "string" } }, - "type": "object" + "additionalProperties": false }, "ServerlessInferenceEndpoint": { - "additionalProperties": false, + "required": [ + "uri" + ], + "type": "object", "properties": { + "uri": { + "format": "uri", + "description": "[Required] The inference uri to target when making requests against the Serverless Endpoint.", + "type": "string", + "x-ms-mutability": [ + "read" + ] + }, "headers": { + "description": "Specifies any required headers to target this serverless endpoint.", + "type": "object", "additionalProperties": { "type": "string", "x-nullable": true }, - "description": "Specifies any required headers to target this serverless endpoint.", "readOnly": true, - "type": "object", "x-ms-mutability": [ "read" ], "x-nullable": true - }, - "uri": { - "description": "[Required] The inference uri to target when making requests against the Serverless Endpoint.", - "format": "uri", - "type": "string", - "x-ms-mutability": [ - "read" - ] } }, - "required": [ - "uri" - ], - "type": "object" + "additionalProperties": false }, "ServerlessInferenceEndpointAuthMode": { - "additionalProperties": false, "enum": [ "Key" ], "type": "string", "x-ms-enum": { - "modelAsString": true, "name": "ServerlessInferenceEndpointAuthMode", + "modelAsString": true, "values": [ { "value": "Key" } ] - } + }, + "additionalProperties": false }, "ServiceDataAccessAuthIdentity": { "enum": [ @@ -22394,16 +22394,21 @@ "type": "string", "x-nullable": true }, - "clientId": { - "format": "uuid", - "description": "[Required] Service principal client ID.", - "type": "string" - }, "resourceUrl": { "description": "Resource the service principal has access to.", "type": "string", "x-nullable": true }, + "tenantId": { + "format": "uuid", + "description": "[Required] ID of the tenant to which the service principal belongs.", + "type": "string" + }, + "clientId": { + "format": "uuid", + "description": "[Required] Service principal client ID.", + "type": "string" + }, "secrets": { "description": "[Required] Service principal secrets.", "$ref": "#/definitions/ServicePrincipalDatastoreSecrets", @@ -22412,11 +22417,6 @@ "update" ], "x-ms-secret": true - }, - "tenantId": { - "format": "uuid", - "description": "[Required] ID of the tenant to which the service principal belongs.", - "type": "string" } }, "x-ms-discriminator-value": "ServicePrincipal", @@ -22477,9 +22477,9 @@ "description": "SKU capacity information", "type": "object", "properties": { - "default": { + "minimum": { "format": "int32", - "description": "Gets or sets the default capacity.", + "description": "Gets or sets the minimum.", "default": 0, "type": "integer" }, @@ -22489,9 +22489,9 @@ "default": 0, "type": "integer" }, - "minimum": { + "default": { "format": "int32", - "description": "Gets or sets the minimum.", + "description": "Gets or sets the default capacity.", "default": 0, "type": "integer" }, @@ -22507,11 +22507,6 @@ "description": "Fulfills ARM Contract requirement to list all available SKUS for a resource.", "type": "object", "properties": { - "capacity": { - "description": "Gets or sets the Sku Capacity.", - "$ref": "#/definitions/SkuCapacity", - "x-nullable": true - }, "resourceType": { "description": "The resource type name.", "type": "string", @@ -22525,6 +22520,11 @@ "description": "Gets or sets the Sku.", "$ref": "#/definitions/SkuSetting", "x-nullable": true + }, + "capacity": { + "description": "Gets or sets the Sku Capacity.", + "$ref": "#/definitions/SkuCapacity", + "x-nullable": true } }, "additionalProperties": false @@ -22533,10 +22533,6 @@ "description": "A paginated list of SkuResource entities.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of SkuResource objects. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "An array of objects of type SkuResource.", "type": "array", @@ -22544,6 +22540,10 @@ "$ref": "#/definitions/SkuResource" }, "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The link to the next page of SkuResource objects. If null, there are no additional pages.", + "type": "string" } }, "additionalProperties": false @@ -22610,12 +22610,9 @@ } ], "properties": { - "archives": { - "description": "Archive files used in the job.", - "type": "array", - "items": { - "type": "string" - }, + "resources": { + "description": "Compute Resource configuration for the job.", + "$ref": "#/definitions/SparkResourceConfiguration", "x-ms-mutability": [ "create", "read" @@ -22643,24 +22640,6 @@ "read" ] }, - "conf": { - "description": "Spark configured properties.", - "type": "object", - "additionalProperties": { - "type": "string", - "x-nullable": true - }, - "example": [ - { - "spark.driver.memory": "2g" - } - ], - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, "entry": { "description": "[Required] The entry to execute on startup of the job.", "$ref": "#/definitions/SparkJobEntry", @@ -22679,11 +22658,12 @@ ], "x-nullable": true }, - "environmentVariables": { - "description": "Environment variables included in the job.", + "inputs": { + "description": "Mapping of input data bindings used in the job.", "type": "object", "additionalProperties": { - "type": "string", + "description": "Command job definition.", + "$ref": "#/definitions/JobInput", "x-nullable": true }, "x-ms-mutability": [ @@ -22692,11 +22672,13 @@ ], "x-nullable": true }, - "files": { - "description": "Files used in the job.", - "type": "array", - "items": { - "type": "string" + "outputs": { + "description": "Mapping of output data bindings used in the job.", + "type": "object", + "additionalProperties": { + "description": "Job output definition container information on where to find job output/logs.", + "$ref": "#/definitions/JobOutput", + "x-nullable": true }, "x-ms-mutability": [ "create", @@ -22704,13 +22686,11 @@ ], "x-nullable": true }, - "inputs": { - "description": "Mapping of input data bindings used in the job.", - "type": "object", - "additionalProperties": { - "description": "Command job definition.", - "$ref": "#/definitions/JobInput", - "x-nullable": true + "pyFiles": { + "description": "Python files used in the job.", + "type": "array", + "items": { + "type": "string" }, "x-ms-mutability": [ "create", @@ -22730,13 +22710,11 @@ ], "x-nullable": true }, - "outputs": { - "description": "Mapping of output data bindings used in the job.", - "type": "object", - "additionalProperties": { - "description": "Job output definition container information on where to find job output/logs.", - "$ref": "#/definitions/JobOutput", - "x-nullable": true + "files": { + "description": "Files used in the job.", + "type": "array", + "items": { + "type": "string" }, "x-ms-mutability": [ "create", @@ -22744,8 +22722,8 @@ ], "x-nullable": true }, - "pyFiles": { - "description": "Python files used in the job.", + "archives": { + "description": "Archive files used in the job.", "type": "array", "items": { "type": "string" @@ -22756,6 +22734,24 @@ ], "x-nullable": true }, + "conf": { + "description": "Spark configured properties.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "example": [ + { + "spark.driver.memory": "2g" + } + ], + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, "queueSettings": { "description": "Queue settings for the job", "$ref": "#/definitions/QueueSettings", @@ -22765,9 +22761,13 @@ ], "x-nullable": true }, - "resources": { - "description": "Compute Resource configuration for the job.", - "$ref": "#/definitions/SparkResourceConfiguration", + "environmentVariables": { + "description": "Environment variables included in the job.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, "x-ms-mutability": [ "create", "read" @@ -22896,10 +22896,10 @@ "description": "Advances setting to customize StackEnsemble run.", "type": "object", "properties": { - "stackMetaLearnerKWargs": { - "description": "Optional parameters to pass to the initializer of the meta-learner.", - "type": "object", - "x-nullable": true + "stackMetaLearnerType": { + "description": "The meta-learner is a model trained on the output of the individual heterogeneous models.", + "default": "None", + "$ref": "#/definitions/StackMetaLearnerType" }, "stackMetaLearnerTrainPercentage": { "format": "double", @@ -22907,10 +22907,10 @@ "default": 0.2, "type": "number" }, - "stackMetaLearnerType": { - "description": "The meta-learner is a model trained on the output of the individual heterogeneous models.", - "default": "None", - "$ref": "#/definitions/StackMetaLearnerType" + "stackMetaLearnerKWargs": { + "description": "Optional parameters to pass to the initializer of the meta-learner.", + "type": "object", + "x-nullable": true } }, "additionalProperties": false @@ -22977,14 +22977,14 @@ } ], "properties": { - "preprocessingComponentId": { - "description": "Reference to the component asset used to preprocess the data.", + "windowStart": { + "format": "date-time", + "description": "[Required] The start date of the data window.", "type": "string", "x-ms-mutability": [ "create", "read" - ], - "x-nullable": true + ] }, "windowEnd": { "format": "date-time", @@ -22995,14 +22995,14 @@ "read" ] }, - "windowStart": { - "format": "date-time", - "description": "[Required] The start date of the data window.", + "preprocessingComponentId": { + "description": "Reference to the component asset used to preprocess the data.", "type": "string", "x-ms-mutability": [ "create", "read" - ] + ], + "x-nullable": true } }, "x-ms-discriminator-value": "Static", @@ -23056,11 +23056,36 @@ } ], "properties": { + "searchSpace": { + "description": "[Required] A dictionary containing each parameter and its distribution. The dictionary key is the name of the parameter", + "type": "object" + }, + "samplingAlgorithm": { + "description": "[Required] The hyperparameter sampling algorithm", + "$ref": "#/definitions/SamplingAlgorithm" + }, + "limits": { + "description": "Sweep Job limit.", + "default": "{}", + "$ref": "#/definitions/SweepJobLimits", + "x-ms-mutability": [ + "create", + "read" + ] + }, "earlyTermination": { "description": "Early termination policies enable canceling poor-performing runs before they complete", "$ref": "#/definitions/EarlyTerminationPolicy", "x-nullable": true }, + "objective": { + "description": "[Required] Optimization objective.", + "$ref": "#/definitions/Objective" + }, + "trial": { + "description": "[Required] Trial component definition.", + "$ref": "#/definitions/TrialComponent" + }, "inputs": { "description": "Mapping of input data bindings used in the job.", "type": "object", @@ -23075,19 +23100,6 @@ ], "x-nullable": true }, - "limits": { - "description": "Sweep Job limit.", - "default": "{}", - "$ref": "#/definitions/SweepJobLimits", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "objective": { - "description": "[Required] Optimization objective.", - "$ref": "#/definitions/Objective" - }, "outputs": { "description": "Mapping of output data bindings used in the job.", "type": "object", @@ -23110,18 +23122,6 @@ "read" ], "x-nullable": true - }, - "samplingAlgorithm": { - "description": "[Required] The hyperparameter sampling algorithm", - "$ref": "#/definitions/SamplingAlgorithm" - }, - "searchSpace": { - "description": "[Required] A dictionary containing each parameter and its distribution. The dictionary key is the name of the parameter", - "type": "object" - }, - "trial": { - "description": "[Required] Trial component definition.", - "$ref": "#/definitions/TrialComponent" } }, "x-ms-discriminator-value": "Sweep", @@ -23136,15 +23136,15 @@ } ], "properties": { - "maxConcurrentTrials": { + "maxTotalTrials": { "format": "int32", - "description": "Sweep Job max concurrent trials.", + "description": "Sweep Job max total trials.", "type": "integer", "x-nullable": true }, - "maxTotalTrials": { + "maxConcurrentTrials": { "format": "int32", - "description": "Sweep Job max total trials.", + "description": "Sweep Job max concurrent trials.", "type": "integer", "x-nullable": true }, @@ -23162,19 +23162,6 @@ "description": "Abstract class for AutoML tasks that use table dataset as input - such as Classification/Regression/Forecasting.", "type": "object", "properties": { - "cvSplitColumnNames": { - "description": "Columns to use for CVSplit data.", - "type": "array", - "items": { - "type": "string" - }, - "x-nullable": true - }, - "featurizationSettings": { - "description": "Featurization inputs needed for AutoML job.", - "$ref": "#/definitions/TableVerticalFeaturizationSettings", - "x-nullable": true - }, "limitSettings": { "description": "Execution constraints for AutoMLJob.", "$ref": "#/definitions/TableVerticalLimitSettings", @@ -23185,15 +23172,17 @@ "$ref": "#/definitions/NCrossValidations", "x-nullable": true }, - "testData": { - "description": "Test data input.", - "$ref": "#/definitions/MLTableJobInput", + "cvSplitColumnNames": { + "description": "Columns to use for CVSplit data.", + "type": "array", + "items": { + "type": "string" + }, "x-nullable": true }, - "testDataSize": { - "format": "double", - "description": "The fraction of test dataset that needs to be set aside for validation purpose.\r\nValues between (0.0 , 1.0)\r\nApplied when validation dataset is not provided.", - "type": "number", + "weightColumnName": { + "description": "The name of the sample weight column. Automated ML supports a weighted column as an input, causing rows in the data to be weighted up or down.", + "type": "string", "x-nullable": true }, "validationData": { @@ -23201,15 +23190,26 @@ "$ref": "#/definitions/MLTableJobInput", "x-nullable": true }, + "testData": { + "description": "Test data input.", + "$ref": "#/definitions/MLTableJobInput", + "x-nullable": true + }, "validationDataSize": { "format": "double", "description": "The fraction of training dataset that needs to be set aside for validation purpose.\r\nValues between (0.0 , 1.0)\r\nApplied when validation dataset is not provided.", "type": "number", "x-nullable": true }, - "weightColumnName": { - "description": "The name of the sample weight column. Automated ML supports a weighted column as an input, causing rows in the data to be weighted up or down.", - "type": "string", + "testDataSize": { + "format": "double", + "description": "The fraction of test dataset that needs to be set aside for validation purpose.\r\nValues between (0.0 , 1.0)\r\nApplied when validation dataset is not provided.", + "type": "number", + "x-nullable": true + }, + "featurizationSettings": { + "description": "Featurization inputs needed for AutoML job.", + "$ref": "#/definitions/TableVerticalFeaturizationSettings", "x-nullable": true } }, @@ -23224,6 +23224,11 @@ } ], "properties": { + "mode": { + "description": "Featurization mode - User can keep the default 'Auto' mode and AutoML will take care of necessary transformation of the data in featurization phase.\r\nIf 'Off' is selected then no featurization is done.\r\nIf 'Custom' is selected then user can specify additional inputs to customize how featurization is done.", + "default": "Auto", + "$ref": "#/definitions/FeaturizationMode" + }, "blockedTransformers": { "description": "These transformers shall not be used in featurization.", "type": "array", @@ -23241,16 +23246,6 @@ }, "x-nullable": true }, - "enableDnnFeaturization": { - "description": "Determines whether to use Dnn based featurizers for data featurization.", - "default": false, - "type": "boolean" - }, - "mode": { - "description": "Featurization mode - User can keep the default 'Auto' mode and AutoML will take care of necessary transformation of the data in featurization phase.\r\nIf 'Off' is selected then no featurization is done.\r\nIf 'Custom' is selected then user can specify additional inputs to customize how featurization is done.", - "default": "Auto", - "$ref": "#/definitions/FeaturizationMode" - }, "transformerParams": { "description": "User can specify additional transformers to be used along with the columns to which it would be applied and parameters for the transformer constructor.", "type": "object", @@ -23263,6 +23258,11 @@ "x-ms-identifiers": [] }, "x-nullable": true + }, + "enableDnnFeaturization": { + "description": "Determines whether to use Dnn based featurizers for data featurization.", + "default": false, + "type": "boolean" } }, "additionalProperties": false @@ -23271,16 +23271,23 @@ "description": "Job execution constraints.", "type": "object", "properties": { - "enableEarlyTermination": { - "description": "Enable early termination, determines whether or not if AutoMLJob will terminate early if there is no score improvement in last 20 iterations.", - "default": true, - "type": "boolean" + "maxTrials": { + "format": "int32", + "description": "Number of iterations.", + "default": 1000, + "type": "integer" }, - "exitScore": { - "format": "double", - "description": "Exit score for the AutoML job.", - "type": "number", - "x-nullable": true + "trialTimeout": { + "format": "duration", + "description": "Iteration timeout.", + "default": "PT30M", + "type": "string" + }, + "timeout": { + "format": "duration", + "description": "AutoML job timeout.", + "default": "PT6H", + "type": "string" }, "maxConcurrentTrials": { "format": "int32", @@ -23294,23 +23301,16 @@ "default": -1, "type": "integer" }, - "maxTrials": { - "format": "int32", - "description": "Number of iterations.", - "default": 1000, - "type": "integer" - }, - "timeout": { - "format": "duration", - "description": "AutoML job timeout.", - "default": "PT6H", - "type": "string" + "exitScore": { + "format": "double", + "description": "Exit score for the AutoML job.", + "type": "number", + "x-nullable": true }, - "trialTimeout": { - "format": "duration", - "description": "Iteration timeout.", - "default": "PT30M", - "type": "string" + "enableEarlyTermination": { + "description": "Enable early termination, determines whether or not if AutoMLJob will terminate early if there is no score improvement in last 20 iterations.", + "default": true, + "type": "boolean" } }, "additionalProperties": false @@ -23439,18 +23439,6 @@ } ], "properties": { - "maxInstances": { - "format": "int32", - "description": "The maximum number of instances that the deployment can scale to. The quota will be reserved for max_instances.", - "default": 1, - "type": "integer" - }, - "minInstances": { - "format": "int32", - "description": "The minimum number of instances to always be present.", - "default": 1, - "type": "integer" - }, "pollingInterval": { "format": "duration", "description": "The polling interval in ISO 8691 format. Only supports duration with precision as low as Seconds.", @@ -23462,6 +23450,18 @@ "description": "Target CPU usage for the autoscaler.", "default": 70, "type": "integer" + }, + "minInstances": { + "format": "int32", + "description": "The minimum number of instances to always be present.", + "default": 1, + "type": "integer" + }, + "maxInstances": { + "format": "int32", + "description": "The maximum number of instances that the deployment can scale to. The quota will be reserved for max_instances.", + "default": 1, + "type": "integer" } }, "x-ms-discriminator-value": "TargetUtilization", @@ -23539,25 +23539,25 @@ } ], "properties": { - "parameterServerCount": { + "workerCount": { "format": "int32", - "description": "Number of parameter server tasks.", - "default": 0, + "description": "Number of workers. If not specified, will default to the instance count.", "type": "integer", "x-ms-mutability": [ "create", "read" - ] + ], + "x-nullable": true }, - "workerCount": { + "parameterServerCount": { "format": "int32", - "description": "Number of workers. If not specified, will default to the instance count.", + "description": "Number of parameter server tasks.", + "default": 0, "type": "integer", "x-ms-mutability": [ "create", "read" - ], - "x-nullable": true + ] } }, "x-ms-discriminator-value": "TensorFlow", @@ -23655,21 +23655,16 @@ "description": "Training related configuration.", "type": "object", "properties": { - "enableDnnTraining": { - "description": "Enable recommendation of DNN models.", - "default": false, - "type": "boolean" - }, - "enableModelExplainability": { - "description": "Flag to turn on explainability on best model.", - "default": true, - "type": "boolean" - }, "enableOnnxCompatibleModels": { "description": "Flag for enabling onnx compatible models.", "default": false, "type": "boolean" }, + "stackEnsembleSettings": { + "description": "Stack ensemble settings for stack ensemble run.", + "$ref": "#/definitions/StackEnsembleSettings", + "x-nullable": true + }, "enableStackEnsemble": { "description": "Enable stack ensemble run.", "default": true, @@ -23686,10 +23681,15 @@ "default": "PT5M", "type": "string" }, - "stackEnsembleSettings": { - "description": "Stack ensemble settings for stack ensemble run.", - "$ref": "#/definitions/StackEnsembleSettings", - "x-nullable": true + "enableModelExplainability": { + "description": "Flag to turn on explainability on best model.", + "default": true, + "type": "boolean" + }, + "enableDnnTraining": { + "description": "Enable recommendation of DNN models.", + "default": false, + "type": "boolean" } }, "additionalProperties": false @@ -23721,15 +23721,6 @@ "read" ] }, - "distribution": { - "description": "Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.", - "$ref": "#/definitions/DistributionConfiguration", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, "environmentId": { "description": "[Required] The ARM resource ID of the Environment specification for the job.", "minLength": 1, @@ -23749,6 +23740,15 @@ ], "x-nullable": true }, + "distribution": { + "description": "Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.", + "$ref": "#/definitions/DistributionConfiguration", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, "resources": { "description": "Compute Resource configuration for the job.", "default": "{}", @@ -23767,6 +23767,15 @@ ], "type": "object", "properties": { + "triggerType": { + "description": "[Required] ", + "$ref": "#/definitions/TriggerType", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + }, "endTime": { "description": "Specifies end time of schedule in ISO 8601, but without a UTC offset. Refer https://en.wikipedia.org/wiki/ISO_8601.\r\nRecommented format would be \"2022-06-01T00:00:01\"\r\nIf not present, the schedule will run indefinitely", "type": "string", @@ -23781,15 +23790,6 @@ "description": "Specifies time zone in which the schedule runs.\r\nTimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11", "default": "UTC", "type": "string" - }, - "triggerType": { - "description": "[Required] ", - "$ref": "#/definitions/TriggerType", - "x-ms-mutability": [ - "create", - "read", - "update" - ] } }, "discriminator": "triggerType" @@ -24010,6 +24010,14 @@ ], "type": "object", "properties": { + "webhookType": { + "description": "[Required] Specifies the type of service to send a callback", + "$ref": "#/definitions/WebhookType", + "x-ms-mutability": [ + "create", + "read" + ] + }, "eventType": { "description": "Send callback on a specified notification event", "type": "string", @@ -24018,14 +24026,6 @@ "read" ], "x-nullable": true - }, - "webhookType": { - "description": "[Required] Specifies the type of service to send a callback", - "$ref": "#/definitions/WebhookType", - "x-ms-mutability": [ - "create", - "read" - ] } }, "discriminator": "webhookType" diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/tspconfig.yaml b/specification/mobilepacketcore/MobilePacketCore.Management/tspconfig.yaml index e61542d86672..c832c62ba194 100644 --- a/specification/mobilepacketcore/MobilePacketCore.Management/tspconfig.yaml +++ b/specification/mobilepacketcore/MobilePacketCore.Management/tspconfig.yaml @@ -7,6 +7,9 @@ options: "@azure-tools/typespec-autorest": use-read-only-status-schema: true azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true emitter-output-dir: "{project-root}/.." examples-directory: "{project-root}/examples" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/mobilepacketcore.json" diff --git a/specification/mongocluster/DocumentDB.MongoCluster.Management/FirewallRule.tsp b/specification/mongocluster/DocumentDB.MongoCluster.Management/FirewallRule.tsp index 924d19397e63..441a21449bfe 100644 --- a/specification/mongocluster/DocumentDB.MongoCluster.Management/FirewallRule.tsp +++ b/specification/mongocluster/DocumentDB.MongoCluster.Management/FirewallRule.tsp @@ -51,5 +51,5 @@ interface FirewallRules { /** Deletes a mongo cluster firewall rule. */ delete is ArmResourceDeleteWithoutOkAsync; /** List all the firewall rules in a given mongo cluster. */ - listByParent is ArmResourceListByParent; + listByMongoCluster is ArmResourceListByParent; } diff --git a/specification/mongocluster/DocumentDB.MongoCluster.Management/MongoCluster.tsp b/specification/mongocluster/DocumentDB.MongoCluster.Management/MongoCluster.tsp index e024ef88aa50..36958d551ef4 100644 --- a/specification/mongocluster/DocumentDB.MongoCluster.Management/MongoCluster.tsp +++ b/specification/mongocluster/DocumentDB.MongoCluster.Management/MongoCluster.tsp @@ -33,7 +33,13 @@ interface MongoClusters { LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; /** Updates an existing mongo cluster. The request body can contain one to many of the properties present in the normal mongo cluster definition. */ - update is ArmResourcePatchAsync; + update is ArmCustomPatchAsync< + MongoCluster, + Azure.ResourceManager.Foundations.ResourceUpdateModel< + MongoCluster, + MongoClusterProperties + > + >; /** Deletes a mongo cluster. */ delete is ArmResourceDeleteWithoutOkAsync; /** List all the mongo clusters in a given resource group. */ diff --git a/specification/mongocluster/DocumentDB.MongoCluster.Management/PrivateEndpointConnection.tsp b/specification/mongocluster/DocumentDB.MongoCluster.Management/PrivateEndpointConnection.tsp index 68df9614f342..fef2a5670502 100644 --- a/specification/mongocluster/DocumentDB.MongoCluster.Management/PrivateEndpointConnection.tsp +++ b/specification/mongocluster/DocumentDB.MongoCluster.Management/PrivateEndpointConnection.tsp @@ -13,7 +13,7 @@ model PrivateEndpointConnectionResource @armResourceOperations(PrivateEndpointConnectionResource) interface PrivateEndpointConnections { /** List existing private connections */ - listConnections is ArmResourceListByParent; + listByMongoCluster is ArmResourceListByParent; /** Get a specific private connection */ get is ArmResourceRead; /** Create a Private endpoint connection */ @@ -41,5 +41,5 @@ model PrivateLinkResource is ProxyResource { @armResourceOperations(PrivateLinkResource) interface PrivateLinks { /** list private links on the given resource */ - list is ArmResourceListByParent; + listByMongoCluster is ArmResourceListByParent; } diff --git a/specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml b/specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml index 8efab22596a5..b5b2b1e1b6a7 100644 --- a/specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml +++ b/specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml @@ -8,6 +8,9 @@ options: use-read-only-status-schema: true emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/mongoCluster.json" examples-directory: "{project-root}/examples" "@azure-tools/typespec-python": diff --git a/specification/mongocluster/resource-manager/Microsoft.DocumentDB/preview/2024-03-01-preview/mongoCluster.json b/specification/mongocluster/resource-manager/Microsoft.DocumentDB/preview/2024-03-01-preview/mongoCluster.json index ea08773fcbe3..7016ea3efe2e 100644 --- a/specification/mongocluster/resource-manager/Microsoft.DocumentDB/preview/2024-03-01-preview/mongoCluster.json +++ b/specification/mongocluster/resource-manager/Microsoft.DocumentDB/preview/2024-03-01-preview/mongoCluster.json @@ -1438,6 +1438,7 @@ }, "properties": { "$ref": "#/definitions/MongoClusterUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/AzureMonitorWorkspaceCreate.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/AzureMonitorWorkspaceCreate.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/AzureMonitorWorkspaceCreate.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/AzureMonitorWorkspaceCreate.json diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/AzureMonitorWorkspaceDelete.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/AzureMonitorWorkspaceDelete.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/AzureMonitorWorkspaceDelete.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/AzureMonitorWorkspaceDelete.json diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/AzureMonitorWorkspaceGet.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/AzureMonitorWorkspaceGet.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/AzureMonitorWorkspaceGet.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/AzureMonitorWorkspaceGet.json diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/AzureMonitorWorkspaceUpdate.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/AzureMonitorWorkspaceUpdate.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/AzureMonitorWorkspaceUpdate.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/AzureMonitorWorkspaceUpdate.json diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/AzureMonitorWorkspacesListByResourceGroup.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/AzureMonitorWorkspacesListByResourceGroup.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/AzureMonitorWorkspacesListByResourceGroup.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/AzureMonitorWorkspacesListByResourceGroup.json diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/AzureMonitorWorkspacesListBySubscription.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/AzureMonitorWorkspacesListBySubscription.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/AzureMonitorWorkspacesListBySubscription.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/AzureMonitorWorkspacesListBySubscription.json diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/OperationsList.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/OperationsList.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/OperationsList.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/OperationsList.json diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupCreateSyslogs.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupCreateSyslogs.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupCreateSyslogs.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupCreateSyslogs.json diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupCreateSyslogsWithCache.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupCreateSyslogsWithCache.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupCreateSyslogsWithCache.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupCreateSyslogsWithCache.json diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupCreateSyslogsWithNetworking.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupCreateSyslogsWithNetworking.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupCreateSyslogsWithNetworking.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupCreateSyslogsWithNetworking.json diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupCreateUdp.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupCreateUdp.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupCreateUdp.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupCreateUdp.json diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupDelete.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupDelete.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupDelete.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupDelete.json diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupGet.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupGet.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupGet.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupGet.json diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupListByResourceGroup.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupListByResourceGroup.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupListByResourceGroup.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupListByResourceGroup.json diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupListBySubscription.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupListBySubscription.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupListBySubscription.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupListBySubscription.json diff --git a/specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupUpdate.json b/specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupUpdate.json similarity index 100% rename from specification/monitor/Microsoft.Monitor/examples/2023-10-01-preview/PipelineGroupUpdate.json rename to specification/monitor/Microsoft.Monitor.Management/examples/2023-10-01-preview/PipelineGroupUpdate.json diff --git a/specification/monitor/Microsoft.Monitor/main.tsp b/specification/monitor/Microsoft.Monitor.Management/main.tsp similarity index 100% rename from specification/monitor/Microsoft.Monitor/main.tsp rename to specification/monitor/Microsoft.Monitor.Management/main.tsp diff --git a/specification/monitor/Microsoft.Monitor.Management/tspconfig.yaml b/specification/monitor/Microsoft.Monitor.Management/tspconfig.yaml new file mode 100644 index 000000000000..c20e339177b6 --- /dev/null +++ b/specification/monitor/Microsoft.Monitor.Management/tspconfig.yaml @@ -0,0 +1,16 @@ +emit: + - "@azure-tools/typespec-autorest" +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" +options: + "@azure-tools/typespec-autorest": + use-read-only-status-schema: true + azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true + emitter-output-dir: "{project-root}/.." + examples-directory: "examples" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/azuremonitor.json" + new-line: lf diff --git a/specification/monitor/Microsoft.Monitor/typespec/azureMonitorWorkspace.tsp b/specification/monitor/Microsoft.Monitor.Management/typespec/azureMonitorWorkspace.tsp similarity index 95% rename from specification/monitor/Microsoft.Monitor/typespec/azureMonitorWorkspace.tsp rename to specification/monitor/Microsoft.Monitor.Management/typespec/azureMonitorWorkspace.tsp index d02420de7cfc..8c5fdd256459 100644 --- a/specification/monitor/Microsoft.Monitor/typespec/azureMonitorWorkspace.tsp +++ b/specification/monitor/Microsoft.Monitor.Management/typespec/azureMonitorWorkspace.tsp @@ -95,9 +95,12 @@ interface AzureMonitorWorkspaces { LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; @doc("Updates part of a workspace") - update is ArmResourcePatchSync< + update is ArmCustomPatchSync< AzureMonitorWorkspace, - AzureMonitorWorkspaceProperties + Azure.ResourceManager.Foundations.ResourceUpdateModel< + AzureMonitorWorkspace, + AzureMonitorWorkspaceProperties + > >; @doc("Delete a workspace") delete is ArmResourceDeleteWithoutOkAsync; diff --git a/specification/monitor/Microsoft.Monitor/typespec/exporters/AzureMonitorWorkspaceLogs.tsp b/specification/monitor/Microsoft.Monitor.Management/typespec/exporters/AzureMonitorWorkspaceLogs.tsp similarity index 100% rename from specification/monitor/Microsoft.Monitor/typespec/exporters/AzureMonitorWorkspaceLogs.tsp rename to specification/monitor/Microsoft.Monitor.Management/typespec/exporters/AzureMonitorWorkspaceLogs.tsp diff --git a/specification/monitor/Microsoft.Monitor/typespec/exporters/TcpExporters.tsp b/specification/monitor/Microsoft.Monitor.Management/typespec/exporters/TcpExporters.tsp similarity index 100% rename from specification/monitor/Microsoft.Monitor/typespec/exporters/TcpExporters.tsp rename to specification/monitor/Microsoft.Monitor.Management/typespec/exporters/TcpExporters.tsp diff --git a/specification/monitor/Microsoft.Monitor/typespec/pipelineGroup.tsp b/specification/monitor/Microsoft.Monitor.Management/typespec/pipelineGroup.tsp similarity index 97% rename from specification/monitor/Microsoft.Monitor/typespec/pipelineGroup.tsp rename to specification/monitor/Microsoft.Monitor.Management/typespec/pipelineGroup.tsp index 0ceb17c19270..1f2013076a96 100644 --- a/specification/monitor/Microsoft.Monitor/typespec/pipelineGroup.tsp +++ b/specification/monitor/Microsoft.Monitor.Management/typespec/pipelineGroup.tsp @@ -257,7 +257,13 @@ interface PipelineGroups { delete is ArmResourceDeleteWithoutOkAsync; @doc("Updates a pipeline group instance") - update is ArmResourcePatchAsync; + update is ArmCustomPatchAsync< + PipelineGroup, + Azure.ResourceManager.Foundations.ResourceUpdateModel< + PipelineGroup, + PipelineGroupProperties + > + >; @doc("Lists all workspaces in the specified resource group") listByResourceGroup is ArmResourceListByParent; diff --git a/specification/monitor/Microsoft.Monitor/typespec/processors/BatchProcessor.tsp b/specification/monitor/Microsoft.Monitor.Management/typespec/processors/BatchProcessor.tsp similarity index 100% rename from specification/monitor/Microsoft.Monitor/typespec/processors/BatchProcessor.tsp rename to specification/monitor/Microsoft.Monitor.Management/typespec/processors/BatchProcessor.tsp diff --git a/specification/monitor/Microsoft.Monitor/typespec/receivers/OtlpReceiver.tsp b/specification/monitor/Microsoft.Monitor.Management/typespec/receivers/OtlpReceiver.tsp similarity index 100% rename from specification/monitor/Microsoft.Monitor/typespec/receivers/OtlpReceiver.tsp rename to specification/monitor/Microsoft.Monitor.Management/typespec/receivers/OtlpReceiver.tsp diff --git a/specification/monitor/Microsoft.Monitor/typespec/receivers/SyslogReceiver.tsp b/specification/monitor/Microsoft.Monitor.Management/typespec/receivers/SyslogReceiver.tsp similarity index 100% rename from specification/monitor/Microsoft.Monitor/typespec/receivers/SyslogReceiver.tsp rename to specification/monitor/Microsoft.Monitor.Management/typespec/receivers/SyslogReceiver.tsp diff --git a/specification/monitor/Microsoft.Monitor/typespec/receivers/TcpReceivers.tsp b/specification/monitor/Microsoft.Monitor.Management/typespec/receivers/TcpReceivers.tsp similarity index 100% rename from specification/monitor/Microsoft.Monitor/typespec/receivers/TcpReceivers.tsp rename to specification/monitor/Microsoft.Monitor.Management/typespec/receivers/TcpReceivers.tsp diff --git a/specification/monitor/Microsoft.Monitor/typespec/service.tsp b/specification/monitor/Microsoft.Monitor.Management/typespec/service.tsp similarity index 100% rename from specification/monitor/Microsoft.Monitor/typespec/service.tsp rename to specification/monitor/Microsoft.Monitor.Management/typespec/service.tsp diff --git a/specification/monitor/Microsoft.Monitor/tspconfig.yaml b/specification/monitor/Microsoft.Monitor/tspconfig.yaml deleted file mode 100644 index 6ae6d2d8b91e..000000000000 --- a/specification/monitor/Microsoft.Monitor/tspconfig.yaml +++ /dev/null @@ -1,13 +0,0 @@ -emit: - - "@azure-tools/typespec-autorest" -linter: - extends: - - "@azure-tools/typespec-azure-rulesets/resource-manager" -options: - "@azure-tools/typespec-autorest": - use-read-only-status-schema: true - azure-resource-provider-folder: "resource-manager" - emitter-output-dir: "{project-root}/.." - examples-directory: "examples" - output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/azuremonitor.json" - new-line: lf diff --git a/specification/monitor/resource-manager/Microsoft.Monitor/preview/2023-10-01-preview/azuremonitor.json b/specification/monitor/resource-manager/Microsoft.Monitor/preview/2023-10-01-preview/azuremonitor.json index 9692991c5239..2b8a864c6f9c 100644 --- a/specification/monitor/resource-manager/Microsoft.Monitor/preview/2023-10-01-preview/azuremonitor.json +++ b/specification/monitor/resource-manager/Microsoft.Monitor/preview/2023-10-01-preview/azuremonitor.json @@ -881,6 +881,7 @@ }, "properties": { "$ref": "#/definitions/AzureMonitorWorkspaceUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } @@ -1344,6 +1345,7 @@ }, "properties": { "$ref": "#/definitions/PipelineGroupUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } diff --git a/specification/mpcnetworkfunction/MpcNetworkFunction.Management/tspconfig.yaml b/specification/mpcnetworkfunction/MpcNetworkFunction.Management/tspconfig.yaml index e8e45e0c419f..d520acfa5dd8 100644 --- a/specification/mpcnetworkfunction/MpcNetworkFunction.Management/tspconfig.yaml +++ b/specification/mpcnetworkfunction/MpcNetworkFunction.Management/tspconfig.yaml @@ -8,6 +8,9 @@ linter: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true emitter-output-dir: "{project-root}/.." examples-directory: "examples" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/networkfunction.json" diff --git a/specification/mysql/resource-manager/readme.md b/specification/mysql/resource-manager/readme.md index 394e79d024c1..08200b9f581c 100644 --- a/specification/mysql/resource-manager/readme.md +++ b/specification/mysql/resource-manager/readme.md @@ -500,7 +500,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-python-track2 + - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Accounts_ChangeKeyVault.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Accounts_ChangeKeyVault.json new file mode 100644 index 000000000000..7ad85b7bd494 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Accounts_ChangeKeyVault.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-03-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-03-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Accounts_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Accounts_CreateOrUpdate.json new file mode 100644 index 000000000000..46edf29ca342 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Accounts_CreateOrUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-03-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-03-01-preview/examples/Accounts_CreateOrUpdateAD.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Accounts_CreateOrUpdateAD.json new file mode 100644 index 000000000000..da0dfdcca14b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Accounts_CreateOrUpdateAD.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-03-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-03-01-preview/examples/Accounts_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Accounts_Delete.json new file mode 100644 index 000000000000..80f2558a3f40 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Accounts_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-03-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-03-01-preview&operationResultResponseType=Location" + } + }, + "204": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Accounts_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Accounts_Get.json new file mode 100644 index 000000000000..a91d1b3bb302 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Accounts_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-03-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-03-01-preview/examples/Accounts_GetChangeKeyVaultInformation.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Accounts_GetChangeKeyVaultInformation.json new file mode 100644 index 000000000000..c97d9f45cc99 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Accounts_GetChangeKeyVaultInformation.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-03-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-03-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Accounts_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Accounts_List.json new file mode 100644 index 000000000000..3dd97c14ab24 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Accounts_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "api-version": "2024-03-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-03-01-preview/examples/Accounts_MigrateEncryptionKey.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Accounts_MigrateEncryptionKey.json new file mode 100644 index 000000000000..6bc8faa8a839 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Accounts_MigrateEncryptionKey.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-03-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-03-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-03-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Accounts_RenewCredentials.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Accounts_RenewCredentials.json new file mode 100644 index 000000000000..5aefd0b09a37 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Accounts_RenewCredentials.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-03-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-03-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Accounts_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Accounts_Update.json new file mode 100644 index 000000000000..90b0819c378b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Accounts_Update.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-03-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-03-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-03-01-preview/examples/BackupPolicies_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/BackupPolicies_Create.json new file mode 100644 index 000000000000..03bb6b39c1b2 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/BackupPolicies_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/BackupPolicies_Delete.json new file mode 100644 index 000000000000..c48183e3d597 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/BackupPolicies_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/BackupPolicies_Get.json new file mode 100644 index 000000000000..e88286aeadf8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/BackupPolicies_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/BackupPolicies_List.json new file mode 100644 index 000000000000..415a0928340c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/BackupPolicies_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-03-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-03-01-preview/examples/BackupPolicies_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/BackupPolicies_Update.json new file mode 100644 index 000000000000..0be1ea3da247 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-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-03-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-03-01-preview/examples/BackupVaults_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/BackupVaults_Create.json new file mode 100644 index 000000000000..53b934ee6273 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/BackupVaults_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/BackupVaults_Delete.json new file mode 100644 index 000000000000..828a804c70ee --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-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-03-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/BackupVaults_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/BackupVaults_Get.json new file mode 100644 index 000000000000..edae9e1d7c36 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/BackupVaults_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/BackupVaults_List.json new file mode 100644 index 000000000000..19b41b47de42 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/BackupVaults_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-03-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-03-01-preview/examples/BackupVaults_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/BackupVaults_Update.json new file mode 100644 index 000000000000..26cb4a89d99c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-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-03-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-03-01-preview/examples/BackupsUnderAccount_Migrate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/BackupsUnderAccount_Migrate.json new file mode 100644 index 000000000000..6b31bd0f8fc9 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/BackupsUnderAccount_Migrate.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-03-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-03-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-03-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/BackupsUnderBackupVault_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/BackupsUnderBackupVault_Create.json new file mode 100644 index 000000000000..b39a72cfa638 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/BackupsUnderBackupVault_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/BackupsUnderBackupVault_Delete.json new file mode 100644 index 000000000000..44ee6ac49272 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-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-03-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/BackupsUnderBackupVault_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/BackupsUnderBackupVault_Get.json new file mode 100644 index 000000000000..6c1f45a1d14b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/BackupsUnderBackupVault_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/BackupsUnderBackupVault_List.json new file mode 100644 index 000000000000..7dc1bf3630c9 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/BackupsUnderBackupVault_SingleFileRestore.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/BackupsUnderBackupVault_SingleFileRestore.json new file mode 100644 index 000000000000..967db7c3664b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/BackupsUnderBackupVault_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/BackupsUnderBackupVault_Update.json new file mode 100644 index 000000000000..d56a02d9c469 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-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-03-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-03-01-preview/examples/BackupsUnderVolume_Migrate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/BackupsUnderVolume_Migrate.json new file mode 100644 index 000000000000..fdf065fb717d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-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-03-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/CheckFilePathAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/CheckFilePathAvailability.json new file mode 100644 index 000000000000..a117b1de963f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/CheckFilePathAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-03-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-03-01-preview/examples/CheckNameAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..2538b3298f67 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/CheckNameAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-03-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-03-01-preview/examples/CheckQuotaAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/CheckQuotaAvailability.json new file mode 100644 index 000000000000..12826d01329d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/CheckQuotaAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-03-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-03-01-preview/examples/GroupIdListForLDAPUser.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/GroupIdListForLDAPUser.json new file mode 100644 index 000000000000..dbfe79d7e516 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-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-03-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/NetworkSiblingSet_Query.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/NetworkSiblingSet_Query.json new file mode 100644 index 000000000000..2fe1ce5304d2 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/NetworkSiblingSet_Query.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-03-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-03-01-preview/examples/NetworkSiblingSet_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/NetworkSiblingSet_Update.json new file mode 100644 index 000000000000..bc1739aba3b2 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/NetworkSiblingSet_Update.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-03-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-03-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/OperationList.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/OperationList.json new file mode 100644 index 000000000000..380e37ec0431 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/OperationList.json @@ -0,0 +1,1565 @@ +{ + "parameters": { + "api-version": "2024-03-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-03-01-preview/examples/Pools_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Pools_CreateOrUpdate.json new file mode 100644 index 000000000000..5d0c86267f4a --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/Pools_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Pools_Delete.json new file mode 100644 index 000000000000..d8b84b71f46d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Pools_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Pools_Get.json new file mode 100644 index 000000000000..0724aa4f26aa --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/Pools_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Pools_List.json new file mode 100644 index 000000000000..fe4b3e5425ee --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Pools_List.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-03-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 + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Pools_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Pools_Update.json new file mode 100644 index 000000000000..682b5b531d3b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/QuotaLimits_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/QuotaLimits_Get.json new file mode 100644 index 000000000000..0e9a8043be76 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/QuotaLimits_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "quotaLimitName": "totalCoolAccessVolumesPerSubscription", + "api-version": "2024-03-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-03-01-preview/examples/QuotaLimits_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/QuotaLimits_List.json new file mode 100644 index 000000000000..3d7edd9b2539 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/QuotaLimits_List.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-03-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-03-01-preview/examples/RegionInfo.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/RegionInfo.json new file mode 100644 index 000000000000..e34d84df9c46 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/RegionInfo.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-03-01-preview" + }, + "responses": { + "200": { + "body": { + "storageToNetworkProximity": "T2", + "availabilityZoneMappings": [ + { + "availabilityZone": "1", + "isAvailable": true + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/RegionInfos_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/RegionInfos_Get.json new file mode 100644 index 000000000000..f94f2e146067 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/RegionInfos_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-03-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-03-01-preview/examples/RegionInfos_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/RegionInfos_List.json new file mode 100644 index 000000000000..87eacaf26250 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/RegionInfos_List.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-03-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-03-01-preview/examples/SnapshotPolicies_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/SnapshotPolicies_Create.json new file mode 100644 index 000000000000..459131dd1f12 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/SnapshotPolicies_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/SnapshotPolicies_Delete.json new file mode 100644 index 000000000000..69c57bd54485 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/SnapshotPolicies_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/SnapshotPolicies_Get.json new file mode 100644 index 000000000000..923b934443ac --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/SnapshotPolicies_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/SnapshotPolicies_List.json new file mode 100644 index 000000000000..8dac4cb8dc63 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/SnapshotPolicies_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-03-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-03-01-preview/examples/SnapshotPolicies_ListVolumes.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/SnapshotPolicies_ListVolumes.json new file mode 100644 index 000000000000..560b9f3a4561 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/SnapshotPolicies_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/SnapshotPolicies_Update.json new file mode 100644 index 000000000000..d487355f80b3 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-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-03-01-preview/examples/Snapshots_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Snapshots_Create.json new file mode 100644 index 000000000000..805789b42100 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/Snapshots_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Snapshots_Delete.json new file mode 100644 index 000000000000..ed216e1df55c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Snapshots_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Snapshots_Get.json new file mode 100644 index 000000000000..92cfbd0b2574 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/Snapshots_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Snapshots_List.json new file mode 100644 index 000000000000..daed5ac9d406 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/Snapshots_SingleFileRestore.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Snapshots_SingleFileRestore.json new file mode 100644 index 000000000000..7f998c40865e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Snapshots_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Snapshots_Update.json new file mode 100644 index 000000000000..42d98148b864 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Subvolumes_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Subvolumes_Create.json new file mode 100644 index 000000000000..17d65bff30ce --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/Subvolumes_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Subvolumes_Delete.json new file mode 100644 index 000000000000..25be1d58bafa --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Subvolumes_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Subvolumes_Get.json new file mode 100644 index 000000000000..c8d043d8c2e2 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/Subvolumes_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Subvolumes_List.json new file mode 100644 index 000000000000..ddd0d74f71be --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/Subvolumes_Metadata.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Subvolumes_Metadata.json new file mode 100644 index 000000000000..4f77bcc5fa8e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Subvolumes_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Subvolumes_Update.json new file mode 100644 index 000000000000..d94fa3e39ea2 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/VolumeGroups_Create_Oracle.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/VolumeGroups_Create_Oracle.json new file mode 100644 index 000000000000..c59876432de6 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/VolumeGroups_Create_SapHana.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/VolumeGroups_Create_SapHana.json new file mode 100644 index 000000000000..e030326a8f37 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/VolumeGroups_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/VolumeGroups_Delete.json new file mode 100644 index 000000000000..1f828a12ea6b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/VolumeGroups_Get_Oracle.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/VolumeGroups_Get_Oracle.json new file mode 100644 index 000000000000..c145884c4bb3 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/VolumeGroups_Get_SapHana.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/VolumeGroups_Get_SapHana.json new file mode 100644 index 000000000000..b12771461f92 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/VolumeGroups_List_Oracle.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/VolumeGroups_List_Oracle.json new file mode 100644 index 000000000000..4f35fe338724 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/VolumeGroups_List_SapHana.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/VolumeGroups_List_SapHana.json new file mode 100644 index 000000000000..962ff4247d9e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/VolumeQuotaRules_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/VolumeQuotaRules_Create.json new file mode 100644 index 000000000000..99d0b7ec9baf --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-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-03-01-preview/examples/VolumeQuotaRules_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/VolumeQuotaRules_Delete.json new file mode 100644 index 000000000000..219ac0aacfbf --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/VolumeQuotaRules_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/VolumeQuotaRules_Get.json new file mode 100644 index 000000000000..be517ffaf270 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/VolumeQuotaRules_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/VolumeQuotaRules_List.json new file mode 100644 index 000000000000..f3e85c5d04c1 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/VolumeQuotaRules_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/VolumeQuotaRules_Update.json new file mode 100644 index 000000000000..c6a307c38c30 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_AuthorizeExternalReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_AuthorizeExternalReplication.json new file mode 100644 index 000000000000..0b6b72f79251 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-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-03-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_AuthorizeReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_AuthorizeReplication.json new file mode 100644 index 000000000000..34cf7b61e7be --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_BreakFileLocks.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_BreakFileLocks.json new file mode 100644 index 000000000000..d59326c3e5c6 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_BreakReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_BreakReplication.json new file mode 100644 index 000000000000..c3f4a1e03aa9 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_CreateOrUpdate.json new file mode 100644 index 000000000000..4a10a7615779 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/Volumes_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_Delete.json new file mode 100644 index 000000000000..eb1d3fa60ce3 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_DeleteReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_DeleteReplication.json new file mode 100644 index 000000000000..fb132558bba0 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_FinalizeExternalReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_FinalizeExternalReplication.json new file mode 100644 index 000000000000..b62059cbb73e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_FinalizeRelocation.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_FinalizeRelocation.json new file mode 100644 index 000000000000..1d171e4de21a --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/Volumes_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_Get.json new file mode 100644 index 000000000000..140d2567628d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/Volumes_LatestBackupStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_LatestBackupStatus.json new file mode 100644 index 000000000000..8a4541a56d93 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/Volumes_LatestRestoreStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_LatestRestoreStatus.json new file mode 100644 index 000000000000..74749e35649b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/Volumes_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_List.json new file mode 100644 index 000000000000..62116e5876cd --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/Volumes_ListQuotaReport.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_ListQuotaReport.json new file mode 100644 index 000000000000..7ad8b99b2b5c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-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-03-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_ListReplications.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_ListReplications.json new file mode 100644 index 000000000000..11c56bc556e9 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/Volumes_PeerExternalCluster.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_PeerExternalCluster.json new file mode 100644 index 000000000000..b51fd88097f8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-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-03-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_PerformReplicationTransfer.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_PerformReplicationTransfer.json new file mode 100644 index 000000000000..5469795b11d2 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_PoolChange.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_PoolChange.json new file mode 100644 index 000000000000..d3ab3d940ade --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_PopulateAvailabilityZones.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_PopulateAvailabilityZones.json new file mode 100644 index 000000000000..8efc2280b01b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_ReInitializeReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_ReInitializeReplication.json new file mode 100644 index 000000000000..fb132558bba0 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_ReestablishReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_ReestablishReplication.json new file mode 100644 index 000000000000..346549ca1bd8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_Relocate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_Relocate.json new file mode 100644 index 000000000000..7c7aa98a7844 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_ReplicationStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_ReplicationStatus.json new file mode 100644 index 000000000000..1786d655c091 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview/examples/Volumes_ResetCifsPassword.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_ResetCifsPassword.json new file mode 100644 index 000000000000..5469795b11d2 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_ResyncReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_ResyncReplication.json new file mode 100644 index 000000000000..fb132558bba0 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_Revert.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_Revert.json new file mode 100644 index 000000000000..a92149aecf08 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_RevertRelocation.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_RevertRelocation.json new file mode 100644 index 000000000000..fb132558bba0 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_SplitClone.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_SplitClone.json new file mode 100644 index 000000000000..b62059cbb73e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/examples/Volumes_Update.json new file mode 100644 index 000000000000..2a7c04599b6f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-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-03-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-03-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/netapp.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/netapp.json new file mode 100644 index 000000000000..1393948bc097 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-03-01-preview/netapp.json @@ -0,0 +1,10651 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft NetApp", + "description": "Microsoft NetApp Azure Resource Provider specification", + "version": "2024-03-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_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}/migrateEncryption": { + "post": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_MigrateEncryptionKey", + "summary": "Migrate volumes encryption key source.", + "description": "Migrates 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 migration.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/encryptionMigrationRequest" + } + } + ], + "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_MigrateEncryptionKey.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 MHSM to Key Vault, Key Vault to MHSM, MHSM to MHSM 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}/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]?)((, ?)(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 addresses 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 + }, + "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", + "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", + "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" + }, + "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" + }, + "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", + "required": [ + "remoteVolumeResourceId" + ], + "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 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" + }, + "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" + } + } + }, + "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 Resource 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" + ], + "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" + } + ] + } + }, + "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 + } + }, + "encryptionMigrationRequest": { + "description": "Encryption migration 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 + } + }, + "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", + "description": "Backup Policy Resource ID" + }, + "policyEnforced": { + "type": "boolean", + "description": "Policy Enforced" + }, + "backupVaultId": { + "type": "string", + "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", + "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", + "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", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/privateIP1" + } + } + }, + "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" + } + } + } + } + }, + "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/Microsoft.NetApp/stable/2024-03-01/examples/Accounts_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Accounts_CreateOrUpdate.json new file mode 100644 index 000000000000..fee14b23d650 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Accounts_CreateOrUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-03-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-03-01/examples/Accounts_CreateOrUpdateAD.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Accounts_CreateOrUpdateAD.json new file mode 100644 index 000000000000..e9025d495ca5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Accounts_CreateOrUpdateAD.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-03-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-03-01/examples/Accounts_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Accounts_Delete.json new file mode 100644 index 000000000000..d017137a27ef --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Accounts_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-03-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-03-01&operationResultResponseType=Location" + } + }, + "204": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Accounts_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Accounts_Get.json new file mode 100644 index 000000000000..ef6555b626d4 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Accounts_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-03-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-03-01/examples/Accounts_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Accounts_List.json new file mode 100644 index 000000000000..e019a58d2faa --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Accounts_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "api-version": "2024-03-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-03-01/examples/Accounts_RenewCredentials.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Accounts_RenewCredentials.json new file mode 100644 index 000000000000..cbc1f21f7311 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Accounts_RenewCredentials.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-03-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-03-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Accounts_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Accounts_Update.json new file mode 100644 index 000000000000..947641319efc --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Accounts_Update.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-03-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-03-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-03-01/examples/BackupPolicies_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/BackupPolicies_Create.json new file mode 100644 index 000000000000..b32cb0ae5b15 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/BackupPolicies_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/BackupPolicies_Delete.json new file mode 100644 index 000000000000..0b8ed4d043e5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/BackupPolicies_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/BackupPolicies_Get.json new file mode 100644 index 000000000000..fa6c15105b0d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/BackupPolicies_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/BackupPolicies_List.json new file mode 100644 index 000000000000..0974a7c31e30 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/BackupPolicies_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-03-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-03-01/examples/BackupPolicies_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/BackupPolicies_Update.json new file mode 100644 index 000000000000..ca9b41dc0139 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-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-03-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-03-01/examples/BackupVaults_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/BackupVaults_Create.json new file mode 100644 index 000000000000..68bebdb7c37f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/BackupVaults_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/BackupVaults_Delete.json new file mode 100644 index 000000000000..2c0cd98a20d2 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-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-03-01" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/BackupVaults_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/BackupVaults_Get.json new file mode 100644 index 000000000000..3ec22aab43f6 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/BackupVaults_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/BackupVaults_List.json new file mode 100644 index 000000000000..5cad0df0e9ec --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/BackupVaults_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-03-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-03-01/examples/BackupVaults_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/BackupVaults_Update.json new file mode 100644 index 000000000000..7ef3e9d705c5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-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-03-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-03-01/examples/BackupsUnderAccount_Migrate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/BackupsUnderAccount_Migrate.json new file mode 100644 index 000000000000..c6616d2d682d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/BackupsUnderAccount_Migrate.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-03-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-03-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-03-01" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/BackupsUnderBackupVault_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/BackupsUnderBackupVault_Create.json new file mode 100644 index 000000000000..fa4bb458d0bd --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/BackupsUnderBackupVault_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/BackupsUnderBackupVault_Delete.json new file mode 100644 index 000000000000..323f374484f0 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-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-03-01" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/BackupsUnderBackupVault_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/BackupsUnderBackupVault_Get.json new file mode 100644 index 000000000000..5a1855b8c4b7 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/BackupsUnderBackupVault_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/BackupsUnderBackupVault_List.json new file mode 100644 index 000000000000..bdb4477e2e47 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/BackupsUnderBackupVault_SingleFileRestore.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/BackupsUnderBackupVault_SingleFileRestore.json new file mode 100644 index 000000000000..85a5a87322bd --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/BackupsUnderBackupVault_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/BackupsUnderBackupVault_Update.json new file mode 100644 index 000000000000..1837a2cf3e52 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-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-03-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-03-01/examples/BackupsUnderVolume_Migrate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/BackupsUnderVolume_Migrate.json new file mode 100644 index 000000000000..24b3996b57b2 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-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-03-01" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/CheckFilePathAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/CheckFilePathAvailability.json new file mode 100644 index 000000000000..6316b1273700 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/CheckFilePathAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-03-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-03-01/examples/CheckNameAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..dd87972e685f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/CheckNameAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-03-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-03-01/examples/CheckQuotaAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/CheckQuotaAvailability.json new file mode 100644 index 000000000000..19bfdb1882b9 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/CheckQuotaAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-03-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-03-01/examples/GroupIdListForLDAPUser.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/GroupIdListForLDAPUser.json new file mode 100644 index 000000000000..c18a4367f83c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-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-03-01" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/NetworkSiblingSet_Query.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/NetworkSiblingSet_Query.json new file mode 100644 index 000000000000..31f62ef19ad4 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/NetworkSiblingSet_Query.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-03-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-03-01/examples/NetworkSiblingSet_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/NetworkSiblingSet_Update.json new file mode 100644 index 000000000000..b5166607c878 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/NetworkSiblingSet_Update.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-03-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-03-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/OperationList.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/OperationList.json new file mode 100644 index 000000000000..cad898835527 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/OperationList.json @@ -0,0 +1,1565 @@ +{ + "parameters": { + "api-version": "2024-03-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-03-01/examples/Pools_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Pools_CreateOrUpdate.json new file mode 100644 index 000000000000..79275c4a56a0 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/Pools_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Pools_Delete.json new file mode 100644 index 000000000000..121b55948a4b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Pools_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Pools_Get.json new file mode 100644 index 000000000000..a8ed0ad5ad53 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/Pools_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Pools_List.json new file mode 100644 index 000000000000..2b29555ad167 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Pools_List.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-03-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 + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Pools_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Pools_Update.json new file mode 100644 index 000000000000..a88552e79634 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/QuotaLimits_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/QuotaLimits_Get.json new file mode 100644 index 000000000000..c372abefc4ce --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/QuotaLimits_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "quotaLimitName": "totalCoolAccessVolumesPerSubscription", + "api-version": "2024-03-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-03-01/examples/QuotaLimits_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/QuotaLimits_List.json new file mode 100644 index 000000000000..530b434f6a48 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/QuotaLimits_List.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-03-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-03-01/examples/RegionInfo.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/RegionInfo.json new file mode 100644 index 000000000000..6b3e4077ee81 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/RegionInfo.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-03-01" + }, + "responses": { + "200": { + "body": { + "storageToNetworkProximity": "T2", + "availabilityZoneMappings": [ + { + "availabilityZone": "1", + "isAvailable": true + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/RegionInfos_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/RegionInfos_Get.json new file mode 100644 index 000000000000..8f175b03c233 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/RegionInfos_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-03-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-03-01/examples/RegionInfos_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/RegionInfos_List.json new file mode 100644 index 000000000000..59ff44ce620a --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/RegionInfos_List.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-03-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-03-01/examples/SnapshotPolicies_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/SnapshotPolicies_Create.json new file mode 100644 index 000000000000..bb6bf9b8c01a --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/SnapshotPolicies_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/SnapshotPolicies_Delete.json new file mode 100644 index 000000000000..81697aaa0109 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/SnapshotPolicies_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/SnapshotPolicies_Get.json new file mode 100644 index 000000000000..b855bcc43a71 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/SnapshotPolicies_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/SnapshotPolicies_List.json new file mode 100644 index 000000000000..a3745a84a766 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/SnapshotPolicies_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-03-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-03-01/examples/SnapshotPolicies_ListVolumes.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/SnapshotPolicies_ListVolumes.json new file mode 100644 index 000000000000..b4580d5ec6cb --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/SnapshotPolicies_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/SnapshotPolicies_Update.json new file mode 100644 index 000000000000..2d65d931e514 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-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-03-01/examples/Snapshots_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Snapshots_Create.json new file mode 100644 index 000000000000..b94236602fab --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/Snapshots_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Snapshots_Delete.json new file mode 100644 index 000000000000..d765831229f2 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Snapshots_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Snapshots_Get.json new file mode 100644 index 000000000000..292be7e049ec --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/Snapshots_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Snapshots_List.json new file mode 100644 index 000000000000..b5b1f57d8493 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/Snapshots_SingleFileRestore.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Snapshots_SingleFileRestore.json new file mode 100644 index 000000000000..e63e0ba45248 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Snapshots_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Snapshots_Update.json new file mode 100644 index 000000000000..64aec5176720 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Subvolumes_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Subvolumes_Create.json new file mode 100644 index 000000000000..f526163d940f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/Subvolumes_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Subvolumes_Delete.json new file mode 100644 index 000000000000..04ddb57eeeb5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Subvolumes_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Subvolumes_Get.json new file mode 100644 index 000000000000..16aee67f96aa --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/Subvolumes_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Subvolumes_List.json new file mode 100644 index 000000000000..346672e2eaf7 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/Subvolumes_Metadata.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Subvolumes_Metadata.json new file mode 100644 index 000000000000..4ec76ae7d8f8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Subvolumes_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Subvolumes_Update.json new file mode 100644 index 000000000000..1f1bf8c915f6 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/VolumeGroups_Create_Oracle.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/VolumeGroups_Create_Oracle.json new file mode 100644 index 000000000000..964b81b753ec --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/VolumeGroups_Create_SapHana.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/VolumeGroups_Create_SapHana.json new file mode 100644 index 000000000000..dad7a3dd7eea --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/VolumeGroups_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/VolumeGroups_Delete.json new file mode 100644 index 000000000000..9abdea79d2ea --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/VolumeGroups_Get_Oracle.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/VolumeGroups_Get_Oracle.json new file mode 100644 index 000000000000..4b784dd7fef0 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/VolumeGroups_Get_SapHana.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/VolumeGroups_Get_SapHana.json new file mode 100644 index 000000000000..2edf6d84d225 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/VolumeGroups_List_Oracle.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/VolumeGroups_List_Oracle.json new file mode 100644 index 000000000000..f49273f233d2 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/VolumeGroups_List_Oracle.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-03-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-03-01/examples/VolumeGroups_List_SapHana.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/VolumeGroups_List_SapHana.json new file mode 100644 index 000000000000..9b332b45ee79 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/VolumeGroups_List_SapHana.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-03-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-03-01/examples/VolumeQuotaRules_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/VolumeQuotaRules_Create.json new file mode 100644 index 000000000000..eca84497534e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-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-03-01/examples/VolumeQuotaRules_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/VolumeQuotaRules_Delete.json new file mode 100644 index 000000000000..48c4459fc71a --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/VolumeQuotaRules_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/VolumeQuotaRules_Get.json new file mode 100644 index 000000000000..aa32a98a6d21 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/VolumeQuotaRules_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/VolumeQuotaRules_List.json new file mode 100644 index 000000000000..2e9d952a9971 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/VolumeQuotaRules_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/VolumeQuotaRules_Update.json new file mode 100644 index 000000000000..59c488ef7ec9 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_AuthorizeReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_AuthorizeReplication.json new file mode 100644 index 000000000000..35f1fdecc26a --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_BreakFileLocks.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_BreakFileLocks.json new file mode 100644 index 000000000000..a836f77e3b7e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_BreakReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_BreakReplication.json new file mode 100644 index 000000000000..a2a8d7afae5f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_CreateOrUpdate.json new file mode 100644 index 000000000000..fee7b7511ad6 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/Volumes_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_Delete.json new file mode 100644 index 000000000000..45c2816900ff --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_DeleteReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_DeleteReplication.json new file mode 100644 index 000000000000..35b29aab6191 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_FinalizeRelocation.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_FinalizeRelocation.json new file mode 100644 index 000000000000..35b29aab6191 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_Get.json new file mode 100644 index 000000000000..95c9e9774ed7 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/Volumes_LatestBackupStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_LatestBackupStatus.json new file mode 100644 index 000000000000..c92b64b399ca --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/Volumes_LatestRestoreStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_LatestRestoreStatus.json new file mode 100644 index 000000000000..a6ae2a7c745b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/Volumes_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_List.json new file mode 100644 index 000000000000..3afeb21c4b8f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/Volumes_ListReplications.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_ListReplications.json new file mode 100644 index 000000000000..ac45a73e1832 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/Volumes_PoolChange.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_PoolChange.json new file mode 100644 index 000000000000..02f50e5d1b30 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_PopulateAvailabilityZones.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_PopulateAvailabilityZones.json new file mode 100644 index 000000000000..2e0cc5907ac1 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_ReInitializeReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_ReInitializeReplication.json new file mode 100644 index 000000000000..35b29aab6191 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_ReestablishReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_ReestablishReplication.json new file mode 100644 index 000000000000..dd43542fabf6 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_Relocate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_Relocate.json new file mode 100644 index 000000000000..577903798490 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_ReplicationStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_ReplicationStatus.json new file mode 100644 index 000000000000..1af0f2d321c9 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01/examples/Volumes_ResetCifsPassword.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_ResetCifsPassword.json new file mode 100644 index 000000000000..cea35e670722 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_ResyncReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_ResyncReplication.json new file mode 100644 index 000000000000..35b29aab6191 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_Revert.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_Revert.json new file mode 100644 index 000000000000..c25285c5909e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_RevertRelocation.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_RevertRelocation.json new file mode 100644 index 000000000000..35b29aab6191 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/examples/Volumes_Update.json new file mode 100644 index 000000000000..cbae7a76f77e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-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-03-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-03-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/netapp.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/netapp.json new file mode 100644 index 000000000000..bb66f155208b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-03-01/netapp.json @@ -0,0 +1,9396 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft NetApp", + "description": "Microsoft NetApp Azure Resource Provider specification", + "version": "2024-03-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}/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}/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" + } + } + }, + "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]?)((, ?)(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 addresses 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", + "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", + "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" + }, + "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" + }, + "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", + "required": [ + "remoteVolumeResourceId" + ], + "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." + }, + "remoteVolumeRegion": { + "type": "string", + "description": "The remote region for the other end of the Volume Replication." + } + } + }, + "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" + }, + "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" + } + } + }, + "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 Resource 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 + } + }, + "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 + } + }, + "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", + "description": "Backup Policy Resource ID" + }, + "policyEnforced": { + "type": "boolean", + "description": "Policy Enforced" + }, + "backupVaultId": { + "type": "string", + "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", + "description": "The ResourceId of the Backup Vault", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1" + } + } + } + }, + "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.go.md b/specification/netapp/resource-manager/readme.go.md index 8741030ff102..815979e023e8 100644 --- a/specification/netapp/resource-manager/readme.go.md +++ b/specification/netapp/resource-manager/readme.go.md @@ -21,6 +21,8 @@ azure-arm: true ``` yaml $(go) && $(multiapi) batch: + - tag: package-2024-03 + - tag: package-preview-2024-03 - tag: package-netapp-2023-11-01 - tag: package-netapp-2023-07-01 - tag: package-preview-2023-05 @@ -55,6 +57,24 @@ batch: - tag: package-2017-08-15 ``` +### Tag: package-2024-03 and go + +These settings apply only when `--tag=package-2024-03 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2024-03' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2024-03-01/$(namespace) +``` + +### Tag: package-preview-2024-03 and go + +These settings apply only when `--tag=package-preview-2024-03 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-preview-2024-03' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2024-03-01-preview/$(namespace) +``` + ### Tag: package-netapp-2023-11-01 and go These settings apply only when `--tag=package-netapp-2023-11-01 --go` is specified on the command line. diff --git a/specification/netapp/resource-manager/readme.java.md b/specification/netapp/resource-manager/readme.java.md index 98db1ad58f44..01daf2a6dd57 100644 --- a/specification/netapp/resource-manager/readme.java.md +++ b/specification/netapp/resource-manager/readme.java.md @@ -18,6 +18,8 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-netapp ``` yaml $(java) && $(multiapi) batch: + - tag: package-2024-03-01 + - tag: package-preview-2024-03 - tag: package-netapp-2023-11-01 - tag: package-netapp-2023-07-01 - tag: package-preview-2023-05 @@ -52,6 +54,32 @@ batch: - tag: package-2017-08-15 ``` +### Tag: package-2024-03-01 and java + +These settings apply only when `--tag=package-2024-03-01 --java` is specified on the command line. +Please also specify the `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2024-03-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.netapp.v2024_03_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/netapp/mgmt-v2024_03_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-preview-2024-03 and java + +These settings apply only when `--tag=package-preview-2024-03 --java` is specified on the command line. +Please also specify the `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-preview-2024-03' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.netapp.v2024_03_01_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/netapp/mgmt-v2024_03_01_preview +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-netapp-2023-11-01 and java These settings apply only when `--tag=package-netapp-2023-11-01 --java` is specified on the command line. diff --git a/specification/netapp/resource-manager/readme.md b/specification/netapp/resource-manager/readme.md index 7034493e594a..61cfa7a5a285 100644 --- a/specification/netapp/resource-manager/readme.md +++ b/specification/netapp/resource-manager/readme.md @@ -28,7 +28,25 @@ 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-preview-2023-11 +tag: package-2024-03 +``` + +### Tag: package-2024-03 + +These settings apply only when `--tag=package-2024-03` is specified on the command line. + +```yaml $(tag) == 'package-2024-03' +input-file: + - Microsoft.NetApp/stable/2024-03-01/netapp.json +``` + +### Tag: package-preview-2024-03 + +These settings apply only when `--tag=package-preview-2024-03` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-03' +input-file: + - Microsoft.NetApp/preview/2024-03-01-preview/netapp.json ``` ### Tag: package-preview-2023-11 @@ -48,7 +66,6 @@ These settings apply only when `--tag=package-netapp-2023-11-01` is specified on input-file: - Microsoft.NetApp/stable/2023-11-01/netapp.json ``` -### Tag: package-netapp-2023-07-01 ### Tag: package-preview-2023-07 @@ -58,6 +75,7 @@ These settings apply only when `--tag=package-preview-2023-07` is specified on t input-file: - Microsoft.NetApp/preview/2023-07-01-preview/netapp.json ``` + ### Tag: package-netapp-2023-07-01 These settings apply only when `--tag=package-netapp-2023-07-01` is specified on the command line. @@ -74,7 +92,6 @@ These settings apply only when `--tag=package-preview-2023-05` is specified on t ``` yaml $(tag) == 'package-preview-2023-05' input-file: - Microsoft.NetApp/preview/2023-05-01-preview/netapp.json -tag: package-preview-2023-11 ``` ### Tag: package-netapp-2023-05-01 diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/GetApplicationGatewayWafDynamicManifests.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/GetApplicationGatewayWafDynamicManifests.json index d43626f03a9e..079cb03335f1 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/GetApplicationGatewayWafDynamicManifests.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/GetApplicationGatewayWafDynamicManifests.json @@ -1,7 +1,7 @@ { "parameters": { "location": "westus", - "api-version": "2021-05-01", + "api-version": "2023-06-01", "subscriptionId": "subid" }, "responses": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/GetApplicationGatewayWafDynamicManifestsDefault.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/GetApplicationGatewayWafDynamicManifestsDefault.json index 1cc8e34e1230..05ffbeb32811 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/GetApplicationGatewayWafDynamicManifestsDefault.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/examples/GetApplicationGatewayWafDynamicManifestsDefault.json @@ -1,7 +1,7 @@ { "parameters": { "location": "westus", - "api-version": "2021-05-01", + "api-version": "2023-06-01", "subscriptionId": "subid" }, "responses": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/GetApplicationGatewayWafDynamicManifests.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/GetApplicationGatewayWafDynamicManifests.json index d43626f03a9e..4a50b20dc34d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/GetApplicationGatewayWafDynamicManifests.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/GetApplicationGatewayWafDynamicManifests.json @@ -1,7 +1,7 @@ { "parameters": { "location": "westus", - "api-version": "2021-05-01", + "api-version": "2023-09-01", "subscriptionId": "subid" }, "responses": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/GetApplicationGatewayWafDynamicManifestsDefault.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/GetApplicationGatewayWafDynamicManifestsDefault.json index 1cc8e34e1230..ab9f2e39eb66 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/GetApplicationGatewayWafDynamicManifestsDefault.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/GetApplicationGatewayWafDynamicManifestsDefault.json @@ -1,7 +1,7 @@ { "parameters": { "location": "westus", - "api-version": "2021-05-01", + "api-version": "2023-09-01", "subscriptionId": "subid" }, "responses": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/GetApplicationGatewayWafDynamicManifests.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/GetApplicationGatewayWafDynamicManifests.json index d43626f03a9e..ed6a00181d90 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/GetApplicationGatewayWafDynamicManifests.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/GetApplicationGatewayWafDynamicManifests.json @@ -1,7 +1,7 @@ { "parameters": { "location": "westus", - "api-version": "2021-05-01", + "api-version": "2023-11-01", "subscriptionId": "subid" }, "responses": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/GetApplicationGatewayWafDynamicManifestsDefault.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/GetApplicationGatewayWafDynamicManifestsDefault.json index 1cc8e34e1230..0afde7a90d1c 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/GetApplicationGatewayWafDynamicManifestsDefault.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/GetApplicationGatewayWafDynamicManifestsDefault.json @@ -1,7 +1,7 @@ { "parameters": { "location": "westus", - "api-version": "2021-05-01", + "api-version": "2023-11-01", "subscriptionId": "subid" }, "responses": { diff --git a/specification/networkanalytics/NetworkAnalytics.Management/main.tsp b/specification/networkanalytics/NetworkAnalytics.Management/main.tsp index 36853645c013..5eee7314f3be 100644 --- a/specification/networkanalytics/NetworkAnalytics.Management/main.tsp +++ b/specification/networkanalytics/NetworkAnalytics.Management/main.tsp @@ -543,7 +543,13 @@ interface DataTypes { get is ArmResourceRead; @doc("Update data type resource.") - update is ArmResourcePatchAsync; + update is ArmCustomPatchAsync< + DataType, + Azure.ResourceManager.Foundations.ResourceUpdateModel< + DataType, + DataTypeProperties + > + >; @doc("Delete data type resource.") delete is ArmResourceDeleteWithoutOkAsync; @@ -560,7 +566,7 @@ interface DataTypes { >; @doc("List data type by parent resource.") - listByParent is ArmResourceListByParent; + listByDataProduct is ArmResourceListByParent; } @doc("Operations on data product resource.") @@ -579,7 +585,13 @@ interface DataProducts { get is ArmResourceRead; @doc("Update data product resource.") - update is ArmResourcePatchAsync; + update is ArmCustomPatchAsync< + DataProduct, + Azure.ResourceManager.Foundations.ResourceUpdateModel< + DataProduct, + DataProductProperties + > + >; @doc("Delete data product resource.") delete is ArmResourceDeleteWithoutOkAsync; diff --git a/specification/networkanalytics/NetworkAnalytics.Management/tspconfig.yaml b/specification/networkanalytics/NetworkAnalytics.Management/tspconfig.yaml index 16afa526957d..58a836335be3 100644 --- a/specification/networkanalytics/NetworkAnalytics.Management/tspconfig.yaml +++ b/specification/networkanalytics/NetworkAnalytics.Management/tspconfig.yaml @@ -9,6 +9,9 @@ options: "@azure-tools/typespec-autorest": emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/networkanalytics.json" examples-directory: "{project-root}/examples" "@azure-tools/cadl-python": diff --git a/specification/networkanalytics/resource-manager/Microsoft.NetworkAnalytics/stable/2023-11-15/networkanalytics.json b/specification/networkanalytics/resource-manager/Microsoft.NetworkAnalytics/stable/2023-11-15/networkanalytics.json index d4505aa801b0..e88241621228 100644 --- a/specification/networkanalytics/resource-manager/Microsoft.NetworkAnalytics/stable/2023-11-15/networkanalytics.json +++ b/specification/networkanalytics/resource-manager/Microsoft.NetworkAnalytics/stable/2023-11-15/networkanalytics.json @@ -1885,6 +1885,7 @@ }, "properties": { "$ref": "#/definitions/DataProductUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } @@ -2165,6 +2166,7 @@ "properties": { "properties": { "$ref": "#/definitions/DataTypeUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } diff --git a/specification/oracle/Oracle.Database/client.tsp b/specification/oracle/Oracle.Database.Management/client.tsp similarity index 100% rename from specification/oracle/Oracle.Database/client.tsp rename to specification/oracle/Oracle.Database.Management/client.tsp diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseBackup_create.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabaseBackup_create.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseBackup_create.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabaseBackup_create.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseBackup_delete.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabaseBackup_delete.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseBackup_delete.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabaseBackup_delete.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseBackup_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabaseBackup_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseBackup_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabaseBackup_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseBackup_listByParent.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabaseBackup_listByParent.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseBackup_listByParent.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabaseBackup_listByParent.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseBackup_patch.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabaseBackup_patch.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseBackup_patch.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabaseBackup_patch.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseCharacterSet_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabaseCharacterSet_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseCharacterSet_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabaseCharacterSet_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseCharacterSet_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabaseCharacterSet_listByLocation.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseCharacterSet_listByLocation.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabaseCharacterSet_listByLocation.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseClone_create.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabaseClone_create.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseClone_create.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabaseClone_create.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseNationalCharacterSet_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabaseNationalCharacterSet_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseNationalCharacterSet_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabaseNationalCharacterSet_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseNationalCharacterSet_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabaseNationalCharacterSet_listByLocation.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseNationalCharacterSet_listByLocation.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabaseNationalCharacterSet_listByLocation.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseVersion_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabaseVersion_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseVersion_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabaseVersion_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseVersion_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabaseVersion_listByLocation.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabaseVersion_listByLocation.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabaseVersion_listByLocation.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_create.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabase_create.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_create.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabase_create.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_delete.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabase_delete.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_delete.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabase_delete.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_failover.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabase_failover.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_failover.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabase_failover.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_generateWallet.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabase_generateWallet.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_generateWallet.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabase_generateWallet.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabase_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabase_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_listByResourceGroup.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabase_listByResourceGroup.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_listByResourceGroup.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabase_listByResourceGroup.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_listBySubscription.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabase_listBySubscription.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_listBySubscription.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabase_listBySubscription.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_patch.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabase_patch.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_patch.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabase_patch.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_restore.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabase_restore.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_restore.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabase_restore.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_shrink.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabase_shrink.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_shrink.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabase_shrink.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_switchover.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabase_switchover.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/autonomousDatabase_switchover.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/autonomousDatabase_switchover.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbNodes_action.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/dbNodes_action.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbNodes_action.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/dbNodes_action.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbNodes_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/dbNodes_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbNodes_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/dbNodes_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbNodes_listByParent.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/dbNodes_listByParent.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbNodes_listByParent.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/dbNodes_listByParent.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbServers_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/dbServers_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbServers_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/dbServers_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbServers_listByParent.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/dbServers_listByParent.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbServers_listByParent.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/dbServers_listByParent.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbSystemShapes_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/dbSystemShapes_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbSystemShapes_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/dbSystemShapes_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbSystemShapes_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/dbSystemShapes_listByLocation.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/dbSystemShapes_listByLocation.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/dbSystemShapes_listByLocation.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dnsPrivateViews_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/dnsPrivateViews_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/dnsPrivateViews_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/dnsPrivateViews_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dnsPrivateViews_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/dnsPrivateViews_listByLocation.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/dnsPrivateViews_listByLocation.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/dnsPrivateViews_listByLocation.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dnsPrivateZones_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/dnsPrivateZones_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/dnsPrivateZones_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/dnsPrivateZones_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/dnsPrivateZones_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/dnsPrivateZones_listByLocation.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/dnsPrivateZones_listByLocation.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/dnsPrivateZones_listByLocation.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_addStorageCapacity.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/exaInfra_addStorageCapacity.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_addStorageCapacity.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/exaInfra_addStorageCapacity.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_create.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/exaInfra_create.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_create.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/exaInfra_create.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_delete.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/exaInfra_delete.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_delete.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/exaInfra_delete.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/exaInfra_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/exaInfra_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_listByResourceGroup.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/exaInfra_listByResourceGroup.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_listByResourceGroup.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/exaInfra_listByResourceGroup.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_listBySubscription.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/exaInfra_listBySubscription.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_listBySubscription.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/exaInfra_listBySubscription.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_patch.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/exaInfra_patch.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/exaInfra_patch.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/exaInfra_patch.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/giVersions_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/giVersions_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/giVersions_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/giVersions_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/giVersions_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/giVersions_listByLocation.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/giVersions_listByLocation.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/giVersions_listByLocation.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/operations_list.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/operations_list.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/operations_list.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/operations_list.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_create.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/oracleSubscriptions_create.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_create.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/oracleSubscriptions_create.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_delete.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/oracleSubscriptions_delete.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_delete.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/oracleSubscriptions_delete.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/oracleSubscriptions_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/oracleSubscriptions_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_listActivationLinks.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/oracleSubscriptions_listActivationLinks.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_listActivationLinks.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/oracleSubscriptions_listActivationLinks.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_listBySubscription.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/oracleSubscriptions_listBySubscription.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_listBySubscription.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/oracleSubscriptions_listBySubscription.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_listCloudAccountDetails.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/oracleSubscriptions_listCloudAccountDetails.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_listCloudAccountDetails.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/oracleSubscriptions_listCloudAccountDetails.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_listSaasSubscriptionDetails.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/oracleSubscriptions_listSaasSubscriptionDetails.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_listSaasSubscriptionDetails.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/oracleSubscriptions_listSaasSubscriptionDetails.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_patch.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/oracleSubscriptions_patch.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/oracleSubscriptions_patch.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/oracleSubscriptions_patch.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/systemVersions_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/systemVersions_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/systemVersions_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/systemVersions_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/systemVersions_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/systemVersions_listByLocation.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/systemVersions_listByLocation.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/systemVersions_listByLocation.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/virtualNetworkAddresses_create.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/virtualNetworkAddresses_create.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/virtualNetworkAddresses_create.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/virtualNetworkAddresses_create.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/virtualNetworkAddresses_delete.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/virtualNetworkAddresses_delete.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/virtualNetworkAddresses_delete.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/virtualNetworkAddresses_delete.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/virtualNetworkAddresses_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/virtualNetworkAddresses_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/virtualNetworkAddresses_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/virtualNetworkAddresses_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/virtualNetworkAddresses_listByParent.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/virtualNetworkAddresses_listByParent.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/virtualNetworkAddresses_listByParent.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/virtualNetworkAddresses_listByParent.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_addVms.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/vmClusters_addVms.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_addVms.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/vmClusters_addVms.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_create.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/vmClusters_create.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_create.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/vmClusters_create.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_delete.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/vmClusters_delete.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_delete.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/vmClusters_delete.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/vmClusters_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/vmClusters_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_listByResourceGroup.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/vmClusters_listByResourceGroup.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_listByResourceGroup.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/vmClusters_listByResourceGroup.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_listBySubscription.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/vmClusters_listBySubscription.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_listBySubscription.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/vmClusters_listBySubscription.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_listPrivateIpAddresses.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/vmClusters_listPrivateIpAddresses.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_listPrivateIpAddresses.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/vmClusters_listPrivateIpAddresses.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_patch.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/vmClusters_patch.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_patch.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/vmClusters_patch.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_removeVms.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/vmClusters_removeVms.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01-preview/vmClusters_removeVms.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/vmClusters_removeVms.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseBackup_create.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabaseBackup_create.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseBackup_create.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabaseBackup_create.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseBackup_delete.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabaseBackup_delete.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseBackup_delete.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabaseBackup_delete.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseBackup_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabaseBackup_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseBackup_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabaseBackup_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseBackup_listByParent.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabaseBackup_listByParent.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseBackup_listByParent.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabaseBackup_listByParent.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseBackup_patch.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabaseBackup_patch.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseBackup_patch.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabaseBackup_patch.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseCharacterSet_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabaseCharacterSet_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseCharacterSet_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabaseCharacterSet_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseCharacterSet_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabaseCharacterSet_listByLocation.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseCharacterSet_listByLocation.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabaseCharacterSet_listByLocation.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseClone_create.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabaseClone_create.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseClone_create.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabaseClone_create.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseNationalCharacterSet_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabaseNationalCharacterSet_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseNationalCharacterSet_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabaseNationalCharacterSet_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseNationalCharacterSet_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabaseNationalCharacterSet_listByLocation.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseNationalCharacterSet_listByLocation.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabaseNationalCharacterSet_listByLocation.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseVersion_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabaseVersion_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseVersion_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabaseVersion_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseVersion_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabaseVersion_listByLocation.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabaseVersion_listByLocation.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabaseVersion_listByLocation.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_create.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabase_create.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_create.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabase_create.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_delete.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabase_delete.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_delete.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabase_delete.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_failover.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabase_failover.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_failover.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabase_failover.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_generateWallet.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabase_generateWallet.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_generateWallet.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabase_generateWallet.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabase_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabase_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_listByResourceGroup.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabase_listByResourceGroup.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_listByResourceGroup.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabase_listByResourceGroup.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_listBySubscription.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabase_listBySubscription.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_listBySubscription.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabase_listBySubscription.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_patch.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabase_patch.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_patch.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabase_patch.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_restore.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabase_restore.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_restore.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabase_restore.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_shrink.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabase_shrink.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_shrink.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabase_shrink.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_switchover.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabase_switchover.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/autonomousDatabase_switchover.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/autonomousDatabase_switchover.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/dbNodes_action.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/dbNodes_action.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/dbNodes_action.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/dbNodes_action.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/dbNodes_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/dbNodes_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/dbNodes_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/dbNodes_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/dbNodes_listByParent.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/dbNodes_listByParent.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/dbNodes_listByParent.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/dbNodes_listByParent.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/dbServers_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/dbServers_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/dbServers_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/dbServers_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/dbServers_listByParent.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/dbServers_listByParent.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/dbServers_listByParent.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/dbServers_listByParent.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/dbSystemShapes_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/dbSystemShapes_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/dbSystemShapes_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/dbSystemShapes_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/dbSystemShapes_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/dbSystemShapes_listByLocation.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/dbSystemShapes_listByLocation.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/dbSystemShapes_listByLocation.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/dnsPrivateViews_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/dnsPrivateViews_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/dnsPrivateViews_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/dnsPrivateViews_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/dnsPrivateViews_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/dnsPrivateViews_listByLocation.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/dnsPrivateViews_listByLocation.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/dnsPrivateViews_listByLocation.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/dnsPrivateZones_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/dnsPrivateZones_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/dnsPrivateZones_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/dnsPrivateZones_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/dnsPrivateZones_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/dnsPrivateZones_listByLocation.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/dnsPrivateZones_listByLocation.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/dnsPrivateZones_listByLocation.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_addStorageCapacity.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/exaInfra_addStorageCapacity.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_addStorageCapacity.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/exaInfra_addStorageCapacity.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_create.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/exaInfra_create.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_create.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/exaInfra_create.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_delete.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/exaInfra_delete.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_delete.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/exaInfra_delete.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/exaInfra_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/exaInfra_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_listByResourceGroup.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/exaInfra_listByResourceGroup.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_listByResourceGroup.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/exaInfra_listByResourceGroup.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_listBySubscription.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/exaInfra_listBySubscription.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_listBySubscription.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/exaInfra_listBySubscription.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_patch.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/exaInfra_patch.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/exaInfra_patch.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/exaInfra_patch.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/giVersions_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/giVersions_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/giVersions_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/giVersions_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/giVersions_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/giVersions_listByLocation.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/giVersions_listByLocation.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/giVersions_listByLocation.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/operations_list.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/operations_list.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/operations_list.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/operations_list.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_create.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/oracleSubscriptions_create.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_create.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/oracleSubscriptions_create.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_delete.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/oracleSubscriptions_delete.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_delete.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/oracleSubscriptions_delete.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/oracleSubscriptions_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/oracleSubscriptions_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_listActivationLinks.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/oracleSubscriptions_listActivationLinks.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_listActivationLinks.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/oracleSubscriptions_listActivationLinks.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_listBySubscription.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/oracleSubscriptions_listBySubscription.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_listBySubscription.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/oracleSubscriptions_listBySubscription.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_listCloudAccountDetails.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/oracleSubscriptions_listCloudAccountDetails.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_listCloudAccountDetails.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/oracleSubscriptions_listCloudAccountDetails.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_listSaasSubscriptionDetails.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/oracleSubscriptions_listSaasSubscriptionDetails.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_listSaasSubscriptionDetails.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/oracleSubscriptions_listSaasSubscriptionDetails.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_patch.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/oracleSubscriptions_patch.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/oracleSubscriptions_patch.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/oracleSubscriptions_patch.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/systemVersions_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/systemVersions_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/systemVersions_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/systemVersions_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/systemVersions_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/systemVersions_listByLocation.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/systemVersions_listByLocation.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/systemVersions_listByLocation.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/virtualNetworkAddresses_create.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/virtualNetworkAddresses_create.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/virtualNetworkAddresses_create.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/virtualNetworkAddresses_create.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/virtualNetworkAddresses_delete.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/virtualNetworkAddresses_delete.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/virtualNetworkAddresses_delete.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/virtualNetworkAddresses_delete.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/virtualNetworkAddresses_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/virtualNetworkAddresses_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/virtualNetworkAddresses_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/virtualNetworkAddresses_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/virtualNetworkAddresses_listByParent.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/virtualNetworkAddresses_listByParent.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/virtualNetworkAddresses_listByParent.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/virtualNetworkAddresses_listByParent.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_addVms.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/vmClusters_addVms.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_addVms.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/vmClusters_addVms.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_create.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/vmClusters_create.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_create.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/vmClusters_create.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_delete.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/vmClusters_delete.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_delete.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/vmClusters_delete.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_get.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/vmClusters_get.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_get.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/vmClusters_get.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_listByResourceGroup.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/vmClusters_listByResourceGroup.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_listByResourceGroup.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/vmClusters_listByResourceGroup.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_listBySubscription.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/vmClusters_listBySubscription.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_listBySubscription.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/vmClusters_listBySubscription.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_listPrivateIpAddresses.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/vmClusters_listPrivateIpAddresses.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_listPrivateIpAddresses.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/vmClusters_listPrivateIpAddresses.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_patch.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/vmClusters_patch.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_patch.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/vmClusters_patch.json diff --git a/specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_removeVms.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/vmClusters_removeVms.json similarity index 100% rename from specification/oracle/Oracle.Database/examples/2023-09-01/vmClusters_removeVms.json rename to specification/oracle/Oracle.Database.Management/examples/2023-09-01/vmClusters_removeVms.json diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseBackup_create.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseBackup_create.json new file mode 100644 index 000000000000..e7a747bf7f99 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseBackup_create.json @@ -0,0 +1,71 @@ +{ + "operationId": "AutonomousDatabaseBackups_CreateOrUpdate", + "title": "AutonomousDatabaseBackups_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130", + "resource": { + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "displayName": "Nightly Backup", + "retentionPeriodInDays": 365 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "headers": { + "Retry-After": 100 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/backupdb1", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseBackup_delete.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseBackup_delete.json new file mode 100644 index 000000000000..9024bb556814 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseBackup_delete.json @@ -0,0 +1,20 @@ +{ + "operationId": "AutonomousDatabaseBackups_Delete", + "title": "AutonomousDatabaseBackups_Delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseBackup_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseBackup_get.json new file mode 100644 index 000000000000..28b9844e4af7 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseBackup_get.json @@ -0,0 +1,37 @@ +{ + "operationId": "AutonomousDatabaseBackups_Get", + "title": "AutonomousDatabaseBackups_Get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseBackup_listByParent.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseBackup_listByParent.json new file mode 100644 index 000000000000..3b8ef5d0c023 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseBackup_listByParent.json @@ -0,0 +1,40 @@ +{ + "operationId": "AutonomousDatabaseBackups_ListByAutonomousDatabase", + "title": "AutonomousDatabaseBackups_ListByAutonomousDatabase", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseBackup_patch.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseBackup_patch.json new file mode 100644 index 000000000000..d770ccd7bf25 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseBackup_patch.json @@ -0,0 +1,41 @@ +{ + "operationId": "AutonomousDatabaseBackups_Update", + "title": "AutonomousDatabaseBackups_Update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130", + "properties": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup updated successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 400, + "sizeInTbs": 2, + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseCharacterSet_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseCharacterSet_get.json new file mode 100644 index 000000000000..6b48c38b3242 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseCharacterSet_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseCharacterSets_get", + "title": "AutonomousDatabaseCharacterSets_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "adbscharsetname": "DATABASE" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "AL32UTF8" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseCharacterSet_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseCharacterSet_listByLocation.json new file mode 100644 index 000000000000..3208a62ffde7 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseCharacterSet_listByLocation.json @@ -0,0 +1,32 @@ +{ + "operationId": "AutonomousDatabaseCharacterSets_listByLocation", + "title": "AutonomousDatabaseCharacterSets_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "AL32UTF8" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "UTF8" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseClone_create.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseClone_create.json new file mode 100644 index 000000000000..fe956ffdd48e --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseClone_create.json @@ -0,0 +1,141 @@ +{ + "operationId": "AutonomousDatabases_CreateOrUpdate", + "title": "AutonomousDatabases_CreateOrUpdate_clone", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "resource": { + "properties": { + "dataBaseType": "Clone", + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "cloneType": "Full", + "displayName": "example_autonomous_databasedb1_clone", + "computeModel": "ECPU", + "computeCount": 2, + "dataStorageSizeInTbs": 1, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "adminPassword": "********", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1Clone", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "cloneType": "Full", + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Clone", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1Clone", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "cloneType": "Full", + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Clone", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseNationalCharacterSet_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseNationalCharacterSet_get.json new file mode 100644 index 000000000000..ad1ecd6d6092 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseNationalCharacterSet_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseNationalCharacterSets_get", + "title": "AutonomousDatabaseNationalCharacterSets_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "adbsncharsetname": "NATIONAL" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseNationalCharacterSets/NATIONAL", + "type": "Oracle.Database/locations/autonomousDatabaseNationalCharacterSets", + "properties": { + "characterSet": "AL16UTF16" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseNationalCharacterSet_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseNationalCharacterSet_listByLocation.json new file mode 100644 index 000000000000..6acb2eb02a49 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseNationalCharacterSet_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabaseNationalCharacterSets_listByLocation", + "title": "AutonomousDatabaseNationalCharacterSets_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseNationalCharacterSets/NATIONAL", + "type": "Oracle.Database/locations/autonomousDatabaseNationalCharacterSets", + "properties": { + "characterSet": "AL16UTF16" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseVersion_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseVersion_get.json new file mode 100644 index 000000000000..1e516b3b27ed --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseVersion_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseVersions_get", + "title": "AutonomousDatabaseVersions_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "autonomousdbversionsname": "18.4.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDbVersions/18.4.0.0", + "type": "Oracle.Database/locations/autonomousDbVersions", + "properties": { + "version": "18.4.0.0" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseVersion_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseVersion_listByLocation.json new file mode 100644 index 000000000000..899b89d86f16 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabaseVersion_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabaseVersions_listByLocation", + "title": "AutonomousDatabaseVersions_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDbVersions/18.4.0.0", + "type": "Oracle.Database/locations/autonomousDbVersions", + "properties": { + "version": "18.4.0.0" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_create.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_create.json new file mode 100644 index 000000000000..92fa3fd8899a --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_create.json @@ -0,0 +1,136 @@ +{ + "operationId": "AutonomousDatabases_CreateOrUpdate", + "title": "AutonomousDatabases_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "resource": { + "properties": { + "dataBaseType": "Regular", + "displayName": "example_autonomous_databasedb1", + "computeModel": "ECPU", + "computeCount": 2, + "dataStorageSizeInTbs": 1, + "adminPassword": "********", + "dbVersion": "18.4.0.0", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_delete.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_delete.json new file mode 100644 index 000000000000..1b362325b846 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "AutonomousDatabases_delete", + "title": "AutonomousDatabases_delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_failover.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_failover.json new file mode 100644 index 000000000000..d252740d5b69 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_failover.json @@ -0,0 +1,90 @@ +{ + "operationId": "AutonomousDatabases_Failover", + "title": "AutonomousDatabases_Failover", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "peerDbId": "peerDbId" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "failedDataRecoveryInSeconds": null, + "isLocalDataGuardEnabled": true, + "timeLocalDataGuardEnabled": "2024-02-28T19:03:43.714Z", + "localDisasterRecoveryType": "Adg", + "localAdgAutoFailoverMaxDataLossLimit": 300, + "role": "Primary", + "peerDbIds": null, + "localStandbyDb": { + "lagTimeInSeconds": null, + "lifecycleDetails": null, + "lifecycleState": "RoleChangeInProgress", + "timeDataGuardRoleChanged": null, + "timeDisasterRecoveryRoleChanged": null + }, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Updating", + "lifecycleDetails": null, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Provisioning", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeOfLastFailover": null, + "timeOfLastSwitchover": null, + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_generateWallet.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_generateWallet.json new file mode 100644 index 000000000000..9605115fd580 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_generateWallet.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabases_generateWallet", + "title": "AutonomousDatabases_generateWallet", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "generateType": "Single", + "isRegional": false, + "password": "********" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "walletFiles": "testEncodedFiles" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_get.json new file mode 100644 index 000000000000..4b888b79d297 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_get.json @@ -0,0 +1,63 @@ +{ + "operationId": "AutonomousDatabases_Get", + "title": "AutonomousDatabases_Get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_listByResourceGroup.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_listByResourceGroup.json new file mode 100644 index 000000000000..b4ed6e0a4a6d --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_listByResourceGroup.json @@ -0,0 +1,67 @@ +{ + "operationId": "AutonomousDatabases_listByResourceGroup", + "title": "AutonomousDatabases_listByResourceGroup", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_listBySubscription.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_listBySubscription.json new file mode 100644 index 000000000000..80112af9c96d --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_listBySubscription.json @@ -0,0 +1,66 @@ +{ + "operationId": "AutonomousDatabases_listBySubscription", + "title": "AutonomousDatabases_listBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_patch.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_patch.json new file mode 100644 index 000000000000..dc9c1975b077 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_patch.json @@ -0,0 +1,73 @@ +{ + "operationId": "AutonomousDatabases_update", + "title": "AutonomousDatabases_update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_restore.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_restore.json new file mode 100644 index 000000000000..5022c67f321b --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_restore.json @@ -0,0 +1,80 @@ +{ + "operationId": "AutonomousDatabases_Restore", + "title": "AutonomousDatabases_Restore", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "timestamp": "2024-04-23T00:00:00.000Z" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "backupRetentionPeriodInDays": 60, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "RestoreInProgress", + "lifecycleDetails": "", + "nextLongTermBackupTimeStamp": "2024-04-24T21:03:41.000Z", + "longTermBackupSchedule": { + "isDisabled": null, + "repeatCadence": "Weekly", + "retentionPeriodInDays": 365, + "timeOfBackup": "2024-04-21T21:03:41.309Z" + }, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_shrink.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_shrink.json new file mode 100644 index 000000000000..f7cd000c059b --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_shrink.json @@ -0,0 +1,77 @@ +{ + "operationId": "AutonomousDatabase_shrink", + "title": "AutonomousDatabase_shrink", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "backupRetentionPeriodInDays": 90, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "ScaleInProgress", + "lifecycleDetails": "", + "nextLongTermBackupTimeStamp": "2024-04-24T21:03:41.000Z", + "longTermBackupSchedule": { + "isDisabled": null, + "repeatCadence": "Weekly", + "retentionPeriodInDays": 365, + "timeOfBackup": "2024-04-21T21:03:41.309Z" + }, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_switchover.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_switchover.json new file mode 100644 index 000000000000..32d91768c7a9 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/autonomousDatabase_switchover.json @@ -0,0 +1,89 @@ +{ + "operationId": "AutonomousDatabases_Switchover", + "title": "AutonomousDatabases_Switchover", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "peerDbId": "peerDbId" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "failedDataRecoveryInSeconds": null, + "isLocalDataGuardEnabled": false, + "localDisasterRecoveryType": "BackupBased", + "localAdgAutoFailoverMaxDataLossLimit": null, + "role": "Primary", + "peerDbIds": null, + "localStandbyDb": { + "lagTimeInSeconds": null, + "lifecycleDetails": null, + "lifecycleState": "RoleChangeInProgress", + "timeDataGuardRoleChanged": null, + "timeDisasterRecoveryRoleChanged": null + }, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Updating", + "lifecycleDetails": null, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Provisioning", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeOfLastFailover": null, + "timeOfLastSwitchover": "2024-02-27T18:37:08.069Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dbNodes_action.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dbNodes_action.json new file mode 100644 index 000000000000..ba39d8bb992f --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dbNodes_action.json @@ -0,0 +1,50 @@ +{ + "operationId": "DbNodes_Action", + "title": "DbNodes_Action", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "dbnodeocid": "ocid1....aaaaaa", + "body": { + "action": "Start" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "provisioningState": "Succeeded", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dbNodes_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dbNodes_get.json new file mode 100644 index 000000000000..0dae0617aa9b --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dbNodes_get.json @@ -0,0 +1,41 @@ +{ + "operationId": "DbNodes_get", + "title": "DbNodes_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "dbnodeocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "lifecycleState": "Available", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dbNodes_listByParent.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dbNodes_listByParent.json new file mode 100644 index 000000000000..997a2a6df52f --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dbNodes_listByParent.json @@ -0,0 +1,45 @@ +{ + "operationId": "DbNodes_listByParent", + "title": "DbNodes_listByParent", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "lifecycleState": "Available", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dbServers_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dbServers_get.json new file mode 100644 index 000000000000..54fa1809fb1e --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dbServers_get.json @@ -0,0 +1,42 @@ +{ + "operationId": "DbServers_get", + "title": "DbServers_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "dbserverocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1/dbServers/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbServers", + "properties": { + "ocid": "ocid1", + "displayName": "dbserver1", + "compartmentId": "ocid1....aaaa", + "exadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "cpuCoreCount": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 150, + "vmClusterIds": [ + "ocid1..aaaaa" + ], + "dbNodeIds": [ + "ocid1..aaaaa" + ], + "lifecycleState": "Available", + "maxCpuCount": 1000, + "autonomousVmClusterIds": [ + "ocid1..aaaaa" + ], + "autonomousVirtualMachineIds": [ + "ocid1..aaaaa" + ] + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dbServers_listByParent.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dbServers_listByParent.json new file mode 100644 index 000000000000..77a7073106e8 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dbServers_listByParent.json @@ -0,0 +1,46 @@ +{ + "operationId": "DbServers_listByCloudExadataInfrastructure", + "title": "DbServers_listByCloudExadataInfrastructure", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1/dbServers/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbServers", + "properties": { + "ocid": "ocid1", + "displayName": "dbserver1", + "compartmentId": "ocid1....aaaa", + "exadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "cpuCoreCount": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 150, + "vmClusterIds": [ + "ocid1..aaaaa" + ], + "dbNodeIds": [ + "ocid1..aaaaa" + ], + "lifecycleState": "Available", + "maxCpuCount": 1000, + "autonomousVmClusterIds": [ + "ocid1..aaaaa" + ], + "autonomousVirtualMachineIds": [ + "ocid1..aaaaa" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dbSystemShapes_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dbSystemShapes_get.json new file mode 100644 index 000000000000..249db363069d --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dbSystemShapes_get.json @@ -0,0 +1,40 @@ +{ + "operationId": "DbSystemShapes_get", + "title": "DbSystemShapes_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dbsystemshapename": "EXADATA.X9M" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dbSystemShapes/EXADATA.X9M", + "type": "Oracle.Database/locations/dbSystemShapes", + "properties": { + "shapeFamily": "EXADATA", + "availableCoreCount": 100, + "minimumCoreCount": 1, + "runtimeMinimumCoreCount": 1, + "coreCountIncrement": 1, + "minStorageCount": 0, + "maxStorageCount": 100, + "availableDataStoragePerServerInTbs": 100, + "availableMemoryPerNodeInGbs": 10, + "availableDbNodePerNodeInGbs": 10, + "minCoreCountPerNode": 0, + "availableMemoryInGbs": 10, + "minMemoryPerNodeInGbs": 0, + "availableDbNodeStorageInGbs": 10, + "minDbNodeStoragePerNodeInGbs": 0, + "availableDataStorageInTbs": 10, + "minDataStorageInTbs": 0, + "minimumNodeCount": 0, + "maximumNodeCount": 1000, + "availableCoreCountPerNode": 1000 + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dbSystemShapes_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dbSystemShapes_listByLocation.json new file mode 100644 index 000000000000..eb2183605dbf --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dbSystemShapes_listByLocation.json @@ -0,0 +1,44 @@ +{ + "operationId": "DbSystemShapes_listByLocation", + "title": "DbSystemShapes_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dbSystemShapes/EXADATA.X9M", + "type": "Oracle.Database/locations/dbSystemShapes", + "properties": { + "shapeFamily": "EXADATA", + "availableCoreCount": 100, + "minimumCoreCount": 1, + "runtimeMinimumCoreCount": 1, + "coreCountIncrement": 1, + "minStorageCount": 0, + "maxStorageCount": 100, + "availableDataStoragePerServerInTbs": 100, + "availableMemoryPerNodeInGbs": 10, + "availableDbNodePerNodeInGbs": 10, + "minCoreCountPerNode": 0, + "availableMemoryInGbs": 10, + "minMemoryPerNodeInGbs": 0, + "availableDbNodeStorageInGbs": 10, + "minDbNodeStoragePerNodeInGbs": 0, + "availableDataStorageInTbs": 10, + "minDataStorageInTbs": 0, + "minimumNodeCount": 0, + "maximumNodeCount": 1000, + "availableCoreCountPerNode": 1000 + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dnsPrivateViews_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dnsPrivateViews_get.json new file mode 100644 index 000000000000..5f4a3f707f16 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dnsPrivateViews_get.json @@ -0,0 +1,27 @@ +{ + "operationId": "DnsPrivateViews_get", + "title": "DnsPrivateViews_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dnsprivateviewocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaaa", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaaa", + "displayName": "example-dns-private-view", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/your-dns-private-view", + "timeCreated": "2023-10-26T12:34:56Z", + "timeUpdated": "2023-10-26T14:00:00Z" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dnsPrivateViews_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dnsPrivateViews_listByLocation.json new file mode 100644 index 000000000000..befa9f52d572 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dnsPrivateViews_listByLocation.json @@ -0,0 +1,44 @@ +{ + "operationId": "DnsPrivateViews_listByLocation", + "title": "DnsPrivateViews_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaaa", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaaa", + "displayName": "example-dns-private-view1", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/view1", + "timeCreated": "2023-10-26T12:34:56Z", + "timeUpdated": "2023-10-26T14:00:00Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaab", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaab", + "displayName": "example-dns-private-view2", + "isProtected": true, + "lifecycleState": "Creating", + "self": "https://api.example.com/view2", + "timeCreated": "2023-10-27T09:45:00Z", + "timeUpdated": "2023-10-27T10:30:00Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dnsPrivateZones_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dnsPrivateZones_get.json new file mode 100644 index 000000000000..237b23d32ef4 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dnsPrivateZones_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "DnsPrivateZones_get", + "title": "DnsPrivateZones_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dnsprivatezonename": "example-dns-private-zone" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/example-dns-private-zone", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "your-zone-id", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/your-dns-private-zone", + "serial": 12345, + "version": "1.0.0.0", + "viewId": "your-view-id", + "zoneType": "Primary", + "timeCreated": "2023-10-26T12:34:56Z" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dnsPrivateZones_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dnsPrivateZones_listByLocation.json new file mode 100644 index 000000000000..9b716d67db53 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dnsPrivateZones_listByLocation.json @@ -0,0 +1,48 @@ +{ + "operationId": "DnsPrivateZones_listByLocation", + "title": "DnsPrivateZones_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/zone1", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "zone-id-1", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/zone1", + "serial": 12345, + "version": "1.0.0.0", + "viewId": "view-id-1", + "zoneType": "Primary", + "timeCreated": "2023-10-26T12:34:56Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/zone2", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "zone-id-2", + "isProtected": true, + "lifecycleState": "Creating", + "self": "https://api.example.com/zone2", + "serial": 54321, + "version": "2.0.0.0", + "viewId": "view-id-2", + "zoneType": "Secondary", + "timeCreated": "2023-10-27T09:45:00Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/exaInfra_addStorageCapacity.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/exaInfra_addStorageCapacity.json new file mode 100644 index 000000000000..2f1f55f1e0f5 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/exaInfra_addStorageCapacity.json @@ -0,0 +1,95 @@ +{ + "operationId": "CloudExadataInfrastructures_addStorageCapacity", + "title": "CloudExadataInfrastructures_addStorageCapacity", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/exaInfra_create.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/exaInfra_create.json new file mode 100644 index 000000000000..950670cb1a0e --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/exaInfra_create.json @@ -0,0 +1,184 @@ +{ + "operationId": "CloudExadataInfrastructures_createOrUpdate", + "title": "CloudExadataInfrastructures_createOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "resource": { + "properties": { + "computeCount": 100, + "storageCount": 10, + "shape": "EXADATA.X9M", + "displayName": "infra 1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "zones": [ + "1" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/exaInfra_delete.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/exaInfra_delete.json new file mode 100644 index 000000000000..d6544bee4267 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/exaInfra_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "CloudExadataInfrastructures_delete", + "title": "CloudExadataInfrastructures_delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/exaInfra_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/exaInfra_get.json new file mode 100644 index 000000000000..35f9d5ca638c --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/exaInfra_get.json @@ -0,0 +1,89 @@ +{ + "operationId": "CloudExadataInfrastructures_get", + "title": "CloudExadataInfrastructures_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/exaInfra_listByResourceGroup.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/exaInfra_listByResourceGroup.json new file mode 100644 index 000000000000..c7b0ec071c04 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/exaInfra_listByResourceGroup.json @@ -0,0 +1,93 @@ +{ + "operationId": "CloudExadataInfrastructures_listByResourceGroup", + "title": "CloudExadataInfrastructures_listByResourceGroup", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/exaInfra_listBySubscription.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/exaInfra_listBySubscription.json new file mode 100644 index 000000000000..97acca1bb5fd --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/exaInfra_listBySubscription.json @@ -0,0 +1,92 @@ +{ + "operationId": "CloudExadataInfrastructures_listBySubscription", + "title": "CloudExadataInfrastructures_listBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/exaInfra_patch.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/exaInfra_patch.json new file mode 100644 index 000000000000..83b7cef6f8db --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/exaInfra_patch.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudExadataInfrastructures_update", + "title": "CloudExadataInfrastructures_update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + }, + "zones": [ + "1" + ] + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/giVersions_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/giVersions_get.json new file mode 100644 index 000000000000..60ec5e30ae01 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/giVersions_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "GiVersions_get", + "title": "GiVersions_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "giversionname": "19.0.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/giVersions/19.0.0.0", + "type": "Oracle.Database/locations/giVersions", + "properties": { + "version": "19.0.0.0" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/giVersions_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/giVersions_listByLocation.json new file mode 100644 index 000000000000..3563879e8421 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/giVersions_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "GiVersions_listByLocation", + "title": "GiVersions_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/giVersions/19.0.0.0", + "type": "Oracle.Database/locations/giVersions", + "properties": { + "version": "19.0.0.0" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/operations_list.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/operations_list.json new file mode 100644 index 000000000000..7f3d0d47252f --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/operations_list.json @@ -0,0 +1,25 @@ +{ + "operationId": "Operations_list", + "title": "Operations_list", + "parameters": { + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Oracle.Database/cloudExadataInfrastructures/Read", + "isDataAction": false, + "display": { + "provider": "Oracle.Database", + "resource": "cloudExadataInfrastructures", + "operation": "Get/list Exadata Infrastructure resources", + "description": "Reads Exadata Infrastructure" + } + } + ] + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/oracleSubscriptions_addAzureSubscriptions.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/oracleSubscriptions_addAzureSubscriptions.json new file mode 100644 index 000000000000..91211e23321f --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/oracleSubscriptions_addAzureSubscriptions.json @@ -0,0 +1,21 @@ +{ + "operationId": "OracleSubscriptions_addAzureSubscriptions", + "title": "OracleSubscriptions_addAzureSubscriptions", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "body": { + "azureSubscriptionIds": [ + "00000000-0000-0000-0000-000000000001" + ] + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/oracleSubscriptions_create.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/oracleSubscriptions_create.json new file mode 100644 index 000000000000..5e5e61d7a559 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/oracleSubscriptions_create.json @@ -0,0 +1,56 @@ +{ + "operationId": "OracleSubscriptions_createOrUpdate", + "title": "OracleSubscriptions_createOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resource": { + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/oracleSubscriptions_delete.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/oracleSubscriptions_delete.json new file mode 100644 index 000000000000..ebd194b690dc --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/oracleSubscriptions_delete.json @@ -0,0 +1,17 @@ +{ + "operationId": "OracleSubscriptions_delete", + "title": "OracleSubscriptions_delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/oracleSubscriptions_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/oracleSubscriptions_get.json new file mode 100644 index 000000000000..42519ceb1456 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/oracleSubscriptions_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "OracleSubscriptions_get", + "title": "OracleSubscriptions_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/oracleSubscriptions_listActivationLinks.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/oracleSubscriptions_listActivationLinks.json new file mode 100644 index 000000000000..752a012c3b30 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/oracleSubscriptions_listActivationLinks.json @@ -0,0 +1,22 @@ +{ + "operationId": "OracleSubscriptions_listActivationLinks", + "title": "OracleSubscriptions_listActivationLinks", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "newCloudAccountActivationLink": "https://new-tenancy-activation-link", + "existingCloudAccountActivationLink": "https://existing-tenancy-activation-link" + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/oracleSubscriptions_listBySubscription.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/oracleSubscriptions_listBySubscription.json new file mode 100644 index 000000000000..ea13f43dba02 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/oracleSubscriptions_listBySubscription.json @@ -0,0 +1,34 @@ +{ + "operationId": "OracleSubscriptions_listBySubscription", + "title": "OracleSubscriptions_listBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/oracleSubscriptions_listCloudAccountDetails.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/oracleSubscriptions_listCloudAccountDetails.json new file mode 100644 index 000000000000..9d091d428625 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/oracleSubscriptions_listCloudAccountDetails.json @@ -0,0 +1,22 @@ +{ + "operationId": "OracleSubscriptions_listCloudAccountDetails", + "title": "OracleSubscriptions_listCloudAccountDetails", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "cloudAccountName": "Cloud Account", + "cloudAccountHomeRegion": "East US" + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/oracleSubscriptions_listSaasSubscriptionDetails.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/oracleSubscriptions_listSaasSubscriptionDetails.json new file mode 100644 index 000000000000..f33b7487c230 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/oracleSubscriptions_listSaasSubscriptionDetails.json @@ -0,0 +1,32 @@ +{ + "operationId": "OracleSubscriptions_listSaasSubscriptionDetails", + "title": "OracleSubscriptions_listSaasSubscriptionDetails", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "1234567890", + "subscriptionName": "Oracle", + "timeCreated": "2022-03-07T00:00:00Z", + "offerId": "offer1", + "planId": "silver", + "saasSubscriptionStatus": "PendingFulfillmentStart", + "publisherId": "Oracle", + "purchaserEmailId": "test@test.com", + "purchaserTenantId": "1234567890", + "termUnit": "P1M", + "isAutoRenew": true, + "isFreeTrial": false + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/oracleSubscriptions_patch.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/oracleSubscriptions_patch.json new file mode 100644 index 000000000000..eb3bf9935a8c --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/oracleSubscriptions_patch.json @@ -0,0 +1,43 @@ +{ + "operationId": "OracleSubscriptions_update", + "title": "OracleSubscriptions_update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/systemVersions_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/systemVersions_get.json new file mode 100644 index 000000000000..772079509ae6 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/systemVersions_get.json @@ -0,0 +1,20 @@ +{ + "operationId": "SystemVersions_Get", + "title": "systemVersions_listSystemVersions", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "systemversionname": "22.x" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/systemVersion/22.1.7.0.0.230113", + "properties": { + "systemVersion": "22.1.7.0.0.230113" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/systemVersions_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/systemVersions_listByLocation.json new file mode 100644 index 000000000000..b7d86b03d49b --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/systemVersions_listByLocation.json @@ -0,0 +1,24 @@ +{ + "operationId": "SystemVersions_ListByLocation", + "title": "systemVersions_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/systemVersion/22.1.7.0.0.230113", + "properties": { + "systemVersion": "22.1.7.0.0.230113" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/virtualNetworkAddresses_create.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/virtualNetworkAddresses_create.json new file mode 100644 index 000000000000..f55ccc3f7a31 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/virtualNetworkAddresses_create.json @@ -0,0 +1,48 @@ +{ + "operationId": "VirtualNetworkAddresses_createOrUpdate", + "title": "VirtualNetworkAddresses_createOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1", + "resource": { + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/virtualNetworkAddresses_delete.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/virtualNetworkAddresses_delete.json new file mode 100644 index 000000000000..0cd1fcd5de39 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/virtualNetworkAddresses_delete.json @@ -0,0 +1,20 @@ +{ + "operationId": "VirtualNetworkAddresses_delete", + "title": "VirtualNetworkAddresses_delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/virtualNetworkAddresses_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/virtualNetworkAddresses_get.json new file mode 100644 index 000000000000..4e6ca34d8a8a --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/virtualNetworkAddresses_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "VirtualNetworkAddresses_get", + "title": "VirtualNetworkAddresses_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/virtualNetworkAddresses_listByParent.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/virtualNetworkAddresses_listByParent.json new file mode 100644 index 000000000000..06393148fcf5 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/virtualNetworkAddresses_listByParent.json @@ -0,0 +1,33 @@ +{ + "operationId": "VirtualNetworkAddresses_listByCloudVmCluster", + "title": "VirtualNetworkAddresses_listByCloudVmCluster", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/vmClusters_addVms.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/vmClusters_addVms.json new file mode 100644 index 000000000000..ae3e82195734 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/vmClusters_addVms.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudVmClusters_addVms", + "title": "CloudVmClusters_addVms", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "dbServers": [ + "ocid1..aaaa", + "ocid1..aaaaaa" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/vmClusters_create.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/vmClusters_create.json new file mode 100644 index 000000000000..81d70bdfea31 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/vmClusters_create.json @@ -0,0 +1,224 @@ +{ + "operationId": "CloudVmClusters_createOrUpdate", + "title": "CloudVmClusters_createOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "resource": { + "properties": { + "dataStorageSizeInTbs": 1000, + "dbNodeStorageSizeInGbs": 1000, + "memorySizeInGbs": 1000, + "timeZone": "UTC", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 2, + "ocpuCount": 3, + "clusterName": "cluster1", + "dataStoragePercentage": 100, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "nsgCidrs": [ + { + "source": "10.0.0.0/16", + "destinationPortRange": { + "min": 1520, + "max": 1522 + } + }, + { + "source": "10.10.0.0/24" + } + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "dbServers": [ + "ocid1..aaaa" + ] + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "BootStrapping", + "lifecycleState": "BootStrapping", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/vmClusters_delete.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/vmClusters_delete.json new file mode 100644 index 000000000000..26b2c05ca71f --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/vmClusters_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "CloudVmClusters_delete", + "title": "CloudVmClusters_delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/vmClusters_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/vmClusters_get.json new file mode 100644 index 000000000000..8b5d66fc5d5a --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/vmClusters_get.json @@ -0,0 +1,104 @@ +{ + "operationId": "CloudVmClusters_get", + "title": "CloudVmClusters_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "nsgCidrs": [ + { + "source": "10.0.0.0/16", + "destinationPortRange": { + "min": 1520, + "max": 1522 + } + }, + { + "source": "10.10.0.0/24" + } + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "nsgUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/vmClusters_listByResourceGroup.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/vmClusters_listByResourceGroup.json new file mode 100644 index 000000000000..1b0434639d71 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/vmClusters_listByResourceGroup.json @@ -0,0 +1,95 @@ +{ + "operationId": "CloudVmClusters_listByResourceGroup", + "title": "CloudVmClusters_listByResourceGroup", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/vmClusters_listBySubscription.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/vmClusters_listBySubscription.json new file mode 100644 index 000000000000..7be3134c943b --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/vmClusters_listBySubscription.json @@ -0,0 +1,94 @@ +{ + "operationId": "CloudVmClusters_listBySubscription", + "title": "CloudVmClusters_listBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/vmClusters_listPrivateIpAddresses.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/vmClusters_listPrivateIpAddresses.json new file mode 100644 index 000000000000..496cecd570e3 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/vmClusters_listPrivateIpAddresses.json @@ -0,0 +1,27 @@ +{ + "operationId": "CloudVmClusters_listPrivateIpAddresses", + "title": "CloudVmClusters_listPrivateIpAddresses", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "subnetId": "ocid1..aaaaaa", + "vnicId": "ocid1..aaaaa" + } + }, + "responses": { + "200": { + "body": [ + { + "displayName": "ip1", + "hostnameLabel": "hostname1", + "ocid": "ocid1..aaaa", + "ipAddress": "192.168.0.1", + "subnetId": "ocid1..aaaa" + } + ] + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/vmClusters_patch.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/vmClusters_patch.json new file mode 100644 index 000000000000..eca77cb6d6b2 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/vmClusters_patch.json @@ -0,0 +1,101 @@ +{ + "operationId": "CloudVmClusters_update", + "title": "CloudVmClusters_update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/vmClusters_removeVms.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/vmClusters_removeVms.json new file mode 100644 index 000000000000..b7142d5d1909 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/vmClusters_removeVms.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudVmClusters_removeVms", + "title": "CloudVmClusters_removeVms", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "dbServers": [ + "ocid1..aaaa" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseBackup_create.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseBackup_create.json new file mode 100644 index 000000000000..9ebce87139c0 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseBackup_create.json @@ -0,0 +1,71 @@ +{ + "operationId": "AutonomousDatabaseBackups_CreateOrUpdate", + "title": "AutonomousDatabaseBackups_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130", + "resource": { + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "displayName": "Nightly Backup", + "retentionPeriodInDays": 365 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "headers": { + "Retry-After": 100 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/backupdb1", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseBackup_delete.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseBackup_delete.json new file mode 100644 index 000000000000..14b89f7ae2b5 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseBackup_delete.json @@ -0,0 +1,20 @@ +{ + "operationId": "AutonomousDatabaseBackups_Delete", + "title": "AutonomousDatabaseBackups_Delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseBackup_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseBackup_get.json new file mode 100644 index 000000000000..18f1545476f1 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseBackup_get.json @@ -0,0 +1,37 @@ +{ + "operationId": "AutonomousDatabaseBackups_Get", + "title": "AutonomousDatabaseBackups_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseBackup_listByParent.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseBackup_listByParent.json new file mode 100644 index 000000000000..a29bb766f51b --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseBackup_listByParent.json @@ -0,0 +1,40 @@ +{ + "operationId": "AutonomousDatabaseBackups_ListByAutonomousDatabase", + "title": "AutonomousDatabaseBackups_ListByAutonomousDatabase", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseBackup_patch.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseBackup_patch.json new file mode 100644 index 000000000000..bbad833f86a4 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseBackup_patch.json @@ -0,0 +1,41 @@ +{ + "operationId": "AutonomousDatabaseBackups_Update", + "title": "AutonomousDatabaseBackups_Update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130", + "properties": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup updated successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 400, + "sizeInTbs": 2, + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseCharacterSet_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseCharacterSet_get.json new file mode 100644 index 000000000000..523f1ff24bed --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseCharacterSet_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseCharacterSets_get", + "title": "AutonomousDatabaseCharacterSets_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "adbscharsetname": "DATABASE" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "AL32UTF8" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseCharacterSet_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseCharacterSet_listByLocation.json new file mode 100644 index 000000000000..a76071985fef --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseCharacterSet_listByLocation.json @@ -0,0 +1,32 @@ +{ + "operationId": "AutonomousDatabaseCharacterSets_listByLocation", + "title": "AutonomousDatabaseCharacterSets_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "AL32UTF8" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "UTF8" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseClone_create.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseClone_create.json new file mode 100644 index 000000000000..9d2b4af6f591 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseClone_create.json @@ -0,0 +1,141 @@ +{ + "operationId": "AutonomousDatabases_CreateOrUpdate", + "title": "AutonomousDatabases_CreateOrUpdate_clone", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "resource": { + "properties": { + "dataBaseType": "Clone", + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "cloneType": "Full", + "displayName": "example_autonomous_databasedb1_clone", + "computeModel": "ECPU", + "computeCount": 2, + "dataStorageSizeInTbs": 1, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "adminPassword": "********", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1Clone", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "cloneType": "Full", + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Clone", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1Clone", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "cloneType": "Full", + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Clone", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseNationalCharacterSet_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseNationalCharacterSet_get.json new file mode 100644 index 000000000000..37dafabacdd5 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseNationalCharacterSet_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseNationalCharacterSets_get", + "title": "AutonomousDatabaseNationalCharacterSets_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "adbsncharsetname": "NATIONAL" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseNationalCharacterSets/NATIONAL", + "type": "Oracle.Database/locations/autonomousDatabaseNationalCharacterSets", + "properties": { + "characterSet": "AL16UTF16" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseNationalCharacterSet_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseNationalCharacterSet_listByLocation.json new file mode 100644 index 000000000000..c0b0c4f7a0aa --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseNationalCharacterSet_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabaseNationalCharacterSets_listByLocation", + "title": "AutonomousDatabaseNationalCharacterSets_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseNationalCharacterSets/NATIONAL", + "type": "Oracle.Database/locations/autonomousDatabaseNationalCharacterSets", + "properties": { + "characterSet": "AL16UTF16" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseVersion_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseVersion_get.json new file mode 100644 index 000000000000..47fa4b9d66d6 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseVersion_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseVersions_get", + "title": "AutonomousDatabaseVersions_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "autonomousdbversionsname": "18.4.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDbVersions/18.4.0.0", + "type": "Oracle.Database/locations/autonomousDbVersions", + "properties": { + "version": "18.4.0.0" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseVersion_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseVersion_listByLocation.json new file mode 100644 index 000000000000..9a726ca84fb9 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabaseVersion_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabaseVersions_listByLocation", + "title": "AutonomousDatabaseVersions_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDbVersions/18.4.0.0", + "type": "Oracle.Database/locations/autonomousDbVersions", + "properties": { + "version": "18.4.0.0" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_create.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_create.json new file mode 100644 index 000000000000..f6fea70651ba --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_create.json @@ -0,0 +1,136 @@ +{ + "operationId": "AutonomousDatabases_CreateOrUpdate", + "title": "AutonomousDatabases_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "resource": { + "properties": { + "dataBaseType": "Regular", + "displayName": "example_autonomous_databasedb1", + "computeModel": "ECPU", + "computeCount": 2, + "dataStorageSizeInTbs": 1, + "adminPassword": "********", + "dbVersion": "18.4.0.0", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_delete.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_delete.json new file mode 100644 index 000000000000..6b708c825459 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "AutonomousDatabases_delete", + "title": "AutonomousDatabases_delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_failover.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_failover.json new file mode 100644 index 000000000000..61a9ed318856 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_failover.json @@ -0,0 +1,90 @@ +{ + "operationId": "AutonomousDatabases_Failover", + "title": "AutonomousDatabases_Failover", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "peerDbId": "peerDbId" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "failedDataRecoveryInSeconds": null, + "isLocalDataGuardEnabled": true, + "timeLocalDataGuardEnabled": "2024-02-28T19:03:43.714Z", + "localDisasterRecoveryType": "Adg", + "localAdgAutoFailoverMaxDataLossLimit": 300, + "role": "Primary", + "peerDbIds": null, + "localStandbyDb": { + "lagTimeInSeconds": null, + "lifecycleDetails": null, + "lifecycleState": "RoleChangeInProgress", + "timeDataGuardRoleChanged": null, + "timeDisasterRecoveryRoleChanged": null + }, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Updating", + "lifecycleDetails": null, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Provisioning", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeOfLastFailover": null, + "timeOfLastSwitchover": null, + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_generateWallet.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_generateWallet.json new file mode 100644 index 000000000000..f7d99778b93d --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_generateWallet.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabases_generateWallet", + "title": "AutonomousDatabases_generateWallet", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "generateType": "Single", + "isRegional": false, + "password": "********" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "walletFiles": "testEncodedFiles" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_get.json new file mode 100644 index 000000000000..70f7a939e68f --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_get.json @@ -0,0 +1,63 @@ +{ + "operationId": "AutonomousDatabases_Get", + "title": "AutonomousDatabases_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_listByResourceGroup.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_listByResourceGroup.json new file mode 100644 index 000000000000..3e3e79afdef9 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_listByResourceGroup.json @@ -0,0 +1,67 @@ +{ + "operationId": "AutonomousDatabases_listByResourceGroup", + "title": "AutonomousDatabases_listByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_listBySubscription.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_listBySubscription.json new file mode 100644 index 000000000000..fc9fc22c896c --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_listBySubscription.json @@ -0,0 +1,66 @@ +{ + "operationId": "AutonomousDatabases_listBySubscription", + "title": "AutonomousDatabases_listBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_patch.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_patch.json new file mode 100644 index 000000000000..c87c05211523 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_patch.json @@ -0,0 +1,73 @@ +{ + "operationId": "AutonomousDatabases_update", + "title": "AutonomousDatabases_update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_restore.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_restore.json new file mode 100644 index 000000000000..e1ad46f498f2 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_restore.json @@ -0,0 +1,80 @@ +{ + "operationId": "AutonomousDatabases_Restore", + "title": "AutonomousDatabases_Restore", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "timestamp": "2024-04-23T00:00:00.000Z" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "backupRetentionPeriodInDays": 60, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "RestoreInProgress", + "lifecycleDetails": "", + "nextLongTermBackupTimeStamp": "2024-04-24T21:03:41.000Z", + "longTermBackupSchedule": { + "isDisabled": null, + "repeatCadence": "Weekly", + "retentionPeriodInDays": 365, + "timeOfBackup": "2024-04-21T21:03:41.309Z" + }, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_shrink.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_shrink.json new file mode 100644 index 000000000000..0d4514db9cc7 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_shrink.json @@ -0,0 +1,77 @@ +{ + "operationId": "AutonomousDatabase_shrink", + "title": "AutonomousDatabase_shrink", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "backupRetentionPeriodInDays": 90, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "ScaleInProgress", + "lifecycleDetails": "", + "nextLongTermBackupTimeStamp": "2024-04-24T21:03:41.000Z", + "longTermBackupSchedule": { + "isDisabled": null, + "repeatCadence": "Weekly", + "retentionPeriodInDays": 365, + "timeOfBackup": "2024-04-21T21:03:41.309Z" + }, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_switchover.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_switchover.json new file mode 100644 index 000000000000..24a17baf196a --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/autonomousDatabase_switchover.json @@ -0,0 +1,89 @@ +{ + "operationId": "AutonomousDatabases_Switchover", + "title": "AutonomousDatabases_Switchover", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "peerDbId": "peerDbId" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "failedDataRecoveryInSeconds": null, + "isLocalDataGuardEnabled": false, + "localDisasterRecoveryType": "BackupBased", + "localAdgAutoFailoverMaxDataLossLimit": null, + "role": "Primary", + "peerDbIds": null, + "localStandbyDb": { + "lagTimeInSeconds": null, + "lifecycleDetails": null, + "lifecycleState": "RoleChangeInProgress", + "timeDataGuardRoleChanged": null, + "timeDisasterRecoveryRoleChanged": null + }, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Updating", + "lifecycleDetails": null, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Provisioning", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeOfLastFailover": null, + "timeOfLastSwitchover": "2024-02-27T18:37:08.069Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dbNodes_action.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dbNodes_action.json new file mode 100644 index 000000000000..8759060a9153 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dbNodes_action.json @@ -0,0 +1,50 @@ +{ + "operationId": "DbNodes_Action", + "title": "DbNodes_Action", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "dbnodeocid": "ocid1....aaaaaa", + "body": { + "action": "Start" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "provisioningState": "Succeeded", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dbNodes_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dbNodes_get.json new file mode 100644 index 000000000000..f1c05c614172 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dbNodes_get.json @@ -0,0 +1,41 @@ +{ + "operationId": "DbNodes_get", + "title": "DbNodes_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "dbnodeocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "lifecycleState": "Available", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dbNodes_listByParent.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dbNodes_listByParent.json new file mode 100644 index 000000000000..a129607a449b --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dbNodes_listByParent.json @@ -0,0 +1,45 @@ +{ + "operationId": "DbNodes_listByParent", + "title": "DbNodes_listByParent", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "lifecycleState": "Available", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dbServers_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dbServers_get.json new file mode 100644 index 000000000000..b36cbd0ca1f1 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dbServers_get.json @@ -0,0 +1,42 @@ +{ + "operationId": "DbServers_get", + "title": "DbServers_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "dbserverocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1/dbServers/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbServers", + "properties": { + "ocid": "ocid1", + "displayName": "dbserver1", + "compartmentId": "ocid1....aaaa", + "exadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "cpuCoreCount": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 150, + "vmClusterIds": [ + "ocid1..aaaaa" + ], + "dbNodeIds": [ + "ocid1..aaaaa" + ], + "lifecycleState": "Available", + "maxCpuCount": 1000, + "autonomousVmClusterIds": [ + "ocid1..aaaaa" + ], + "autonomousVirtualMachineIds": [ + "ocid1..aaaaa" + ] + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dbServers_listByParent.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dbServers_listByParent.json new file mode 100644 index 000000000000..e373e2fe04ff --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dbServers_listByParent.json @@ -0,0 +1,46 @@ +{ + "operationId": "DbServers_listByCloudExadataInfrastructure", + "title": "DbServers_listByCloudExadataInfrastructure", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1/dbServers/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbServers", + "properties": { + "ocid": "ocid1", + "displayName": "dbserver1", + "compartmentId": "ocid1....aaaa", + "exadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "cpuCoreCount": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 150, + "vmClusterIds": [ + "ocid1..aaaaa" + ], + "dbNodeIds": [ + "ocid1..aaaaa" + ], + "lifecycleState": "Available", + "maxCpuCount": 1000, + "autonomousVmClusterIds": [ + "ocid1..aaaaa" + ], + "autonomousVirtualMachineIds": [ + "ocid1..aaaaa" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dbSystemShapes_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dbSystemShapes_get.json new file mode 100644 index 000000000000..ded7bb7b5c5e --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dbSystemShapes_get.json @@ -0,0 +1,40 @@ +{ + "operationId": "DbSystemShapes_get", + "title": "DbSystemShapes_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dbsystemshapename": "EXADATA.X9M" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dbSystemShapes/EXADATA.X9M", + "type": "Oracle.Database/locations/dbSystemShapes", + "properties": { + "shapeFamily": "EXADATA", + "availableCoreCount": 100, + "minimumCoreCount": 1, + "runtimeMinimumCoreCount": 1, + "coreCountIncrement": 1, + "minStorageCount": 0, + "maxStorageCount": 100, + "availableDataStoragePerServerInTbs": 100, + "availableMemoryPerNodeInGbs": 10, + "availableDbNodePerNodeInGbs": 10, + "minCoreCountPerNode": 0, + "availableMemoryInGbs": 10, + "minMemoryPerNodeInGbs": 0, + "availableDbNodeStorageInGbs": 10, + "minDbNodeStoragePerNodeInGbs": 0, + "availableDataStorageInTbs": 10, + "minDataStorageInTbs": 0, + "minimumNodeCount": 0, + "maximumNodeCount": 1000, + "availableCoreCountPerNode": 1000 + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dbSystemShapes_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dbSystemShapes_listByLocation.json new file mode 100644 index 000000000000..961bceef1071 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dbSystemShapes_listByLocation.json @@ -0,0 +1,44 @@ +{ + "operationId": "DbSystemShapes_listByLocation", + "title": "DbSystemShapes_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dbSystemShapes/EXADATA.X9M", + "type": "Oracle.Database/locations/dbSystemShapes", + "properties": { + "shapeFamily": "EXADATA", + "availableCoreCount": 100, + "minimumCoreCount": 1, + "runtimeMinimumCoreCount": 1, + "coreCountIncrement": 1, + "minStorageCount": 0, + "maxStorageCount": 100, + "availableDataStoragePerServerInTbs": 100, + "availableMemoryPerNodeInGbs": 10, + "availableDbNodePerNodeInGbs": 10, + "minCoreCountPerNode": 0, + "availableMemoryInGbs": 10, + "minMemoryPerNodeInGbs": 0, + "availableDbNodeStorageInGbs": 10, + "minDbNodeStoragePerNodeInGbs": 0, + "availableDataStorageInTbs": 10, + "minDataStorageInTbs": 0, + "minimumNodeCount": 0, + "maximumNodeCount": 1000, + "availableCoreCountPerNode": 1000 + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dnsPrivateViews_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dnsPrivateViews_get.json new file mode 100644 index 000000000000..826e6cbed202 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dnsPrivateViews_get.json @@ -0,0 +1,27 @@ +{ + "operationId": "DnsPrivateViews_get", + "title": "DnsPrivateViews_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dnsprivateviewocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaaa", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaaa", + "displayName": "example-dns-private-view", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/your-dns-private-view", + "timeCreated": "2023-10-26T12:34:56Z", + "timeUpdated": "2023-10-26T14:00:00Z" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dnsPrivateViews_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dnsPrivateViews_listByLocation.json new file mode 100644 index 000000000000..41452ef83946 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dnsPrivateViews_listByLocation.json @@ -0,0 +1,44 @@ +{ + "operationId": "DnsPrivateViews_listByLocation", + "title": "DnsPrivateViews_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaaa", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaaa", + "displayName": "example-dns-private-view1", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/view1", + "timeCreated": "2023-10-26T12:34:56Z", + "timeUpdated": "2023-10-26T14:00:00Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaab", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaab", + "displayName": "example-dns-private-view2", + "isProtected": true, + "lifecycleState": "Creating", + "self": "https://api.example.com/view2", + "timeCreated": "2023-10-27T09:45:00Z", + "timeUpdated": "2023-10-27T10:30:00Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dnsPrivateZones_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dnsPrivateZones_get.json new file mode 100644 index 000000000000..8f025cdf4583 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dnsPrivateZones_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "DnsPrivateZones_get", + "title": "DnsPrivateZones_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dnsprivatezonename": "example-dns-private-zone" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/example-dns-private-zone", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "your-zone-id", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/your-dns-private-zone", + "serial": 12345, + "version": "1.0.0.0", + "viewId": "your-view-id", + "zoneType": "Primary", + "timeCreated": "2023-10-26T12:34:56Z" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dnsPrivateZones_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dnsPrivateZones_listByLocation.json new file mode 100644 index 000000000000..f83d475eaf7a --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dnsPrivateZones_listByLocation.json @@ -0,0 +1,48 @@ +{ + "operationId": "DnsPrivateZones_listByLocation", + "title": "DnsPrivateZones_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/zone1", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "zone-id-1", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/zone1", + "serial": 12345, + "version": "1.0.0.0", + "viewId": "view-id-1", + "zoneType": "Primary", + "timeCreated": "2023-10-26T12:34:56Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/zone2", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "zone-id-2", + "isProtected": true, + "lifecycleState": "Creating", + "self": "https://api.example.com/zone2", + "serial": 54321, + "version": "2.0.0.0", + "viewId": "view-id-2", + "zoneType": "Secondary", + "timeCreated": "2023-10-27T09:45:00Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/exaInfra_addStorageCapacity.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/exaInfra_addStorageCapacity.json new file mode 100644 index 000000000000..a8c9b7f02411 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/exaInfra_addStorageCapacity.json @@ -0,0 +1,95 @@ +{ + "operationId": "CloudExadataInfrastructures_addStorageCapacity", + "title": "CloudExadataInfrastructures_addStorageCapacity", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/exaInfra_create.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/exaInfra_create.json new file mode 100644 index 000000000000..fe163d1df594 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/exaInfra_create.json @@ -0,0 +1,184 @@ +{ + "operationId": "CloudExadataInfrastructures_createOrUpdate", + "title": "CloudExadataInfrastructures_createOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "resource": { + "properties": { + "computeCount": 100, + "storageCount": 10, + "shape": "EXADATA.X9M", + "displayName": "infra 1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "zones": [ + "1" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/exaInfra_delete.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/exaInfra_delete.json new file mode 100644 index 000000000000..690faa2619be --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/exaInfra_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "CloudExadataInfrastructures_delete", + "title": "CloudExadataInfrastructures_delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/exaInfra_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/exaInfra_get.json new file mode 100644 index 000000000000..02018dc9d070 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/exaInfra_get.json @@ -0,0 +1,89 @@ +{ + "operationId": "CloudExadataInfrastructures_get", + "title": "CloudExadataInfrastructures_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/exaInfra_listByResourceGroup.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/exaInfra_listByResourceGroup.json new file mode 100644 index 000000000000..637714be7f17 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/exaInfra_listByResourceGroup.json @@ -0,0 +1,93 @@ +{ + "operationId": "CloudExadataInfrastructures_listByResourceGroup", + "title": "CloudExadataInfrastructures_listByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/exaInfra_listBySubscription.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/exaInfra_listBySubscription.json new file mode 100644 index 000000000000..bc1d84648c85 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/exaInfra_listBySubscription.json @@ -0,0 +1,92 @@ +{ + "operationId": "CloudExadataInfrastructures_listBySubscription", + "title": "CloudExadataInfrastructures_listBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/exaInfra_patch.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/exaInfra_patch.json new file mode 100644 index 000000000000..4d224bfb31e5 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/exaInfra_patch.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudExadataInfrastructures_update", + "title": "CloudExadataInfrastructures_update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + }, + "zones": [ + "1" + ] + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/giVersions_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/giVersions_get.json new file mode 100644 index 000000000000..9f869012ffa4 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/giVersions_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "GiVersions_get", + "title": "GiVersions_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "giversionname": "19.0.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/giVersions/19.0.0.0", + "type": "Oracle.Database/locations/giVersions", + "properties": { + "version": "19.0.0.0" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/giVersions_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/giVersions_listByLocation.json new file mode 100644 index 000000000000..e1f9a8790206 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/giVersions_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "GiVersions_listByLocation", + "title": "GiVersions_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/giVersions/19.0.0.0", + "type": "Oracle.Database/locations/giVersions", + "properties": { + "version": "19.0.0.0" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/operations_list.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/operations_list.json new file mode 100644 index 000000000000..90d233fd2bed --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/operations_list.json @@ -0,0 +1,25 @@ +{ + "operationId": "Operations_list", + "title": "Operations_list", + "parameters": { + "api-version": "2024-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Oracle.Database/cloudExadataInfrastructures/Read", + "isDataAction": false, + "display": { + "provider": "Oracle.Database", + "resource": "cloudExadataInfrastructures", + "operation": "Get/list Exadata Infrastructure resources", + "description": "Reads Exadata Infrastructure" + } + } + ] + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/oracleSubscriptions_addAzureSubscriptions.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/oracleSubscriptions_addAzureSubscriptions.json new file mode 100644 index 000000000000..5ced338ab0a8 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/oracleSubscriptions_addAzureSubscriptions.json @@ -0,0 +1,21 @@ +{ + "operationId": "OracleSubscriptions_addAzureSubscriptions", + "title": "OracleSubscriptions_addAzureSubscriptions", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "body": { + "azureSubscriptionIds": [ + "00000000-0000-0000-0000-000000000001" + ] + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/oracleSubscriptions_create.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/oracleSubscriptions_create.json new file mode 100644 index 000000000000..087479add3a6 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/oracleSubscriptions_create.json @@ -0,0 +1,56 @@ +{ + "operationId": "OracleSubscriptions_createOrUpdate", + "title": "OracleSubscriptions_createOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resource": { + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/oracleSubscriptions_delete.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/oracleSubscriptions_delete.json new file mode 100644 index 000000000000..8f36e973bb3e --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/oracleSubscriptions_delete.json @@ -0,0 +1,17 @@ +{ + "operationId": "OracleSubscriptions_delete", + "title": "OracleSubscriptions_delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/oracleSubscriptions_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/oracleSubscriptions_get.json new file mode 100644 index 000000000000..54ff6b48c87e --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/oracleSubscriptions_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "OracleSubscriptions_get", + "title": "OracleSubscriptions_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/oracleSubscriptions_listActivationLinks.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/oracleSubscriptions_listActivationLinks.json new file mode 100644 index 000000000000..8e1f22e31ef5 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/oracleSubscriptions_listActivationLinks.json @@ -0,0 +1,22 @@ +{ + "operationId": "OracleSubscriptions_listActivationLinks", + "title": "OracleSubscriptions_listActivationLinks", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "newCloudAccountActivationLink": "https://new-tenancy-activation-link", + "existingCloudAccountActivationLink": "https://existing-tenancy-activation-link" + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/oracleSubscriptions_listBySubscription.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/oracleSubscriptions_listBySubscription.json new file mode 100644 index 000000000000..e7ddb186b915 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/oracleSubscriptions_listBySubscription.json @@ -0,0 +1,34 @@ +{ + "operationId": "OracleSubscriptions_listBySubscription", + "title": "OracleSubscriptions_listBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/oracleSubscriptions_listCloudAccountDetails.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/oracleSubscriptions_listCloudAccountDetails.json new file mode 100644 index 000000000000..92430982a4a4 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/oracleSubscriptions_listCloudAccountDetails.json @@ -0,0 +1,22 @@ +{ + "operationId": "OracleSubscriptions_listCloudAccountDetails", + "title": "OracleSubscriptions_listCloudAccountDetails", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "cloudAccountName": "Cloud Account", + "cloudAccountHomeRegion": "East US" + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/oracleSubscriptions_listSaasSubscriptionDetails.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/oracleSubscriptions_listSaasSubscriptionDetails.json new file mode 100644 index 000000000000..7fbb31a28fb5 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/oracleSubscriptions_listSaasSubscriptionDetails.json @@ -0,0 +1,32 @@ +{ + "operationId": "OracleSubscriptions_listSaasSubscriptionDetails", + "title": "OracleSubscriptions_listSaasSubscriptionDetails", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "1234567890", + "subscriptionName": "Oracle", + "timeCreated": "2022-03-07T00:00:00Z", + "offerId": "offer1", + "planId": "silver", + "saasSubscriptionStatus": "PendingFulfillmentStart", + "publisherId": "Oracle", + "purchaserEmailId": "test@test.com", + "purchaserTenantId": "1234567890", + "termUnit": "P1M", + "isAutoRenew": true, + "isFreeTrial": false + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/oracleSubscriptions_patch.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/oracleSubscriptions_patch.json new file mode 100644 index 000000000000..68ba78376523 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/oracleSubscriptions_patch.json @@ -0,0 +1,43 @@ +{ + "operationId": "OracleSubscriptions_update", + "title": "OracleSubscriptions_update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/systemVersions_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/systemVersions_get.json new file mode 100644 index 000000000000..5f490d631bd4 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/systemVersions_get.json @@ -0,0 +1,20 @@ +{ + "operationId": "SystemVersions_Get", + "title": "systemVersions_listSystemVersions", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "systemversionname": "22.x" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/systemVersion/22.1.7.0.0.230113", + "properties": { + "systemVersion": "22.1.7.0.0.230113" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/systemVersions_listByLocation.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/systemVersions_listByLocation.json new file mode 100644 index 000000000000..cab8022e27f1 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/systemVersions_listByLocation.json @@ -0,0 +1,24 @@ +{ + "operationId": "SystemVersions_ListByLocation", + "title": "systemVersions_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/systemVersion/22.1.7.0.0.230113", + "properties": { + "systemVersion": "22.1.7.0.0.230113" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/virtualNetworkAddresses_create.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/virtualNetworkAddresses_create.json new file mode 100644 index 000000000000..1060f3098866 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/virtualNetworkAddresses_create.json @@ -0,0 +1,48 @@ +{ + "operationId": "VirtualNetworkAddresses_createOrUpdate", + "title": "VirtualNetworkAddresses_createOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1", + "resource": { + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/virtualNetworkAddresses_delete.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/virtualNetworkAddresses_delete.json new file mode 100644 index 000000000000..154d26c1fccb --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/virtualNetworkAddresses_delete.json @@ -0,0 +1,20 @@ +{ + "operationId": "VirtualNetworkAddresses_delete", + "title": "VirtualNetworkAddresses_delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/virtualNetworkAddresses_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/virtualNetworkAddresses_get.json new file mode 100644 index 000000000000..21de10dd3bc8 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/virtualNetworkAddresses_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "VirtualNetworkAddresses_get", + "title": "VirtualNetworkAddresses_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/virtualNetworkAddresses_listByParent.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/virtualNetworkAddresses_listByParent.json new file mode 100644 index 000000000000..8cb03a39fb76 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/virtualNetworkAddresses_listByParent.json @@ -0,0 +1,33 @@ +{ + "operationId": "VirtualNetworkAddresses_listByCloudVmCluster", + "title": "VirtualNetworkAddresses_listByCloudVmCluster", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/vmClusters_addVms.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/vmClusters_addVms.json new file mode 100644 index 000000000000..376ab18bcab7 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/vmClusters_addVms.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudVmClusters_addVms", + "title": "CloudVmClusters_addVms", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "dbServers": [ + "ocid1..aaaa", + "ocid1..aaaaaa" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/vmClusters_create.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/vmClusters_create.json new file mode 100644 index 000000000000..5f3f539ba6a8 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/vmClusters_create.json @@ -0,0 +1,224 @@ +{ + "operationId": "CloudVmClusters_createOrUpdate", + "title": "CloudVmClusters_createOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "resource": { + "properties": { + "dataStorageSizeInTbs": 1000, + "dbNodeStorageSizeInGbs": 1000, + "memorySizeInGbs": 1000, + "timeZone": "UTC", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 2, + "ocpuCount": 3, + "clusterName": "cluster1", + "dataStoragePercentage": 100, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "nsgCidrs": [ + { + "source": "10.0.0.0/16", + "destinationPortRange": { + "min": 1520, + "max": 1522 + } + }, + { + "source": "10.10.0.0/24" + } + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "dbServers": [ + "ocid1..aaaa" + ] + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "BootStrapping", + "lifecycleState": "BootStrapping", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/vmClusters_delete.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/vmClusters_delete.json new file mode 100644 index 000000000000..4892b0899e72 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/vmClusters_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "CloudVmClusters_delete", + "title": "CloudVmClusters_delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/vmClusters_get.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/vmClusters_get.json new file mode 100644 index 000000000000..7bf1d3d3d351 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/vmClusters_get.json @@ -0,0 +1,104 @@ +{ + "operationId": "CloudVmClusters_get", + "title": "CloudVmClusters_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "nsgCidrs": [ + { + "source": "10.0.0.0/16", + "destinationPortRange": { + "min": 1520, + "max": 1522 + } + }, + { + "source": "10.10.0.0/24" + } + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "nsgUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/vmClusters_listByResourceGroup.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/vmClusters_listByResourceGroup.json new file mode 100644 index 000000000000..ebe7f027aacb --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/vmClusters_listByResourceGroup.json @@ -0,0 +1,95 @@ +{ + "operationId": "CloudVmClusters_listByResourceGroup", + "title": "CloudVmClusters_listByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/vmClusters_listBySubscription.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/vmClusters_listBySubscription.json new file mode 100644 index 000000000000..26d22f28ced8 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/vmClusters_listBySubscription.json @@ -0,0 +1,94 @@ +{ + "operationId": "CloudVmClusters_listBySubscription", + "title": "CloudVmClusters_listBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/vmClusters_listPrivateIpAddresses.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/vmClusters_listPrivateIpAddresses.json new file mode 100644 index 000000000000..9bf2ea94b6e0 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/vmClusters_listPrivateIpAddresses.json @@ -0,0 +1,27 @@ +{ + "operationId": "CloudVmClusters_listPrivateIpAddresses", + "title": "CloudVmClusters_listPrivateIpAddresses", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "subnetId": "ocid1..aaaaaa", + "vnicId": "ocid1..aaaaa" + } + }, + "responses": { + "200": { + "body": [ + { + "displayName": "ip1", + "hostnameLabel": "hostname1", + "ocid": "ocid1..aaaa", + "ipAddress": "192.168.0.1", + "subnetId": "ocid1..aaaa" + } + ] + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/vmClusters_patch.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/vmClusters_patch.json new file mode 100644 index 000000000000..677fa1d0a913 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/vmClusters_patch.json @@ -0,0 +1,101 @@ +{ + "operationId": "CloudVmClusters_update", + "title": "CloudVmClusters_update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/vmClusters_removeVms.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/vmClusters_removeVms.json new file mode 100644 index 000000000000..27fe11214c93 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/vmClusters_removeVms.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudVmClusters_removeVms", + "title": "CloudVmClusters_removeVms", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "dbServers": [ + "ocid1..aaaa" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/Oracle.Database.Management/main.tsp b/specification/oracle/Oracle.Database.Management/main.tsp new file mode 100644 index 000000000000..b94fd50efc8e --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/main.tsp @@ -0,0 +1,41 @@ +import "@azure-tools/typespec-autorest"; +import "./operations/exadata/exadatainfrastructureOperations.tsp"; +import "./operations/exadata/dbServersOperations.tsp"; +import "./operations/exadata/vmclusterOperations.tsp"; +import "./operations/exadata/virtualNetworkAddressOperations.tsp"; +import "./operations/exadata/systemVersionOperations.tsp"; +import "./operations/oraclesubscription/oracleSubscriptionOperations.tsp"; +import "./operations/exadata/dbNodesOperations.tsp"; +import "./operations/exadata/giVersionOperations.tsp"; +import "./operations/exadata/dbSystemShapeOperations.tsp"; +import "./operations/exadata/dnsPrivateViewsOperations.tsp"; +import "./operations/exadata/dnsPrivateZonesOperations.tsp"; +import "./operations/autonomousdatabase/autonomousDatabaseOperations.tsp"; +import "./operations/autonomousdatabase/autonomousDatabaseBackupOperations.tsp"; +import "./operations/autonomousdatabase/autonomousDatabaseCharacterSetOperations.tsp"; +import "./operations/autonomousdatabase/autonomousDatabaseNationalCharacterSetOperations.tsp"; +import "./operations/autonomousdatabase/autonomousDatabaseVersionOperations.tsp"; + +import "./versions.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.ResourceManager; +using OpenAPI; +using Autorest; + +@armProviderNamespace +@service({ + title: "Oracle Database Resource Manager", +}) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +@versioned(Oracle.Database.Versions) +namespace Oracle.Database; + +interface Operations extends Azure.ResourceManager.Operations {} + +@@Autorest.example(Operations.list, + "./examples/operations_list.json", + "List Operations" +); diff --git a/specification/oracle/Oracle.Database.Management/operations/autonomousdatabase/autonomousDatabaseBackupOperations.tsp b/specification/oracle/Oracle.Database.Management/operations/autonomousdatabase/autonomousDatabaseBackupOperations.tsp new file mode 100644 index 000000000000..cbc60e6f6656 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/operations/autonomousdatabase/autonomousDatabaseBackupOperations.tsp @@ -0,0 +1,46 @@ +import "../../../models/autonomousdatabase/autonomousDatabaseBackup.tsp"; +import "../commons.tsp"; + +using Azure.ResourceManager; +using Autorest; +using TypeSpec.Versioning; + +namespace Oracle.Database; + +@armResourceOperations(AutonomousDatabaseBackup) +interface AutonomousDatabaseBackups + extends OracleChildResource< + AutonomousDatabaseBackup, + AutonomousDatabaseBackupProperties + > { + @Autorest.example( + "./examples/autonomousDatabaseBackup_patch.json", + "Patch Autonomous Database Backup." + ) + update is ArmCustomPatchAsync< + AutonomousDatabaseBackup, + Azure.ResourceManager.Foundations.ResourceUpdateModel< + AutonomousDatabaseBackup, + AutonomousDatabaseBackupProperties + > + >; + + @Autorest.example( + "./examples/autonomousDatabaseBackup_listByParent.json", + "List Autonomous Database Backups by Autonomous Database." + ) + listByAutonomousDatabase is ArmResourceListByParent; +} + +@@Autorest.example(AutonomousDatabaseBackups.createOrUpdate, + "./examples/autonomousDatabaseBackup_create.json", + "Create Autonomous Database Backup." +); +@@Autorest.example(AutonomousDatabaseBackups.get, + "./examples/autonomousDatabaseBackup_get.json", + "Get Autonomous Database Backup." +); +@@Autorest.example(AutonomousDatabaseBackups.delete, + "./examples/autonomousDatabaseBackup_delete.json", + "Delete Autonomous Database Backup." +); diff --git a/specification/oracle/Oracle.Database.Management/operations/autonomousdatabase/autonomousDatabaseCharacterSetOperations.tsp b/specification/oracle/Oracle.Database.Management/operations/autonomousdatabase/autonomousDatabaseCharacterSetOperations.tsp new file mode 100644 index 000000000000..221e5878de33 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/operations/autonomousdatabase/autonomousDatabaseCharacterSetOperations.tsp @@ -0,0 +1,24 @@ +import "../../../models/autonomousdatabase/autonomousDatabaseCharacterSet.tsp"; + +using Azure.ResourceManager; +using Autorest; +using TypeSpec.Versioning; + +namespace Oracle.Database; + +@armResourceOperations +interface AutonomousDatabaseCharacterSets + extends OracleLocationBasedResource {} + +@@doc(AutonomousDatabaseCharacterSets.listByLocation, + "List AutonomousDatabaseCharacterSet resources by Location" +); + +@@Autorest.example(AutonomousDatabaseCharacterSets.listByLocation, + "./examples/autonomousDatabaseCharacterSet_listByLocation.json", + "List autonomous db character sets by location" +); +@@Autorest.example(AutonomousDatabaseCharacterSets.get, + "./examples/autonomousDatabaseCharacterSet_get.json", + "Get autonomous db character set" +); diff --git a/specification/oracle/Oracle.Database.Management/operations/autonomousdatabase/autonomousDatabaseNationalCharacterSetOperations.tsp b/specification/oracle/Oracle.Database.Management/operations/autonomousdatabase/autonomousDatabaseNationalCharacterSetOperations.tsp new file mode 100644 index 000000000000..a71ed0035476 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/operations/autonomousdatabase/autonomousDatabaseNationalCharacterSetOperations.tsp @@ -0,0 +1,24 @@ +import "../../../models/autonomousdatabase/autonomousDatabaseNationalCharacterSet.tsp"; + +using Azure.ResourceManager; +using Autorest; +using TypeSpec.Versioning; + +namespace Oracle.Database; + +@armResourceOperations +interface AutonomousDatabaseNationalCharacterSets + extends OracleLocationBasedResource {} + +@@doc(AutonomousDatabaseNationalCharacterSets.listByLocation, + "List AutonomousDatabaseNationalCharacterSet resources by Location" +); + +@@Autorest.example(AutonomousDatabaseNationalCharacterSets.listByLocation, + "./examples/autonomousDatabaseNationalCharacterSet_listByLocation.json", + "List autonomous db national character sets by location" +); +@@Autorest.example(AutonomousDatabaseNationalCharacterSets.get, + "./examples/autonomousDatabaseNationalCharacterSet_get.json", + "Get autonomous db national character set" +); diff --git a/specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseOperations.tsp b/specification/oracle/Oracle.Database.Management/operations/autonomousdatabase/autonomousDatabaseOperations.tsp similarity index 87% rename from specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseOperations.tsp rename to specification/oracle/Oracle.Database.Management/operations/autonomousdatabase/autonomousDatabaseOperations.tsp index 904388c44365..b8f7b72e0066 100644 --- a/specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseOperations.tsp +++ b/specification/oracle/Oracle.Database.Management/operations/autonomousdatabase/autonomousDatabaseOperations.tsp @@ -13,7 +13,7 @@ interface AutonomousDatabases > { //OCI switchover API doc: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/SwitchoverAutonomousDatabase @doc("Perform switchover action on Autonomous Database") - @example( + @Autorest.example( "./examples/autonomousDatabase_switchover.json", "Perform switchover action on Autonomous Database" ) @@ -25,7 +25,7 @@ interface AutonomousDatabases //OCI failover API doc: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/FailOverAutonomousDatabase @doc("Perform failover action on Autonomous Database") - @example( + @Autorest.example( "./examples/autonomousDatabase_failover.json", "Perform failover action on Autonomous Database" ) @@ -37,7 +37,7 @@ interface AutonomousDatabases //OCI generate wallet API doc: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/GenerateAutonomousDatabaseWallet @doc("Generate wallet action on Autonomous Database") - @example( + @Autorest.example( "./examples/autonomousDatabase_generateWallet.json", "Generate wallet action on Autonomous Database" ) @@ -49,7 +49,7 @@ interface AutonomousDatabases //OCI RestoreAutonomousDatabase API doc: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/RestoreAutonomousDatabase @doc("Restores an Autonomous Database based on the provided request parameters.") - @example( + @Autorest.example( "./examples/autonomousDatabase_restore.json", "Perform restore action on Autonomous Database" ) @@ -61,7 +61,7 @@ interface AutonomousDatabases //OCI ShrinkAutonomousDatabase API doc: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/ShrinkAutonomousDatabase @doc("This operation shrinks the current allocated storage down to the current actual used data storage.") - @example( + @Autorest.example( "./examples/autonomousDatabase_shrink.json", "Perform shrink action on Autonomous Database" ) @@ -72,31 +72,31 @@ interface AutonomousDatabases >; } -@@example(AutonomousDatabases.listBySubscription, +@@Autorest.example(AutonomousDatabases.listBySubscription, "./examples/autonomousDatabase_listBySubscription.json", "List Autonomous Database by subscription" ); -@@example(AutonomousDatabases.listByResourceGroup, +@@Autorest.example(AutonomousDatabases.listByResourceGroup, "./examples/autonomousDatabase_listByResourceGroup.json", "List Autonomous Database by resource group" ); -@@example(AutonomousDatabases.createOrUpdate, +@@Autorest.example(AutonomousDatabases.createOrUpdate, "./examples/autonomousDatabase_create.json", "Create Autonomous Database" ); -@@example(AutonomousDatabases.createOrUpdate, +@@Autorest.example(AutonomousDatabases.createOrUpdate, "./examples/autonomousDatabaseClone_create.json", "Create clone Autonomous Database" ); -@@example(AutonomousDatabases.get, +@@Autorest.example(AutonomousDatabases.get, "./examples/autonomousDatabase_get.json", "Get Autonomous Database" ); -@@example(AutonomousDatabases.update, +@@Autorest.example(AutonomousDatabases.update, "./examples/autonomousDatabase_patch.json", "Patch Autonomous Database" ); -@@example(AutonomousDatabases.delete, +@@Autorest.example(AutonomousDatabases.delete, "./examples/autonomousDatabase_delete.json", "Delete Autonomous Database" ); diff --git a/specification/oracle/Oracle.Database.Management/operations/autonomousdatabase/autonomousDatabaseVersionOperations.tsp b/specification/oracle/Oracle.Database.Management/operations/autonomousdatabase/autonomousDatabaseVersionOperations.tsp new file mode 100644 index 000000000000..fba17da1afeb --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/operations/autonomousdatabase/autonomousDatabaseVersionOperations.tsp @@ -0,0 +1,25 @@ +import "@azure-tools/typespec-azure-resource-manager"; +import "../../../models/autonomousdatabase/autonomousDatabaseVersion.tsp"; + +using Azure.ResourceManager; +using Autorest; +using TypeSpec.Versioning; + +namespace Oracle.Database; + +@armResourceOperations +interface AutonomousDatabaseVersions + extends OracleLocationBasedResource {} + +@@doc(AutonomousDatabaseVersions.listByLocation, + "List AutonomousDbVersion resources by Location" +); + +@@Autorest.example(AutonomousDatabaseVersions.listByLocation, + "./examples/autonomousDatabaseVersion_listByLocation.json", + "List an autonomous versions by location" +); +@@Autorest.example(AutonomousDatabaseVersions.get, + "./examples/autonomousDatabaseVersion_get.json", + "Get an autonomous version" +); diff --git a/specification/oracle/Oracle.Database/operations/commons.tsp b/specification/oracle/Oracle.Database.Management/operations/commons.tsp similarity index 100% rename from specification/oracle/Oracle.Database/operations/commons.tsp rename to specification/oracle/Oracle.Database.Management/operations/commons.tsp diff --git a/specification/oracle/Oracle.Database.Management/operations/exadata/dbNodesOperations.tsp b/specification/oracle/Oracle.Database.Management/operations/exadata/dbNodesOperations.tsp new file mode 100644 index 000000000000..0404892cf0bb --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/operations/exadata/dbNodesOperations.tsp @@ -0,0 +1,27 @@ +import "@azure-tools/typespec-azure-resource-manager"; +import "../../../models/exadata/dbNodes.tsp"; + +using Azure.ResourceManager; +using Autorest; +using TypeSpec.Versioning; + +namespace Oracle.Database; + +@armResourceOperations +interface DbNodes extends OracleReadOnlyResource { + // TODO: Swagger generator bug, cannot be extracted to interface + @Autorest.example( + "./examples/dbNodes_listByParent.json", + "List DbNodes by VM Cluster" + ) + listByCloudVmCluster is ArmResourceListByParent; + + @doc("VM actions on DbNode of VM Cluster by the provided filter") + @Autorest.example( + "./examples/dbNodes_action.json", + "VM actions on DbNodes of VM Cluster" + ) + action is ArmResourceActionAsync; +} + +@@Autorest.example(DbNodes.get, "./examples/dbNodes_get.json", "Get DbNode"); diff --git a/specification/oracle/Oracle.Database/operations/exadata/dbServersOperations.tsp b/specification/oracle/Oracle.Database.Management/operations/exadata/dbServersOperations.tsp similarity index 78% rename from specification/oracle/Oracle.Database/operations/exadata/dbServersOperations.tsp rename to specification/oracle/Oracle.Database.Management/operations/exadata/dbServersOperations.tsp index 01a98b2d27af..d85881cbfe66 100644 --- a/specification/oracle/Oracle.Database/operations/exadata/dbServersOperations.tsp +++ b/specification/oracle/Oracle.Database.Management/operations/exadata/dbServersOperations.tsp @@ -9,14 +9,14 @@ namespace Oracle.Database; @armResourceOperations interface DbServers extends OracleReadOnlyResource { - @example( + @Autorest.example( "./examples/dbServers_listByParent.json", "List DbServers by Exadata Infrastructure" ) - listByParent is ArmResourceListByParent; + listByCloudExadataInfrastructure is ArmResourceListByParent; } -@@example(DbServers.get, +@@Autorest.example(DbServers.get, "./examples/dbServers_get.json", "Get DbServer by parent" ); diff --git a/specification/oracle/Oracle.Database.Management/operations/exadata/dbSystemShapeOperations.tsp b/specification/oracle/Oracle.Database.Management/operations/exadata/dbSystemShapeOperations.tsp new file mode 100644 index 000000000000..14842e0c2216 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/operations/exadata/dbSystemShapeOperations.tsp @@ -0,0 +1,22 @@ +import "../../../models/exadata/dbSystemShapes.tsp"; + +using Azure.ResourceManager; +using Autorest; + +namespace Oracle.Database; + +@armResourceOperations +interface DbSystemShapes extends OracleLocationBasedResource {} + +@@doc(DbSystemShapes.listByLocation, + "List DbSystemShape resources by Location" +); + +@@Autorest.example(DbSystemShapes.listByLocation, + "./examples/dbSystemShapes_listByLocation.json", + "List DbSystemShapes by location" +); +@@Autorest.example(DbSystemShapes.get, + "./examples/dbSystemShapes_get.json", + "Get a DbSystemShape by name" +); diff --git a/specification/oracle/Oracle.Database.Management/operations/exadata/dnsPrivateViewsOperations.tsp b/specification/oracle/Oracle.Database.Management/operations/exadata/dnsPrivateViewsOperations.tsp new file mode 100644 index 000000000000..edd7a5616f34 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/operations/exadata/dnsPrivateViewsOperations.tsp @@ -0,0 +1,22 @@ +import "../../../models/exadata/dnsPrivateViews.tsp"; + +using Azure.ResourceManager; +using Autorest; + +namespace Oracle.Database; + +@armResourceOperations +interface DnsPrivateViews extends OracleLocationBasedResource {} + +@@doc(DnsPrivateViews.listByLocation, + "List DnsPrivateView resources by Location" +); + +@@Autorest.example(DnsPrivateViews.listByLocation, + "./examples/dnsPrivateViews_listByLocation.json", + "List DnsPrivateViews by location" +); +@@Autorest.example(DnsPrivateViews.get, + "./examples/dnsPrivateViews_get.json", + "Get a DnsPrivateView by name" +); diff --git a/specification/oracle/Oracle.Database.Management/operations/exadata/dnsPrivateZonesOperations.tsp b/specification/oracle/Oracle.Database.Management/operations/exadata/dnsPrivateZonesOperations.tsp new file mode 100644 index 000000000000..7ca39016ff1a --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/operations/exadata/dnsPrivateZonesOperations.tsp @@ -0,0 +1,22 @@ +import "../../../models/exadata/dnsPrivateZones.tsp"; + +using Azure.ResourceManager; +using Autorest; + +namespace Oracle.Database; + +@armResourceOperations +interface DnsPrivateZones extends OracleLocationBasedResource {} + +@@doc(DnsPrivateZones.listByLocation, + "List DnsPrivateZone resources by Location" +); + +@@Autorest.example(DnsPrivateZones.listByLocation, + "./examples/dnsPrivateZones_listByLocation.json", + "List DnsPrivateZones by location" +); +@@Autorest.example(DnsPrivateZones.get, + "./examples/dnsPrivateZones_get.json", + "Get a DnsPrivateZone by name" +); diff --git a/specification/oracle/Oracle.Database/operations/exadata/exadatainfrastructureOperations.tsp b/specification/oracle/Oracle.Database.Management/operations/exadata/exadatainfrastructureOperations.tsp similarity index 77% rename from specification/oracle/Oracle.Database/operations/exadata/exadatainfrastructureOperations.tsp rename to specification/oracle/Oracle.Database.Management/operations/exadata/exadatainfrastructureOperations.tsp index d4afa8337da0..4de022cd8a39 100644 --- a/specification/oracle/Oracle.Database/operations/exadata/exadatainfrastructureOperations.tsp +++ b/specification/oracle/Oracle.Database.Management/operations/exadata/exadatainfrastructureOperations.tsp @@ -14,7 +14,7 @@ interface CloudExadataInfrastructures > { //OCI addStorageCapacityCloudExadataInfrastructure API doc: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudExadataInfrastructure/AddStorageCapacityCloudExadataInfrastructure @doc("Perform add storage capacity on exadata infra") - @example( + @Autorest.example( "./examples/exaInfra_addStorageCapacity.json", "Perform add storage capacity on exadata infra" ) @@ -25,27 +25,27 @@ interface CloudExadataInfrastructures >; } -@@example(CloudExadataInfrastructures.listBySubscription, +@@Autorest.example(CloudExadataInfrastructures.listBySubscription, "./examples/exaInfra_listBySubscription.json", "List Exadata Infrastructure by subscription" ); -@@example(CloudExadataInfrastructures.listByResourceGroup, +@@Autorest.example(CloudExadataInfrastructures.listByResourceGroup, "./examples/exaInfra_listByResourceGroup.json", "List Exadata Infrastructure by resource group" ); -@@example(CloudExadataInfrastructures.createOrUpdate, +@@Autorest.example(CloudExadataInfrastructures.createOrUpdate, "./examples/exaInfra_create.json", "Create Exadata Infrastructure" ); -@@example(CloudExadataInfrastructures.get, +@@Autorest.example(CloudExadataInfrastructures.get, "./examples/exaInfra_get.json", "Get Exadata Infrastructure" ); -@@example(CloudExadataInfrastructures.update, +@@Autorest.example(CloudExadataInfrastructures.update, "./examples/exaInfra_patch.json", "Patch Exadata Infrastructure" ); -@@example(CloudExadataInfrastructures.delete, +@@Autorest.example(CloudExadataInfrastructures.delete, "./examples/exaInfra_delete.json", "Delete Exadata Infrastructure" ); diff --git a/specification/oracle/Oracle.Database.Management/operations/exadata/giVersionOperations.tsp b/specification/oracle/Oracle.Database.Management/operations/exadata/giVersionOperations.tsp new file mode 100644 index 000000000000..e671ffbcc0e7 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/operations/exadata/giVersionOperations.tsp @@ -0,0 +1,20 @@ +import "../../../models/exadata/giVersions.tsp"; + +using Azure.ResourceManager; +using Autorest; + +namespace Oracle.Database; + +@armResourceOperations +interface GiVersions extends OracleLocationBasedResource {} + +@@doc(GiVersions.listByLocation, "List GiVersion resources by Location"); + +@@Autorest.example(GiVersions.listByLocation, + "./examples/giVersions_listByLocation.json", + "List GiVersions by location" +); +@@Autorest.example(GiVersions.get, + "./examples/giVersions_get.json", + "Get a GiVersion by name" +); diff --git a/specification/oracle/Oracle.Database.Management/operations/exadata/systemVersionOperations.tsp b/specification/oracle/Oracle.Database.Management/operations/exadata/systemVersionOperations.tsp new file mode 100644 index 000000000000..ac9f924a42b5 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/operations/exadata/systemVersionOperations.tsp @@ -0,0 +1,23 @@ +import "../../../models/exadata/systemVersions.tsp"; + +using Azure.ResourceManager; +using Autorest; + +namespace Oracle.Database; + +@armResourceOperations +interface SystemVersions extends OracleLocationBasedResource {} + +@@doc(SystemVersions.listByLocation, + "List SystemVersion resources by Location" +); + +@@Autorest.example(SystemVersions.listByLocation, + "./examples/systemVersions_listByLocation.json", + "List Exadata System Versions by the provided filter" +); + +@@Autorest.example(SystemVersions.get, + "./examples/systemVersions_get.json", + "Get Exadata System Version" +); diff --git a/specification/oracle/Oracle.Database/operations/exadata/virtualNetworkAddressOperations.tsp b/specification/oracle/Oracle.Database.Management/operations/exadata/virtualNetworkAddressOperations.tsp similarity index 76% rename from specification/oracle/Oracle.Database/operations/exadata/virtualNetworkAddressOperations.tsp rename to specification/oracle/Oracle.Database.Management/operations/exadata/virtualNetworkAddressOperations.tsp index b70cd518221e..d35a33fe067d 100644 --- a/specification/oracle/Oracle.Database/operations/exadata/virtualNetworkAddressOperations.tsp +++ b/specification/oracle/Oracle.Database.Management/operations/exadata/virtualNetworkAddressOperations.tsp @@ -14,22 +14,22 @@ interface VirtualNetworkAddresses VirtualNetworkAddressProperties > { // TODO: Swagger generator bug, cannot be extracted to interface - @example( + @Autorest.example( "./examples/virtualNetworkAddresses_listByParent.json", "List Virtual Network Addresses by VM Cluster" ) - listByParent is ArmResourceListByParent; + listByCloudVmCluster is ArmResourceListByParent; } -@@example(VirtualNetworkAddresses.createOrUpdate, +@@Autorest.example(VirtualNetworkAddresses.createOrUpdate, "./examples/virtualNetworkAddresses_create.json", "Create Virtual Network Address" ); -@@example(VirtualNetworkAddresses.get, +@@Autorest.example(VirtualNetworkAddresses.get, "./examples/virtualNetworkAddresses_get.json", "Get Virtual Network Address" ); -@@example(VirtualNetworkAddresses.delete, +@@Autorest.example(VirtualNetworkAddresses.delete, "./examples/virtualNetworkAddresses_delete.json", "Delete Virtual Network Address" ); diff --git a/specification/oracle/Oracle.Database.Management/operations/exadata/vmclusterOperations.tsp b/specification/oracle/Oracle.Database.Management/operations/exadata/vmclusterOperations.tsp new file mode 100644 index 000000000000..6c3b29f835a3 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/operations/exadata/vmclusterOperations.tsp @@ -0,0 +1,70 @@ +import "@azure-tools/typespec-azure-resource-manager"; +import "../../../models/exadata/vmcluster.tsp"; +import "../../../models/exadata/privateIpAddresses.tsp"; + +using Azure.ResourceManager; +using Autorest; + +namespace Oracle.Database; + +@armResourceOperations +interface CloudVmClusters + extends OracleTrackedResource { + @doc("Add VMs to the VM Cluster") + @Autorest.example( + "./examples/vmClusters_addVms.json", + "Add VMs to VM Cluster" + ) + addVms is ArmResourceActionAsync< + CloudVmCluster, + AddRemoveDbNode, + CloudVmCluster + >; + + @doc("Remove VMs from the VM Cluster") + @Autorest.example( + "./examples/vmClusters_removeVms.json", + "Remove VMs from VM Cluster" + ) + removeVms is ArmResourceActionAsync< + CloudVmCluster, + AddRemoveDbNode, + CloudVmCluster + >; + + @doc("List Private IP Addresses by the provided filter") + @Autorest.example( + "./examples/vmClusters_listPrivateIpAddresses.json", + "List Private IP Addresses for VM Cluster" + ) + listPrivateIpAddresses is ArmResourceActionSync< + CloudVmCluster, + PrivateIpAddressesFilter, + Array + >; +} + +@@Autorest.example(CloudVmClusters.listBySubscription, + "./examples/vmClusters_listBySubscription.json", + "List VM Clusters by subscription" +); +@@Autorest.example(CloudVmClusters.createOrUpdate, + "./examples/vmClusters_create.json", + "Create VM Cluster" +); +@@Autorest.example(CloudVmClusters.get, + "./examples/vmClusters_get.json", + "Get VM Cluster" +); +@@Autorest.example(CloudVmClusters.update, + "./examples/vmClusters_patch.json", + "Patch VM Cluster" +); +@@Autorest.example(CloudVmClusters.delete, + "./examples/vmClusters_delete.json", + "Delete VM Cluster" +); +@@Autorest.example(CloudVmClusters.listByResourceGroup, + "./examples/vmClusters_listByResourceGroup.json", + "List VM Clusters by resource group" +); diff --git a/specification/oracle/Oracle.Database/operations/oraclesubscription/oracleSubscriptionOperations.tsp b/specification/oracle/Oracle.Database.Management/operations/oraclesubscription/oracleSubscriptionOperations.tsp similarity index 76% rename from specification/oracle/Oracle.Database/operations/oraclesubscription/oracleSubscriptionOperations.tsp rename to specification/oracle/Oracle.Database.Management/operations/oraclesubscription/oracleSubscriptionOperations.tsp index 24189714b5ba..d3356ea3f56d 100644 --- a/specification/oracle/Oracle.Database/operations/oraclesubscription/oracleSubscriptionOperations.tsp +++ b/specification/oracle/Oracle.Database.Management/operations/oraclesubscription/oracleSubscriptionOperations.tsp @@ -3,6 +3,7 @@ import "../../../models/oraclesubscription/oracleSubscription.tsp"; using Azure.ResourceManager; using Azure.ResourceManager.Foundations; using Autorest; +using TypeSpec.Versioning; namespace Oracle.Database; @@ -13,7 +14,7 @@ interface OracleSubscriptions OracleSubscriptionProperties > { @doc("List Cloud Account Details") - @example( + @Autorest.example( "./examples/oracleSubscriptions_listCloudAccountDetails.json", "List Cloud Account details for the Oracle Subscription" ) @@ -23,7 +24,7 @@ interface OracleSubscriptions >; @doc("List Saas Subscription Details") - @example( + @Autorest.example( "./examples/oracleSubscriptions_listSaasSubscriptionDetails.json", "List Saas Subscription details for the Oracle Subscription" ) @@ -33,7 +34,7 @@ interface OracleSubscriptions >; @doc("List Activation Links") - @example( + @Autorest.example( "./examples/oracleSubscriptions_listActivationLinks.json", "List Activation Links for the Oracle Subscription" ) @@ -42,6 +43,17 @@ interface OracleSubscriptions ActivationLinks >; + @added(Versions.v20240601_preview) + @doc("Add Azure Subscriptions") + @Autorest.example( + "./examples/oracleSubscriptions_addAzureSubscriptions.json", + "Add Azure Subscriptions to the OracleSubscription" + ) + addAzureSubscriptions is ArmResourceActionNoResponseContentAsync< + OracleSubscription, + AzureSubscriptions + >; + /** * @dev Update a resource using the asynchronous call pattern. * @template Resource The ArmResource to update. @@ -58,23 +70,23 @@ interface OracleSubscriptions >; } -@@example(OracleSubscriptions.listBySubscription, +@@Autorest.example(OracleSubscriptions.listBySubscription, "./examples/oracleSubscriptions_listBySubscription.json", "List Oracle Subscriptions by subscription" ); -@@example(OracleSubscriptions.createOrUpdate, +@@Autorest.example(OracleSubscriptions.createOrUpdate, "./examples/oracleSubscriptions_create.json", "Create or Update Oracle Subscription" ); -@@example(OracleSubscriptions.get, +@@Autorest.example(OracleSubscriptions.get, "./examples/oracleSubscriptions_get.json", "Get Oracle Subscription" ); -@@example(OracleSubscriptions.update, +@@Autorest.example(OracleSubscriptions.update, "./examples/oracleSubscriptions_patch.json", "Patch Oracle Subscription" ); -@@example(OracleSubscriptions.delete, +@@Autorest.example(OracleSubscriptions.delete, "./examples/oracleSubscriptions_delete.json", "Delete Oracle Subscription" ); diff --git a/specification/oracle/Oracle.Database.Management/tspconfig.yaml b/specification/oracle/Oracle.Database.Management/tspconfig.yaml new file mode 100644 index 000000000000..832d1d86c4a3 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/tspconfig.yaml @@ -0,0 +1,27 @@ +parameters: + "service-dir": + default: "sdk/oracledatabase" + +emit: + - "@azure-tools/typespec-autorest" + +options: + "@azure-tools/typespec-autorest": + arm-types-dir: "../../../../../common-types/resource-management" + use-read-only-status-schema: true + azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true + emitter-output-dir: "{project-root}/.." + examples-directory: "examples" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openapi.json" + "@azure-tools/typespec-ts": + package-dir: "arm-oracledatabase" + packageDetails: + name: "@azure/arm-oracledatabase" + flavor: azure + +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/oracle/Oracle.Database.Management/versions.tsp b/specification/oracle/Oracle.Database.Management/versions.tsp new file mode 100644 index 000000000000..a577e1983f4e --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/versions.tsp @@ -0,0 +1,26 @@ +using TypeSpec.Versioning; + +namespace Oracle.Database; + +@doc("Versions for API") +enum Versions { + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @doc("2023-09-01-preview") + v20230901_preview: "2023-09-01-preview", + + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @doc("2023-09-01") + v20230901: "2023-09-01", + + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @doc("2024-06-01-preview") + v20240601_preview: "2024-06-01-preview", + + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @doc("2024-06-01") + v20240601: "2024-06-01", +} diff --git a/specification/oracle/Oracle.Database/main.tsp b/specification/oracle/Oracle.Database/main.tsp deleted file mode 100644 index 3594c17ff745..000000000000 --- a/specification/oracle/Oracle.Database/main.tsp +++ /dev/null @@ -1,41 +0,0 @@ -import "@azure-tools/typespec-autorest"; -import "./operations/exadata/exadatainfrastructureOperations.tsp"; -import "./operations/exadata/dbServersOperations.tsp"; -import "./operations/exadata/vmclusterOperations.tsp"; -import "./operations/exadata/virtualNetworkAddressOperations.tsp"; -import "./operations/exadata/systemVersionOperations.tsp"; -import "./operations/oraclesubscription/oracleSubscriptionOperations.tsp"; -import "./operations/exadata/dbNodesOperations.tsp"; -import "./operations/exadata/giVersionOperations.tsp"; -import "./operations/exadata/dbSystemShapeOperations.tsp"; -import "./operations/exadata/dnsPrivateViewsOperations.tsp"; -import "./operations/exadata/dnsPrivateZonesOperations.tsp"; -import "./operations/autonomousdatabase/autonomousDatabaseOperations.tsp"; -import "./operations/autonomousdatabase/autonomousDatabaseBackupOperations.tsp"; -import "./operations/autonomousdatabase/autonomousDatabaseCharacterSetOperations.tsp"; -import "./operations/autonomousdatabase/autonomousDatabaseNationalCharacterSetOperations.tsp"; -import "./operations/autonomousdatabase/autonomousDatabaseVersionOperations.tsp"; - -import "./versions.tsp"; - -using TypeSpec.Http; -using TypeSpec.Rest; -using TypeSpec.Versioning; -using Azure.ResourceManager; -using OpenAPI; -using Autorest; - -@armProviderNamespace -@service({ - title: "Oracle Database Resource Manager", -}) -@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) -@versioned(Oracle.Database.Versions) -namespace Oracle.Database; - -interface Operations extends Azure.ResourceManager.Operations {} - -@@example(Operations.list, - "./examples/operations_list.json", - "List Operations" -); diff --git a/specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseBackupOperations.tsp b/specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseBackupOperations.tsp deleted file mode 100644 index b7a0bde9287d..000000000000 --- a/specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseBackupOperations.tsp +++ /dev/null @@ -1,43 +0,0 @@ -import "../../../models/autonomousdatabase/autonomousDatabaseBackup.tsp"; -import "../commons.tsp"; - -using Azure.ResourceManager; -using Autorest; -using TypeSpec.Versioning; - -namespace Oracle.Database; - -@armResourceOperations(AutonomousDatabaseBackup) -interface AutonomousDatabaseBackups - extends OracleChildResource< - AutonomousDatabaseBackup, - AutonomousDatabaseBackupProperties - > { - @example( - "./examples/autonomousDatabaseBackup_patch.json", - "Patch Autonomous Database Backup." - ) - update is ArmResourcePatchAsync< - AutonomousDatabaseBackup, - AutonomousDatabaseBackupProperties - >; - - @example( - "./examples/autonomousDatabaseBackup_listByParent.json", - "List Autonomous Database Backups by Autonomous Database." - ) - listByParent is ArmResourceListByParent; -} - -@@example(AutonomousDatabaseBackups.createOrUpdate, - "./examples/autonomousDatabaseBackup_create.json", - "Create Autonomous Database Backup." -); -@@example(AutonomousDatabaseBackups.get, - "./examples/autonomousDatabaseBackup_get.json", - "Get Autonomous Database Backup." -); -@@example(AutonomousDatabaseBackups.delete, - "./examples/autonomousDatabaseBackup_delete.json", - "Delete Autonomous Database Backup." -); diff --git a/specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseCharacterSetOperations.tsp b/specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseCharacterSetOperations.tsp deleted file mode 100644 index e08e8e50f1c6..000000000000 --- a/specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseCharacterSetOperations.tsp +++ /dev/null @@ -1,20 +0,0 @@ -import "../../../models/autonomousdatabase/autonomousDatabaseCharacterSet.tsp"; - -using Azure.ResourceManager; -using Autorest; -using TypeSpec.Versioning; - -namespace Oracle.Database; - -@armResourceOperations -interface AutonomousDatabaseCharacterSets - extends OracleLocationBasedResource {} - -@@example(AutonomousDatabaseCharacterSets.listByLocation, - "./examples/autonomousDatabaseCharacterSet_listByLocation.json", - "List autonomous db character sets by location" -); -@@example(AutonomousDatabaseCharacterSets.get, - "./examples/autonomousDatabaseCharacterSet_get.json", - "Get autonomous db character set" -); diff --git a/specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseNationalCharacterSetOperations.tsp b/specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseNationalCharacterSetOperations.tsp deleted file mode 100644 index 68265c9e2271..000000000000 --- a/specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseNationalCharacterSetOperations.tsp +++ /dev/null @@ -1,20 +0,0 @@ -import "../../../models/autonomousdatabase/autonomousDatabaseNationalCharacterSet.tsp"; - -using Azure.ResourceManager; -using Autorest; -using TypeSpec.Versioning; - -namespace Oracle.Database; - -@armResourceOperations -interface AutonomousDatabaseNationalCharacterSets - extends OracleLocationBasedResource {} - -@@example(AutonomousDatabaseNationalCharacterSets.listByLocation, - "./examples/autonomousDatabaseNationalCharacterSet_listByLocation.json", - "List autonomous db national character sets by location" -); -@@example(AutonomousDatabaseNationalCharacterSets.get, - "./examples/autonomousDatabaseNationalCharacterSet_get.json", - "Get autonomous db national character set" -); diff --git a/specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseVersionOperations.tsp b/specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseVersionOperations.tsp deleted file mode 100644 index 55e19cb00a8e..000000000000 --- a/specification/oracle/Oracle.Database/operations/autonomousdatabase/autonomousDatabaseVersionOperations.tsp +++ /dev/null @@ -1,21 +0,0 @@ -import "@azure-tools/typespec-azure-resource-manager"; -import "../../../models/autonomousdatabase/autonomousDatabaseVersion.tsp"; - -using Azure.ResourceManager; -using Autorest; -using TypeSpec.Versioning; - -namespace Oracle.Database; - -@armResourceOperations -interface AutonomousDatabaseVersions - extends OracleLocationBasedResource {} - -@@example(AutonomousDatabaseVersions.listByLocation, - "./examples/autonomousDatabaseVersion_listByLocation.json", - "List an autonomous versions by location" -); -@@example(AutonomousDatabaseVersions.get, - "./examples/autonomousDatabaseVersion_get.json", - "Get an autonomous version" -); diff --git a/specification/oracle/Oracle.Database/operations/exadata/dbNodesOperations.tsp b/specification/oracle/Oracle.Database/operations/exadata/dbNodesOperations.tsp deleted file mode 100644 index 79680dd6061c..000000000000 --- a/specification/oracle/Oracle.Database/operations/exadata/dbNodesOperations.tsp +++ /dev/null @@ -1,24 +0,0 @@ -import "@azure-tools/typespec-azure-resource-manager"; -import "../../../models/exadata/dbNodes.tsp"; - -using Azure.ResourceManager; -using Autorest; -using TypeSpec.Versioning; - -namespace Oracle.Database; - -@armResourceOperations -interface DbNodes extends OracleReadOnlyResource { - // TODO: Swagger generator bug, cannot be extracted to interface - @example("./examples/dbNodes_listByParent.json", "List DbNodes by VM Cluster") - listByParent is ArmResourceListByParent; - - @doc("VM actions on DbNode of VM Cluster by the provided filter") - @example( - "./examples/dbNodes_action.json", - "VM actions on DbNodes of VM Cluster" - ) - action is ArmResourceActionAsync; -} - -@@example(DbNodes.get, "./examples/dbNodes_get.json", "Get DbNode"); diff --git a/specification/oracle/Oracle.Database/operations/exadata/dbSystemShapeOperations.tsp b/specification/oracle/Oracle.Database/operations/exadata/dbSystemShapeOperations.tsp deleted file mode 100644 index ec298b0f12e2..000000000000 --- a/specification/oracle/Oracle.Database/operations/exadata/dbSystemShapeOperations.tsp +++ /dev/null @@ -1,18 +0,0 @@ -import "../../../models/exadata/dbSystemShapes.tsp"; - -using Azure.ResourceManager; -using Autorest; - -namespace Oracle.Database; - -@armResourceOperations -interface DbSystemShapes extends OracleLocationBasedResource {} - -@@example(DbSystemShapes.listByLocation, - "./examples/dbSystemShapes_listByLocation.json", - "List DbSystemShapes by location" -); -@@example(DbSystemShapes.get, - "./examples/dbSystemShapes_get.json", - "Get a DbSystemShape by name" -); diff --git a/specification/oracle/Oracle.Database/operations/exadata/dnsPrivateViewsOperations.tsp b/specification/oracle/Oracle.Database/operations/exadata/dnsPrivateViewsOperations.tsp deleted file mode 100644 index 4fc9dd100bfd..000000000000 --- a/specification/oracle/Oracle.Database/operations/exadata/dnsPrivateViewsOperations.tsp +++ /dev/null @@ -1,18 +0,0 @@ -import "../../../models/exadata/dnsPrivateViews.tsp"; - -using Azure.ResourceManager; -using Autorest; - -namespace Oracle.Database; - -@armResourceOperations -interface DnsPrivateViews extends OracleLocationBasedResource {} - -@@example(DnsPrivateViews.listByLocation, - "./examples/dnsPrivateViews_listByLocation.json", - "List DnsPrivateViews by location" -); -@@example(DnsPrivateViews.get, - "./examples/dnsPrivateViews_get.json", - "Get a DnsPrivateView by name" -); diff --git a/specification/oracle/Oracle.Database/operations/exadata/dnsPrivateZonesOperations.tsp b/specification/oracle/Oracle.Database/operations/exadata/dnsPrivateZonesOperations.tsp deleted file mode 100644 index a1d18acd98ca..000000000000 --- a/specification/oracle/Oracle.Database/operations/exadata/dnsPrivateZonesOperations.tsp +++ /dev/null @@ -1,18 +0,0 @@ -import "../../../models/exadata/dnsPrivateZones.tsp"; - -using Azure.ResourceManager; -using Autorest; - -namespace Oracle.Database; - -@armResourceOperations -interface DnsPrivateZones extends OracleLocationBasedResource {} - -@@example(DnsPrivateZones.listByLocation, - "./examples/dnsPrivateZones_listByLocation.json", - "List DnsPrivateZones by location" -); -@@example(DnsPrivateZones.get, - "./examples/dnsPrivateZones_get.json", - "Get a DnsPrivateZone by name" -); diff --git a/specification/oracle/Oracle.Database/operations/exadata/giVersionOperations.tsp b/specification/oracle/Oracle.Database/operations/exadata/giVersionOperations.tsp deleted file mode 100644 index 9e8f2f617ebd..000000000000 --- a/specification/oracle/Oracle.Database/operations/exadata/giVersionOperations.tsp +++ /dev/null @@ -1,18 +0,0 @@ -import "../../../models/exadata/giVersions.tsp"; - -using Azure.ResourceManager; -using Autorest; - -namespace Oracle.Database; - -@armResourceOperations -interface GiVersions extends OracleLocationBasedResource {} - -@@example(GiVersions.listByLocation, - "./examples/giVersions_listByLocation.json", - "List GiVersions by location" -); -@@example(GiVersions.get, - "./examples/giVersions_get.json", - "Get a GiVersion by name" -); diff --git a/specification/oracle/Oracle.Database/operations/exadata/systemVersionOperations.tsp b/specification/oracle/Oracle.Database/operations/exadata/systemVersionOperations.tsp deleted file mode 100644 index 481648c95039..000000000000 --- a/specification/oracle/Oracle.Database/operations/exadata/systemVersionOperations.tsp +++ /dev/null @@ -1,19 +0,0 @@ -import "../../../models/exadata/systemVersions.tsp"; - -using Azure.ResourceManager; -using Autorest; - -namespace Oracle.Database; - -@armResourceOperations -interface SystemVersions extends OracleLocationBasedResource {} - -@@example(SystemVersions.listByLocation, - "./examples/systemVersions_listByLocation.json", - "List Exadata System Versions by the provided filter" -); - -@@example(SystemVersions.get, - "./examples/systemVersions_get.json", - "Get Exadata System Version" -); diff --git a/specification/oracle/Oracle.Database/operations/exadata/vmclusterOperations.tsp b/specification/oracle/Oracle.Database/operations/exadata/vmclusterOperations.tsp deleted file mode 100644 index d5bcd6ce3ed0..000000000000 --- a/specification/oracle/Oracle.Database/operations/exadata/vmclusterOperations.tsp +++ /dev/null @@ -1,64 +0,0 @@ -import "@azure-tools/typespec-azure-resource-manager"; -import "../../../models/exadata/vmcluster.tsp"; -import "../../../models/exadata/privateIpAddresses.tsp"; - -using Azure.ResourceManager; -using Autorest; - -namespace Oracle.Database; - -@armResourceOperations -interface CloudVmClusters - extends OracleTrackedResource { - @doc("Add VMs to the VM Cluster") - @example("./examples/vmClusters_addVms.json", "Add VMs to VM Cluster") - addVms is ArmResourceActionAsync< - CloudVmCluster, - AddRemoveDbNode, - CloudVmCluster - >; - - @doc("Remove VMs from the VM Cluster") - @example("./examples/vmClusters_removeVms.json", "Remove VMs from VM Cluster") - removeVms is ArmResourceActionAsync< - CloudVmCluster, - AddRemoveDbNode, - CloudVmCluster - >; - - @doc("List Private IP Addresses by the provided filter") - @example( - "./examples/vmClusters_listPrivateIpAddresses.json", - "List Private IP Addresses for VM Cluster" - ) - listPrivateIpAddresses is ArmResourceActionSync< - CloudVmCluster, - PrivateIpAddressesFilter, - Array - >; -} - -@@example(CloudVmClusters.listBySubscription, - "./examples/vmClusters_listBySubscription.json", - "List VM Clusters by subscription" -); -@@example(CloudVmClusters.createOrUpdate, - "./examples/vmClusters_create.json", - "Create VM Cluster" -); -@@example(CloudVmClusters.get, - "./examples/vmClusters_get.json", - "Get VM Cluster" -); -@@example(CloudVmClusters.update, - "./examples/vmClusters_patch.json", - "Patch VM Cluster" -); -@@example(CloudVmClusters.delete, - "./examples/vmClusters_delete.json", - "Delete VM Cluster" -); -@@example(CloudVmClusters.listByResourceGroup, - "./examples/vmClusters_listByResourceGroup.json", - "List VM Clusters by resource group" -); diff --git a/specification/oracle/Oracle.Database/tspconfig.yaml b/specification/oracle/Oracle.Database/tspconfig.yaml deleted file mode 100644 index 9d705425bb6a..000000000000 --- a/specification/oracle/Oracle.Database/tspconfig.yaml +++ /dev/null @@ -1,24 +0,0 @@ -parameters: - "service-dir": - default: "sdk/oracledatabase" - -emit: - - "@azure-tools/typespec-autorest" - -options: - "@azure-tools/typespec-autorest": - arm-types-dir: "../../../../../common-types/resource-management" - use-read-only-status-schema: true - azure-resource-provider-folder: "resource-manager" - emitter-output-dir: "{project-root}/.." - examples-directory: "examples" - output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openapi.json" - "@azure-tools/typespec-ts": - package-dir: "arm-oracledatabase" - packageDetails: - name: "@azure/arm-oracledatabase" - flavor: azure - -linter: - extends: - - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/oracle/Oracle.Database/versions.tsp b/specification/oracle/Oracle.Database/versions.tsp deleted file mode 100644 index 6536215fc8a8..000000000000 --- a/specification/oracle/Oracle.Database/versions.tsp +++ /dev/null @@ -1,16 +0,0 @@ -using TypeSpec.Versioning; - -namespace Oracle.Database; - -@doc("Versions for API") -enum Versions { - @useDependency(Azure.Core.Versions.v1_0_Preview_2) - @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) - @doc("2023-09-01-preview") - v20230901_preview: "2023-09-01-preview", - - @useDependency(Azure.Core.Versions.v1_0_Preview_2) - @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) - @doc("2023-09-01") - v20230901: "2023-09-01", -} diff --git a/specification/oracle/models/oraclesubscription/oracleSubscription.tsp b/specification/oracle/models/oraclesubscription/oracleSubscription.tsp index 35f57cae1404..1d21cb098e5a 100644 --- a/specification/oracle/models/oraclesubscription/oracleSubscription.tsp +++ b/specification/oracle/models/oraclesubscription/oracleSubscription.tsp @@ -1,5 +1,6 @@ using TypeSpec.Http; using TypeSpec.Rest; +using TypeSpec.Versioning; using Azure.ResourceManager; namespace Oracle.Database; @@ -145,6 +146,28 @@ model ActivationLinks { existingCloudAccountActivationLink?: string; } +@added(Versions.v20240601_preview) +@doc("Azure Subscriptions model") +model AzureSubscriptions { + @doc("Azure Subscription Ids to be updated") + azureSubscriptionIds: string[]; +} + +@added(Versions.v20240601_preview) +@doc("Add Subscription Operation state enum") +union AddSubscriptionOperationState { + @doc("Succeeded - State when Add Subscription operation succeeded") + Succeeded: "Succeeded", + + @doc("Updating - State when Add Subscription operation is being Updated") + Updating: "Updating", + + @doc("Failed - State when Add Subscription operation failed") + Failed: "Failed", + + string, +} + @doc("Oracle Subscription resource model") model OracleSubscriptionProperties { @doc("OracleSubscriptionProvisioningState provisioning state") @@ -174,4 +197,19 @@ model OracleSubscriptionProperties { @doc("Intent for the update operation") @visibility("update") intent?: Intent; + + @added(Versions.v20240601_preview) + @doc("Azure subscriptions associated with this OracleSubscription") + @visibility("read") + azureSubscriptionIds?: string[]; + + @added(Versions.v20240601_preview) + @doc("State of the add Azure subscription operation on Oracle subscription") + @visibility("read") + addSubscriptionOperationState?: AddSubscriptionOperationState; + + @added(Versions.v20240601_preview) + @doc("Status details of the last operation on Oracle subscription") + @visibility("read") + lastOperationStatusDetail?: string; } diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/openapi.json b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/openapi.json index 60ebeff32eec..382992784012 100644 --- a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/openapi.json +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/openapi.json @@ -4120,6 +4120,7 @@ "properties": { "properties": { "$ref": "#/definitions/AutonomousDatabaseBackupUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } @@ -5098,6 +5099,7 @@ }, "properties": { "$ref": "#/definitions/AutonomousDatabaseUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } @@ -5928,6 +5930,7 @@ }, "properties": { "$ref": "#/definitions/CloudExadataInfrastructureUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } @@ -6452,6 +6455,7 @@ }, "properties": { "$ref": "#/definitions/CloudVmClusterUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } @@ -8695,6 +8699,7 @@ }, "properties": { "$ref": "#/definitions/OracleSubscriptionUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_create.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_create.json new file mode 100644 index 000000000000..e7a747bf7f99 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_create.json @@ -0,0 +1,71 @@ +{ + "operationId": "AutonomousDatabaseBackups_CreateOrUpdate", + "title": "AutonomousDatabaseBackups_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130", + "resource": { + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "displayName": "Nightly Backup", + "retentionPeriodInDays": 365 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "headers": { + "Retry-After": 100 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/backupdb1", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_delete.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_delete.json new file mode 100644 index 000000000000..9024bb556814 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_delete.json @@ -0,0 +1,20 @@ +{ + "operationId": "AutonomousDatabaseBackups_Delete", + "title": "AutonomousDatabaseBackups_Delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_get.json new file mode 100644 index 000000000000..28b9844e4af7 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_get.json @@ -0,0 +1,37 @@ +{ + "operationId": "AutonomousDatabaseBackups_Get", + "title": "AutonomousDatabaseBackups_Get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_listByParent.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_listByParent.json new file mode 100644 index 000000000000..3b8ef5d0c023 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_listByParent.json @@ -0,0 +1,40 @@ +{ + "operationId": "AutonomousDatabaseBackups_ListByAutonomousDatabase", + "title": "AutonomousDatabaseBackups_ListByAutonomousDatabase", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_patch.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_patch.json new file mode 100644 index 000000000000..d770ccd7bf25 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseBackup_patch.json @@ -0,0 +1,41 @@ +{ + "operationId": "AutonomousDatabaseBackups_Update", + "title": "AutonomousDatabaseBackups_Update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130", + "properties": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup updated successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 400, + "sizeInTbs": 2, + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseCharacterSet_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseCharacterSet_get.json new file mode 100644 index 000000000000..6b48c38b3242 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseCharacterSet_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseCharacterSets_get", + "title": "AutonomousDatabaseCharacterSets_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "adbscharsetname": "DATABASE" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "AL32UTF8" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseCharacterSet_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseCharacterSet_listByLocation.json new file mode 100644 index 000000000000..3208a62ffde7 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseCharacterSet_listByLocation.json @@ -0,0 +1,32 @@ +{ + "operationId": "AutonomousDatabaseCharacterSets_listByLocation", + "title": "AutonomousDatabaseCharacterSets_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "AL32UTF8" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "UTF8" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseClone_create.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseClone_create.json new file mode 100644 index 000000000000..fe956ffdd48e --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseClone_create.json @@ -0,0 +1,141 @@ +{ + "operationId": "AutonomousDatabases_CreateOrUpdate", + "title": "AutonomousDatabases_CreateOrUpdate_clone", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "resource": { + "properties": { + "dataBaseType": "Clone", + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "cloneType": "Full", + "displayName": "example_autonomous_databasedb1_clone", + "computeModel": "ECPU", + "computeCount": 2, + "dataStorageSizeInTbs": 1, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "adminPassword": "********", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1Clone", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "cloneType": "Full", + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Clone", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1Clone", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "cloneType": "Full", + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Clone", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseNationalCharacterSet_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseNationalCharacterSet_get.json new file mode 100644 index 000000000000..ad1ecd6d6092 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseNationalCharacterSet_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseNationalCharacterSets_get", + "title": "AutonomousDatabaseNationalCharacterSets_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "adbsncharsetname": "NATIONAL" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseNationalCharacterSets/NATIONAL", + "type": "Oracle.Database/locations/autonomousDatabaseNationalCharacterSets", + "properties": { + "characterSet": "AL16UTF16" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseNationalCharacterSet_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseNationalCharacterSet_listByLocation.json new file mode 100644 index 000000000000..6acb2eb02a49 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseNationalCharacterSet_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabaseNationalCharacterSets_listByLocation", + "title": "AutonomousDatabaseNationalCharacterSets_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseNationalCharacterSets/NATIONAL", + "type": "Oracle.Database/locations/autonomousDatabaseNationalCharacterSets", + "properties": { + "characterSet": "AL16UTF16" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseVersion_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseVersion_get.json new file mode 100644 index 000000000000..1e516b3b27ed --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseVersion_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseVersions_get", + "title": "AutonomousDatabaseVersions_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "autonomousdbversionsname": "18.4.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDbVersions/18.4.0.0", + "type": "Oracle.Database/locations/autonomousDbVersions", + "properties": { + "version": "18.4.0.0" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseVersion_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseVersion_listByLocation.json new file mode 100644 index 000000000000..899b89d86f16 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabaseVersion_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabaseVersions_listByLocation", + "title": "AutonomousDatabaseVersions_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDbVersions/18.4.0.0", + "type": "Oracle.Database/locations/autonomousDbVersions", + "properties": { + "version": "18.4.0.0" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_create.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_create.json new file mode 100644 index 000000000000..92fa3fd8899a --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_create.json @@ -0,0 +1,136 @@ +{ + "operationId": "AutonomousDatabases_CreateOrUpdate", + "title": "AutonomousDatabases_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "resource": { + "properties": { + "dataBaseType": "Regular", + "displayName": "example_autonomous_databasedb1", + "computeModel": "ECPU", + "computeCount": 2, + "dataStorageSizeInTbs": 1, + "adminPassword": "********", + "dbVersion": "18.4.0.0", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_delete.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_delete.json new file mode 100644 index 000000000000..1b362325b846 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "AutonomousDatabases_delete", + "title": "AutonomousDatabases_delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_failover.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_failover.json new file mode 100644 index 000000000000..d252740d5b69 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_failover.json @@ -0,0 +1,90 @@ +{ + "operationId": "AutonomousDatabases_Failover", + "title": "AutonomousDatabases_Failover", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "peerDbId": "peerDbId" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "failedDataRecoveryInSeconds": null, + "isLocalDataGuardEnabled": true, + "timeLocalDataGuardEnabled": "2024-02-28T19:03:43.714Z", + "localDisasterRecoveryType": "Adg", + "localAdgAutoFailoverMaxDataLossLimit": 300, + "role": "Primary", + "peerDbIds": null, + "localStandbyDb": { + "lagTimeInSeconds": null, + "lifecycleDetails": null, + "lifecycleState": "RoleChangeInProgress", + "timeDataGuardRoleChanged": null, + "timeDisasterRecoveryRoleChanged": null + }, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Updating", + "lifecycleDetails": null, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Provisioning", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeOfLastFailover": null, + "timeOfLastSwitchover": null, + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_generateWallet.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_generateWallet.json new file mode 100644 index 000000000000..9605115fd580 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_generateWallet.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabases_generateWallet", + "title": "AutonomousDatabases_generateWallet", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "generateType": "Single", + "isRegional": false, + "password": "********" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "walletFiles": "testEncodedFiles" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_get.json new file mode 100644 index 000000000000..4b888b79d297 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_get.json @@ -0,0 +1,63 @@ +{ + "operationId": "AutonomousDatabases_Get", + "title": "AutonomousDatabases_Get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_listByResourceGroup.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_listByResourceGroup.json new file mode 100644 index 000000000000..b4ed6e0a4a6d --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_listByResourceGroup.json @@ -0,0 +1,67 @@ +{ + "operationId": "AutonomousDatabases_listByResourceGroup", + "title": "AutonomousDatabases_listByResourceGroup", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_listBySubscription.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_listBySubscription.json new file mode 100644 index 000000000000..80112af9c96d --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_listBySubscription.json @@ -0,0 +1,66 @@ +{ + "operationId": "AutonomousDatabases_listBySubscription", + "title": "AutonomousDatabases_listBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_patch.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_patch.json new file mode 100644 index 000000000000..dc9c1975b077 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_patch.json @@ -0,0 +1,73 @@ +{ + "operationId": "AutonomousDatabases_update", + "title": "AutonomousDatabases_update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_restore.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_restore.json new file mode 100644 index 000000000000..5022c67f321b --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_restore.json @@ -0,0 +1,80 @@ +{ + "operationId": "AutonomousDatabases_Restore", + "title": "AutonomousDatabases_Restore", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "timestamp": "2024-04-23T00:00:00.000Z" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "backupRetentionPeriodInDays": 60, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "RestoreInProgress", + "lifecycleDetails": "", + "nextLongTermBackupTimeStamp": "2024-04-24T21:03:41.000Z", + "longTermBackupSchedule": { + "isDisabled": null, + "repeatCadence": "Weekly", + "retentionPeriodInDays": 365, + "timeOfBackup": "2024-04-21T21:03:41.309Z" + }, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_shrink.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_shrink.json new file mode 100644 index 000000000000..f7cd000c059b --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_shrink.json @@ -0,0 +1,77 @@ +{ + "operationId": "AutonomousDatabase_shrink", + "title": "AutonomousDatabase_shrink", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "backupRetentionPeriodInDays": 90, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "ScaleInProgress", + "lifecycleDetails": "", + "nextLongTermBackupTimeStamp": "2024-04-24T21:03:41.000Z", + "longTermBackupSchedule": { + "isDisabled": null, + "repeatCadence": "Weekly", + "retentionPeriodInDays": 365, + "timeOfBackup": "2024-04-21T21:03:41.309Z" + }, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_switchover.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_switchover.json new file mode 100644 index 000000000000..32d91768c7a9 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/autonomousDatabase_switchover.json @@ -0,0 +1,89 @@ +{ + "operationId": "AutonomousDatabases_Switchover", + "title": "AutonomousDatabases_Switchover", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "peerDbId": "peerDbId" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "failedDataRecoveryInSeconds": null, + "isLocalDataGuardEnabled": false, + "localDisasterRecoveryType": "BackupBased", + "localAdgAutoFailoverMaxDataLossLimit": null, + "role": "Primary", + "peerDbIds": null, + "localStandbyDb": { + "lagTimeInSeconds": null, + "lifecycleDetails": null, + "lifecycleState": "RoleChangeInProgress", + "timeDataGuardRoleChanged": null, + "timeDisasterRecoveryRoleChanged": null + }, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Updating", + "lifecycleDetails": null, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Provisioning", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeOfLastFailover": null, + "timeOfLastSwitchover": "2024-02-27T18:37:08.069Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbNodes_action.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbNodes_action.json new file mode 100644 index 000000000000..ba39d8bb992f --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbNodes_action.json @@ -0,0 +1,50 @@ +{ + "operationId": "DbNodes_Action", + "title": "DbNodes_Action", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "dbnodeocid": "ocid1....aaaaaa", + "body": { + "action": "Start" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "provisioningState": "Succeeded", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbNodes_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbNodes_get.json new file mode 100644 index 000000000000..0dae0617aa9b --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbNodes_get.json @@ -0,0 +1,41 @@ +{ + "operationId": "DbNodes_get", + "title": "DbNodes_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "dbnodeocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "lifecycleState": "Available", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbNodes_listByParent.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbNodes_listByParent.json new file mode 100644 index 000000000000..997a2a6df52f --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbNodes_listByParent.json @@ -0,0 +1,45 @@ +{ + "operationId": "DbNodes_listByParent", + "title": "DbNodes_listByParent", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "lifecycleState": "Available", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbServers_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbServers_get.json new file mode 100644 index 000000000000..54fa1809fb1e --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbServers_get.json @@ -0,0 +1,42 @@ +{ + "operationId": "DbServers_get", + "title": "DbServers_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "dbserverocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1/dbServers/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbServers", + "properties": { + "ocid": "ocid1", + "displayName": "dbserver1", + "compartmentId": "ocid1....aaaa", + "exadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "cpuCoreCount": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 150, + "vmClusterIds": [ + "ocid1..aaaaa" + ], + "dbNodeIds": [ + "ocid1..aaaaa" + ], + "lifecycleState": "Available", + "maxCpuCount": 1000, + "autonomousVmClusterIds": [ + "ocid1..aaaaa" + ], + "autonomousVirtualMachineIds": [ + "ocid1..aaaaa" + ] + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbServers_listByParent.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbServers_listByParent.json new file mode 100644 index 000000000000..77a7073106e8 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbServers_listByParent.json @@ -0,0 +1,46 @@ +{ + "operationId": "DbServers_listByCloudExadataInfrastructure", + "title": "DbServers_listByCloudExadataInfrastructure", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1/dbServers/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbServers", + "properties": { + "ocid": "ocid1", + "displayName": "dbserver1", + "compartmentId": "ocid1....aaaa", + "exadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "cpuCoreCount": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 150, + "vmClusterIds": [ + "ocid1..aaaaa" + ], + "dbNodeIds": [ + "ocid1..aaaaa" + ], + "lifecycleState": "Available", + "maxCpuCount": 1000, + "autonomousVmClusterIds": [ + "ocid1..aaaaa" + ], + "autonomousVirtualMachineIds": [ + "ocid1..aaaaa" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbSystemShapes_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbSystemShapes_get.json new file mode 100644 index 000000000000..249db363069d --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbSystemShapes_get.json @@ -0,0 +1,40 @@ +{ + "operationId": "DbSystemShapes_get", + "title": "DbSystemShapes_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dbsystemshapename": "EXADATA.X9M" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dbSystemShapes/EXADATA.X9M", + "type": "Oracle.Database/locations/dbSystemShapes", + "properties": { + "shapeFamily": "EXADATA", + "availableCoreCount": 100, + "minimumCoreCount": 1, + "runtimeMinimumCoreCount": 1, + "coreCountIncrement": 1, + "minStorageCount": 0, + "maxStorageCount": 100, + "availableDataStoragePerServerInTbs": 100, + "availableMemoryPerNodeInGbs": 10, + "availableDbNodePerNodeInGbs": 10, + "minCoreCountPerNode": 0, + "availableMemoryInGbs": 10, + "minMemoryPerNodeInGbs": 0, + "availableDbNodeStorageInGbs": 10, + "minDbNodeStoragePerNodeInGbs": 0, + "availableDataStorageInTbs": 10, + "minDataStorageInTbs": 0, + "minimumNodeCount": 0, + "maximumNodeCount": 1000, + "availableCoreCountPerNode": 1000 + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbSystemShapes_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbSystemShapes_listByLocation.json new file mode 100644 index 000000000000..eb2183605dbf --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbSystemShapes_listByLocation.json @@ -0,0 +1,44 @@ +{ + "operationId": "DbSystemShapes_listByLocation", + "title": "DbSystemShapes_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dbSystemShapes/EXADATA.X9M", + "type": "Oracle.Database/locations/dbSystemShapes", + "properties": { + "shapeFamily": "EXADATA", + "availableCoreCount": 100, + "minimumCoreCount": 1, + "runtimeMinimumCoreCount": 1, + "coreCountIncrement": 1, + "minStorageCount": 0, + "maxStorageCount": 100, + "availableDataStoragePerServerInTbs": 100, + "availableMemoryPerNodeInGbs": 10, + "availableDbNodePerNodeInGbs": 10, + "minCoreCountPerNode": 0, + "availableMemoryInGbs": 10, + "minMemoryPerNodeInGbs": 0, + "availableDbNodeStorageInGbs": 10, + "minDbNodeStoragePerNodeInGbs": 0, + "availableDataStorageInTbs": 10, + "minDataStorageInTbs": 0, + "minimumNodeCount": 0, + "maximumNodeCount": 1000, + "availableCoreCountPerNode": 1000 + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dnsPrivateViews_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dnsPrivateViews_get.json new file mode 100644 index 000000000000..5f4a3f707f16 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dnsPrivateViews_get.json @@ -0,0 +1,27 @@ +{ + "operationId": "DnsPrivateViews_get", + "title": "DnsPrivateViews_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dnsprivateviewocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaaa", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaaa", + "displayName": "example-dns-private-view", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/your-dns-private-view", + "timeCreated": "2023-10-26T12:34:56Z", + "timeUpdated": "2023-10-26T14:00:00Z" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dnsPrivateViews_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dnsPrivateViews_listByLocation.json new file mode 100644 index 000000000000..befa9f52d572 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dnsPrivateViews_listByLocation.json @@ -0,0 +1,44 @@ +{ + "operationId": "DnsPrivateViews_listByLocation", + "title": "DnsPrivateViews_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaaa", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaaa", + "displayName": "example-dns-private-view1", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/view1", + "timeCreated": "2023-10-26T12:34:56Z", + "timeUpdated": "2023-10-26T14:00:00Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaab", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaab", + "displayName": "example-dns-private-view2", + "isProtected": true, + "lifecycleState": "Creating", + "self": "https://api.example.com/view2", + "timeCreated": "2023-10-27T09:45:00Z", + "timeUpdated": "2023-10-27T10:30:00Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dnsPrivateZones_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dnsPrivateZones_get.json new file mode 100644 index 000000000000..237b23d32ef4 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dnsPrivateZones_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "DnsPrivateZones_get", + "title": "DnsPrivateZones_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dnsprivatezonename": "example-dns-private-zone" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/example-dns-private-zone", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "your-zone-id", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/your-dns-private-zone", + "serial": 12345, + "version": "1.0.0.0", + "viewId": "your-view-id", + "zoneType": "Primary", + "timeCreated": "2023-10-26T12:34:56Z" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dnsPrivateZones_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dnsPrivateZones_listByLocation.json new file mode 100644 index 000000000000..9b716d67db53 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dnsPrivateZones_listByLocation.json @@ -0,0 +1,48 @@ +{ + "operationId": "DnsPrivateZones_listByLocation", + "title": "DnsPrivateZones_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/zone1", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "zone-id-1", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/zone1", + "serial": 12345, + "version": "1.0.0.0", + "viewId": "view-id-1", + "zoneType": "Primary", + "timeCreated": "2023-10-26T12:34:56Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/zone2", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "zone-id-2", + "isProtected": true, + "lifecycleState": "Creating", + "self": "https://api.example.com/zone2", + "serial": 54321, + "version": "2.0.0.0", + "viewId": "view-id-2", + "zoneType": "Secondary", + "timeCreated": "2023-10-27T09:45:00Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_addStorageCapacity.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_addStorageCapacity.json new file mode 100644 index 000000000000..2f1f55f1e0f5 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_addStorageCapacity.json @@ -0,0 +1,95 @@ +{ + "operationId": "CloudExadataInfrastructures_addStorageCapacity", + "title": "CloudExadataInfrastructures_addStorageCapacity", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_create.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_create.json new file mode 100644 index 000000000000..950670cb1a0e --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_create.json @@ -0,0 +1,184 @@ +{ + "operationId": "CloudExadataInfrastructures_createOrUpdate", + "title": "CloudExadataInfrastructures_createOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "resource": { + "properties": { + "computeCount": 100, + "storageCount": 10, + "shape": "EXADATA.X9M", + "displayName": "infra 1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "zones": [ + "1" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_delete.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_delete.json new file mode 100644 index 000000000000..d6544bee4267 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "CloudExadataInfrastructures_delete", + "title": "CloudExadataInfrastructures_delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_get.json new file mode 100644 index 000000000000..35f9d5ca638c --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_get.json @@ -0,0 +1,89 @@ +{ + "operationId": "CloudExadataInfrastructures_get", + "title": "CloudExadataInfrastructures_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_listByResourceGroup.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_listByResourceGroup.json new file mode 100644 index 000000000000..c7b0ec071c04 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_listByResourceGroup.json @@ -0,0 +1,93 @@ +{ + "operationId": "CloudExadataInfrastructures_listByResourceGroup", + "title": "CloudExadataInfrastructures_listByResourceGroup", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_listBySubscription.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_listBySubscription.json new file mode 100644 index 000000000000..97acca1bb5fd --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_listBySubscription.json @@ -0,0 +1,92 @@ +{ + "operationId": "CloudExadataInfrastructures_listBySubscription", + "title": "CloudExadataInfrastructures_listBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_patch.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_patch.json new file mode 100644 index 000000000000..83b7cef6f8db --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/exaInfra_patch.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudExadataInfrastructures_update", + "title": "CloudExadataInfrastructures_update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + }, + "zones": [ + "1" + ] + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/giVersions_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/giVersions_get.json new file mode 100644 index 000000000000..60ec5e30ae01 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/giVersions_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "GiVersions_get", + "title": "GiVersions_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "giversionname": "19.0.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/giVersions/19.0.0.0", + "type": "Oracle.Database/locations/giVersions", + "properties": { + "version": "19.0.0.0" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/giVersions_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/giVersions_listByLocation.json new file mode 100644 index 000000000000..3563879e8421 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/giVersions_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "GiVersions_listByLocation", + "title": "GiVersions_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/giVersions/19.0.0.0", + "type": "Oracle.Database/locations/giVersions", + "properties": { + "version": "19.0.0.0" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/operations_list.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/operations_list.json new file mode 100644 index 000000000000..7f3d0d47252f --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/operations_list.json @@ -0,0 +1,25 @@ +{ + "operationId": "Operations_list", + "title": "Operations_list", + "parameters": { + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Oracle.Database/cloudExadataInfrastructures/Read", + "isDataAction": false, + "display": { + "provider": "Oracle.Database", + "resource": "cloudExadataInfrastructures", + "operation": "Get/list Exadata Infrastructure resources", + "description": "Reads Exadata Infrastructure" + } + } + ] + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_addAzureSubscriptions.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_addAzureSubscriptions.json new file mode 100644 index 000000000000..91211e23321f --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_addAzureSubscriptions.json @@ -0,0 +1,21 @@ +{ + "operationId": "OracleSubscriptions_addAzureSubscriptions", + "title": "OracleSubscriptions_addAzureSubscriptions", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "body": { + "azureSubscriptionIds": [ + "00000000-0000-0000-0000-000000000001" + ] + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_create.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_create.json new file mode 100644 index 000000000000..5e5e61d7a559 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_create.json @@ -0,0 +1,56 @@ +{ + "operationId": "OracleSubscriptions_createOrUpdate", + "title": "OracleSubscriptions_createOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resource": { + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_delete.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_delete.json new file mode 100644 index 000000000000..ebd194b690dc --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_delete.json @@ -0,0 +1,17 @@ +{ + "operationId": "OracleSubscriptions_delete", + "title": "OracleSubscriptions_delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_get.json new file mode 100644 index 000000000000..42519ceb1456 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "OracleSubscriptions_get", + "title": "OracleSubscriptions_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_listActivationLinks.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_listActivationLinks.json new file mode 100644 index 000000000000..752a012c3b30 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_listActivationLinks.json @@ -0,0 +1,22 @@ +{ + "operationId": "OracleSubscriptions_listActivationLinks", + "title": "OracleSubscriptions_listActivationLinks", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "newCloudAccountActivationLink": "https://new-tenancy-activation-link", + "existingCloudAccountActivationLink": "https://existing-tenancy-activation-link" + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_listBySubscription.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_listBySubscription.json new file mode 100644 index 000000000000..ea13f43dba02 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_listBySubscription.json @@ -0,0 +1,34 @@ +{ + "operationId": "OracleSubscriptions_listBySubscription", + "title": "OracleSubscriptions_listBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_listCloudAccountDetails.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_listCloudAccountDetails.json new file mode 100644 index 000000000000..9d091d428625 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_listCloudAccountDetails.json @@ -0,0 +1,22 @@ +{ + "operationId": "OracleSubscriptions_listCloudAccountDetails", + "title": "OracleSubscriptions_listCloudAccountDetails", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "cloudAccountName": "Cloud Account", + "cloudAccountHomeRegion": "East US" + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_listSaasSubscriptionDetails.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_listSaasSubscriptionDetails.json new file mode 100644 index 000000000000..f33b7487c230 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_listSaasSubscriptionDetails.json @@ -0,0 +1,32 @@ +{ + "operationId": "OracleSubscriptions_listSaasSubscriptionDetails", + "title": "OracleSubscriptions_listSaasSubscriptionDetails", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "1234567890", + "subscriptionName": "Oracle", + "timeCreated": "2022-03-07T00:00:00Z", + "offerId": "offer1", + "planId": "silver", + "saasSubscriptionStatus": "PendingFulfillmentStart", + "publisherId": "Oracle", + "purchaserEmailId": "test@test.com", + "purchaserTenantId": "1234567890", + "termUnit": "P1M", + "isAutoRenew": true, + "isFreeTrial": false + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_patch.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_patch.json new file mode 100644 index 000000000000..eb3bf9935a8c --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/oracleSubscriptions_patch.json @@ -0,0 +1,43 @@ +{ + "operationId": "OracleSubscriptions_update", + "title": "OracleSubscriptions_update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/systemVersions_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/systemVersions_get.json new file mode 100644 index 000000000000..772079509ae6 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/systemVersions_get.json @@ -0,0 +1,20 @@ +{ + "operationId": "SystemVersions_Get", + "title": "systemVersions_listSystemVersions", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "systemversionname": "22.x" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/systemVersion/22.1.7.0.0.230113", + "properties": { + "systemVersion": "22.1.7.0.0.230113" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/systemVersions_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/systemVersions_listByLocation.json new file mode 100644 index 000000000000..b7d86b03d49b --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/systemVersions_listByLocation.json @@ -0,0 +1,24 @@ +{ + "operationId": "SystemVersions_ListByLocation", + "title": "systemVersions_listByLocation", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/systemVersion/22.1.7.0.0.230113", + "properties": { + "systemVersion": "22.1.7.0.0.230113" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/virtualNetworkAddresses_create.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/virtualNetworkAddresses_create.json new file mode 100644 index 000000000000..f55ccc3f7a31 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/virtualNetworkAddresses_create.json @@ -0,0 +1,48 @@ +{ + "operationId": "VirtualNetworkAddresses_createOrUpdate", + "title": "VirtualNetworkAddresses_createOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1", + "resource": { + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/virtualNetworkAddresses_delete.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/virtualNetworkAddresses_delete.json new file mode 100644 index 000000000000..0cd1fcd5de39 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/virtualNetworkAddresses_delete.json @@ -0,0 +1,20 @@ +{ + "operationId": "VirtualNetworkAddresses_delete", + "title": "VirtualNetworkAddresses_delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/virtualNetworkAddresses_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/virtualNetworkAddresses_get.json new file mode 100644 index 000000000000..4e6ca34d8a8a --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/virtualNetworkAddresses_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "VirtualNetworkAddresses_get", + "title": "VirtualNetworkAddresses_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/virtualNetworkAddresses_listByParent.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/virtualNetworkAddresses_listByParent.json new file mode 100644 index 000000000000..06393148fcf5 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/virtualNetworkAddresses_listByParent.json @@ -0,0 +1,33 @@ +{ + "operationId": "VirtualNetworkAddresses_listByCloudVmCluster", + "title": "VirtualNetworkAddresses_listByCloudVmCluster", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_addVms.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_addVms.json new file mode 100644 index 000000000000..ae3e82195734 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_addVms.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudVmClusters_addVms", + "title": "CloudVmClusters_addVms", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "dbServers": [ + "ocid1..aaaa", + "ocid1..aaaaaa" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_create.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_create.json new file mode 100644 index 000000000000..81d70bdfea31 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_create.json @@ -0,0 +1,224 @@ +{ + "operationId": "CloudVmClusters_createOrUpdate", + "title": "CloudVmClusters_createOrUpdate", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "resource": { + "properties": { + "dataStorageSizeInTbs": 1000, + "dbNodeStorageSizeInGbs": 1000, + "memorySizeInGbs": 1000, + "timeZone": "UTC", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 2, + "ocpuCount": 3, + "clusterName": "cluster1", + "dataStoragePercentage": 100, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "nsgCidrs": [ + { + "source": "10.0.0.0/16", + "destinationPortRange": { + "min": 1520, + "max": 1522 + } + }, + { + "source": "10.10.0.0/24" + } + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "dbServers": [ + "ocid1..aaaa" + ] + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "BootStrapping", + "lifecycleState": "BootStrapping", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_delete.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_delete.json new file mode 100644 index 000000000000..26b2c05ca71f --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "CloudVmClusters_delete", + "title": "CloudVmClusters_delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_get.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_get.json new file mode 100644 index 000000000000..8b5d66fc5d5a --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_get.json @@ -0,0 +1,104 @@ +{ + "operationId": "CloudVmClusters_get", + "title": "CloudVmClusters_get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "nsgCidrs": [ + { + "source": "10.0.0.0/16", + "destinationPortRange": { + "min": 1520, + "max": 1522 + } + }, + { + "source": "10.10.0.0/24" + } + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "nsgUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_listByResourceGroup.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_listByResourceGroup.json new file mode 100644 index 000000000000..1b0434639d71 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_listByResourceGroup.json @@ -0,0 +1,95 @@ +{ + "operationId": "CloudVmClusters_listByResourceGroup", + "title": "CloudVmClusters_listByResourceGroup", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_listBySubscription.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_listBySubscription.json new file mode 100644 index 000000000000..7be3134c943b --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_listBySubscription.json @@ -0,0 +1,94 @@ +{ + "operationId": "CloudVmClusters_listBySubscription", + "title": "CloudVmClusters_listBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_listPrivateIpAddresses.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_listPrivateIpAddresses.json new file mode 100644 index 000000000000..496cecd570e3 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_listPrivateIpAddresses.json @@ -0,0 +1,27 @@ +{ + "operationId": "CloudVmClusters_listPrivateIpAddresses", + "title": "CloudVmClusters_listPrivateIpAddresses", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "subnetId": "ocid1..aaaaaa", + "vnicId": "ocid1..aaaaa" + } + }, + "responses": { + "200": { + "body": [ + { + "displayName": "ip1", + "hostnameLabel": "hostname1", + "ocid": "ocid1..aaaa", + "ipAddress": "192.168.0.1", + "subnetId": "ocid1..aaaa" + } + ] + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_patch.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_patch.json new file mode 100644 index 000000000000..eca77cb6d6b2 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_patch.json @@ -0,0 +1,101 @@ +{ + "operationId": "CloudVmClusters_update", + "title": "CloudVmClusters_update", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_removeVms.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_removeVms.json new file mode 100644 index 000000000000..b7142d5d1909 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/vmClusters_removeVms.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudVmClusters_removeVms", + "title": "CloudVmClusters_removeVms", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "dbServers": [ + "ocid1..aaaa" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/openapi.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/openapi.json new file mode 100644 index 000000000000..84c01a35bf38 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/openapi.json @@ -0,0 +1,9900 @@ +{ + "swagger": "2.0", + "info": { + "title": "Oracle Database Resource Manager", + "version": "2024-06-01-preview", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "CloudExadataInfrastructures" + }, + { + "name": "DbServers" + }, + { + "name": "CloudVmClusters" + }, + { + "name": "VirtualNetworkAddresses" + }, + { + "name": "SystemVersions" + }, + { + "name": "OracleSubscriptions" + }, + { + "name": "DbNodes" + }, + { + "name": "GiVersions" + }, + { + "name": "DbSystemShapes" + }, + { + "name": "DnsPrivateViews" + }, + { + "name": "DnsPrivateZones" + }, + { + "name": "AutonomousDatabases" + }, + { + "name": "AutonomousDatabaseBackups" + }, + { + "name": "AutonomousDatabaseCharacterSets" + }, + { + "name": "AutonomousDatabaseNationalCharacterSets" + }, + { + "name": "AutonomousDatabaseVersions" + } + ], + "paths": { + "/providers/Oracle.Database/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/Oracle.Database/autonomousDatabases": { + "get": { + "operationId": "AutonomousDatabases_ListBySubscription", + "tags": [ + "AutonomousDatabases" + ], + "description": "List AutonomousDatabase 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/AutonomousDatabaseListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Autonomous Database by subscription": { + "$ref": "./examples/autonomousDatabase_listBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/cloudExadataInfrastructures": { + "get": { + "operationId": "CloudExadataInfrastructures_ListBySubscription", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "List CloudExadataInfrastructure 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/CloudExadataInfrastructureListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Exadata Infrastructure by subscription": { + "$ref": "./examples/exaInfra_listBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/cloudVmClusters": { + "get": { + "operationId": "CloudVmClusters_ListBySubscription", + "tags": [ + "CloudVmClusters" + ], + "description": "List CloudVmCluster 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/CloudVmClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List VM Clusters by subscription": { + "$ref": "./examples/vmClusters_listBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDatabaseCharacterSets": { + "get": { + "operationId": "AutonomousDatabaseCharacterSets_ListByLocation", + "tags": [ + "AutonomousDatabaseCharacterSets" + ], + "description": "List AutonomousDatabaseCharacterSet resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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/AutonomousDatabaseCharacterSetListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List autonomous db character sets by location": { + "$ref": "./examples/autonomousDatabaseCharacterSet_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDatabaseCharacterSets/{adbscharsetname}": { + "get": { + "operationId": "AutonomousDatabaseCharacterSets_Get", + "tags": [ + "AutonomousDatabaseCharacterSets" + ], + "description": "Get a AutonomousDatabaseCharacterSet", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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": "adbscharsetname", + "in": "path", + "description": "AutonomousDatabaseCharacterSet name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseCharacterSet" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get autonomous db character set": { + "$ref": "./examples/autonomousDatabaseCharacterSet_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDatabaseNationalCharacterSets": { + "get": { + "operationId": "AutonomousDatabaseNationalCharacterSets_ListByLocation", + "tags": [ + "AutonomousDatabaseNationalCharacterSets" + ], + "description": "List AutonomousDatabaseNationalCharacterSet resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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/AutonomousDatabaseNationalCharacterSetListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List autonomous db national character sets by location": { + "$ref": "./examples/autonomousDatabaseNationalCharacterSet_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDatabaseNationalCharacterSets/{adbsncharsetname}": { + "get": { + "operationId": "AutonomousDatabaseNationalCharacterSets_Get", + "tags": [ + "AutonomousDatabaseNationalCharacterSets" + ], + "description": "Get a AutonomousDatabaseNationalCharacterSet", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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": "adbsncharsetname", + "in": "path", + "description": "AutonomousDatabaseNationalCharacterSets name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseNationalCharacterSet" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get autonomous db national character set": { + "$ref": "./examples/autonomousDatabaseNationalCharacterSet_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDbVersions": { + "get": { + "operationId": "AutonomousDatabaseVersions_ListByLocation", + "tags": [ + "AutonomousDatabaseVersions" + ], + "description": "List AutonomousDbVersion resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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/AutonomousDbVersionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List an autonomous versions by location": { + "$ref": "./examples/autonomousDatabaseVersion_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDbVersions/{autonomousdbversionsname}": { + "get": { + "operationId": "AutonomousDatabaseVersions_Get", + "tags": [ + "AutonomousDatabaseVersions" + ], + "description": "Get a AutonomousDbVersion", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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": "autonomousdbversionsname", + "in": "path", + "description": "AutonomousDbVersion name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDbVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get an autonomous version": { + "$ref": "./examples/autonomousDatabaseVersion_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dbSystemShapes": { + "get": { + "operationId": "DbSystemShapes_ListByLocation", + "tags": [ + "DbSystemShapes" + ], + "description": "List DbSystemShape resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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/DbSystemShapeListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List DbSystemShapes by location": { + "$ref": "./examples/dbSystemShapes_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dbSystemShapes/{dbsystemshapename}": { + "get": { + "operationId": "DbSystemShapes_Get", + "tags": [ + "DbSystemShapes" + ], + "description": "Get a DbSystemShape", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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": "dbsystemshapename", + "in": "path", + "description": "DbSystemShape name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbSystemShape" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a DbSystemShape by name": { + "$ref": "./examples/dbSystemShapes_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dnsPrivateViews": { + "get": { + "operationId": "DnsPrivateViews_ListByLocation", + "tags": [ + "DnsPrivateViews" + ], + "description": "List DnsPrivateView resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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/DnsPrivateViewListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List DnsPrivateViews by location": { + "$ref": "./examples/dnsPrivateViews_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dnsPrivateViews/{dnsprivateviewocid}": { + "get": { + "operationId": "DnsPrivateViews_Get", + "tags": [ + "DnsPrivateViews" + ], + "description": "Get a DnsPrivateView", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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": "dnsprivateviewocid", + "in": "path", + "description": "DnsPrivateView OCID", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DnsPrivateView" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a DnsPrivateView by name": { + "$ref": "./examples/dnsPrivateViews_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dnsPrivateZones": { + "get": { + "operationId": "DnsPrivateZones_ListByLocation", + "tags": [ + "DnsPrivateZones" + ], + "description": "List DnsPrivateZone resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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/DnsPrivateZoneListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List DnsPrivateZones by location": { + "$ref": "./examples/dnsPrivateZones_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dnsPrivateZones/{dnsprivatezonename}": { + "get": { + "operationId": "DnsPrivateZones_Get", + "tags": [ + "DnsPrivateZones" + ], + "description": "Get a DnsPrivateZone", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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": "dnsprivatezonename", + "in": "path", + "description": "DnsPrivateZone name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DnsPrivateZone" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a DnsPrivateZone by name": { + "$ref": "./examples/dnsPrivateZones_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/giVersions": { + "get": { + "operationId": "GiVersions_ListByLocation", + "tags": [ + "GiVersions" + ], + "description": "List GiVersion resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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/GiVersionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List GiVersions by location": { + "$ref": "./examples/giVersions_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/giVersions/{giversionname}": { + "get": { + "operationId": "GiVersions_Get", + "tags": [ + "GiVersions" + ], + "description": "Get a GiVersion", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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": "giversionname", + "in": "path", + "description": "GiVersion name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GiVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a GiVersion by name": { + "$ref": "./examples/giVersions_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/systemVersions": { + "get": { + "operationId": "SystemVersions_ListByLocation", + "tags": [ + "SystemVersions" + ], + "description": "List SystemVersion resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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/SystemVersionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Exadata System Versions by the provided filter": { + "$ref": "./examples/systemVersions_listByLocation.json" + }, + "systemVersions_listByLocation": { + "$ref": "./examples/systemVersions_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/systemVersions/{systemversionname}": { + "get": { + "operationId": "SystemVersions_Get", + "tags": [ + "SystemVersions" + ], + "description": "Get a SystemVersion", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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": "systemversionname", + "in": "path", + "description": "SystemVersion name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SystemVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Exadata System Version": { + "$ref": "./examples/systemVersions_get.json" + }, + "systemVersions_listSystemVersions": { + "$ref": "./examples/systemVersions_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions": { + "get": { + "operationId": "OracleSubscriptions_ListBySubscription", + "tags": [ + "OracleSubscriptions" + ], + "description": "List OracleSubscription 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/OracleSubscriptionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Oracle Subscriptions by subscription": { + "$ref": "./examples/oracleSubscriptions_listBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default": { + "get": { + "operationId": "OracleSubscriptions_Get", + "tags": [ + "OracleSubscriptions" + ], + "description": "Get a OracleSubscription", + "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/OracleSubscription" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_get.json" + } + } + }, + "put": { + "operationId": "OracleSubscriptions_CreateOrUpdate", + "tags": [ + "OracleSubscriptions" + ], + "description": "Create a OracleSubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/OracleSubscription" + } + } + ], + "responses": { + "200": { + "description": "Resource 'OracleSubscription' update operation succeeded", + "schema": { + "$ref": "#/definitions/OracleSubscription" + } + }, + "201": { + "description": "Resource 'OracleSubscription' create operation succeeded", + "schema": { + "$ref": "#/definitions/OracleSubscription" + }, + "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": { + "Create or Update Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "OracleSubscriptions_Update", + "tags": [ + "OracleSubscriptions" + ], + "description": "Update a OracleSubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/OracleSubscriptionUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OracleSubscription" + } + }, + "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": { + "Patch Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_patch.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "OracleSubscriptions_Delete", + "tags": [ + "OracleSubscriptions" + ], + "description": "Delete a OracleSubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "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 Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default/addAzureSubscriptions": { + "post": { + "operationId": "OracleSubscriptions_AddAzureSubscriptions", + "tags": [ + "OracleSubscriptions" + ], + "description": "Add Azure Subscriptions", + "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 content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/AzureSubscriptions" + } + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Add Azure Subscriptions to the OracleSubscription": { + "$ref": "./examples/oracleSubscriptions_addAzureSubscriptions.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default/listActivationLinks": { + "post": { + "operationId": "OracleSubscriptions_ListActivationLinks", + "tags": [ + "OracleSubscriptions" + ], + "description": "List Activation Links", + "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/ActivationLinks" + } + }, + "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": { + "List Activation Links for the Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_listActivationLinks.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default/listCloudAccountDetails": { + "post": { + "operationId": "OracleSubscriptions_ListCloudAccountDetails", + "tags": [ + "OracleSubscriptions" + ], + "description": "List Cloud Account Details", + "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/CloudAccountDetails" + } + }, + "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": { + "List Cloud Account details for the Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_listCloudAccountDetails.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default/listSaasSubscriptionDetails": { + "post": { + "operationId": "OracleSubscriptions_ListSaasSubscriptionDetails", + "tags": [ + "OracleSubscriptions" + ], + "description": "List Saas Subscription Details", + "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/SaasSubscriptionDetails" + } + }, + "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": { + "List Saas Subscription details for the Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_listSaasSubscriptionDetails.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases": { + "get": { + "operationId": "AutonomousDatabases_ListByResourceGroup", + "tags": [ + "AutonomousDatabases" + ], + "description": "List AutonomousDatabase 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/AutonomousDatabaseListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Autonomous Database by resource group": { + "$ref": "./examples/autonomousDatabase_listByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}": { + "get": { + "operationId": "AutonomousDatabases_Get", + "tags": [ + "AutonomousDatabases" + ], + "description": "Get a AutonomousDatabase", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabases_Get": { + "$ref": "./examples/autonomousDatabase_get.json" + }, + "Get Autonomous Database": { + "$ref": "./examples/autonomousDatabase_get.json" + } + } + }, + "put": { + "operationId": "AutonomousDatabases_CreateOrUpdate", + "tags": [ + "AutonomousDatabases" + ], + "description": "Create a AutonomousDatabase", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AutonomousDatabase' update operation succeeded", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "201": { + "description": "Resource 'AutonomousDatabase' create operation succeeded", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + }, + "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": { + "AutonomousDatabases_CreateOrUpdate": { + "$ref": "./examples/autonomousDatabase_create.json" + }, + "AutonomousDatabases_CreateOrUpdate_clone": { + "$ref": "./examples/autonomousDatabaseClone_create.json" + }, + "Create Autonomous Database": { + "$ref": "./examples/autonomousDatabase_create.json" + }, + "Create clone Autonomous Database": { + "$ref": "./examples/autonomousDatabaseClone_create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "AutonomousDatabases_Update", + "tags": [ + "AutonomousDatabases" + ], + "description": "Update a AutonomousDatabase", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AutonomousDatabaseUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "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": { + "Patch Autonomous Database": { + "$ref": "./examples/autonomousDatabase_patch.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "AutonomousDatabases_Delete", + "tags": [ + "AutonomousDatabases" + ], + "description": "Delete a AutonomousDatabase", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + } + ], + "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 Autonomous Database": { + "$ref": "./examples/autonomousDatabase_delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/autonomousDatabaseBackups": { + "get": { + "operationId": "AutonomousDatabaseBackups_ListByAutonomousDatabase", + "tags": [ + "AutonomousDatabaseBackups" + ], + "description": "List AutonomousDatabaseBackup resources by AutonomousDatabase", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabaseBackups_ListByAutonomousDatabase": { + "$ref": "./examples/autonomousDatabaseBackup_listByParent.json" + }, + "List Autonomous Database Backups by Autonomous Database.": { + "$ref": "./examples/autonomousDatabaseBackup_listByParent.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/autonomousDatabaseBackups/{adbbackupid}": { + "get": { + "operationId": "AutonomousDatabaseBackups_Get", + "tags": [ + "AutonomousDatabaseBackups" + ], + "description": "Get a AutonomousDatabaseBackup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "adbbackupid", + "in": "path", + "description": "AutonomousDatabaseBackup id", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabaseBackups_Get": { + "$ref": "./examples/autonomousDatabaseBackup_get.json" + }, + "Get Autonomous Database Backup.": { + "$ref": "./examples/autonomousDatabaseBackup_get.json" + } + } + }, + "put": { + "operationId": "AutonomousDatabaseBackups_CreateOrUpdate", + "tags": [ + "AutonomousDatabaseBackups" + ], + "description": "Create a AutonomousDatabaseBackup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "adbbackupid", + "in": "path", + "description": "AutonomousDatabaseBackup id", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackup" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AutonomousDatabaseBackup' update operation succeeded", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackup" + } + }, + "201": { + "description": "Resource 'AutonomousDatabaseBackup' create operation succeeded", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackup" + }, + "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": { + "AutonomousDatabaseBackups_CreateOrUpdate": { + "$ref": "./examples/autonomousDatabaseBackup_create.json" + }, + "Create Autonomous Database Backup.": { + "$ref": "./examples/autonomousDatabaseBackup_create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "AutonomousDatabaseBackups_Update", + "tags": [ + "AutonomousDatabaseBackups" + ], + "description": "Update a AutonomousDatabaseBackup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "adbbackupid", + "in": "path", + "description": "AutonomousDatabaseBackup id", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackupUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackup" + } + }, + "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": { + "AutonomousDatabaseBackups_Update": { + "$ref": "./examples/autonomousDatabaseBackup_patch.json" + }, + "Patch Autonomous Database Backup.": { + "$ref": "./examples/autonomousDatabaseBackup_patch.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "AutonomousDatabaseBackups_Delete", + "tags": [ + "AutonomousDatabaseBackups" + ], + "description": "Delete a AutonomousDatabaseBackup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "adbbackupid", + "in": "path", + "description": "AutonomousDatabaseBackup id", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "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": { + "AutonomousDatabaseBackups_Delete": { + "$ref": "./examples/autonomousDatabaseBackup_delete.json" + }, + "Delete Autonomous Database Backup.": { + "$ref": "./examples/autonomousDatabaseBackup_delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/failover": { + "post": { + "operationId": "AutonomousDatabases_Failover", + "tags": [ + "AutonomousDatabases" + ], + "description": "Perform failover action on Autonomous Database", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/PeerDbDetails" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "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": { + "AutonomousDatabases_Failover": { + "$ref": "./examples/autonomousDatabase_failover.json" + }, + "Perform failover action on Autonomous Database": { + "$ref": "./examples/autonomousDatabase_failover.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/generateWallet": { + "post": { + "operationId": "AutonomousDatabases_GenerateWallet", + "tags": [ + "AutonomousDatabases" + ], + "description": "Generate wallet action on Autonomous Database", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/GenerateAutonomousDatabaseWalletDetails" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseWalletFile" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Generate wallet action on Autonomous Database": { + "$ref": "./examples/autonomousDatabase_generateWallet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/restore": { + "post": { + "operationId": "AutonomousDatabases_Restore", + "tags": [ + "AutonomousDatabases" + ], + "description": "Restores an Autonomous Database based on the provided request parameters.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/RestoreAutonomousDatabaseDetails" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "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": { + "AutonomousDatabases_Restore": { + "$ref": "./examples/autonomousDatabase_restore.json" + }, + "Perform restore action on Autonomous Database": { + "$ref": "./examples/autonomousDatabase_restore.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/shrink": { + "post": { + "operationId": "AutonomousDatabases_Shrink", + "tags": [ + "AutonomousDatabases" + ], + "description": "This operation shrinks the current allocated storage down to the current actual used data storage.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "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": { + "Perform shrink action on Autonomous Database": { + "$ref": "./examples/autonomousDatabase_shrink.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/switchover": { + "post": { + "operationId": "AutonomousDatabases_Switchover", + "tags": [ + "AutonomousDatabases" + ], + "description": "Perform switchover action on Autonomous Database", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/PeerDbDetails" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "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": { + "AutonomousDatabases_Switchover": { + "$ref": "./examples/autonomousDatabase_switchover.json" + }, + "Perform switchover action on Autonomous Database": { + "$ref": "./examples/autonomousDatabase_switchover.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures": { + "get": { + "operationId": "CloudExadataInfrastructures_ListByResourceGroup", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "List CloudExadataInfrastructure 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/CloudExadataInfrastructureListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Exadata Infrastructure by resource group": { + "$ref": "./examples/exaInfra_listByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures/{cloudexadatainfrastructurename}": { + "get": { + "operationId": "CloudExadataInfrastructures_Get", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "Get a CloudExadataInfrastructure", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructure" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Exadata Infrastructure": { + "$ref": "./examples/exaInfra_get.json" + } + } + }, + "put": { + "operationId": "CloudExadataInfrastructures_CreateOrUpdate", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "Create a CloudExadataInfrastructure", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructure" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CloudExadataInfrastructure' update operation succeeded", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructure" + } + }, + "201": { + "description": "Resource 'CloudExadataInfrastructure' create operation succeeded", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructure" + }, + "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": { + "Create Exadata Infrastructure": { + "$ref": "./examples/exaInfra_create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "CloudExadataInfrastructures_Update", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "Update a CloudExadataInfrastructure", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructureUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructure" + } + }, + "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": { + "Patch Exadata Infrastructure": { + "$ref": "./examples/exaInfra_patch.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "CloudExadataInfrastructures_Delete", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "Delete a CloudExadataInfrastructure", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "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 Exadata Infrastructure": { + "$ref": "./examples/exaInfra_delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures/{cloudexadatainfrastructurename}/addStorageCapacity": { + "post": { + "operationId": "CloudExadataInfrastructures_AddStorageCapacity", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "Perform add storage capacity on exadata infra", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructure" + } + }, + "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": { + "Perform add storage capacity on exadata infra": { + "$ref": "./examples/exaInfra_addStorageCapacity.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures/{cloudexadatainfrastructurename}/dbServers": { + "get": { + "operationId": "DbServers_ListByCloudExadataInfrastructure", + "tags": [ + "DbServers" + ], + "description": "List DbServer resources by CloudExadataInfrastructure", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbServerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List DbServers by Exadata Infrastructure": { + "$ref": "./examples/dbServers_listByParent.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures/{cloudexadatainfrastructurename}/dbServers/{dbserverocid}": { + "get": { + "operationId": "DbServers_Get", + "tags": [ + "DbServers" + ], + "description": "Get a DbServer", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "dbserverocid", + "in": "path", + "description": "DbServer OCID.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbServer" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get DbServer by parent": { + "$ref": "./examples/dbServers_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters": { + "get": { + "operationId": "CloudVmClusters_ListByResourceGroup", + "tags": [ + "CloudVmClusters" + ], + "description": "List CloudVmCluster 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/CloudVmClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List VM Clusters by resource group": { + "$ref": "./examples/vmClusters_listByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}": { + "get": { + "operationId": "CloudVmClusters_Get", + "tags": [ + "CloudVmClusters" + ], + "description": "Get a CloudVmCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudVmCluster" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get VM Cluster": { + "$ref": "./examples/vmClusters_get.json" + } + } + }, + "put": { + "operationId": "CloudVmClusters_CreateOrUpdate", + "tags": [ + "CloudVmClusters" + ], + "description": "Create a CloudVmCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudVmCluster" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CloudVmCluster' update operation succeeded", + "schema": { + "$ref": "#/definitions/CloudVmCluster" + } + }, + "201": { + "description": "Resource 'CloudVmCluster' create operation succeeded", + "schema": { + "$ref": "#/definitions/CloudVmCluster" + }, + "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": { + "Create VM Cluster": { + "$ref": "./examples/vmClusters_create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "CloudVmClusters_Update", + "tags": [ + "CloudVmClusters" + ], + "description": "Update a CloudVmCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudVmClusterUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudVmCluster" + } + }, + "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": { + "Patch VM Cluster": { + "$ref": "./examples/vmClusters_patch.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "CloudVmClusters_Delete", + "tags": [ + "CloudVmClusters" + ], + "description": "Delete a CloudVmCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "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 VM Cluster": { + "$ref": "./examples/vmClusters_delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/addVms": { + "post": { + "operationId": "CloudVmClusters_AddVms", + "tags": [ + "CloudVmClusters" + ], + "description": "Add VMs to the VM Cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/AddRemoveDbNode" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudVmCluster" + } + }, + "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": { + "Add VMs to VM Cluster": { + "$ref": "./examples/vmClusters_addVms.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/dbNodes": { + "get": { + "operationId": "DbNodes_ListByCloudVmCluster", + "tags": [ + "DbNodes" + ], + "description": "List DbNode resources by CloudVmCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbNodeListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List DbNodes by VM Cluster": { + "$ref": "./examples/dbNodes_listByParent.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/dbNodes/{dbnodeocid}": { + "get": { + "operationId": "DbNodes_Get", + "tags": [ + "DbNodes" + ], + "description": "Get a DbNode", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "dbnodeocid", + "in": "path", + "description": "DbNode OCID.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbNode" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get DbNode": { + "$ref": "./examples/dbNodes_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/dbNodes/{dbnodeocid}/action": { + "post": { + "operationId": "DbNodes_Action", + "tags": [ + "DbNodes" + ], + "description": "VM actions on DbNode of VM Cluster by the provided filter", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "dbnodeocid", + "in": "path", + "description": "DbNode OCID.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DbNodeAction" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbNode" + } + }, + "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": { + "DbNodes_Action": { + "$ref": "./examples/dbNodes_action.json" + }, + "VM actions on DbNodes of VM Cluster": { + "$ref": "./examples/dbNodes_action.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/listPrivateIpAddresses": { + "post": { + "operationId": "CloudVmClusters_ListPrivateIpAddresses", + "tags": [ + "CloudVmClusters" + ], + "description": "List Private IP Addresses by the provided filter", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateIpAddressesFilter" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateIpAddressProperties" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Private IP Addresses for VM Cluster": { + "$ref": "./examples/vmClusters_listPrivateIpAddresses.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/removeVms": { + "post": { + "operationId": "CloudVmClusters_RemoveVms", + "tags": [ + "CloudVmClusters" + ], + "description": "Remove VMs from the VM Cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/AddRemoveDbNode" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudVmCluster" + } + }, + "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": { + "Remove VMs from VM Cluster": { + "$ref": "./examples/vmClusters_removeVms.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/virtualNetworkAddresses": { + "get": { + "operationId": "VirtualNetworkAddresses_ListByCloudVmCluster", + "tags": [ + "VirtualNetworkAddresses" + ], + "description": "List VirtualNetworkAddress resources by CloudVmCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualNetworkAddressListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Virtual Network Addresses by VM Cluster": { + "$ref": "./examples/virtualNetworkAddresses_listByParent.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/virtualNetworkAddresses/{virtualnetworkaddressname}": { + "get": { + "operationId": "VirtualNetworkAddresses_Get", + "tags": [ + "VirtualNetworkAddresses" + ], + "description": "Get a VirtualNetworkAddress", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "virtualnetworkaddressname", + "in": "path", + "description": "Virtual IP address hostname.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualNetworkAddress" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Virtual Network Address": { + "$ref": "./examples/virtualNetworkAddresses_get.json" + } + } + }, + "put": { + "operationId": "VirtualNetworkAddresses_CreateOrUpdate", + "tags": [ + "VirtualNetworkAddresses" + ], + "description": "Create a VirtualNetworkAddress", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "virtualnetworkaddressname", + "in": "path", + "description": "Virtual IP address hostname.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": ".*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkAddress" + } + } + ], + "responses": { + "200": { + "description": "Resource 'VirtualNetworkAddress' update operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualNetworkAddress" + } + }, + "201": { + "description": "Resource 'VirtualNetworkAddress' create operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualNetworkAddress" + }, + "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": { + "Create Virtual Network Address": { + "$ref": "./examples/virtualNetworkAddresses_create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VirtualNetworkAddresses_Delete", + "tags": [ + "VirtualNetworkAddresses" + ], + "description": "Delete a VirtualNetworkAddress", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "virtualnetworkaddressname", + "in": "path", + "description": "Virtual IP address hostname.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": ".*" + } + ], + "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 Virtual Network Address": { + "$ref": "./examples/virtualNetworkAddresses_delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "ActivationLinks": { + "type": "object", + "description": "Activation Links model", + "properties": { + "newCloudAccountActivationLink": { + "type": "string", + "description": "New Cloud Account Activation Link", + "readOnly": true + }, + "existingCloudAccountActivationLink": { + "type": "string", + "description": "Existing Cloud Account Activation Link", + "readOnly": true + } + } + }, + "AddRemoveDbNode": { + "type": "object", + "description": "Add/Remove (Virtual Machine) DbNode model", + "properties": { + "dbServers": { + "type": "array", + "description": "Db servers ocids", + "items": { + "$ref": "#/definitions/Ocid" + } + } + }, + "required": [ + "dbServers" + ] + }, + "AddSubscriptionOperationState": { + "type": "string", + "description": "Add Subscription Operation state enum", + "enum": [ + "Succeeded", + "Updating", + "Failed" + ], + "x-ms-enum": { + "name": "AddSubscriptionOperationState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Succeeded - State when Add Subscription operation succeeded" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Updating - State when Add Subscription operation is being Updated" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed - State when Add Subscription operation failed" + } + ] + }, + "readOnly": true + }, + "AllConnectionStringType": { + "type": "object", + "description": "The connection string profile to allow clients to group, filter and select connection string values based on structured metadata.", + "properties": { + "high": { + "type": "string", + "description": "The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + }, + "low": { + "type": "string", + "description": "The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + }, + "medium": { + "type": "string", + "description": "The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + } + } + }, + "ApexDetailsType": { + "type": "object", + "description": "Information about Oracle APEX Application Development.", + "properties": { + "apexVersion": { + "type": "string", + "description": "The Oracle APEX Application Development version." + }, + "ordsVersion": { + "type": "string", + "description": "The Oracle REST Data Services (ORDS) version." + } + } + }, + "AutonomousDatabase": { + "type": "object", + "description": "Autonomous Database resource model.", + "properties": { + "properties": { + "$ref": "#/definitions/AutonomousDatabaseBaseProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "AutonomousDatabaseBackup": { + "type": "object", + "description": "AutonomousDatabaseBackup resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/AutonomousDatabaseBackupProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AutonomousDatabaseBackupLifecycleState": { + "type": "string", + "description": "Autonomous database backup lifecycle state enum", + "enum": [ + "Creating", + "Active", + "Deleting", + "Failed", + "Updating" + ], + "x-ms-enum": { + "name": "AutonomousDatabaseBackupLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Creating", + "value": "Creating", + "description": "AutonomousDatabase backup is creating" + }, + { + "name": "Active", + "value": "Active", + "description": "AutonomousDatabase backup is active" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "AutonomousDatabase backup is deleting" + }, + { + "name": "Failed", + "value": "Failed", + "description": "AutonomousDatabase backup is failed" + }, + { + "name": "Updating", + "value": "Updating", + "description": "AutonomousDatabase backup is updating" + } + ] + } + }, + "AutonomousDatabaseBackupListResult": { + "type": "object", + "description": "The response of a AutonomousDatabaseBackup list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AutonomousDatabaseBackup items on this page", + "items": { + "$ref": "#/definitions/AutonomousDatabaseBackup" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AutonomousDatabaseBackupProperties": { + "type": "object", + "description": "AutonomousDatabaseBackup resource model", + "properties": { + "autonomousDatabaseOcid": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the Autonomous Database.", + "readOnly": true + }, + "databaseSizeInTbs": { + "type": "number", + "format": "double", + "description": "The size of the database in terabytes at the time the backup was taken.", + "readOnly": true + }, + "dbVersion": { + "type": "string", + "description": "A valid Oracle Database version for Autonomous Database.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The user-friendly name for the backup. The name does not have to be unique.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the Autonomous Database backup.", + "readOnly": true + }, + "isAutomatic": { + "type": "boolean", + "description": "Indicates whether the backup is user-initiated or automatic.", + "readOnly": true + }, + "isRestorable": { + "type": "boolean", + "description": "Indicates whether the backup can be used to restore the associated Autonomous Database.", + "readOnly": true + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycle state.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/AutonomousDatabaseBackupLifecycleState", + "description": "The current state of the backup.", + "readOnly": true + }, + "retentionPeriodInDays": { + "type": "integer", + "format": "int32", + "description": "Retention period, in days, for long-term backups.", + "minimum": 60, + "maximum": 3650, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "sizeInTbs": { + "type": "number", + "format": "double", + "description": "The backup size in terabytes (TB).", + "readOnly": true + }, + "timeAvailableTil": { + "type": "string", + "format": "date-time", + "description": "Timestamp until when the backup will be available.", + "readOnly": true + }, + "timeStarted": { + "type": "string", + "description": "The date and time the backup started.", + "readOnly": true + }, + "timeEnded": { + "type": "string", + "description": "The date and time the backup completed.", + "readOnly": true + }, + "backupType": { + "$ref": "#/definitions/AutonomousDatabaseBackupType", + "description": "The type of backup.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/AzureResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + } + } + }, + "AutonomousDatabaseBackupType": { + "type": "string", + "description": "Autonomous database backup type enum", + "enum": [ + "Incremental", + "Full", + "LongTerm" + ], + "x-ms-enum": { + "name": "AutonomousDatabaseBackupType", + "modelAsString": true, + "values": [ + { + "name": "Incremental", + "value": "Incremental", + "description": "Incremental backup" + }, + { + "name": "Full", + "value": "Full", + "description": "Full backup" + }, + { + "name": "LongTerm", + "value": "LongTerm", + "description": "LongTerm backup" + } + ] + } + }, + "AutonomousDatabaseBackupUpdate": { + "type": "object", + "description": "The type used for update operations of the AutonomousDatabaseBackup.", + "properties": { + "properties": { + "$ref": "#/definitions/AutonomousDatabaseBackupUpdateProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + } + }, + "AutonomousDatabaseBackupUpdateProperties": { + "type": "object", + "description": "The updatable properties of the AutonomousDatabaseBackup.", + "properties": { + "retentionPeriodInDays": { + "type": "integer", + "format": "int32", + "description": "Retention period, in days, for long-term backups.", + "minimum": 60, + "maximum": 3650, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + } + }, + "AutonomousDatabaseBaseProperties": { + "type": "object", + "description": "Autonomous Database base resource model.", + "properties": { + "adminPassword": { + "$ref": "#/definitions/Password", + "description": "Admin password.", + "minLength": 12, + "maxLength": 30, + "x-ms-mutability": [ + "update", + "create" + ] + }, + "dataBaseType": { + "$ref": "#/definitions/DataBaseType", + "description": "Database type to be created.", + "x-ms-mutability": [ + "create" + ] + }, + "autonomousMaintenanceScheduleType": { + "$ref": "#/definitions/AutonomousMaintenanceScheduleType", + "description": "The maintenance schedule type of the Autonomous Database Serverless.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "characterSet": { + "type": "string", + "description": "The character set for the autonomous database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "computeCount": { + "type": "number", + "format": "float", + "description": "The compute amount (CPUs) available to the database.", + "minimum": 0.1, + "maximum": 512, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "computeModel": { + "$ref": "#/definitions/ComputeModel", + "description": "The compute model of the Autonomous Database.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "cpuCoreCount": { + "type": "integer", + "format": "int32", + "description": "The number of CPU cores to be made available to the database.", + "minimum": 1, + "maximum": 128, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "customerContacts": { + "type": "array", + "description": "Customer Contacts.", + "items": { + "$ref": "#/definitions/CustomerContact" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "dataStorageSizeInTbs": { + "type": "integer", + "format": "int32", + "description": "The quantity of data in the database, in terabytes.", + "minimum": 1, + "maximum": 384, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "dataStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The size, in gigabytes, of the data volume that will be created and attached to the database.", + "minimum": 20, + "maximum": 393216, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "dbVersion": { + "type": "string", + "description": "A valid Oracle Database version for Autonomous Database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "dbWorkload": { + "$ref": "#/definitions/WorkloadType", + "description": "The Autonomous Database workload type", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "displayName": { + "type": "string", + "description": "The user-friendly name for the Autonomous Database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isAutoScalingEnabled": { + "type": "boolean", + "description": "Indicates if auto scaling is enabled for the Autonomous Database CPU core count.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isAutoScalingForStorageEnabled": { + "type": "boolean", + "description": "Indicates if auto scaling is enabled for the Autonomous Database storage.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "peerDbIds": { + "type": "array", + "description": "The list of [OCIDs](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for Autonomous Database Serverless instances, standby databases located in the same region as the source primary database do not have OCIDs.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "peerDbId": { + "type": "string", + "description": "The database OCID of the Disaster Recovery peer database, which is located in a different region from the current peer database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "update" + ] + }, + "isLocalDataGuardEnabled": { + "type": "boolean", + "description": "Indicates whether the Autonomous Database has local or called in-region Data Guard enabled.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isRemoteDataGuardEnabled": { + "type": "boolean", + "description": "Indicates whether the Autonomous Database has Cross Region Data Guard enabled.", + "readOnly": true + }, + "localDisasterRecoveryType": { + "$ref": "#/definitions/DisasterRecoveryType", + "description": "Indicates the local disaster recovery (DR) type of the Autonomous Database Serverless instance.Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover.Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover.", + "readOnly": true + }, + "localStandbyDb": { + "$ref": "#/definitions/AutonomousDatabaseStandbySummary", + "description": "Local Autonomous Disaster Recovery standby database details.", + "readOnly": true + }, + "failedDataRecoveryInSeconds": { + "type": "integer", + "format": "int32", + "description": "Indicates the number of seconds of data loss for a Data Guard failover.", + "readOnly": true + }, + "isMtlsConnectionRequired": { + "type": "boolean", + "description": "Specifies if the Autonomous Database requires mTLS connections.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isPreviewVersionWithServiceTermsAccepted": { + "type": "boolean", + "description": "Specifies if the Autonomous Database preview version is being provisioned.", + "x-ms-mutability": [ + "create" + ] + }, + "licenseModel": { + "$ref": "#/definitions/LicenseModel", + "description": "The Oracle license model that applies to the Oracle Autonomous Database. The default is LICENSE_INCLUDED.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "ncharacterSet": { + "type": "string", + "description": "The character set for the Autonomous Database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycle state.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/AzureResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/AutonomousDatabaseLifecycleState", + "description": "Views lifecycleState", + "readOnly": true + }, + "scheduledOperations": { + "$ref": "#/definitions/ScheduledOperationsType", + "description": "The list of scheduled operations.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "privateEndpointIp": { + "type": "string", + "description": "The private endpoint Ip address for the resource.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "privateEndpointLabel": { + "type": "string", + "description": "The resource's private endpoint label.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ociUrl": { + "type": "string", + "description": "HTTPS link to OCI resources exposed to Azure Customer via Azure Interface.", + "readOnly": true + }, + "subnetId": { + "$ref": "#/definitions/SubnetId", + "description": "Client subnet", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "vnetId": { + "$ref": "#/definitions/VnetId", + "description": "VNET for network connectivity", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "The date and time that the database was created.", + "readOnly": true + }, + "timeMaintenanceBegin": { + "type": "string", + "format": "date-time", + "description": "The date and time when maintenance will begin.", + "readOnly": true + }, + "timeMaintenanceEnd": { + "type": "string", + "format": "date-time", + "description": "The date and time when maintenance will end.", + "readOnly": true + }, + "actualUsedDataStorageSizeInTbs": { + "type": "number", + "format": "double", + "description": "The current amount of storage in use for user and system data, in terabytes (TB).", + "readOnly": true + }, + "allocatedStorageSizeInTbs": { + "type": "number", + "format": "double", + "description": "The amount of storage currently allocated for the database tables and billed for, rounded up.", + "readOnly": true + }, + "apexDetails": { + "$ref": "#/definitions/ApexDetailsType", + "description": "Information about Oracle APEX Application Development.", + "readOnly": true + }, + "availableUpgradeVersions": { + "type": "array", + "description": "List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "connectionStrings": { + "$ref": "#/definitions/ConnectionStringType", + "description": "The connection string used to connect to the Autonomous Database.", + "readOnly": true + }, + "connectionUrls": { + "$ref": "#/definitions/ConnectionUrlType", + "description": "The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN. ", + "readOnly": true + }, + "dataSafeStatus": { + "$ref": "#/definitions/DataSafeStatusType", + "description": "Status of the Data Safe registration for this Autonomous Database.", + "readOnly": true + }, + "databaseEdition": { + "$ref": "#/definitions/DatabaseEditionType", + "description": "The Oracle Database Edition that applies to the Autonomous databases.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "autonomousDatabaseId": { + "$ref": "#/definitions/AutonomousDatabaseId", + "description": "Autonomous Database ID", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "inMemoryAreaInGbs": { + "type": "integer", + "format": "int32", + "description": "The area assigned to In-Memory tables in Autonomous Database.", + "readOnly": true + }, + "nextLongTermBackupTimeStamp": { + "type": "string", + "format": "date-time", + "description": "The date and time when the next long-term backup would be created.", + "readOnly": true + }, + "longTermBackupSchedule": { + "$ref": "#/definitions/LongTermBackUpScheduleDetails", + "description": "Details for the long-term backup schedule.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "isPreview": { + "type": "boolean", + "description": "Indicates if the Autonomous Database version is a preview version.", + "readOnly": true + }, + "localAdgAutoFailoverMaxDataLossLimit": { + "type": "integer", + "format": "int32", + "description": "Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard", + "minimum": 0, + "maximum": 3600, + "x-ms-mutability": [ + "read", + "update" + ] + }, + "memoryPerOracleComputeUnitInGbs": { + "type": "integer", + "format": "int32", + "description": "The amount of memory (in GBs) enabled per ECPU or OCPU.", + "readOnly": true + }, + "openMode": { + "$ref": "#/definitions/OpenModeType", + "description": "Indicates the Autonomous Database mode.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "operationsInsightsStatus": { + "$ref": "#/definitions/OperationsInsightsStatusType", + "description": "Status of Operations Insights for this Autonomous Database.", + "readOnly": true + }, + "permissionLevel": { + "$ref": "#/definitions/PermissionLevelType", + "description": "The Autonomous Database permission level.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "privateEndpoint": { + "type": "string", + "description": "The private endpoint for the resource.", + "readOnly": true + }, + "provisionableCpus": { + "type": "array", + "description": "An array of CPU values that an Autonomous Database can be scaled to.", + "items": { + "type": "integer", + "format": "int32" + }, + "readOnly": true + }, + "role": { + "$ref": "#/definitions/RoleType", + "description": "The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "serviceConsoleUrl": { + "type": "string", + "description": "The URL of the Service Console for the Autonomous Database.", + "minLength": 10, + "maxLength": 255, + "readOnly": true + }, + "sqlWebDeveloperUrl": { + "type": "string", + "description": "The SQL Web Developer URL for the Oracle Autonomous Database.", + "minLength": 10, + "maxLength": 2048, + "readOnly": true + }, + "supportedRegionsToCloneTo": { + "type": "array", + "description": "The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database.", + "maxItems": 50, + "items": { + "type": "string" + }, + "readOnly": true + }, + "timeDataGuardRoleChanged": { + "type": "string", + "description": "The date and time the Autonomous Data Guard role was switched for the Autonomous Database.", + "readOnly": true + }, + "timeDeletionOfFreeAutonomousDatabase": { + "type": "string", + "description": "The date and time the Always Free database will be automatically deleted because of inactivity.", + "readOnly": true + }, + "timeLocalDataGuardEnabled": { + "type": "string", + "description": "The date and time that Autonomous Data Guard was enabled for an Autonomous Database where the standby was provisioned in the same region as the primary database.", + "readOnly": true + }, + "timeOfLastFailover": { + "type": "string", + "description": "The timestamp of the last failover operation.", + "readOnly": true + }, + "timeOfLastRefresh": { + "type": "string", + "description": "The date and time when last refresh happened.", + "readOnly": true + }, + "timeOfLastRefreshPoint": { + "type": "string", + "description": "The refresh point timestamp (UTC).", + "readOnly": true + }, + "timeOfLastSwitchover": { + "type": "string", + "description": "The timestamp of the last switchover operation for the Autonomous Database.", + "readOnly": true + }, + "timeReclamationOfFreeAutonomousDatabase": { + "type": "string", + "description": "The date and time the Always Free database will be stopped because of inactivity.", + "readOnly": true + }, + "usedDataStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The storage space consumed by Autonomous Database in GBs.", + "readOnly": true + }, + "usedDataStorageSizeInTbs": { + "type": "integer", + "format": "int32", + "description": "The amount of storage that has been used, in terabytes.", + "readOnly": true + }, + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "Database ocid", + "readOnly": true + }, + "backupRetentionPeriodInDays": { + "type": "integer", + "format": "int32", + "description": "Retention period, in days, for long-term backups", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "whitelistedIps": { + "type": "array", + "description": "The client IP access control list (ACL). This is an array of CIDR notations and/or IP addresses. Values should be separate strings, separated by commas. Example: ['1.1.1.1','1.1.1.0/24','1.1.2.25']", + "items": { + "$ref": "#/definitions/aclString" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + }, + "discriminator": "dataBaseType", + "required": [ + "dataBaseType" + ] + }, + "AutonomousDatabaseCharacterSet": { + "type": "object", + "description": "AutonomousDatabaseCharacterSets resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/AutonomousDatabaseCharacterSetProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AutonomousDatabaseCharacterSetListResult": { + "type": "object", + "description": "The response of a AutonomousDatabaseCharacterSet list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AutonomousDatabaseCharacterSet items on this page", + "items": { + "$ref": "#/definitions/AutonomousDatabaseCharacterSet" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AutonomousDatabaseCharacterSetProperties": { + "type": "object", + "description": "AutonomousDatabaseCharacterSet resource model", + "properties": { + "characterSet": { + "type": "string", + "description": "The Oracle Autonomous Database supported character sets.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + } + } + }, + "AutonomousDatabaseCloneProperties": { + "type": "object", + "description": "Autonomous Database clone resource model.", + "properties": { + "source": { + "$ref": "#/definitions/SourceType", + "description": "The source of the database.", + "x-ms-mutability": [ + "create" + ] + }, + "sourceId": { + "$ref": "#/definitions/AutonomousDatabaseId", + "description": "The Azure ID of the Autonomous Database that was cloned to create the current Autonomous Database.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "cloneType": { + "$ref": "#/definitions/CloneType", + "description": "The Autonomous Database clone type.", + "x-ms-mutability": [ + "create" + ] + }, + "isReconnectCloneEnabled": { + "type": "boolean", + "description": "Indicates if the refreshable clone can be reconnected to its source database.", + "readOnly": true + }, + "isRefreshableClone": { + "type": "boolean", + "description": "Indicates if the Autonomous Database is a refreshable clone.", + "readOnly": true + }, + "refreshableModel": { + "$ref": "#/definitions/RefreshableModelType", + "description": "The refresh mode of the clone.", + "x-ms-mutability": [ + "create" + ] + }, + "refreshableStatus": { + "$ref": "#/definitions/RefreshableStatusType", + "description": "The refresh status of the clone.", + "readOnly": true + }, + "timeUntilReconnectCloneEnabled": { + "type": "string", + "description": "The time and date as an RFC3339 formatted string, e.g., 2022-01-01T12:00:00.000Z, to set the limit for a refreshable clone to be reconnected to its source database.", + "x-ms-mutability": [ + "read", + "update" + ] + } + }, + "required": [ + "sourceId", + "cloneType" + ], + "allOf": [ + { + "$ref": "#/definitions/AutonomousDatabaseBaseProperties" + } + ], + "x-ms-discriminator-value": "Clone" + }, + "AutonomousDatabaseId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Oracle.Database/autonomousDatabases" + } + ] + } + }, + "AutonomousDatabaseLifecycleState": { + "type": "string", + "description": "Autonomous database lifecycle state enum", + "enum": [ + "Provisioning", + "Available", + "Stopping", + "Stopped", + "Starting", + "Terminating", + "Terminated", + "Unavailable", + "RestoreInProgress", + "RestoreFailed", + "BackupInProgress", + "ScaleInProgress", + "AvailableNeedsAttention", + "Updating", + "MaintenanceInProgress", + "Restarting", + "Recreating", + "RoleChangeInProgress", + "Upgrading", + "Inaccessible", + "Standby" + ], + "x-ms-enum": { + "name": "AutonomousDatabaseLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Indicates that resource in Provisioning state" + }, + { + "name": "Available", + "value": "Available", + "description": "Indicates that resource in Available state" + }, + { + "name": "Stopping", + "value": "Stopping", + "description": "Indicates that resource in Stopping state" + }, + { + "name": "Stopped", + "value": "Stopped", + "description": "Indicates that resource in Stopped state" + }, + { + "name": "Starting", + "value": "Starting", + "description": "Indicates that resource in Starting state" + }, + { + "name": "Terminating", + "value": "Terminating", + "description": "Indicates that resource in Terminating state" + }, + { + "name": "Terminated", + "value": "Terminated", + "description": "Indicates that resource in Terminated state" + }, + { + "name": "Unavailable", + "value": "Unavailable", + "description": "Indicates that resource in Unavailable state" + }, + { + "name": "RestoreInProgress", + "value": "RestoreInProgress", + "description": "Indicates that resource in RestoreInProgress state" + }, + { + "name": "RestoreFailed", + "value": "RestoreFailed", + "description": "Indicates that resource in RestoreFailed state" + }, + { + "name": "BackupInProgress", + "value": "BackupInProgress", + "description": "Indicates that resource in BackupInProgress state" + }, + { + "name": "ScaleInProgress", + "value": "ScaleInProgress", + "description": "Indicates that resource in ScaleInProgress state" + }, + { + "name": "AvailableNeedsAttention", + "value": "AvailableNeedsAttention", + "description": "Indicates that resource is available but needs attention" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Indicates that resource in Updating state" + }, + { + "name": "MaintenanceInProgress", + "value": "MaintenanceInProgress", + "description": "Indicates that resource maintenance in progress state" + }, + { + "name": "Restarting", + "value": "Restarting", + "description": "Indicates that resource in Restarting state" + }, + { + "name": "Recreating", + "value": "Recreating", + "description": "Indicates that resource in Recreating state" + }, + { + "name": "RoleChangeInProgress", + "value": "RoleChangeInProgress", + "description": "Indicates that resource role change in progress state" + }, + { + "name": "Upgrading", + "value": "Upgrading", + "description": "Indicates that resource in Upgrading state" + }, + { + "name": "Inaccessible", + "value": "Inaccessible", + "description": "IIndicates that resource in Inaccessible state" + }, + { + "name": "Standby", + "value": "Standby", + "description": "Indicates that resource in Standby state" + } + ] + } + }, + "AutonomousDatabaseListResult": { + "type": "object", + "description": "The response of a AutonomousDatabase list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AutonomousDatabase items on this page", + "items": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AutonomousDatabaseNationalCharacterSet": { + "type": "object", + "description": "AutonomousDatabaseNationalCharacterSets resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/AutonomousDatabaseNationalCharacterSetProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AutonomousDatabaseNationalCharacterSetListResult": { + "type": "object", + "description": "The response of a AutonomousDatabaseNationalCharacterSet list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AutonomousDatabaseNationalCharacterSet items on this page", + "items": { + "$ref": "#/definitions/AutonomousDatabaseNationalCharacterSet" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AutonomousDatabaseNationalCharacterSetProperties": { + "type": "object", + "description": "AutonomousDatabaseNationalCharacterSet resource model", + "properties": { + "characterSet": { + "type": "string", + "description": "The Oracle Autonomous Database supported national character sets.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + } + } + }, + "AutonomousDatabaseProperties": { + "type": "object", + "description": "Autonomous Database resource model.", + "allOf": [ + { + "$ref": "#/definitions/AutonomousDatabaseBaseProperties" + } + ], + "x-ms-discriminator-value": "Regular" + }, + "AutonomousDatabaseStandbySummary": { + "type": "object", + "description": "Autonomous Disaster Recovery standby database details.", + "properties": { + "lagTimeInSeconds": { + "type": "integer", + "format": "int32", + "description": "The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover." + }, + "lifecycleState": { + "$ref": "#/definitions/AutonomousDatabaseLifecycleState", + "description": "The current state of the Autonomous Database." + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycle state." + }, + "timeDataGuardRoleChanged": { + "type": "string", + "description": "The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database." + }, + "timeDisasterRecoveryRoleChanged": { + "type": "string", + "description": "The date and time the Disaster Recovery role was switched for the standby Autonomous Database." + } + } + }, + "AutonomousDatabaseUpdate": { + "type": "object", + "description": "The type used for update operations of the AutonomousDatabase.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/AutonomousDatabaseUpdateProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + } + }, + "AutonomousDatabaseUpdateProperties": { + "type": "object", + "description": "The updatable properties of the AutonomousDatabase.", + "properties": { + "adminPassword": { + "$ref": "#/definitions/Password", + "description": "Admin password.", + "minLength": 12, + "maxLength": 30, + "x-ms-mutability": [ + "update", + "create" + ] + }, + "autonomousMaintenanceScheduleType": { + "$ref": "#/definitions/AutonomousMaintenanceScheduleType", + "description": "The maintenance schedule type of the Autonomous Database Serverless.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "computeCount": { + "type": "number", + "format": "float", + "description": "The compute amount (CPUs) available to the database.", + "minimum": 0.1, + "maximum": 512, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "cpuCoreCount": { + "type": "integer", + "format": "int32", + "description": "The number of CPU cores to be made available to the database.", + "minimum": 1, + "maximum": 128, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "customerContacts": { + "type": "array", + "description": "Customer Contacts.", + "items": { + "$ref": "#/definitions/CustomerContact" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "dataStorageSizeInTbs": { + "type": "integer", + "format": "int32", + "description": "The quantity of data in the database, in terabytes.", + "minimum": 1, + "maximum": 384, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "dataStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The size, in gigabytes, of the data volume that will be created and attached to the database.", + "minimum": 20, + "maximum": 393216, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "displayName": { + "type": "string", + "description": "The user-friendly name for the Autonomous Database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isAutoScalingEnabled": { + "type": "boolean", + "description": "Indicates if auto scaling is enabled for the Autonomous Database CPU core count.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isAutoScalingForStorageEnabled": { + "type": "boolean", + "description": "Indicates if auto scaling is enabled for the Autonomous Database storage.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "peerDbId": { + "type": "string", + "description": "The database OCID of the Disaster Recovery peer database, which is located in a different region from the current peer database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "update" + ] + }, + "isLocalDataGuardEnabled": { + "type": "boolean", + "description": "Indicates whether the Autonomous Database has local or called in-region Data Guard enabled.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isMtlsConnectionRequired": { + "type": "boolean", + "description": "Specifies if the Autonomous Database requires mTLS connections.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "licenseModel": { + "$ref": "#/definitions/LicenseModel", + "description": "The Oracle license model that applies to the Oracle Autonomous Database. The default is LICENSE_INCLUDED.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "scheduledOperations": { + "$ref": "#/definitions/ScheduledOperationsTypeUpdate", + "description": "The list of scheduled operations.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "databaseEdition": { + "$ref": "#/definitions/DatabaseEditionType", + "description": "The Oracle Database Edition that applies to the Autonomous databases.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "longTermBackupSchedule": { + "$ref": "#/definitions/LongTermBackUpScheduleDetails", + "description": "Details for the long-term backup schedule.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "localAdgAutoFailoverMaxDataLossLimit": { + "type": "integer", + "format": "int32", + "description": "Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard", + "minimum": 0, + "maximum": 3600, + "x-ms-mutability": [ + "read", + "update" + ] + }, + "openMode": { + "$ref": "#/definitions/OpenModeType", + "description": "Indicates the Autonomous Database mode.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "permissionLevel": { + "$ref": "#/definitions/PermissionLevelType", + "description": "The Autonomous Database permission level.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "role": { + "$ref": "#/definitions/RoleType", + "description": "The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "backupRetentionPeriodInDays": { + "type": "integer", + "format": "int32", + "description": "Retention period, in days, for long-term backups", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "whitelistedIps": { + "type": "array", + "description": "The client IP access control list (ACL). This is an array of CIDR notations and/or IP addresses. Values should be separate strings, separated by commas. Example: ['1.1.1.1','1.1.1.0/24','1.1.2.25']", + "items": { + "$ref": "#/definitions/aclString" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + } + }, + "AutonomousDatabaseWalletFile": { + "type": "object", + "description": "Autonomous Database Wallet File resource model.", + "properties": { + "walletFiles": { + "type": "string", + "description": "The base64 encoded wallet files" + } + }, + "required": [ + "walletFiles" + ] + }, + "AutonomousDbVersion": { + "type": "object", + "description": "AutonomousDbVersion resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/AutonomousDbVersionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AutonomousDbVersionListResult": { + "type": "object", + "description": "The response of a AutonomousDbVersion list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AutonomousDbVersion items on this page", + "items": { + "$ref": "#/definitions/AutonomousDbVersion" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AutonomousDbVersionProperties": { + "type": "object", + "description": "AutonomousDbVersion resource model", + "properties": { + "version": { + "type": "string", + "description": "Supported Autonomous Db versions.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "dbWorkload": { + "$ref": "#/definitions/WorkloadType", + "description": "The Autonomous Database workload type", + "readOnly": true + }, + "isDefaultForFree": { + "type": "boolean", + "description": "True if this version of the Oracle Database software's default is free.", + "readOnly": true + }, + "isDefaultForPaid": { + "type": "boolean", + "description": "True if this version of the Oracle Database software's default is paid.", + "readOnly": true + }, + "isFreeTierEnabled": { + "type": "boolean", + "description": "True if this version of the Oracle Database software can be used for Always-Free Autonomous Databases.", + "readOnly": true + }, + "isPaidEnabled": { + "type": "boolean", + "description": "True if this version of the Oracle Database software has payments enabled.", + "readOnly": true + } + } + }, + "AutonomousMaintenanceScheduleType": { + "type": "string", + "description": "Autonomous database maintenance schedule type enum.", + "enum": [ + "Early", + "Regular" + ], + "x-ms-enum": { + "name": "AutonomousMaintenanceScheduleType", + "modelAsString": true, + "values": [ + { + "name": "Early", + "value": "Early", + "description": "Early maintenance schedule" + }, + { + "name": "Regular", + "value": "Regular", + "description": "Regular maintenance schedule" + } + ] + } + }, + "Azure.ResourceManager.ResourceProvisioningState": { + "type": "string", + "description": "The provisioning state of a resource type.", + "enum": [ + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ResourceProvisioningState", + "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." + } + ] + }, + "readOnly": true + }, + "AzureResourceProvisioningState": { + "type": "string", + "description": "Azure Resource Provisioning State enum", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning" + ], + "x-ms-enum": { + "name": "AzureResourceProvisioningState", + "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": "Indicates that resource in Provisioning state" + } + ] + }, + "readOnly": true + }, + "AzureSubscriptions": { + "type": "object", + "description": "Azure Subscriptions model", + "properties": { + "azureSubscriptionIds": { + "type": "array", + "description": "Azure Subscription Ids to be updated", + "items": { + "type": "string" + } + } + }, + "required": [ + "azureSubscriptionIds" + ] + }, + "CloneType": { + "type": "string", + "description": "Clone type enum", + "enum": [ + "Full", + "Metadata" + ], + "x-ms-enum": { + "name": "CloneType", + "modelAsString": true, + "values": [ + { + "name": "Full", + "value": "Full", + "description": "Full clone" + }, + { + "name": "Metadata", + "value": "Metadata", + "description": "Metadata only" + } + ] + } + }, + "CloudAccountDetails": { + "type": "object", + "description": "Cloud Account Details model", + "properties": { + "cloudAccountName": { + "type": "string", + "description": "Cloud Account name", + "readOnly": true + }, + "cloudAccountHomeRegion": { + "type": "string", + "description": "Cloud Account Home region", + "readOnly": true + } + } + }, + "CloudAccountProvisioningState": { + "type": "string", + "description": "CloudAccountProvisioningState enum", + "enum": [ + "Pending", + "Provisioning", + "Available" + ], + "x-ms-enum": { + "name": "CloudAccountProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Pending", + "value": "Pending", + "description": "Pending - Initial state when Oracle cloud account is not configured" + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Provisioning - State when Oracle cloud account is being provisioned" + }, + { + "name": "Available", + "value": "Available", + "description": "Available - State when Oracle cloud account cloud linking is complete and it is available" + } + ] + } + }, + "CloudExadataInfrastructure": { + "type": "object", + "description": "CloudExadataInfrastructure resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/CloudExadataInfrastructureProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "zones": { + "type": "array", + "description": "CloudExadataInfrastructure zones", + "items": { + "type": "string" + } + } + }, + "required": [ + "zones" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "CloudExadataInfrastructureId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Oracle.Database/cloudExadataInfrastructures" + } + ] + } + }, + "CloudExadataInfrastructureLifecycleState": { + "type": "string", + "description": "CloudExadataInfrastructureLifecycleState enum", + "enum": [ + "Provisioning", + "Available", + "Updating", + "Terminating", + "Terminated", + "MaintenanceInProgress", + "Failed" + ], + "x-ms-enum": { + "name": "CloudExadataInfrastructureLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Indicates that resource in Provisioning state" + }, + { + "name": "Available", + "value": "Available", + "description": "Indicates that resource in Available state" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Indicates that resource in Updating state" + }, + { + "name": "Terminating", + "value": "Terminating", + "description": "Indicates that resource in Terminating state" + }, + { + "name": "Terminated", + "value": "Terminated", + "description": "Indicates that resource in Terminated state" + }, + { + "name": "MaintenanceInProgress", + "value": "MaintenanceInProgress", + "description": "Indicates that resource maintenance in progress state" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Indicates that resource in Failed state" + } + ] + } + }, + "CloudExadataInfrastructureListResult": { + "type": "object", + "description": "The response of a CloudExadataInfrastructure list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CloudExadataInfrastructure items on this page", + "items": { + "$ref": "#/definitions/CloudExadataInfrastructure" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CloudExadataInfrastructureProperties": { + "type": "object", + "description": "CloudExadataInfrastructure resource model", + "properties": { + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "Exadata infra ocid", + "readOnly": true + }, + "computeCount": { + "type": "integer", + "format": "int32", + "description": "The number of compute servers for the cloud Exadata infrastructure.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "storageCount": { + "type": "integer", + "format": "int32", + "description": "The number of storage servers for the cloud Exadata infrastructure.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "totalStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The total storage allocated to the cloud Exadata infrastructure resource, in gigabytes (GB).", + "readOnly": true + }, + "availableStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The available storage can be allocated to the cloud Exadata infrastructure resource, in gigabytes (GB).", + "readOnly": true + }, + "timeCreated": { + "type": "string", + "description": "The date and time the cloud Exadata infrastructure resource was created.", + "readOnly": true + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycle state.", + "readOnly": true + }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "description": "maintenanceWindow property", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "estimatedPatchingTime": { + "$ref": "#/definitions/EstimatedPatchingTime", + "description": "The estimated total time required in minutes for all patching operations (database server, storage server, and network switch patching).", + "readOnly": true + }, + "customerContacts": { + "type": "array", + "description": "The list of customer email addresses that receive information from Oracle about the specified OCI Database service resource. Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. Up to 10 email addresses can be added to the customer contacts for a cloud Exadata infrastructure instance. ", + "items": { + "$ref": "#/definitions/CustomerContact" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "provisioningState": { + "$ref": "#/definitions/AzureResourceProvisioningState", + "description": "CloudExadataInfrastructure provisioning state", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/CloudExadataInfrastructureLifecycleState", + "description": "CloudExadataInfrastructure lifecycle state", + "readOnly": true + }, + "shape": { + "type": "string", + "description": "The model name of the cloud Exadata infrastructure resource.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ociUrl": { + "type": "string", + "format": "uri", + "description": "HTTPS link to OCI resources exposed to Azure Customer via Azure Interface.", + "readOnly": true + }, + "cpuCount": { + "type": "integer", + "format": "int32", + "description": "The total number of CPU cores allocated.", + "readOnly": true + }, + "maxCpuCount": { + "type": "integer", + "format": "int32", + "description": "The total number of CPU cores available.", + "readOnly": true + }, + "memorySizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The memory allocated in GBs.", + "readOnly": true + }, + "maxMemoryInGbs": { + "type": "integer", + "format": "int32", + "description": "The total memory available in GBs.", + "readOnly": true + }, + "dbNodeStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The local node storage to be allocated in GBs.", + "readOnly": true + }, + "maxDbNodeStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The total local node storage available in GBs.", + "readOnly": true + }, + "dataStorageSizeInTbs": { + "type": "number", + "format": "double", + "description": "The quantity of data in the database, in terabytes.", + "readOnly": true + }, + "maxDataStorageInTbs": { + "type": "number", + "format": "double", + "description": "The total available DATA disk group size.", + "readOnly": true + }, + "dbServerVersion": { + "type": "string", + "description": "The software version of the database servers (dom0) in the Exadata infrastructure.", + "readOnly": true + }, + "storageServerVersion": { + "type": "string", + "description": "The software version of the storage servers (cells) in the Exadata infrastructure.", + "readOnly": true + }, + "activatedStorageCount": { + "type": "integer", + "format": "int32", + "description": "The requested number of additional storage servers activated for the Exadata infrastructure.", + "readOnly": true + }, + "additionalStorageCount": { + "type": "integer", + "format": "int32", + "description": "The requested number of additional storage servers for the Exadata infrastructure.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The name for the Exadata infrastructure.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "lastMaintenanceRunId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the last maintenance run.", + "readOnly": true + }, + "nextMaintenanceRunId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the next maintenance run.", + "readOnly": true + }, + "monthlyDbServerVersion": { + "type": "string", + "description": "Monthly Db Server version", + "readOnly": true + }, + "monthlyStorageServerVersion": { + "type": "string", + "description": "Monthly Storage Server version", + "readOnly": true + } + }, + "required": [ + "shape", + "displayName" + ] + }, + "CloudExadataInfrastructureUpdate": { + "type": "object", + "description": "The type used for update operations of the CloudExadataInfrastructure.", + "properties": { + "zones": { + "type": "array", + "description": "CloudExadataInfrastructure zones", + "items": { + "type": "string" + } + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/CloudExadataInfrastructureUpdateProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + } + }, + "CloudExadataInfrastructureUpdateProperties": { + "type": "object", + "description": "The updatable properties of the CloudExadataInfrastructure.", + "properties": { + "computeCount": { + "type": "integer", + "format": "int32", + "description": "The number of compute servers for the cloud Exadata infrastructure.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "storageCount": { + "type": "integer", + "format": "int32", + "description": "The number of storage servers for the cloud Exadata infrastructure.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "description": "maintenanceWindow property", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "customerContacts": { + "type": "array", + "description": "The list of customer email addresses that receive information from Oracle about the specified OCI Database service resource. Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. Up to 10 email addresses can be added to the customer contacts for a cloud Exadata infrastructure instance. ", + "items": { + "$ref": "#/definitions/CustomerContact" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "displayName": { + "type": "string", + "description": "The name for the Exadata infrastructure.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + } + }, + "CloudVmCluster": { + "type": "object", + "description": "CloudVmCluster resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/CloudVmClusterProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "CloudVmClusterLifecycleState": { + "type": "string", + "description": "Cloud VM Cluster lifecycle state enum", + "enum": [ + "Provisioning", + "Available", + "Updating", + "Terminating", + "Terminated", + "MaintenanceInProgress", + "Failed" + ], + "x-ms-enum": { + "name": "CloudVmClusterLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Indicates that resource in Provisioning state" + }, + { + "name": "Available", + "value": "Available", + "description": "Indicates that resource in Available state" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Indicates that resource in Updating state" + }, + { + "name": "Terminating", + "value": "Terminating", + "description": "Indicates that resource in Terminating state" + }, + { + "name": "Terminated", + "value": "Terminated", + "description": "Indicates that resource in Terminated state" + }, + { + "name": "MaintenanceInProgress", + "value": "MaintenanceInProgress", + "description": "Indicates that resource Maintenance in progress state" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Indicates that resource in Failed state" + } + ] + } + }, + "CloudVmClusterListResult": { + "type": "object", + "description": "The response of a CloudVmCluster list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CloudVmCluster items on this page", + "items": { + "$ref": "#/definitions/CloudVmCluster" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CloudVmClusterProperties": { + "type": "object", + "description": "CloudVmCluster resource model", + "properties": { + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "Cloud VM Cluster ocid", + "readOnly": true + }, + "listenerPort": { + "type": "integer", + "format": "int64", + "description": "The port number configured for the listener on the cloud VM cluster.", + "readOnly": true + }, + "nodeCount": { + "type": "integer", + "format": "int32", + "description": "The number of nodes in the cloud VM cluster. ", + "readOnly": true + }, + "storageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The data disk group size to be allocated in GBs per VM.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "dataStorageSizeInTbs": { + "type": "number", + "format": "double", + "description": "The data disk group size to be allocated in TBs." + }, + "dbNodeStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The local node storage to be allocated in GBs." + }, + "memorySizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The memory to be allocated in GBs." + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "The date and time that the cloud VM cluster was created.", + "readOnly": true + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycle state.", + "readOnly": true + }, + "timeZone": { + "type": "string", + "description": "The time zone of the cloud VM cluster. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm).", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "zoneId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the zone the cloud VM cluster is associated with.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "hostname": { + "type": "string", + "description": "The hostname for the cloud VM cluster.", + "minLength": 1, + "maxLength": 23, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "domain": { + "type": "string", + "description": "The domain name for the cloud VM cluster.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "cpuCoreCount": { + "type": "integer", + "format": "int32", + "description": "The number of CPU cores enabled on the cloud VM cluster." + }, + "ocpuCount": { + "type": "number", + "format": "float", + "description": "The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part." + }, + "clusterName": { + "type": "string", + "description": "The cluster name for cloud VM cluster. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. ", + "minLength": 1, + "maxLength": 11, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "dataStoragePercentage": { + "type": "integer", + "format": "int32", + "description": "The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 35, 40, 60 and 80. The default is 80 percent assigned to DATA storage. See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "isLocalBackupEnabled": { + "type": "boolean", + "description": "If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster. ", + "default": false, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "cloudExadataInfrastructureId": { + "$ref": "#/definitions/CloudExadataInfrastructureId", + "description": "Cloud Exadata Infrastructure ID", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "isSparseDiskgroupEnabled": { + "type": "boolean", + "description": "If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created. ", + "default": false, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "systemVersion": { + "type": "string", + "description": "Operating system version of the image.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "sshPublicKeys": { + "type": "array", + "description": "The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.", + "items": { + "type": "string" + } + }, + "licenseModel": { + "$ref": "#/definitions/LicenseModel", + "description": "The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED. " + }, + "diskRedundancy": { + "$ref": "#/definitions/DiskRedundancy", + "description": "The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy. ", + "readOnly": true + }, + "scanIpIds": { + "type": "array", + "description": "The Single Client Access Name (SCAN) IP addresses associated with the cloud VM cluster. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster. **Note:** For a single-node DB system, this list is empty.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "vipIds": { + "type": "array", + "description": "The virtual IP (VIP) addresses associated with the cloud VM cluster. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "scanDnsName": { + "type": "string", + "description": "The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. ", + "minLength": 1, + "maxLength": 72, + "readOnly": true + }, + "scanListenerPortTcp": { + "type": "integer", + "format": "int32", + "description": "The TCP Single Client Access Name (SCAN) port. The default port is 1521.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "scanListenerPortTcpSsl": { + "type": "integer", + "format": "int32", + "description": "The TCPS Single Client Access Name (SCAN) port. The default port is 2484.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "scanDnsRecordId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.", + "readOnly": true + }, + "shape": { + "type": "string", + "description": "The model name of the Exadata hardware running the cloud VM cluster.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/AzureResourceProvisioningState", + "description": "CloudVmCluster provisioning state", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/CloudVmClusterLifecycleState", + "description": "CloudVmCluster lifecycle state", + "readOnly": true + }, + "vnetId": { + "$ref": "#/definitions/VnetId", + "description": "VNET for network connectivity", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "giVersion": { + "type": "string", + "description": "Oracle Grid Infrastructure (GI) software version", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ociUrl": { + "type": "string", + "format": "uri", + "description": "HTTPS link to OCI resources exposed to Azure Customer via Azure Interface.", + "readOnly": true + }, + "nsgUrl": { + "type": "string", + "format": "uri", + "description": "HTTPS link to OCI Network Security Group exposed to Azure Customer via the Azure Interface.", + "readOnly": true + }, + "subnetId": { + "$ref": "#/definitions/SubnetId", + "description": "Client subnet", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "backupSubnetCidr": { + "type": "string", + "description": "Client OCI backup subnet CIDR, default is 192.168.252.0/22", + "minLength": 1, + "maxLength": 32, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "nsgCidrs": { + "type": "array", + "description": "CIDR blocks for additional NSG ingress rules. The VNET CIDRs used to provision the VM Cluster will be added by default.", + "items": { + "$ref": "#/definitions/NsgCidr" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "create" + ] + }, + "dataCollectionOptions": { + "$ref": "#/definitions/DataCollectionOptions", + "description": "Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS." + }, + "displayName": { + "type": "string", + "description": "Display Name", + "minLength": 1, + "maxLength": 255 + }, + "computeNodes": { + "type": "array", + "description": "The list of compute servers to be added to the cloud VM cluster.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "x-ms-mutability": [ + "update" + ] + }, + "iormConfigCache": { + "$ref": "#/definitions/ExadataIormConfig", + "description": "iormConfigCache details for cloud VM cluster.", + "readOnly": true + }, + "lastUpdateHistoryEntryId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the last maintenance update history entry.", + "readOnly": true + }, + "dbServers": { + "type": "array", + "description": "The list of DB servers.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "compartmentId": { + "$ref": "#/definitions/Ocid", + "description": "Cluster compartmentId", + "readOnly": true + }, + "subnetOcid": { + "$ref": "#/definitions/Ocid", + "description": "Cluster subnet ocid", + "readOnly": true + } + }, + "required": [ + "hostname", + "cpuCoreCount", + "cloudExadataInfrastructureId", + "sshPublicKeys", + "vnetId", + "giVersion", + "subnetId", + "displayName" + ] + }, + "CloudVmClusterUpdate": { + "type": "object", + "description": "The type used for update operations of the CloudVmCluster.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/CloudVmClusterUpdateProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + } + }, + "CloudVmClusterUpdateProperties": { + "type": "object", + "description": "The updatable properties of the CloudVmCluster.", + "properties": { + "storageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The data disk group size to be allocated in GBs per VM.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "dataStorageSizeInTbs": { + "type": "number", + "format": "double", + "description": "The data disk group size to be allocated in TBs." + }, + "dbNodeStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The local node storage to be allocated in GBs." + }, + "memorySizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The memory to be allocated in GBs." + }, + "cpuCoreCount": { + "type": "integer", + "format": "int32", + "description": "The number of CPU cores enabled on the cloud VM cluster." + }, + "ocpuCount": { + "type": "number", + "format": "float", + "description": "The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part." + }, + "sshPublicKeys": { + "type": "array", + "description": "The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.", + "items": { + "type": "string" + } + }, + "licenseModel": { + "$ref": "#/definitions/LicenseModel", + "description": "The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED. " + }, + "dataCollectionOptions": { + "$ref": "#/definitions/DataCollectionOptions", + "description": "Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS." + }, + "displayName": { + "type": "string", + "description": "Display Name", + "minLength": 1, + "maxLength": 255 + }, + "computeNodes": { + "type": "array", + "description": "The list of compute servers to be added to the cloud VM cluster.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "x-ms-mutability": [ + "update" + ] + } + } + }, + "ComputeModel": { + "type": "string", + "description": "Compute model enum", + "enum": [ + "ECPU", + "OCPU" + ], + "x-ms-enum": { + "name": "ComputeModel", + "modelAsString": true, + "values": [ + { + "name": "ECPU", + "value": "ECPU", + "description": "ECPU model type" + }, + { + "name": "OCPU", + "value": "OCPU", + "description": "OCPU model type" + } + ] + } + }, + "ConnectionStringType": { + "type": "object", + "description": "Connection strings to connect to an Oracle Autonomous Database.", + "properties": { + "allConnectionStrings": { + "$ref": "#/definitions/AllConnectionStringType", + "description": "Returns all connection strings that can be used to connect to the Autonomous Database." + }, + "dedicated": { + "type": "string", + "description": "The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + }, + "high": { + "type": "string", + "description": "The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + }, + "low": { + "type": "string", + "description": "The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + }, + "medium": { + "type": "string", + "description": "The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + }, + "profiles": { + "type": "array", + "description": "A list of connection string profiles to allow clients to group, filter and select connection string values based on structured metadata.", + "items": { + "$ref": "#/definitions/ProfileType" + }, + "x-ms-identifiers": [] + } + } + }, + "ConnectionUrlType": { + "type": "object", + "description": "The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN.", + "properties": { + "apexUrl": { + "type": "string", + "description": "Oracle Application Express (APEX) URL.", + "minLength": 10, + "maxLength": 512 + }, + "databaseTransformsUrl": { + "type": "string", + "description": "The URL of the Database Transforms for the Autonomous Database.", + "minLength": 10, + "maxLength": 512 + }, + "graphStudioUrl": { + "type": "string", + "description": "The URL of the Graph Studio for the Autonomous Database.", + "minLength": 10, + "maxLength": 512 + }, + "machineLearningNotebookUrl": { + "type": "string", + "description": "The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database.", + "minLength": 10, + "maxLength": 512 + }, + "mongoDbUrl": { + "type": "string", + "description": "The URL of the MongoDB API for the Autonomous Database.", + "minLength": 10, + "maxLength": 512 + }, + "ordsUrl": { + "type": "string", + "description": "The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database.", + "minLength": 10, + "maxLength": 512 + }, + "sqlDevWebUrl": { + "type": "string", + "description": "Oracle SQL Developer Web URL.", + "minLength": 10, + "maxLength": 512 + } + } + }, + "ConsumerGroup": { + "type": "string", + "description": "Consumer group enum.", + "enum": [ + "High", + "Medium", + "Low", + "Tp", + "Tpurgent" + ], + "x-ms-enum": { + "name": "ConsumerGroup", + "modelAsString": true, + "values": [ + { + "name": "High", + "value": "High", + "description": "High group" + }, + { + "name": "Medium", + "value": "Medium", + "description": "Medium group" + }, + { + "name": "Low", + "value": "Low", + "description": "Low group" + }, + { + "name": "Tp", + "value": "Tp", + "description": "TP group" + }, + { + "name": "Tpurgent", + "value": "Tpurgent", + "description": "TPurgent group" + } + ] + } + }, + "CustomerContact": { + "type": "object", + "description": "CustomerContact resource properties", + "properties": { + "email": { + "type": "string", + "description": "The email address used by Oracle to send notifications regarding databases and infrastructure.", + "minLength": 1, + "maxLength": 320 + } + }, + "required": [ + "email" + ] + }, + "DataBaseType": { + "type": "string", + "description": "Database type enum", + "enum": [ + "Regular", + "Clone" + ], + "x-ms-enum": { + "name": "DataBaseType", + "modelAsString": true, + "values": [ + { + "name": "Regular", + "value": "Regular", + "description": "Regular DB" + }, + { + "name": "Clone", + "value": "Clone", + "description": "Clone DB" + } + ] + } + }, + "DataCollectionOptions": { + "type": "object", + "description": "DataCollectionOptions resource properties", + "properties": { + "isDiagnosticsEventsEnabled": { + "type": "boolean", + "description": "Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS.", + "default": false + }, + "isHealthMonitoringEnabled": { + "type": "boolean", + "description": "Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS.", + "default": false + }, + "isIncidentLogsEnabled": { + "type": "boolean", + "description": "Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS.", + "default": false + } + } + }, + "DataSafeStatusType": { + "type": "string", + "description": "DataSafe status type enum.", + "enum": [ + "Registering", + "Registered", + "Deregistering", + "NotRegistered", + "Failed" + ], + "x-ms-enum": { + "name": "DataSafeStatusType", + "modelAsString": true, + "values": [ + { + "name": "Registering", + "value": "Registering", + "description": "Registering status" + }, + { + "name": "Registered", + "value": "Registered", + "description": "Registered status" + }, + { + "name": "Deregistering", + "value": "Deregistering", + "description": "Deregistering status" + }, + { + "name": "NotRegistered", + "value": "NotRegistered", + "description": "NotRegistered status" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed status" + } + ] + } + }, + "DatabaseEditionType": { + "type": "string", + "description": "Database edition type enum.", + "enum": [ + "StandardEdition", + "EnterpriseEdition" + ], + "x-ms-enum": { + "name": "DatabaseEditionType", + "modelAsString": true, + "values": [ + { + "name": "StandardEdition", + "value": "StandardEdition", + "description": "Standard edition" + }, + { + "name": "EnterpriseEdition", + "value": "EnterpriseEdition", + "description": "Enterprise edition" + } + ] + } + }, + "DayOfWeek": { + "type": "object", + "description": "DayOfWeek resource properties", + "properties": { + "name": { + "$ref": "#/definitions/DayOfWeekName", + "description": "Name of the day of the week." + } + }, + "required": [ + "name" + ] + }, + "DayOfWeekName": { + "type": "string", + "description": "DayOfWeekName enum", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "x-ms-enum": { + "name": "DayOfWeekName", + "modelAsString": true, + "values": [ + { + "name": "Monday", + "value": "Monday", + "description": "Monday value" + }, + { + "name": "Tuesday", + "value": "Tuesday", + "description": "Tuesday value" + }, + { + "name": "Wednesday", + "value": "Wednesday", + "description": "Wednesday value" + }, + { + "name": "Thursday", + "value": "Thursday", + "description": "Thursday value" + }, + { + "name": "Friday", + "value": "Friday", + "description": "Friday value" + }, + { + "name": "Saturday", + "value": "Saturday", + "description": "Saturday value" + }, + { + "name": "Sunday", + "value": "Sunday", + "description": "Sunday value" + } + ] + } + }, + "DayOfWeekUpdate": { + "type": "object", + "description": "DayOfWeek resource properties", + "properties": { + "name": { + "$ref": "#/definitions/DayOfWeekName", + "description": "Name of the day of the week." + } + } + }, + "DbIormConfig": { + "type": "object", + "description": "DbIormConfig for cloud vm cluster", + "properties": { + "dbName": { + "type": "string", + "description": "The database name. For the default DbPlan, the dbName is default." + }, + "flashCacheLimit": { + "type": "string", + "description": "The flash cache limit for this database. This value is internally configured based on the share value assigned to the database." + }, + "share": { + "type": "integer", + "format": "int32", + "description": "The relative priority of this database.", + "minimum": 1, + "maximum": 32 + } + } + }, + "DbNode": { + "type": "object", + "description": "The DbNode resource belonging to vmCluster", + "properties": { + "properties": { + "$ref": "#/definitions/DbNodeProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DbNodeAction": { + "type": "object", + "description": "DbNode action object", + "properties": { + "action": { + "$ref": "#/definitions/DbNodeActionEnum", + "description": "Db action" + } + }, + "required": [ + "action" + ] + }, + "DbNodeActionEnum": { + "type": "string", + "description": "DbNode action enum", + "enum": [ + "Start", + "Stop", + "SoftReset", + "Reset" + ], + "x-ms-enum": { + "name": "DbNodeActionEnum", + "modelAsString": true, + "values": [ + { + "name": "Start", + "value": "Start", + "description": "Start DbNode" + }, + { + "name": "Stop", + "value": "Stop", + "description": "Stop DbNode" + }, + { + "name": "SoftReset", + "value": "SoftReset", + "description": "Soft reset DbNode" + }, + { + "name": "Reset", + "value": "Reset", + "description": "Reset DbNode" + } + ] + } + }, + "DbNodeListResult": { + "type": "object", + "description": "The response of a DbNode list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DbNode items on this page", + "items": { + "$ref": "#/definitions/DbNode" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DbNodeMaintenanceType": { + "type": "string", + "description": "The type of database node maintenance.", + "enum": [ + "VmdbRebootMigration" + ], + "x-ms-enum": { + "name": "DbNodeMaintenanceType", + "modelAsString": true, + "values": [ + { + "name": "VmdbRebootMigration", + "value": "VmdbRebootMigration", + "description": "VMDB reboot migration maintenance type" + } + ] + } + }, + "DbNodeProperties": { + "type": "object", + "description": "The properties of DbNodeResource", + "properties": { + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "DbNode OCID", + "readOnly": true + }, + "additionalDetails": { + "type": "string", + "description": "Additional information about the planned maintenance.", + "readOnly": true + }, + "backupIpId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the backup IP address associated with the database node.", + "readOnly": true + }, + "backupVnic2Id": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the second backup VNIC.", + "readOnly": true + }, + "backupVnicId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the backup VNIC.", + "readOnly": true + }, + "cpuCoreCount": { + "type": "integer", + "format": "int32", + "description": "The number of CPU cores enabled on the Db node.", + "readOnly": true + }, + "dbNodeStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The allocated local node storage in GBs on the Db node.", + "readOnly": true + }, + "dbServerId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the Exacc Db server associated with the database node.", + "readOnly": true + }, + "dbSystemId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the DB system.", + "readOnly": true + }, + "faultDomain": { + "type": "string", + "description": "The name of the Fault Domain the instance is contained in.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "hostIpId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the host IP address associated with the database node.", + "readOnly": true + }, + "hostname": { + "type": "string", + "description": "The host name for the database node.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/DbNodeProvisioningState", + "description": "The current state of the database node.", + "readOnly": true + }, + "lifecycleDetails": { + "type": "string", + "description": "Lifecycle details of Db Node.", + "readOnly": true + }, + "maintenanceType": { + "$ref": "#/definitions/DbNodeMaintenanceType", + "description": "The type of database node maintenance.", + "readOnly": true + }, + "memorySizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The allocated memory in GBs on the Db node.", + "readOnly": true + }, + "softwareStorageSizeInGb": { + "type": "integer", + "format": "int32", + "description": "The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems.", + "readOnly": true + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "The date and time that the database node was created.", + "readOnly": true + }, + "timeMaintenanceWindowEnd": { + "type": "string", + "format": "date-time", + "description": "End date and time of maintenance window.", + "readOnly": true + }, + "timeMaintenanceWindowStart": { + "type": "string", + "format": "date-time", + "description": "Start date and time of maintenance window.", + "readOnly": true + }, + "vnic2Id": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the second VNIC.", + "readOnly": true + }, + "vnicId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the VNIC.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + } + } + }, + "DbNodeProvisioningState": { + "type": "string", + "description": "DnNode provisioning state enum", + "enum": [ + "Provisioning", + "Available", + "Updating", + "Stopping", + "Stopped", + "Starting", + "Terminating", + "Terminated", + "Failed" + ], + "x-ms-enum": { + "name": "DbNodeProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Indicates that resource in Provisioning state" + }, + { + "name": "Available", + "value": "Available", + "description": "Indicates that resource in Available state" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Indicates that resource in Updating state" + }, + { + "name": "Stopping", + "value": "Stopping", + "description": "Indicates that resource in Stopping state" + }, + { + "name": "Stopped", + "value": "Stopped", + "description": "Indicates that resource in Stopped state" + }, + { + "name": "Starting", + "value": "Starting", + "description": "Indicates that resource in Starting state" + }, + { + "name": "Terminating", + "value": "Terminating", + "description": "Indicates that resource in Terminating state" + }, + { + "name": "Terminated", + "value": "Terminated", + "description": "Indicates that resource in Terminated state" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Indicates that resource in Failed state" + } + ] + } + }, + "DbServer": { + "type": "object", + "description": "DbServer resource model", + "properties": { + "properties": { + "$ref": "#/definitions/DbServerProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DbServerListResult": { + "type": "object", + "description": "The response of a DbServer list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DbServer items on this page", + "items": { + "$ref": "#/definitions/DbServer" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DbServerPatchingDetails": { + "type": "object", + "description": "DbServer Patching Properties", + "properties": { + "estimatedPatchDuration": { + "type": "integer", + "format": "int32", + "description": "Estimated Patch Duration", + "minimum": 1, + "maximum": 3000, + "readOnly": true + }, + "patchingStatus": { + "$ref": "#/definitions/DbServerPatchingStatus", + "description": "Patching Status", + "readOnly": true + }, + "timePatchingEnded": { + "type": "string", + "format": "date-time", + "description": "Time Patching Ended", + "readOnly": true + }, + "timePatchingStarted": { + "type": "string", + "format": "date-time", + "description": "Time Patching Started", + "readOnly": true + } + } + }, + "DbServerPatchingStatus": { + "type": "string", + "description": "DB Server patching status enum", + "enum": [ + "Scheduled", + "MaintenanceInProgress", + "Failed", + "Complete" + ], + "x-ms-enum": { + "name": "DbServerPatchingStatus", + "modelAsString": true, + "values": [ + { + "name": "Scheduled", + "value": "Scheduled", + "description": "Patching scheduled" + }, + { + "name": "MaintenanceInProgress", + "value": "MaintenanceInProgress", + "description": "Patching in progress" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Patching failed" + }, + { + "name": "Complete", + "value": "Complete", + "description": "Patching completed" + } + ] + } + }, + "DbServerProperties": { + "type": "object", + "description": "DbServer resource properties", + "properties": { + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "Db server name.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The name for the Db Server.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "compartmentId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the compartment.", + "readOnly": true + }, + "exadataInfrastructureId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the Exadata infrastructure.", + "readOnly": true + }, + "cpuCoreCount": { + "type": "integer", + "format": "int32", + "description": "The number of CPU cores enabled on the Db server.", + "readOnly": true + }, + "dbServerPatchingDetails": { + "$ref": "#/definitions/DbServerPatchingDetails", + "description": "dbServerPatching details of the Db server.", + "readOnly": true + }, + "maxMemoryInGbs": { + "type": "integer", + "format": "int32", + "description": "The total memory available in GBs.", + "readOnly": true + }, + "dbNodeStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The allocated local node storage in GBs on the Db server.", + "readOnly": true + }, + "vmClusterIds": { + "type": "array", + "description": "The OCID of the VM Clusters associated with the Db server.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "readOnly": true + }, + "dbNodeIds": { + "type": "array", + "description": "The OCID of the Db nodes associated with the Db server.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "readOnly": true + }, + "lifecycleDetails": { + "type": "string", + "description": "Lifecycle details of dbServer.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/DbServerProvisioningState", + "description": "DbServer provisioning state.", + "readOnly": true + }, + "maxCpuCount": { + "type": "integer", + "format": "int32", + "description": "The total number of CPU cores available.", + "readOnly": true + }, + "autonomousVmClusterIds": { + "type": "array", + "description": "The list of OCIDs of the Autonomous VM Clusters associated with the Db server.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "readOnly": true + }, + "autonomousVirtualMachineIds": { + "type": "array", + "description": "The list of OCIDs of the Autonomous Virtual Machines associated with the Db server.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "readOnly": true + }, + "maxDbNodeStorageInGbs": { + "type": "integer", + "format": "int32", + "description": "The total max dbNode storage in GBs.", + "readOnly": true + }, + "memorySizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The total memory size in GBs.", + "readOnly": true + }, + "shape": { + "type": "string", + "description": "The shape of the Db server. The shape determines the amount of CPU, storage, and memory resources available.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "The date and time that the Db Server was created.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + } + } + }, + "DbServerProvisioningState": { + "type": "string", + "description": "DbServerProvisioningState enum", + "enum": [ + "Creating", + "Available", + "Unavailable", + "Deleting", + "Deleted", + "MaintenanceInProgress" + ], + "x-ms-enum": { + "name": "DbServerProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Creating", + "value": "Creating", + "description": "Indicates that resource in Creating state" + }, + { + "name": "Available", + "value": "Available", + "description": "Indicates that resource in Available state" + }, + { + "name": "Unavailable", + "value": "Unavailable", + "description": "Indicates that resource in Unavailable state" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Indicates that resource in Deleting state" + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "Indicates that resource in Deleted state" + }, + { + "name": "MaintenanceInProgress", + "value": "MaintenanceInProgress", + "description": "Indicates that resource maintenance in progress state" + } + ] + } + }, + "DbSystemShape": { + "type": "object", + "description": "DbSystemShape resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/DbSystemShapeProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DbSystemShapeListResult": { + "type": "object", + "description": "The response of a DbSystemShape list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DbSystemShape items on this page", + "items": { + "$ref": "#/definitions/DbSystemShape" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DbSystemShapeProperties": { + "type": "object", + "description": "DbSystemShape resource model", + "properties": { + "shapeFamily": { + "type": "string", + "description": "The family of the shape used for the DB system.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "availableCoreCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of CPU cores that can be enabled on the DB system for this shape.", + "readOnly": true + }, + "minimumCoreCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of CPU cores that can be enabled on the DB system for this shape.", + "readOnly": true + }, + "runtimeMinimumCoreCount": { + "type": "integer", + "format": "int32", + "description": "The runtime minimum number of CPU cores that can be enabled on the DB system for this shape.", + "readOnly": true + }, + "coreCountIncrement": { + "type": "integer", + "format": "int32", + "description": "The discrete number by which the CPU core count for this shape can be increased or decreased.", + "readOnly": true + }, + "minStorageCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of Exadata storage servers available for the Exadata infrastructure.", + "readOnly": true + }, + "maxStorageCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of Exadata storage servers available for the Exadata infrastructure.", + "readOnly": true + }, + "availableDataStoragePerServerInTbs": { + "type": "number", + "format": "double", + "description": "The maximum data storage available per storage server for this shape. Only applicable to ExaCC Elastic shapes.", + "readOnly": true + }, + "availableMemoryPerNodeInGbs": { + "type": "integer", + "format": "int32", + "description": "The maximum memory available per database node for this shape. Only applicable to ExaCC Elastic shapes.", + "readOnly": true + }, + "availableDbNodePerNodeInGbs": { + "type": "integer", + "format": "int32", + "description": "The maximum Db Node storage available per database node for this shape. Only applicable to ExaCC Elastic shapes.", + "readOnly": true + }, + "minCoreCountPerNode": { + "type": "integer", + "format": "int32", + "description": "The minimum number of CPU cores that can be enabled per node for this shape.", + "readOnly": true + }, + "availableMemoryInGbs": { + "type": "integer", + "format": "int32", + "description": "The maximum memory that can be enabled for this shape.", + "readOnly": true + }, + "minMemoryPerNodeInGbs": { + "type": "integer", + "format": "int32", + "description": "The minimum memory that need be allocated per node for this shape.", + "readOnly": true + }, + "availableDbNodeStorageInGbs": { + "type": "integer", + "format": "int32", + "description": "The maximum Db Node storage that can be enabled for this shape.", + "readOnly": true + }, + "minDbNodeStoragePerNodeInGbs": { + "type": "integer", + "format": "int32", + "description": "The minimum Db Node storage that need be allocated per node for this shape.", + "readOnly": true + }, + "availableDataStorageInTbs": { + "type": "integer", + "format": "int32", + "description": "The maximum DATA storage that can be enabled for this shape.", + "readOnly": true + }, + "minDataStorageInTbs": { + "type": "integer", + "format": "int32", + "description": "The minimum data storage that need be allocated for this shape.", + "readOnly": true + }, + "minimumNodeCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of database nodes available for this shape.", + "readOnly": true + }, + "maximumNodeCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of database nodes available for this shape.", + "readOnly": true + }, + "availableCoreCountPerNode": { + "type": "integer", + "format": "int32", + "description": "The maximum number of CPU cores per database node that can be enabled for this shape. Only applicable to the flex Exadata shape and ExaCC Elastic shapes.", + "readOnly": true + } + } + }, + "DisasterRecoveryType": { + "type": "string", + "description": "Disaster recovery type enum.", + "enum": [ + "Adg", + "BackupBased" + ], + "x-ms-enum": { + "name": "DisasterRecoveryType", + "modelAsString": true, + "values": [ + { + "name": "Adg", + "value": "Adg", + "description": "ADG type" + }, + { + "name": "BackupBased", + "value": "BackupBased", + "description": "Backup based type" + } + ] + } + }, + "DiskRedundancy": { + "type": "string", + "description": "Disk redundancy enum", + "enum": [ + "High", + "Normal" + ], + "x-ms-enum": { + "name": "DiskRedundancy", + "modelAsString": true, + "values": [ + { + "name": "High", + "value": "High", + "description": "High redundancy" + }, + { + "name": "Normal", + "value": "Normal", + "description": "Normal redundancy" + } + ] + } + }, + "DnsPrivateView": { + "type": "object", + "description": "DnsPrivateView resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/DnsPrivateViewProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DnsPrivateViewListResult": { + "type": "object", + "description": "The response of a DnsPrivateView list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DnsPrivateView items on this page", + "items": { + "$ref": "#/definitions/DnsPrivateView" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DnsPrivateViewProperties": { + "type": "object", + "description": "Views resource model", + "properties": { + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the view", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The display name of the view resource", + "readOnly": true + }, + "isProtected": { + "type": "boolean", + "description": "A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/DnsPrivateViewsLifecycleState", + "description": "Views lifecycleState", + "readOnly": true + }, + "self": { + "type": "string", + "description": "The canonical absolute URL of the resource.", + "readOnly": true + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "views timeCreated", + "readOnly": true + }, + "timeUpdated": { + "type": "string", + "format": "date-time", + "description": "views timeCreated", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + } + } + }, + "DnsPrivateViewsLifecycleState": { + "type": "string", + "description": "DNS Private Views lifecycle state enum", + "enum": [ + "Active", + "Deleted", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "DnsPrivateViewsLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "DNS Private View is active" + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "DNS Private View is deleted" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "DNS Private View is deleting" + }, + { + "name": "Updating", + "value": "Updating", + "description": "DNS Private View is updating" + } + ] + } + }, + "DnsPrivateZone": { + "type": "object", + "description": "DnsPrivateZone resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/DnsPrivateZoneProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DnsPrivateZoneListResult": { + "type": "object", + "description": "The response of a DnsPrivateZone list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DnsPrivateZone items on this page", + "items": { + "$ref": "#/definitions/DnsPrivateZone" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DnsPrivateZoneProperties": { + "type": "object", + "description": "Zones resource model", + "properties": { + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the Zone", + "readOnly": true + }, + "isProtected": { + "type": "boolean", + "description": "A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/DnsPrivateZonesLifecycleState", + "description": "Zones lifecycleState", + "readOnly": true + }, + "self": { + "type": "string", + "description": "The canonical absolute URL of the resource.", + "readOnly": true + }, + "serial": { + "type": "integer", + "format": "int32", + "description": "The current serial of the zone. As seen in the zone's SOA record.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone's SOA record is derived.", + "readOnly": true + }, + "viewId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the private view containing the zone. This value will be null for zones in the global DNS, which are publicly resolvable and not part of a private view.", + "readOnly": true + }, + "zoneType": { + "$ref": "#/definitions/ZoneType", + "description": "The type of the zone. Must be either PRIMARY or SECONDARY. SECONDARY is only supported for GLOBAL zones.", + "readOnly": true + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "Zones timeCreated", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + } + } + }, + "DnsPrivateZonesLifecycleState": { + "type": "string", + "description": "DNS Private Zones lifecycle state enum", + "enum": [ + "Active", + "Creating", + "Deleted", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "DnsPrivateZonesLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "DNS Private Zones is active" + }, + { + "name": "Creating", + "value": "Creating", + "description": "DNS Private Zones is creating" + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "DNS Private Zones is deleted" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "DNS Private Zones is deleting" + }, + { + "name": "Updating", + "value": "Updating", + "description": "DNS Private Zones is updating" + } + ] + } + }, + "EstimatedPatchingTime": { + "type": "object", + "description": "The estimated total time required in minutes for all patching operations (database server, storage server, and network switch patching).", + "properties": { + "estimatedDbServerPatchingTime": { + "type": "integer", + "format": "int32", + "description": "The estimated time required in minutes for database server patching.", + "minimum": 1, + "maximum": 3000, + "readOnly": true + }, + "estimatedNetworkSwitchesPatchingTime": { + "type": "integer", + "format": "int32", + "description": "The estimated time required in minutes for network switch patching.", + "minimum": 1, + "maximum": 3000, + "readOnly": true + }, + "estimatedStorageServerPatchingTime": { + "type": "integer", + "format": "int32", + "description": "The estimated time required in minutes for storage server patching.", + "minimum": 1, + "maximum": 3000, + "readOnly": true + }, + "totalEstimatedPatchingTime": { + "type": "integer", + "format": "int32", + "description": "The estimated total time required in minutes for all patching operations.", + "minimum": 1, + "maximum": 3000, + "readOnly": true + } + } + }, + "ExadataIormConfig": { + "type": "object", + "description": "ExadataIormConfig for cloud vm cluster", + "properties": { + "dbPlans": { + "type": "array", + "description": "An array of IORM settings for all the database in the Exadata DB system.", + "items": { + "$ref": "#/definitions/DbIormConfig" + }, + "x-ms-identifiers": [] + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycleState." + }, + "lifecycleState": { + "$ref": "#/definitions/IormLifecycleState", + "description": "The current state of IORM configuration for the Exadata DB system." + }, + "objective": { + "$ref": "#/definitions/Objective", + "description": "The current value for the IORM objective. The default is AUTO." + } + } + }, + "GenerateAutonomousDatabaseWalletDetails": { + "type": "object", + "description": "Autonomous Database Generate Wallet resource model.", + "properties": { + "generateType": { + "$ref": "#/definitions/GenerateType", + "description": "The type of wallet to generate." + }, + "isRegional": { + "type": "boolean", + "description": "True when requesting regional connection strings in PDB connect info, applicable to cross-region DG only." + }, + "password": { + "$ref": "#/definitions/Password", + "description": "The password to encrypt the keys inside the wallet", + "minLength": 8 + } + }, + "required": [ + "password" + ] + }, + "GenerateType": { + "type": "string", + "description": "Generate type enum", + "enum": [ + "Single", + "All" + ], + "x-ms-enum": { + "name": "GenerateType", + "modelAsString": true, + "values": [ + { + "name": "Single", + "value": "Single", + "description": "Generate single" + }, + { + "name": "All", + "value": "All", + "description": "Generate all" + } + ] + } + }, + "GiVersion": { + "type": "object", + "description": "GiVersion resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/GiVersionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "GiVersionListResult": { + "type": "object", + "description": "The response of a GiVersion list operation.", + "properties": { + "value": { + "type": "array", + "description": "The GiVersion items on this page", + "items": { + "$ref": "#/definitions/GiVersion" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "GiVersionProperties": { + "type": "object", + "description": "GiVersion resource model", + "properties": { + "version": { + "type": "string", + "description": "A valid Oracle Grid Infrastructure (GI) software version.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + } + } + }, + "HostFormatType": { + "type": "string", + "description": "Host format type enum.", + "enum": [ + "Fqdn", + "Ip" + ], + "x-ms-enum": { + "name": "HostFormatType", + "modelAsString": true, + "values": [ + { + "name": "Fqdn", + "value": "Fqdn", + "description": "FQDN format" + }, + { + "name": "Ip", + "value": "Ip", + "description": "IP format" + } + ] + } + }, + "Intent": { + "type": "string", + "description": "Intent enum", + "enum": [ + "Retain", + "Reset" + ], + "x-ms-enum": { + "name": "Intent", + "modelAsString": true, + "values": [ + { + "name": "Retain", + "value": "Retain", + "description": "Retain intent" + }, + { + "name": "Reset", + "value": "Reset", + "description": "Reset intent" + } + ] + } + }, + "IormLifecycleState": { + "type": "string", + "description": "ORM lifecycle state enum", + "enum": [ + "BootStrapping", + "Enabled", + "Disabled", + "Updating", + "Failed" + ], + "x-ms-enum": { + "name": "IormLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "BootStrapping", + "value": "BootStrapping", + "description": "Indicates that resource in Provisioning state" + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "Indicates that resource in Enabled state" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Indicates that resource in Disabled state" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Indicates that resource in Updating state" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Indicates that resource in Failed state" + } + ] + } + }, + "LicenseModel": { + "type": "string", + "description": "LicenseModel enum", + "enum": [ + "LicenseIncluded", + "BringYourOwnLicense" + ], + "x-ms-enum": { + "name": "LicenseModel", + "modelAsString": true, + "values": [ + { + "name": "LicenseIncluded", + "value": "LicenseIncluded", + "description": "License included" + }, + { + "name": "BringYourOwnLicense", + "value": "BringYourOwnLicense", + "description": "Bring Your Own License" + } + ] + } + }, + "LongTermBackUpScheduleDetails": { + "type": "object", + "description": "Details for the long-term backup schedule.", + "properties": { + "repeatCadence": { + "$ref": "#/definitions/RepeatCadenceType", + "description": "The frequency of the long-term backup schedule" + }, + "timeOfBackup": { + "type": "string", + "format": "date-time", + "description": "The timestamp for the long-term backup schedule. For a MONTHLY cadence, months having fewer days than the provided date will have the backup taken on the last day of that month." + }, + "retentionPeriodInDays": { + "$ref": "#/definitions/RetentionPeriod", + "description": "Retention period, in days, for backups." + }, + "isDisabled": { + "type": "boolean", + "description": "Indicates if the long-term backup schedule should be deleted. The default value is `FALSE`." + } + } + }, + "MaintenanceWindow": { + "type": "object", + "description": "MaintenanceWindow resource properties", + "properties": { + "preference": { + "$ref": "#/definitions/Preference", + "description": "The maintenance window scheduling preference." + }, + "months": { + "type": "array", + "description": "Months during the year when maintenance should be performed.", + "items": { + "$ref": "#/definitions/Month" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "weeksOfMonth": { + "type": "array", + "description": "Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. ", + "items": { + "type": "integer", + "format": "int32" + } + }, + "daysOfWeek": { + "type": "array", + "description": "Days during the week when maintenance should be performed.", + "items": { + "$ref": "#/definitions/DayOfWeek" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "hoursOfDay": { + "type": "array", + "description": "The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC", + "items": { + "type": "integer", + "format": "int32" + } + }, + "leadTimeInWeeks": { + "type": "integer", + "format": "int32", + "description": "Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. " + }, + "patchingMode": { + "$ref": "#/definitions/PatchingMode", + "description": "Cloud Exadata infrastructure node patching method." + }, + "customActionTimeoutInMins": { + "type": "integer", + "format": "int32", + "description": "Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).", + "minimum": 0, + "maximum": 120 + }, + "isCustomActionTimeoutEnabled": { + "type": "boolean", + "description": "If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations." + }, + "isMonthlyPatchingEnabled": { + "type": "boolean", + "description": "is Monthly Patching Enabled" + } + } + }, + "Month": { + "type": "object", + "description": "Month resource properties", + "properties": { + "name": { + "$ref": "#/definitions/MonthName", + "description": "Name of the month of the year." + } + }, + "required": [ + "name" + ] + }, + "MonthName": { + "type": "string", + "description": "MonthName enum", + "enum": [ + "January", + "February", + "March", + "April", + "May", + "June", + "July", + "August", + "September", + "October", + "November", + "December" + ], + "x-ms-enum": { + "name": "MonthName", + "modelAsString": true, + "values": [ + { + "name": "January", + "value": "January", + "description": "January value" + }, + { + "name": "February", + "value": "February", + "description": "February value" + }, + { + "name": "March", + "value": "March", + "description": "March value" + }, + { + "name": "April", + "value": "April", + "description": "April value" + }, + { + "name": "May", + "value": "May", + "description": "May value" + }, + { + "name": "June", + "value": "June", + "description": "June value" + }, + { + "name": "July", + "value": "July", + "description": "July value" + }, + { + "name": "August", + "value": "August", + "description": "August value" + }, + { + "name": "September", + "value": "September", + "description": "September value" + }, + { + "name": "October", + "value": "October", + "description": "October value" + }, + { + "name": "November", + "value": "November", + "description": "November value" + }, + { + "name": "December", + "value": "December", + "description": "December value" + } + ] + } + }, + "MsRpaasNewResourceHeader": { + "type": "object", + "description": "Header to distinguish between resource creation or update" + }, + "NsgCidr": { + "type": "object", + "description": "A rule for allowing inbound (INGRESS) IP packets", + "properties": { + "source": { + "type": "string", + "description": "Conceptually, this is the range of IP addresses that a packet coming into the instance can come from.", + "minLength": 1, + "maxLength": 128 + }, + "destinationPortRange": { + "$ref": "#/definitions/PortRange", + "description": "Destination port range to specify particular destination ports for TCP rules." + } + }, + "required": [ + "source" + ] + }, + "Objective": { + "type": "string", + "description": "Objective enum", + "enum": [ + "LowLatency", + "HighThroughput", + "Balanced", + "Auto", + "Basic" + ], + "x-ms-enum": { + "name": "Objective", + "modelAsString": true, + "values": [ + { + "name": "LowLatency", + "value": "LowLatency", + "description": "Low latency objective" + }, + { + "name": "HighThroughput", + "value": "HighThroughput", + "description": "High throughput objective" + }, + { + "name": "Balanced", + "value": "Balanced", + "description": "Balanced objective" + }, + { + "name": "Auto", + "value": "Auto", + "description": "Auto objective" + }, + { + "name": "Basic", + "value": "Basic", + "description": "Basic objective" + } + ] + } + }, + "Ocid": { + "type": "string", + "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the resource.", + "minLength": 1, + "maxLength": 255 + }, + "OpenModeType": { + "type": "string", + "description": "Open mode type enum.", + "enum": [ + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "OpenModeType", + "modelAsString": true, + "values": [ + { + "name": "ReadOnly", + "value": "ReadOnly", + "description": "ReadOnly mode" + }, + { + "name": "ReadWrite", + "value": "ReadWrite", + "description": "ReadWrite mode" + } + ] + } + }, + "OperationsInsightsStatusType": { + "type": "string", + "description": "Operations Insights status type enum.", + "enum": [ + "Enabling", + "Enabled", + "Disabling", + "NotEnabled", + "FailedEnabling", + "FailedDisabling" + ], + "x-ms-enum": { + "name": "OperationsInsightsStatusType", + "modelAsString": true, + "values": [ + { + "name": "Enabling", + "value": "Enabling", + "description": "Enabling status" + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled status" + }, + { + "name": "Disabling", + "value": "Disabling", + "description": "Disabling status" + }, + { + "name": "NotEnabled", + "value": "NotEnabled", + "description": "NotEnabled status" + }, + { + "name": "FailedEnabling", + "value": "FailedEnabling", + "description": "FailedEnabling status" + }, + { + "name": "FailedDisabling", + "value": "FailedDisabling", + "description": "FailedDisabling status" + } + ] + } + }, + "OracleSubscription": { + "type": "object", + "description": "OracleSubscription resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/OracleSubscriptionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "plan": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Plan", + "description": "Details of the resource plan." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "OracleSubscriptionListResult": { + "type": "object", + "description": "The response of a OracleSubscription list operation.", + "properties": { + "value": { + "type": "array", + "description": "The OracleSubscription items on this page", + "items": { + "$ref": "#/definitions/OracleSubscription" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "OracleSubscriptionProperties": { + "type": "object", + "description": "Oracle Subscription resource model", + "properties": { + "provisioningState": { + "$ref": "#/definitions/OracleSubscriptionProvisioningState", + "description": "OracleSubscriptionProvisioningState provisioning state", + "readOnly": true + }, + "saasSubscriptionId": { + "type": "string", + "description": "SAAS subscription ID generated by Marketplace", + "readOnly": true + }, + "cloudAccountId": { + "$ref": "#/definitions/Ocid", + "description": "Cloud Account Id", + "readOnly": true + }, + "cloudAccountState": { + "$ref": "#/definitions/CloudAccountProvisioningState", + "description": "Cloud Account provisioning state.", + "readOnly": true + }, + "termUnit": { + "type": "string", + "description": "Term Unit. P1Y, P3Y, etc, see Durations https://en.wikipedia.org/wiki/ISO_8601", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "productCode": { + "type": "string", + "description": "Product code for the term unit", + "x-ms-mutability": [ + "update" + ] + }, + "intent": { + "$ref": "#/definitions/Intent", + "description": "Intent for the update operation", + "x-ms-mutability": [ + "update" + ] + }, + "azureSubscriptionIds": { + "type": "array", + "description": "Azure subscriptions associated with this OracleSubscription", + "items": { + "type": "string" + }, + "readOnly": true + }, + "addSubscriptionOperationState": { + "$ref": "#/definitions/AddSubscriptionOperationState", + "description": "State of the add Azure subscription operation on Oracle subscription", + "readOnly": true + }, + "lastOperationStatusDetail": { + "type": "string", + "description": "Status details of the last operation on Oracle subscription", + "readOnly": true + } + } + }, + "OracleSubscriptionProvisioningState": { + "type": "string", + "description": "OracleSubscriptionProvisioningState enum", + "enum": [ + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "OracleSubscriptionProvisioningState", + "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." + } + ] + }, + "readOnly": true + }, + "OracleSubscriptionUpdate": { + "type": "object", + "description": "The type used for update operations of the OracleSubscription.", + "properties": { + "plan": { + "$ref": "#/definitions/PlanUpdate", + "description": "Details of the resource plan." + }, + "properties": { + "$ref": "#/definitions/OracleSubscriptionUpdateProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + } + }, + "OracleSubscriptionUpdateProperties": { + "type": "object", + "description": "The updatable properties of the OracleSubscription.", + "properties": { + "productCode": { + "type": "string", + "description": "Product code for the term unit", + "x-ms-mutability": [ + "update" + ] + }, + "intent": { + "$ref": "#/definitions/Intent", + "description": "Intent for the update operation", + "x-ms-mutability": [ + "update" + ] + } + } + }, + "Password": { + "type": "string", + "format": "password", + "description": "Password string.", + "x-ms-secret": true + }, + "PatchingMode": { + "type": "string", + "description": "Patching mode enum", + "enum": [ + "Rolling", + "NonRolling" + ], + "x-ms-enum": { + "name": "PatchingMode", + "modelAsString": true, + "values": [ + { + "name": "Rolling", + "value": "Rolling", + "description": "Rolling patching" + }, + { + "name": "NonRolling", + "value": "NonRolling", + "description": "Non Rolling patching" + } + ] + } + }, + "PeerDbDetails": { + "type": "object", + "description": "PeerDb Details", + "properties": { + "peerDbId": { + "type": "string", + "description": "The database OCID of the Disaster Recovery peer database, which is located in a different region from the current peer database.", + "minLength": 1, + "maxLength": 255 + } + } + }, + "PermissionLevelType": { + "type": "string", + "description": "Permission level type enum.", + "enum": [ + "Restricted", + "Unrestricted" + ], + "x-ms-enum": { + "name": "PermissionLevelType", + "modelAsString": true, + "values": [ + { + "name": "Restricted", + "value": "Restricted", + "description": "Restricted permission level" + }, + { + "name": "Unrestricted", + "value": "Unrestricted", + "description": "Unrestricted permission level" + } + ] + } + }, + "PlanUpdate": { + "type": "object", + "description": "ResourcePlanTypeUpdate model definition", + "properties": { + "name": { + "type": "string", + "description": "A user defined name of the 3rd Party Artifact that is being procured." + }, + "publisher": { + "type": "string", + "description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic" + }, + "product": { + "type": "string", + "description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. " + }, + "promotionCode": { + "type": "string", + "description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact." + }, + "version": { + "type": "string", + "description": "The version of the desired product/artifact." + } + } + }, + "PortRange": { + "type": "object", + "description": "Port Range to specify particular destination ports for TCP rules.", + "properties": { + "min": { + "type": "integer", + "format": "int32", + "description": "The minimum port number, which must not be greater than the maximum port number.", + "minimum": 1, + "maximum": 65535 + }, + "max": { + "type": "integer", + "format": "int32", + "description": "The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.", + "minimum": 1, + "maximum": 65535 + } + }, + "required": [ + "min", + "max" + ] + }, + "Preference": { + "type": "string", + "description": "Preference enum", + "enum": [ + "NoPreference", + "CustomPreference" + ], + "x-ms-enum": { + "name": "Preference", + "modelAsString": true, + "values": [ + { + "name": "NoPreference", + "value": "NoPreference", + "description": "No preference" + }, + { + "name": "CustomPreference", + "value": "CustomPreference", + "description": "Custom preference" + } + ] + } + }, + "PrivateIpAddressProperties": { + "type": "object", + "description": "PrivateIpAddress resource properties", + "properties": { + "displayName": { + "type": "string", + "description": "PrivateIpAddresses displayName" + }, + "hostnameLabel": { + "type": "string", + "description": "PrivateIpAddresses hostnameLabel" + }, + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "PrivateIpAddresses Id" + }, + "ipAddress": { + "type": "string", + "description": "PrivateIpAddresses ipAddress" + }, + "subnetId": { + "$ref": "#/definitions/Ocid", + "description": "PrivateIpAddresses subnetId" + } + }, + "required": [ + "displayName", + "hostnameLabel", + "ocid", + "ipAddress", + "subnetId" + ] + }, + "PrivateIpAddressesFilter": { + "type": "object", + "description": "Private Ip Addresses filter", + "properties": { + "subnetId": { + "$ref": "#/definitions/Ocid", + "description": "Subnet OCID" + }, + "vnicId": { + "$ref": "#/definitions/Ocid", + "description": "VCN OCID" + } + }, + "required": [ + "subnetId", + "vnicId" + ] + }, + "ProfileType": { + "type": "object", + "description": "The connection string profile to allow clients to group, filter and select connection string values based on structured metadata.", + "properties": { + "consumerGroup": { + "$ref": "#/definitions/ConsumerGroup", + "description": "Consumer group used by the connection." + }, + "displayName": { + "type": "string", + "description": "A user-friendly name for the connection.", + "minLength": 1, + "maxLength": 255 + }, + "hostFormat": { + "$ref": "#/definitions/HostFormatType", + "description": "Host format used in connection string." + }, + "isRegional": { + "type": "boolean", + "description": "True for a regional connection string, applicable to cross-region DG only." + }, + "protocol": { + "$ref": "#/definitions/ProtocolType", + "description": "Protocol used by the connection." + }, + "sessionMode": { + "$ref": "#/definitions/SessionModeType", + "description": "Specifies whether the listener performs a direct hand-off of the session, or redirects the session." + }, + "syntaxFormat": { + "$ref": "#/definitions/SyntaxFormatType", + "description": "Specifies whether the connection string is using the long (LONG), Easy Connect (EZCONNECT), or Easy Connect Plus (EZCONNECTPLUS) format." + }, + "tlsAuthentication": { + "$ref": "#/definitions/TlsAuthenticationType", + "description": "Specifies whether the TLS handshake is using one-way (SERVER) or mutual (MUTUAL) authentication." + }, + "value": { + "type": "string", + "description": "Connection string value." + } + }, + "required": [ + "displayName", + "hostFormat", + "protocol", + "sessionMode", + "syntaxFormat", + "value" + ] + }, + "ProtocolType": { + "type": "string", + "description": "Protocol type enum.", + "enum": [ + "TCP", + "TCPS" + ], + "x-ms-enum": { + "name": "ProtocolType", + "modelAsString": true, + "values": [ + { + "name": "TCP", + "value": "TCP", + "description": "TCP protocol" + }, + { + "name": "TCPS", + "value": "TCPS", + "description": "TCPS protocol" + } + ] + } + }, + "RefreshableModelType": { + "type": "string", + "description": "Refreshable model type enum", + "enum": [ + "Automatic", + "Manual" + ], + "x-ms-enum": { + "name": "RefreshableModelType", + "modelAsString": true, + "values": [ + { + "name": "Automatic", + "value": "Automatic", + "description": "Automatic refreshable model type" + }, + { + "name": "Manual", + "value": "Manual", + "description": "Manual refreshable model type" + } + ] + } + }, + "RefreshableStatusType": { + "type": "string", + "description": "Refreshable status type enum.", + "enum": [ + "Refreshing", + "NotRefreshing" + ], + "x-ms-enum": { + "name": "RefreshableStatusType", + "modelAsString": true, + "values": [ + { + "name": "Refreshing", + "value": "Refreshing", + "description": "Refreshing status" + }, + { + "name": "NotRefreshing", + "value": "NotRefreshing", + "description": "NotRefreshing status" + } + ] + } + }, + "RepeatCadenceType": { + "type": "string", + "description": "Repeat cadence type enum", + "enum": [ + "OneTime", + "Weekly", + "Monthly", + "Yearly" + ], + "x-ms-enum": { + "name": "RepeatCadenceType", + "modelAsString": true, + "values": [ + { + "name": "OneTime", + "value": "OneTime", + "description": "Repeat one time" + }, + { + "name": "Weekly", + "value": "Weekly", + "description": "Repeat weekly" + }, + { + "name": "Monthly", + "value": "Monthly", + "description": "Repeat monthly" + }, + { + "name": "Yearly", + "value": "Yearly", + "description": "Repeat yearly" + } + ] + } + }, + "RestoreAutonomousDatabaseDetails": { + "type": "object", + "description": "Details to restore an Oracle Autonomous Database.", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The time to restore the database to." + } + }, + "required": [ + "timestamp" + ] + }, + "RetentionPeriod": { + "type": "integer", + "format": "int32", + "description": "Retention period, in days, for backups.", + "minimum": 90, + "maximum": 2558 + }, + "RoleType": { + "type": "string", + "description": "Role type enum.", + "enum": [ + "Primary", + "Standby", + "DisabledStandby", + "BackupCopy", + "SnapshotStandby" + ], + "x-ms-enum": { + "name": "RoleType", + "modelAsString": true, + "values": [ + { + "name": "Primary", + "value": "Primary", + "description": "Primary role" + }, + { + "name": "Standby", + "value": "Standby", + "description": "Standby role" + }, + { + "name": "DisabledStandby", + "value": "DisabledStandby", + "description": "DisabledStandby role" + }, + { + "name": "BackupCopy", + "value": "BackupCopy", + "description": "BackupCopy role" + }, + { + "name": "SnapshotStandby", + "value": "SnapshotStandby", + "description": "SnapshotStandby role" + } + ] + } + }, + "SaasSubscriptionDetails": { + "type": "object", + "description": "SaaS Subscription Details model", + "properties": { + "id": { + "type": "string", + "description": "Purchased SaaS subscription ID", + "readOnly": true + }, + "subscriptionName": { + "type": "string", + "description": "SaaS subscription name", + "readOnly": true + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "Creation Date and Time", + "readOnly": true + }, + "offerId": { + "type": "string", + "description": "Purchased offer ID", + "readOnly": true + }, + "planId": { + "type": "string", + "description": "Purchased offer's plan ID", + "readOnly": true + }, + "saasSubscriptionStatus": { + "type": "string", + "description": "Indicates the status of the Subscription.", + "readOnly": true + }, + "publisherId": { + "type": "string", + "description": "Publisher ID", + "readOnly": true + }, + "purchaserEmailId": { + "type": "string", + "description": "Purchaser Email ID", + "readOnly": true + }, + "purchaserTenantId": { + "type": "string", + "description": "Purchaser Tenant ID", + "readOnly": true + }, + "termUnit": { + "type": "string", + "description": "Purchase Term Unit", + "readOnly": true + }, + "isAutoRenew": { + "type": "boolean", + "description": "AutoRenew flag", + "readOnly": true + }, + "isFreeTrial": { + "type": "boolean", + "description": "FreeTrial flag", + "readOnly": true + } + } + }, + "ScheduledOperationsType": { + "type": "object", + "description": "The list of scheduled operations.", + "properties": { + "dayOfWeek": { + "$ref": "#/definitions/DayOfWeek", + "description": "Day of week" + }, + "scheduledStartTime": { + "type": "string", + "description": "auto start time. value must be of ISO-8601 format HH:mm", + "minLength": 1, + "maxLength": 50 + }, + "scheduledStopTime": { + "type": "string", + "description": "auto stop time. value must be of ISO-8601 format HH:mm", + "minLength": 1, + "maxLength": 50 + } + }, + "required": [ + "dayOfWeek" + ] + }, + "ScheduledOperationsTypeUpdate": { + "type": "object", + "description": "The list of scheduled operations.", + "properties": { + "dayOfWeek": { + "$ref": "#/definitions/DayOfWeekUpdate", + "description": "Day of week" + }, + "scheduledStartTime": { + "type": "string", + "description": "auto start time. value must be of ISO-8601 format HH:mm", + "minLength": 1, + "maxLength": 50 + }, + "scheduledStopTime": { + "type": "string", + "description": "auto stop time. value must be of ISO-8601 format HH:mm", + "minLength": 1, + "maxLength": 50 + } + } + }, + "SessionModeType": { + "type": "string", + "description": "Session mode type enum.", + "enum": [ + "Direct", + "Redirect" + ], + "x-ms-enum": { + "name": "SessionModeType", + "modelAsString": true, + "values": [ + { + "name": "Direct", + "value": "Direct", + "description": "Direct session mode" + }, + { + "name": "Redirect", + "value": "Redirect", + "description": "Redirect session mode" + } + ] + } + }, + "SourceType": { + "type": "string", + "description": "Source type enum.", + "enum": [ + "None", + "Database", + "BackupFromId", + "BackupFromTimestamp", + "CloneToRefreshable", + "CrossRegionDataguard", + "CrossRegionDisasterRecovery" + ], + "x-ms-enum": { + "name": "SourceType", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "None source" + }, + { + "name": "Database", + "value": "Database", + "description": "Database source" + }, + { + "name": "BackupFromId", + "value": "BackupFromId", + "description": "Backup from ID source" + }, + { + "name": "BackupFromTimestamp", + "value": "BackupFromTimestamp", + "description": "Backup from timestamp source" + }, + { + "name": "CloneToRefreshable", + "value": "CloneToRefreshable", + "description": "Clone to refreshable source" + }, + { + "name": "CrossRegionDataguard", + "value": "CrossRegionDataguard", + "description": "Cross region dataguard source" + }, + { + "name": "CrossRegionDisasterRecovery", + "value": "CrossRegionDisasterRecovery", + "description": "cross region disaster recovery source" + } + ] + } + }, + "SubnetId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + } + }, + "SyntaxFormatType": { + "type": "string", + "description": "Syntax format type enum.", + "enum": [ + "Long", + "Ezconnect", + "Ezconnectplus" + ], + "x-ms-enum": { + "name": "SyntaxFormatType", + "modelAsString": true, + "values": [ + { + "name": "Long", + "value": "Long", + "description": "Long format" + }, + { + "name": "Ezconnect", + "value": "Ezconnect", + "description": "Ezconnect format" + }, + { + "name": "Ezconnectplus", + "value": "Ezconnectplus", + "description": "Ezconnectplus format" + } + ] + } + }, + "SystemVersion": { + "type": "object", + "description": "SystemVersion resource Definition", + "properties": { + "properties": { + "$ref": "#/definitions/SystemVersionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "SystemVersionListResult": { + "type": "object", + "description": "The response of a SystemVersion list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SystemVersion items on this page", + "items": { + "$ref": "#/definitions/SystemVersion" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SystemVersionProperties": { + "type": "object", + "description": "System Version Resource model", + "properties": { + "systemVersion": { + "type": "string", + "description": "A valid Oracle System Version", + "readOnly": true + } + } + }, + "SystemVersionsFilter": { + "type": "object", + "description": "SystemVersions filter", + "properties": { + "giVersion": { + "type": "string", + "description": "Grid Infrastructure version" + }, + "shape": { + "type": "string", + "description": "Exadata shape" + }, + "isLatestVersion": { + "type": "boolean", + "description": "Check If we have to list only latest versions" + } + }, + "required": [ + "giVersion", + "shape" + ] + }, + "TlsAuthenticationType": { + "type": "string", + "description": "TLS authentication type enum.", + "enum": [ + "Server", + "Mutual" + ], + "x-ms-enum": { + "name": "TlsAuthenticationType", + "modelAsString": true, + "values": [ + { + "name": "Server", + "value": "Server", + "description": "Server authentication" + }, + { + "name": "Mutual", + "value": "Mutual", + "description": "Mutual TLS" + } + ] + } + }, + "UpdateAction": { + "type": "string", + "description": "Update action enum", + "enum": [ + "RollingApply", + "NonRollingApply", + "PreCheck", + "RollBack" + ], + "x-ms-enum": { + "name": "UpdateAction", + "modelAsString": true, + "values": [ + { + "name": "RollingApply", + "value": "RollingApply", + "description": "Rolling apply action" + }, + { + "name": "NonRollingApply", + "value": "NonRollingApply", + "description": "Non rolling apply action" + }, + { + "name": "PreCheck", + "value": "PreCheck", + "description": "Pre-check action" + }, + { + "name": "RollBack", + "value": "RollBack", + "description": "Rollback action" + } + ] + } + }, + "ValidationError": { + "type": "object", + "description": "validation error", + "properties": { + "code": { + "type": "string", + "description": "error code" + }, + "message": { + "type": "string", + "description": "error message" + } + }, + "required": [ + "code", + "message" + ] + }, + "ValidationResult": { + "type": "object", + "description": "validation result", + "properties": { + "status": { + "$ref": "#/definitions/ValidationStatus", + "description": "validation status" + }, + "error": { + "$ref": "#/definitions/ValidationError", + "description": "validation error" + } + }, + "required": [ + "status", + "error" + ] + }, + "ValidationStatus": { + "type": "string", + "description": "validation status", + "enum": [ + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "ValidationStatus", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Validation succeeded" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Validation failed" + } + ] + }, + "readOnly": true + }, + "VirtualNetworkAddress": { + "type": "object", + "description": "Virtual IP resource belonging to a vm cluster resource.", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualNetworkAddressProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "VirtualNetworkAddressLifecycleState": { + "type": "string", + "description": "VirtualNetworkAddressLifecycleState enum", + "enum": [ + "Provisioning", + "Available", + "Terminating", + "Terminated", + "Failed" + ], + "x-ms-enum": { + "name": "VirtualNetworkAddressLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Indicates that resource in Provisioning state" + }, + { + "name": "Available", + "value": "Available", + "description": "Indicates that resource in Available state" + }, + { + "name": "Terminating", + "value": "Terminating", + "description": "Indicates that resource in Terminating state" + }, + { + "name": "Terminated", + "value": "Terminated", + "description": "Indicates that resource in Terminated state" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Indicates that resource in Failed state" + } + ] + } + }, + "VirtualNetworkAddressListResult": { + "type": "object", + "description": "The response of a VirtualNetworkAddress list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VirtualNetworkAddress items on this page", + "items": { + "$ref": "#/definitions/VirtualNetworkAddress" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VirtualNetworkAddressProperties": { + "type": "object", + "description": "virtualNetworkAddress resource properties", + "properties": { + "ipAddress": { + "type": "string", + "description": "Virtual network Address address.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "vmOcid": { + "$ref": "#/definitions/Ocid", + "description": "Virtual Machine OCID.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "Application VIP OCID.", + "readOnly": true + }, + "domain": { + "type": "string", + "description": "Virtual network address fully qualified domain name.", + "readOnly": true + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycle state of the application virtual IP (VIP) address.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/AzureResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/VirtualNetworkAddressLifecycleState", + "description": "virtual network address lifecycle state.", + "readOnly": true + }, + "timeAssigned": { + "type": "string", + "format": "date-time", + "description": "The date and time when the create operation for the application virtual IP (VIP) address completed.", + "readOnly": true + } + } + }, + "VnetId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks" + } + ] + } + }, + "WorkloadType": { + "type": "string", + "description": "WorkloadType enum", + "enum": [ + "OLTP", + "DW", + "AJD", + "APEX" + ], + "x-ms-enum": { + "name": "WorkloadType", + "modelAsString": true, + "values": [ + { + "name": "OLTP", + "value": "OLTP", + "description": "OLTP - indicates an Autonomous Transaction Processing database" + }, + { + "name": "DW", + "value": "DW", + "description": "DW - indicates an Autonomous Data Warehouse database" + }, + { + "name": "AJD", + "value": "AJD", + "description": "AJD - indicates an Autonomous JSON Database" + }, + { + "name": "APEX", + "value": "APEX", + "description": "APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type." + } + ] + } + }, + "ZoneType": { + "type": "string", + "description": "Zone type enum", + "enum": [ + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "ZoneType", + "modelAsString": true, + "values": [ + { + "name": "Primary", + "value": "Primary", + "description": "Primary zone" + }, + { + "name": "Secondary", + "value": "Secondary", + "description": "Secondary zone" + } + ] + } + }, + "aclString": { + "type": "string", + "description": "The client IP access control list (ACL). This is an array of CIDR notations and/or IP addresses. Values should be separate strings, separated by commas. Example: ['1.1.1.1','1.1.1.0/24','1.1.2.25']", + "minLength": 1, + "maxLength": 1024 + } + }, + "parameters": {} +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/openapi.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/openapi.json index 1dcb369c3183..6915309bf4bb 100644 --- a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/openapi.json +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/openapi.json @@ -4120,6 +4120,7 @@ "properties": { "properties": { "$ref": "#/definitions/AutonomousDatabaseBackupUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } @@ -5098,6 +5099,7 @@ }, "properties": { "$ref": "#/definitions/AutonomousDatabaseUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } @@ -5928,6 +5930,7 @@ }, "properties": { "$ref": "#/definitions/CloudExadataInfrastructureUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } @@ -6452,6 +6455,7 @@ }, "properties": { "$ref": "#/definitions/CloudVmClusterUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } @@ -8695,6 +8699,7 @@ }, "properties": { "$ref": "#/definitions/OracleSubscriptionUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_create.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_create.json new file mode 100644 index 000000000000..9ebce87139c0 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_create.json @@ -0,0 +1,71 @@ +{ + "operationId": "AutonomousDatabaseBackups_CreateOrUpdate", + "title": "AutonomousDatabaseBackups_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130", + "resource": { + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "displayName": "Nightly Backup", + "retentionPeriodInDays": 365 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "headers": { + "Retry-After": 100 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/backupdb1", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_delete.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_delete.json new file mode 100644 index 000000000000..14b89f7ae2b5 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_delete.json @@ -0,0 +1,20 @@ +{ + "operationId": "AutonomousDatabaseBackups_Delete", + "title": "AutonomousDatabaseBackups_Delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_get.json new file mode 100644 index 000000000000..18f1545476f1 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_get.json @@ -0,0 +1,37 @@ +{ + "operationId": "AutonomousDatabaseBackups_Get", + "title": "AutonomousDatabaseBackups_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeStarted": "2024-01-09T19:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_listByParent.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_listByParent.json new file mode 100644 index 000000000000..a29bb766f51b --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_listByParent.json @@ -0,0 +1,40 @@ +{ + "operationId": "AutonomousDatabaseBackups_ListByAutonomousDatabase", + "title": "AutonomousDatabaseBackups_ListByAutonomousDatabase", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup completed successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 365, + "sizeInTbs": 2, + "timeAvailableTil": "2025-01-09T20:44:09.466Z", + "timeEnded": "2024-01-09T20:44:09.466Z", + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_patch.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_patch.json new file mode 100644 index 000000000000..bbad833f86a4 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseBackup_patch.json @@ -0,0 +1,41 @@ +{ + "operationId": "AutonomousDatabaseBackups_Update", + "title": "AutonomousDatabaseBackups_Update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "adbbackupid": "1711644130", + "properties": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1/autonomousDatabaseBackups/1711644130", + "type": "Oracle.Database/autonomousDatabases/autonomousDatabaseBackups", + "properties": { + "autonomousDatabaseOcid": "ocid1.autonomousdatabase.oc1..aaaaa3klq", + "databaseSizeInTbs": 2, + "dbVersion": "19.6.0.0", + "displayName": "Nightly Backup", + "ocid": "ocid1.autonomousdatabasebackup.oc1..aaaaaaaavwpj", + "isAutomatic": true, + "isRestorable": true, + "lifecycleDetails": "Backup updated successfully", + "lifecycleState": "Active", + "retentionPeriodInDays": 400, + "sizeInTbs": 2, + "backupType": "Full", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseCharacterSet_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseCharacterSet_get.json new file mode 100644 index 000000000000..523f1ff24bed --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseCharacterSet_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseCharacterSets_get", + "title": "AutonomousDatabaseCharacterSets_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "adbscharsetname": "DATABASE" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "AL32UTF8" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseCharacterSet_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseCharacterSet_listByLocation.json new file mode 100644 index 000000000000..a76071985fef --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseCharacterSet_listByLocation.json @@ -0,0 +1,32 @@ +{ + "operationId": "AutonomousDatabaseCharacterSets_listByLocation", + "title": "AutonomousDatabaseCharacterSets_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "AL32UTF8" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseCharacterSets/DATABASE", + "type": "Oracle.Database/locations/autonomousDatabaseCharacterSets", + "properties": { + "characterSet": "UTF8" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseClone_create.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseClone_create.json new file mode 100644 index 000000000000..9d2b4af6f591 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseClone_create.json @@ -0,0 +1,141 @@ +{ + "operationId": "AutonomousDatabases_CreateOrUpdate", + "title": "AutonomousDatabases_CreateOrUpdate_clone", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "resource": { + "properties": { + "dataBaseType": "Clone", + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "cloneType": "Full", + "displayName": "example_autonomous_databasedb1_clone", + "computeModel": "ECPU", + "computeCount": 2, + "dataStorageSizeInTbs": 1, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "adminPassword": "********", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1Clone", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "cloneType": "Full", + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Clone", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1Clone", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "cloneType": "Full", + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Clone", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseNationalCharacterSet_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseNationalCharacterSet_get.json new file mode 100644 index 000000000000..37dafabacdd5 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseNationalCharacterSet_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseNationalCharacterSets_get", + "title": "AutonomousDatabaseNationalCharacterSets_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "adbsncharsetname": "NATIONAL" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseNationalCharacterSets/NATIONAL", + "type": "Oracle.Database/locations/autonomousDatabaseNationalCharacterSets", + "properties": { + "characterSet": "AL16UTF16" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseNationalCharacterSet_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseNationalCharacterSet_listByLocation.json new file mode 100644 index 000000000000..c0b0c4f7a0aa --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseNationalCharacterSet_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabaseNationalCharacterSets_listByLocation", + "title": "AutonomousDatabaseNationalCharacterSets_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDatabaseNationalCharacterSets/NATIONAL", + "type": "Oracle.Database/locations/autonomousDatabaseNationalCharacterSets", + "properties": { + "characterSet": "AL16UTF16" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseVersion_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseVersion_get.json new file mode 100644 index 000000000000..47fa4b9d66d6 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseVersion_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "AutonomousDatabaseVersions_get", + "title": "AutonomousDatabaseVersions_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "autonomousdbversionsname": "18.4.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDbVersions/18.4.0.0", + "type": "Oracle.Database/locations/autonomousDbVersions", + "properties": { + "version": "18.4.0.0" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseVersion_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseVersion_listByLocation.json new file mode 100644 index 000000000000..9a726ca84fb9 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabaseVersion_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabaseVersions_listByLocation", + "title": "AutonomousDatabaseVersions_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/locations/eastus/autonomousDbVersions/18.4.0.0", + "type": "Oracle.Database/locations/autonomousDbVersions", + "properties": { + "version": "18.4.0.0" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_create.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_create.json new file mode 100644 index 000000000000..f6fea70651ba --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_create.json @@ -0,0 +1,136 @@ +{ + "operationId": "AutonomousDatabases_CreateOrUpdate", + "title": "AutonomousDatabases_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "resource": { + "properties": { + "dataBaseType": "Regular", + "displayName": "example_autonomous_databasedb1", + "computeModel": "ECPU", + "computeCount": 2, + "dataStorageSizeInTbs": 1, + "adminPassword": "********", + "dbVersion": "18.4.0.0", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_delete.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_delete.json new file mode 100644 index 000000000000..6b708c825459 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "AutonomousDatabases_delete", + "title": "AutonomousDatabases_delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_failover.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_failover.json new file mode 100644 index 000000000000..61a9ed318856 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_failover.json @@ -0,0 +1,90 @@ +{ + "operationId": "AutonomousDatabases_Failover", + "title": "AutonomousDatabases_Failover", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "peerDbId": "peerDbId" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "failedDataRecoveryInSeconds": null, + "isLocalDataGuardEnabled": true, + "timeLocalDataGuardEnabled": "2024-02-28T19:03:43.714Z", + "localDisasterRecoveryType": "Adg", + "localAdgAutoFailoverMaxDataLossLimit": 300, + "role": "Primary", + "peerDbIds": null, + "localStandbyDb": { + "lagTimeInSeconds": null, + "lifecycleDetails": null, + "lifecycleState": "RoleChangeInProgress", + "timeDataGuardRoleChanged": null, + "timeDisasterRecoveryRoleChanged": null + }, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Updating", + "lifecycleDetails": null, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Provisioning", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeOfLastFailover": null, + "timeOfLastSwitchover": null, + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_generateWallet.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_generateWallet.json new file mode 100644 index 000000000000..f7d99778b93d --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_generateWallet.json @@ -0,0 +1,25 @@ +{ + "operationId": "AutonomousDatabases_generateWallet", + "title": "AutonomousDatabases_generateWallet", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "generateType": "Single", + "isRegional": false, + "password": "********" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "walletFiles": "testEncodedFiles" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_get.json new file mode 100644 index 000000000000..70f7a939e68f --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_get.json @@ -0,0 +1,63 @@ +{ + "operationId": "AutonomousDatabases_Get", + "title": "AutonomousDatabases_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_listByResourceGroup.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_listByResourceGroup.json new file mode 100644 index 000000000000..3e3e79afdef9 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_listByResourceGroup.json @@ -0,0 +1,67 @@ +{ + "operationId": "AutonomousDatabases_listByResourceGroup", + "title": "AutonomousDatabases_listByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_listBySubscription.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_listBySubscription.json new file mode 100644 index 000000000000..fc9fc22c896c --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_listBySubscription.json @@ -0,0 +1,66 @@ +{ + "operationId": "AutonomousDatabases_listBySubscription", + "title": "AutonomousDatabases_listBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_patch.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_patch.json new file mode 100644 index 000000000000..c87c05211523 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_patch.json @@ -0,0 +1,73 @@ +{ + "operationId": "AutonomousDatabases_update", + "title": "AutonomousDatabases_update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Succeeded", + "lifecycleDetails": "success", + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_restore.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_restore.json new file mode 100644 index 000000000000..e1ad46f498f2 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_restore.json @@ -0,0 +1,80 @@ +{ + "operationId": "AutonomousDatabases_Restore", + "title": "AutonomousDatabases_Restore", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "timestamp": "2024-04-23T00:00:00.000Z" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "backupRetentionPeriodInDays": 60, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "RestoreInProgress", + "lifecycleDetails": "", + "nextLongTermBackupTimeStamp": "2024-04-24T21:03:41.000Z", + "longTermBackupSchedule": { + "isDisabled": null, + "repeatCadence": "Weekly", + "retentionPeriodInDays": 365, + "timeOfBackup": "2024-04-21T21:03:41.309Z" + }, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabaseBackups/1711644130/operationStatus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_shrink.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_shrink.json new file mode 100644 index 000000000000..0d4514db9cc7 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_shrink.json @@ -0,0 +1,77 @@ +{ + "operationId": "AutonomousDatabase_shrink", + "title": "AutonomousDatabase_shrink", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "backupRetentionPeriodInDays": 90, + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "isLocalDataGuardEnabled": false, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "ScaleInProgress", + "lifecycleDetails": "", + "nextLongTermBackupTimeStamp": "2024-04-24T21:03:41.000Z", + "longTermBackupSchedule": { + "isDisabled": null, + "repeatCadence": "Weekly", + "retentionPeriodInDays": 365, + "timeOfBackup": "2024-04-21T21:03:41.309Z" + }, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 100, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_switchover.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_switchover.json new file mode 100644 index 000000000000..24a17baf196a --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/autonomousDatabase_switchover.json @@ -0,0 +1,89 @@ +{ + "operationId": "AutonomousDatabases_Switchover", + "title": "AutonomousDatabases_Switchover", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "autonomousdatabasename": "databasedb1", + "body": { + "peerDbId": "peerDbId" + }, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "type": "Oracle.Database/autonomousDatabases", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "autonomousDatabaseId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/autonomousDatabases/databasedb1", + "actualUsedDataStorageSizeInTbs": null, + "autonomousMaintenanceScheduleType": "Regular", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "computeCount": 2.0, + "computeModel": "ECPU", + "cpuCoreCount": 1, + "customerContacts": null, + "dataStorageSizeInGbs": 1024, + "dataStorageSizeInTbs": 1, + "databaseEdition": "EnterpriseEdition", + "dataBaseType": "Regular", + "dbVersion": "18.4.0.0", + "displayName": "example_autonomous_databasedb1", + "isAutoScalingEnabled": false, + "isAutoScalingForStorageEnabled": false, + "failedDataRecoveryInSeconds": null, + "isLocalDataGuardEnabled": false, + "localDisasterRecoveryType": "BackupBased", + "localAdgAutoFailoverMaxDataLossLimit": null, + "role": "Primary", + "peerDbIds": null, + "localStandbyDb": { + "lagTimeInSeconds": null, + "lifecycleDetails": null, + "lifecycleState": "RoleChangeInProgress", + "timeDataGuardRoleChanged": null, + "timeDisasterRecoveryRoleChanged": null + }, + "isMtlsConnectionRequired": true, + "licenseModel": "BringYourOwnLicense", + "lifecycleState": "Updating", + "lifecycleDetails": null, + "privateEndpointIp": null, + "privateEndpointLabel": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "provisioningState": "Provisioning", + "ociUrl": "https://fake", + "timeCreated": "2024-01-09T20:44:09.466Z", + "timeOfLastFailover": null, + "timeOfLastSwitchover": "2024-02-27T18:37:08.069Z", + "timeMaintenanceBegin": null, + "timeMaintenanceEnd": null, + "usedDataStorageSizeInGbs": null, + "usedDataStorageSizeInTbs": null, + "ocid": "ocid1..aaaaa", + "whitelistedIps": [ + "1.1.1.1", + "1.1.1.0/24", + "1.1.2.25" + ] + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbNodes_action.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbNodes_action.json new file mode 100644 index 000000000000..8759060a9153 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbNodes_action.json @@ -0,0 +1,50 @@ +{ + "operationId": "DbNodes_Action", + "title": "DbNodes_Action", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "dbnodeocid": "ocid1....aaaaaa", + "body": { + "action": "Start" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "provisioningState": "Succeeded", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbNodes_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbNodes_get.json new file mode 100644 index 000000000000..f1c05c614172 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbNodes_get.json @@ -0,0 +1,41 @@ +{ + "operationId": "DbNodes_get", + "title": "DbNodes_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "dbnodeocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "lifecycleState": "Available", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbNodes_listByParent.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbNodes_listByParent.json new file mode 100644 index 000000000000..a129607a449b --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbNodes_listByParent.json @@ -0,0 +1,45 @@ +{ + "operationId": "DbNodes_listByParent", + "title": "DbNodes_listByParent", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/dbNodes/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbNodes", + "properties": { + "ocid": "ocid.dbNodes.1", + "backupIpId": "id1", + "backupVnic2Id": "id1", + "backupVnicId": "id1", + "cpuCoreCount": 1000, + "dbNodeStorageSizeInGbs": 500, + "dbServerId": "dbserver1", + "dbSystemId": "db1", + "faultDomain": "domain1", + "hostIpId": "10.0.0.0", + "hostname": "host1", + "lifecycleState": "Available", + "maintenanceType": "VmdbRebootMigration", + "memorySizeInGbs": 100, + "softwareStorageSizeInGb": 1000, + "timeCreated": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", + "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", + "vnic2Id": "ocid.vnic.id2", + "vnicId": "ocid.vnic.id1" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbServers_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbServers_get.json new file mode 100644 index 000000000000..b36cbd0ca1f1 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbServers_get.json @@ -0,0 +1,42 @@ +{ + "operationId": "DbServers_get", + "title": "DbServers_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "dbserverocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1/dbServers/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbServers", + "properties": { + "ocid": "ocid1", + "displayName": "dbserver1", + "compartmentId": "ocid1....aaaa", + "exadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "cpuCoreCount": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 150, + "vmClusterIds": [ + "ocid1..aaaaa" + ], + "dbNodeIds": [ + "ocid1..aaaaa" + ], + "lifecycleState": "Available", + "maxCpuCount": 1000, + "autonomousVmClusterIds": [ + "ocid1..aaaaa" + ], + "autonomousVirtualMachineIds": [ + "ocid1..aaaaa" + ] + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbServers_listByParent.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbServers_listByParent.json new file mode 100644 index 000000000000..e373e2fe04ff --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbServers_listByParent.json @@ -0,0 +1,46 @@ +{ + "operationId": "DbServers_listByCloudExadataInfrastructure", + "title": "DbServers_listByCloudExadataInfrastructure", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1/dbServers/ocid1", + "type": "Oracle.Database/cloudVmClusters/dbServers", + "properties": { + "ocid": "ocid1", + "displayName": "dbserver1", + "compartmentId": "ocid1....aaaa", + "exadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "cpuCoreCount": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 150, + "vmClusterIds": [ + "ocid1..aaaaa" + ], + "dbNodeIds": [ + "ocid1..aaaaa" + ], + "lifecycleState": "Available", + "maxCpuCount": 1000, + "autonomousVmClusterIds": [ + "ocid1..aaaaa" + ], + "autonomousVirtualMachineIds": [ + "ocid1..aaaaa" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbSystemShapes_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbSystemShapes_get.json new file mode 100644 index 000000000000..ded7bb7b5c5e --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbSystemShapes_get.json @@ -0,0 +1,40 @@ +{ + "operationId": "DbSystemShapes_get", + "title": "DbSystemShapes_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dbsystemshapename": "EXADATA.X9M" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dbSystemShapes/EXADATA.X9M", + "type": "Oracle.Database/locations/dbSystemShapes", + "properties": { + "shapeFamily": "EXADATA", + "availableCoreCount": 100, + "minimumCoreCount": 1, + "runtimeMinimumCoreCount": 1, + "coreCountIncrement": 1, + "minStorageCount": 0, + "maxStorageCount": 100, + "availableDataStoragePerServerInTbs": 100, + "availableMemoryPerNodeInGbs": 10, + "availableDbNodePerNodeInGbs": 10, + "minCoreCountPerNode": 0, + "availableMemoryInGbs": 10, + "minMemoryPerNodeInGbs": 0, + "availableDbNodeStorageInGbs": 10, + "minDbNodeStoragePerNodeInGbs": 0, + "availableDataStorageInTbs": 10, + "minDataStorageInTbs": 0, + "minimumNodeCount": 0, + "maximumNodeCount": 1000, + "availableCoreCountPerNode": 1000 + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbSystemShapes_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbSystemShapes_listByLocation.json new file mode 100644 index 000000000000..961bceef1071 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbSystemShapes_listByLocation.json @@ -0,0 +1,44 @@ +{ + "operationId": "DbSystemShapes_listByLocation", + "title": "DbSystemShapes_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dbSystemShapes/EXADATA.X9M", + "type": "Oracle.Database/locations/dbSystemShapes", + "properties": { + "shapeFamily": "EXADATA", + "availableCoreCount": 100, + "minimumCoreCount": 1, + "runtimeMinimumCoreCount": 1, + "coreCountIncrement": 1, + "minStorageCount": 0, + "maxStorageCount": 100, + "availableDataStoragePerServerInTbs": 100, + "availableMemoryPerNodeInGbs": 10, + "availableDbNodePerNodeInGbs": 10, + "minCoreCountPerNode": 0, + "availableMemoryInGbs": 10, + "minMemoryPerNodeInGbs": 0, + "availableDbNodeStorageInGbs": 10, + "minDbNodeStoragePerNodeInGbs": 0, + "availableDataStorageInTbs": 10, + "minDataStorageInTbs": 0, + "minimumNodeCount": 0, + "maximumNodeCount": 1000, + "availableCoreCountPerNode": 1000 + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dnsPrivateViews_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dnsPrivateViews_get.json new file mode 100644 index 000000000000..826e6cbed202 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dnsPrivateViews_get.json @@ -0,0 +1,27 @@ +{ + "operationId": "DnsPrivateViews_get", + "title": "DnsPrivateViews_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dnsprivateviewocid": "ocid1....aaaaaa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaaa", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaaa", + "displayName": "example-dns-private-view", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/your-dns-private-view", + "timeCreated": "2023-10-26T12:34:56Z", + "timeUpdated": "2023-10-26T14:00:00Z" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dnsPrivateViews_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dnsPrivateViews_listByLocation.json new file mode 100644 index 000000000000..41452ef83946 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dnsPrivateViews_listByLocation.json @@ -0,0 +1,44 @@ +{ + "operationId": "DnsPrivateViews_listByLocation", + "title": "DnsPrivateViews_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaaa", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaaa", + "displayName": "example-dns-private-view1", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/view1", + "timeCreated": "2023-10-26T12:34:56Z", + "timeUpdated": "2023-10-26T14:00:00Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateViews/ocid1....aaaaab", + "type": "Oracle.Database/locations/dnsPrivateViews", + "properties": { + "ocid": "ocid1....aaaaab", + "displayName": "example-dns-private-view2", + "isProtected": true, + "lifecycleState": "Creating", + "self": "https://api.example.com/view2", + "timeCreated": "2023-10-27T09:45:00Z", + "timeUpdated": "2023-10-27T10:30:00Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dnsPrivateZones_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dnsPrivateZones_get.json new file mode 100644 index 000000000000..8f025cdf4583 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dnsPrivateZones_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "DnsPrivateZones_get", + "title": "DnsPrivateZones_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "dnsprivatezonename": "example-dns-private-zone" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/example-dns-private-zone", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "your-zone-id", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/your-dns-private-zone", + "serial": 12345, + "version": "1.0.0.0", + "viewId": "your-view-id", + "zoneType": "Primary", + "timeCreated": "2023-10-26T12:34:56Z" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dnsPrivateZones_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dnsPrivateZones_listByLocation.json new file mode 100644 index 000000000000..f83d475eaf7a --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dnsPrivateZones_listByLocation.json @@ -0,0 +1,48 @@ +{ + "operationId": "DnsPrivateZones_listByLocation", + "title": "DnsPrivateZones_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/zone1", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "zone-id-1", + "isProtected": false, + "lifecycleState": "Active", + "self": "https://api.example.com/zone1", + "serial": 12345, + "version": "1.0.0.0", + "viewId": "view-id-1", + "zoneType": "Primary", + "timeCreated": "2023-10-26T12:34:56Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/dnsPrivateZones/zone2", + "type": "Oracle.Database/locations/dnsPrivateZones", + "properties": { + "ocid": "zone-id-2", + "isProtected": true, + "lifecycleState": "Creating", + "self": "https://api.example.com/zone2", + "serial": 54321, + "version": "2.0.0.0", + "viewId": "view-id-2", + "zoneType": "Secondary", + "timeCreated": "2023-10-27T09:45:00Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_addStorageCapacity.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_addStorageCapacity.json new file mode 100644 index 000000000000..a8c9b7f02411 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_addStorageCapacity.json @@ -0,0 +1,95 @@ +{ + "operationId": "CloudExadataInfrastructures_addStorageCapacity", + "title": "CloudExadataInfrastructures_addStorageCapacity", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_create.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_create.json new file mode 100644 index 000000000000..fe163d1df594 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_create.json @@ -0,0 +1,184 @@ +{ + "operationId": "CloudExadataInfrastructures_createOrUpdate", + "title": "CloudExadataInfrastructures_createOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "resource": { + "properties": { + "computeCount": 100, + "storageCount": 10, + "shape": "EXADATA.X9M", + "displayName": "infra 1" + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "zones": [ + "1" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_delete.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_delete.json new file mode 100644 index 000000000000..690faa2619be --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "CloudExadataInfrastructures_delete", + "title": "CloudExadataInfrastructures_delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_get.json new file mode 100644 index 000000000000..02018dc9d070 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_get.json @@ -0,0 +1,89 @@ +{ + "operationId": "CloudExadataInfrastructures_get", + "title": "CloudExadataInfrastructures_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_listByResourceGroup.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_listByResourceGroup.json new file mode 100644 index 000000000000..637714be7f17 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_listByResourceGroup.json @@ -0,0 +1,93 @@ +{ + "operationId": "CloudExadataInfrastructures_listByResourceGroup", + "title": "CloudExadataInfrastructures_listByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_listBySubscription.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_listBySubscription.json new file mode 100644 index 000000000000..bc1d84648c85 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_listBySubscription.json @@ -0,0 +1,92 @@ +{ + "operationId": "CloudExadataInfrastructures_listBySubscription", + "title": "CloudExadataInfrastructures_listBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_patch.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_patch.json new file mode 100644 index 000000000000..4d224bfb31e5 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/exaInfra_patch.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudExadataInfrastructures_update", + "title": "CloudExadataInfrastructures_update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudexadatainfrastructurename": "infra1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + }, + "zones": [ + "1" + ] + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaaaa", + "computeCount": 100, + "storageCount": 10, + "totalStorageSizeInGbs": 1000, + "availableStorageSizeInGbs": 1000, + "timeCreated": "2023-02-01T01:01:00", + "lifecycleDetails": "none", + "maintenanceWindow": { + "preference": "NoPreference", + "months": [ + { + "name": "January" + } + ], + "weeksOfMonth": [ + 0 + ], + "daysOfWeek": [ + { + "name": "Monday" + } + ], + "hoursOfDay": [ + 0 + ], + "leadTimeInWeeks": 0, + "patchingMode": "Rolling", + "customActionTimeoutInMins": 120, + "isCustomActionTimeoutEnabled": true, + "isMonthlyPatchingEnabled": true + }, + "estimatedPatchingTime": { + "estimatedDbServerPatchingTime": 3000, + "estimatedNetworkSwitchesPatchingTime": 3000, + "estimatedStorageServerPatchingTime": 3000, + "totalEstimatedPatchingTime": 3000 + }, + "customerContacts": [ + { + "email": "noreply@oracle.com" + } + ], + "provisioningState": "Succeeded", + "shape": "EXADATA.X9M", + "ociUrl": "https://url", + "cpuCount": 10, + "maxCpuCount": 100, + "memorySizeInGbs": 100, + "maxMemoryInGbs": 1000, + "dbNodeStorageSizeInGbs": 10, + "maxDbNodeStorageSizeInGbs": 10, + "dataStorageSizeInTbs": 10, + "maxDataStorageInTbs": 1000, + "dbServerVersion": "19.0.0.0", + "storageServerVersion": "0.0", + "activatedStorageCount": 1, + "additionalStorageCount": 1, + "displayName": "infra 1", + "lastMaintenanceRunId": "ocid1..aaaaa", + "nextMaintenanceRunId": "ocid1..aaaaaa", + "monthlyDbServerVersion": "aaaa", + "monthlyStorageServerVersion": "aaaa" + }, + "zones": [ + "1" + ] + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/giVersions_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/giVersions_get.json new file mode 100644 index 000000000000..9f869012ffa4 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/giVersions_get.json @@ -0,0 +1,21 @@ +{ + "operationId": "GiVersions_get", + "title": "GiVersions_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "giversionname": "19.0.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/giVersions/19.0.0.0", + "type": "Oracle.Database/locations/giVersions", + "properties": { + "version": "19.0.0.0" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/giVersions_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/giVersions_listByLocation.json new file mode 100644 index 000000000000..e1f9a8790206 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/giVersions_listByLocation.json @@ -0,0 +1,25 @@ +{ + "operationId": "GiVersions_listByLocation", + "title": "GiVersions_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/giVersions/19.0.0.0", + "type": "Oracle.Database/locations/giVersions", + "properties": { + "version": "19.0.0.0" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/operations_list.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/operations_list.json new file mode 100644 index 000000000000..90d233fd2bed --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/operations_list.json @@ -0,0 +1,25 @@ +{ + "operationId": "Operations_list", + "title": "Operations_list", + "parameters": { + "api-version": "2024-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Oracle.Database/cloudExadataInfrastructures/Read", + "isDataAction": false, + "display": { + "provider": "Oracle.Database", + "resource": "cloudExadataInfrastructures", + "operation": "Get/list Exadata Infrastructure resources", + "description": "Reads Exadata Infrastructure" + } + } + ] + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_addAzureSubscriptions.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_addAzureSubscriptions.json new file mode 100644 index 000000000000..5ced338ab0a8 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_addAzureSubscriptions.json @@ -0,0 +1,21 @@ +{ + "operationId": "OracleSubscriptions_addAzureSubscriptions", + "title": "OracleSubscriptions_addAzureSubscriptions", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "body": { + "azureSubscriptionIds": [ + "00000000-0000-0000-0000-000000000001" + ] + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_create.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_create.json new file mode 100644 index 000000000000..087479add3a6 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_create.json @@ -0,0 +1,56 @@ +{ + "operationId": "OracleSubscriptions_createOrUpdate", + "title": "OracleSubscriptions_createOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resource": { + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_delete.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_delete.json new file mode 100644 index 000000000000..8f36e973bb3e --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_delete.json @@ -0,0 +1,17 @@ +{ + "operationId": "OracleSubscriptions_delete", + "title": "OracleSubscriptions_delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_get.json new file mode 100644 index 000000000000..54ff6b48c87e --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "OracleSubscriptions_get", + "title": "OracleSubscriptions_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_listActivationLinks.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_listActivationLinks.json new file mode 100644 index 000000000000..8e1f22e31ef5 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_listActivationLinks.json @@ -0,0 +1,22 @@ +{ + "operationId": "OracleSubscriptions_listActivationLinks", + "title": "OracleSubscriptions_listActivationLinks", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "newCloudAccountActivationLink": "https://new-tenancy-activation-link", + "existingCloudAccountActivationLink": "https://existing-tenancy-activation-link" + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_listBySubscription.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_listBySubscription.json new file mode 100644 index 000000000000..e7ddb186b915 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_listBySubscription.json @@ -0,0 +1,34 @@ +{ + "operationId": "OracleSubscriptions_listBySubscription", + "title": "OracleSubscriptions_listBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_listCloudAccountDetails.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_listCloudAccountDetails.json new file mode 100644 index 000000000000..92430982a4a4 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_listCloudAccountDetails.json @@ -0,0 +1,22 @@ +{ + "operationId": "OracleSubscriptions_listCloudAccountDetails", + "title": "OracleSubscriptions_listCloudAccountDetails", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "cloudAccountName": "Cloud Account", + "cloudAccountHomeRegion": "East US" + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_listSaasSubscriptionDetails.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_listSaasSubscriptionDetails.json new file mode 100644 index 000000000000..7fbb31a28fb5 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_listSaasSubscriptionDetails.json @@ -0,0 +1,32 @@ +{ + "operationId": "OracleSubscriptions_listSaasSubscriptionDetails", + "title": "OracleSubscriptions_listSaasSubscriptionDetails", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "1234567890", + "subscriptionName": "Oracle", + "timeCreated": "2022-03-07T00:00:00Z", + "offerId": "offer1", + "planId": "silver", + "saasSubscriptionStatus": "PendingFulfillmentStart", + "publisherId": "Oracle", + "purchaserEmailId": "test@test.com", + "purchaserTenantId": "1234567890", + "termUnit": "P1M", + "isAutoRenew": true, + "isFreeTrial": false + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_patch.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_patch.json new file mode 100644 index 000000000000..68ba78376523 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/oracleSubscriptions_patch.json @@ -0,0 +1,43 @@ +{ + "operationId": "OracleSubscriptions_update", + "title": "OracleSubscriptions_update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "properties": {}, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/oracleSubscriptions/default", + "type": "Oracle.Database/oracleSubscriptions", + "properties": { + "provisioningState": "Succeeded", + "saasSubscriptionId": "saas1", + "cloudAccountId": "ocid1..aaaaaa", + "cloudAccountState": "Pending" + }, + "plan": { + "name": "plan1", + "publisher": "publisher1", + "product": "product1", + "promotionCode": "none", + "version": "alpha" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/systemVersions_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/systemVersions_get.json new file mode 100644 index 000000000000..5f490d631bd4 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/systemVersions_get.json @@ -0,0 +1,20 @@ +{ + "operationId": "SystemVersions_Get", + "title": "systemVersions_listSystemVersions", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "systemversionname": "22.x" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/systemVersion/22.1.7.0.0.230113", + "properties": { + "systemVersion": "22.1.7.0.0.230113" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/systemVersions_listByLocation.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/systemVersions_listByLocation.json new file mode 100644 index 000000000000..cab8022e27f1 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/systemVersions_listByLocation.json @@ -0,0 +1,24 @@ +{ + "operationId": "SystemVersions_ListByLocation", + "title": "systemVersions_listByLocation", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/systemVersion/22.1.7.0.0.230113", + "properties": { + "systemVersion": "22.1.7.0.0.230113" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/virtualNetworkAddresses_create.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/virtualNetworkAddresses_create.json new file mode 100644 index 000000000000..1060f3098866 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/virtualNetworkAddresses_create.json @@ -0,0 +1,48 @@ +{ + "operationId": "VirtualNetworkAddresses_createOrUpdate", + "title": "VirtualNetworkAddresses_createOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1", + "resource": { + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "type": "Oracle.Database/cloudExadataInfrastructures", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/virtualNetworkAddresses_delete.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/virtualNetworkAddresses_delete.json new file mode 100644 index 000000000000..154d26c1fccb --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/virtualNetworkAddresses_delete.json @@ -0,0 +1,20 @@ +{ + "operationId": "VirtualNetworkAddresses_delete", + "title": "VirtualNetworkAddresses_delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/virtualNetworkAddresses_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/virtualNetworkAddresses_get.json new file mode 100644 index 000000000000..21de10dd3bc8 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/virtualNetworkAddresses_get.json @@ -0,0 +1,29 @@ +{ + "operationId": "VirtualNetworkAddresses_get", + "title": "VirtualNetworkAddresses_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "virtualnetworkaddressname": "hostname1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/virtualNetworkAddresses_listByParent.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/virtualNetworkAddresses_listByParent.json new file mode 100644 index 000000000000..8cb03a39fb76 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/virtualNetworkAddresses_listByParent.json @@ -0,0 +1,33 @@ +{ + "operationId": "VirtualNetworkAddresses_listByCloudVmCluster", + "title": "VirtualNetworkAddresses_listByCloudVmCluster", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/virtualNetworkAddresses/hostname1", + "type": "Oracle.Database/cloudVmClusters/virtualNetworkAddresses", + "properties": { + "ipAddress": "192.168.0.1", + "vmOcid": "ocid1..aaaa", + "ocid": "ocid1..aaaaaa", + "domain": "domain1", + "lifecycleDetails": "success", + "provisioningState": "Succeeded", + "lifecycleState": "Available", + "timeAssigned": "2023-10-22T00:27:02.119Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_addVms.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_addVms.json new file mode 100644 index 000000000000..376ab18bcab7 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_addVms.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudVmClusters_addVms", + "title": "CloudVmClusters_addVms", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "dbServers": [ + "ocid1..aaaa", + "ocid1..aaaaaa" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_create.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_create.json new file mode 100644 index 000000000000..5f3f539ba6a8 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_create.json @@ -0,0 +1,224 @@ +{ + "operationId": "CloudVmClusters_createOrUpdate", + "title": "CloudVmClusters_createOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "resource": { + "properties": { + "dataStorageSizeInTbs": 1000, + "dbNodeStorageSizeInGbs": 1000, + "memorySizeInGbs": 1000, + "timeZone": "UTC", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 2, + "ocpuCount": 3, + "clusterName": "cluster1", + "dataStoragePercentage": 100, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "nsgCidrs": [ + { + "source": "10.0.0.0/16", + "destinationPortRange": { + "min": 1520, + "max": 1522 + } + }, + { + "source": "10.10.0.0/24" + } + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "dbServers": [ + "ocid1..aaaa" + ] + }, + "location": "eastus", + "tags": { + "tagK1": "tagV1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "201": { + "headers": { + "Retry-After": 100000000 + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "BootStrapping", + "lifecycleState": "BootStrapping", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_delete.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_delete.json new file mode 100644 index 000000000000..4892b0899e72 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "CloudVmClusters_delete", + "title": "CloudVmClusters_delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + }, + "204": {} + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_get.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_get.json new file mode 100644 index 000000000000..7bf1d3d3d351 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_get.json @@ -0,0 +1,104 @@ +{ + "operationId": "CloudVmClusters_get", + "title": "CloudVmClusters_get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "nsgCidrs": [ + { + "source": "10.0.0.0/16", + "destinationPortRange": { + "min": 1520, + "max": 1522 + } + }, + { + "source": "10.10.0.0/24" + } + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "nsgUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_listByResourceGroup.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_listByResourceGroup.json new file mode 100644 index 000000000000..ebe7f027aacb --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_listByResourceGroup.json @@ -0,0 +1,95 @@ +{ + "operationId": "CloudVmClusters_listByResourceGroup", + "title": "CloudVmClusters_listByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_listBySubscription.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_listBySubscription.json new file mode 100644 index 000000000000..26d22f28ced8 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_listBySubscription.json @@ -0,0 +1,94 @@ +{ + "operationId": "CloudVmClusters_listBySubscription", + "title": "CloudVmClusters_listBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_listPrivateIpAddresses.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_listPrivateIpAddresses.json new file mode 100644 index 000000000000..9bf2ea94b6e0 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_listPrivateIpAddresses.json @@ -0,0 +1,27 @@ +{ + "operationId": "CloudVmClusters_listPrivateIpAddresses", + "title": "CloudVmClusters_listPrivateIpAddresses", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "subnetId": "ocid1..aaaaaa", + "vnicId": "ocid1..aaaaa" + } + }, + "responses": { + "200": { + "body": [ + { + "displayName": "ip1", + "hostnameLabel": "hostname1", + "ocid": "ocid1..aaaa", + "ipAddress": "192.168.0.1", + "subnetId": "ocid1..aaaa" + } + ] + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_patch.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_patch.json new file mode 100644 index 000000000000..677fa1d0a913 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_patch.json @@ -0,0 +1,101 @@ +{ + "operationId": "CloudVmClusters_update", + "title": "CloudVmClusters_update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "properties": {}, + "tags": { + "tagK1": "tagV1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_removeVms.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_removeVms.json new file mode 100644 index 000000000000..27fe11214c93 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/vmClusters_removeVms.json @@ -0,0 +1,102 @@ +{ + "operationId": "CloudVmClusters_removeVms", + "title": "CloudVmClusters_removeVms", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg000", + "cloudvmclustername": "cluster1", + "body": { + "dbServers": [ + "ocid1..aaaa" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1", + "type": "Oracle.Database/cloudVmClusters", + "location": "eastus", + "tags": { + "tagK1": "tagV1" + }, + "properties": { + "ocid": "ocid1..aaaa", + "listenerPort": 1050, + "nodeCount": 100, + "storageSizeInGbs": 1000, + "dataStorageSizeInTbs": 10, + "dbNodeStorageSizeInGbs": 100, + "memorySizeInGbs": 1000, + "timeCreated": "2023-10-22T02:18:35.683Z", + "lifecycleDetails": "success", + "timeZone": "UTC", + "zoneId": "ocid1..aaaa", + "hostname": "hostname1", + "domain": "domain1", + "cpuCoreCount": 10, + "ocpuCount": 100, + "clusterName": "cluster1", + "dataStoragePercentage": 80, + "isLocalBackupEnabled": false, + "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1", + "isSparseDiskgroupEnabled": false, + "sshPublicKeys": [ + "ssh-key 1" + ], + "licenseModel": "LicenseIncluded", + "scanListenerPortTcp": 1050, + "scanListenerPortTcpSsl": 1025, + "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1", + "giVersion": "19.0.0.0", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "backupSubnetCidr": "172.17.5.0/24", + "systemVersion": "v1", + "diskRedundancy": "High", + "scanIpIds": [ + "10.0.0.1" + ], + "vipIds": [ + "10.0.1.3" + ], + "scanDnsName": "dbdns1", + "scanDnsRecordId": "scandns1", + "shape": "EXADATA.X9M", + "provisioningState": "Succeeded", + "ociUrl": "https://fake", + "dataCollectionOptions": { + "isDiagnosticsEventsEnabled": false, + "isHealthMonitoringEnabled": false, + "isIncidentLogsEnabled": false + }, + "displayName": "cluster 1", + "iormConfigCache": { + "dbPlans": [ + { + "dbName": "db1", + "flashCacheLimit": "none", + "share": 32 + } + ], + "lifecycleDetails": "Disabled", + "lifecycleState": "Disabled", + "objective": "LowLatency" + }, + "lastUpdateHistoryEntryId": "none", + "dbServers": [ + "ocid1..aaaa" + ], + "compartmentId": "ocid1..aaaaaa", + "subnetOcid": "ocid1..aaaaaa" + } + } + }, + "202": { + "headers": { + "Retry-After": 10000000, + "Location": "eastus" + } + } + } +} diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/openapi.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/openapi.json new file mode 100644 index 000000000000..a40dfc017dd0 --- /dev/null +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/openapi.json @@ -0,0 +1,9900 @@ +{ + "swagger": "2.0", + "info": { + "title": "Oracle Database Resource Manager", + "version": "2024-06-01", + "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": "CloudExadataInfrastructures" + }, + { + "name": "DbServers" + }, + { + "name": "CloudVmClusters" + }, + { + "name": "VirtualNetworkAddresses" + }, + { + "name": "SystemVersions" + }, + { + "name": "OracleSubscriptions" + }, + { + "name": "DbNodes" + }, + { + "name": "GiVersions" + }, + { + "name": "DbSystemShapes" + }, + { + "name": "DnsPrivateViews" + }, + { + "name": "DnsPrivateZones" + }, + { + "name": "AutonomousDatabases" + }, + { + "name": "AutonomousDatabaseBackups" + }, + { + "name": "AutonomousDatabaseCharacterSets" + }, + { + "name": "AutonomousDatabaseNationalCharacterSets" + }, + { + "name": "AutonomousDatabaseVersions" + } + ], + "paths": { + "/providers/Oracle.Database/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/Oracle.Database/autonomousDatabases": { + "get": { + "operationId": "AutonomousDatabases_ListBySubscription", + "tags": [ + "AutonomousDatabases" + ], + "description": "List AutonomousDatabase 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/AutonomousDatabaseListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Autonomous Database by subscription": { + "$ref": "./examples/autonomousDatabase_listBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/cloudExadataInfrastructures": { + "get": { + "operationId": "CloudExadataInfrastructures_ListBySubscription", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "List CloudExadataInfrastructure 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/CloudExadataInfrastructureListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Exadata Infrastructure by subscription": { + "$ref": "./examples/exaInfra_listBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/cloudVmClusters": { + "get": { + "operationId": "CloudVmClusters_ListBySubscription", + "tags": [ + "CloudVmClusters" + ], + "description": "List CloudVmCluster 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/CloudVmClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List VM Clusters by subscription": { + "$ref": "./examples/vmClusters_listBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDatabaseCharacterSets": { + "get": { + "operationId": "AutonomousDatabaseCharacterSets_ListByLocation", + "tags": [ + "AutonomousDatabaseCharacterSets" + ], + "description": "List AutonomousDatabaseCharacterSet resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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/AutonomousDatabaseCharacterSetListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List autonomous db character sets by location": { + "$ref": "./examples/autonomousDatabaseCharacterSet_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDatabaseCharacterSets/{adbscharsetname}": { + "get": { + "operationId": "AutonomousDatabaseCharacterSets_Get", + "tags": [ + "AutonomousDatabaseCharacterSets" + ], + "description": "Get a AutonomousDatabaseCharacterSet", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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": "adbscharsetname", + "in": "path", + "description": "AutonomousDatabaseCharacterSet name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseCharacterSet" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get autonomous db character set": { + "$ref": "./examples/autonomousDatabaseCharacterSet_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDatabaseNationalCharacterSets": { + "get": { + "operationId": "AutonomousDatabaseNationalCharacterSets_ListByLocation", + "tags": [ + "AutonomousDatabaseNationalCharacterSets" + ], + "description": "List AutonomousDatabaseNationalCharacterSet resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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/AutonomousDatabaseNationalCharacterSetListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List autonomous db national character sets by location": { + "$ref": "./examples/autonomousDatabaseNationalCharacterSet_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDatabaseNationalCharacterSets/{adbsncharsetname}": { + "get": { + "operationId": "AutonomousDatabaseNationalCharacterSets_Get", + "tags": [ + "AutonomousDatabaseNationalCharacterSets" + ], + "description": "Get a AutonomousDatabaseNationalCharacterSet", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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": "adbsncharsetname", + "in": "path", + "description": "AutonomousDatabaseNationalCharacterSets name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseNationalCharacterSet" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get autonomous db national character set": { + "$ref": "./examples/autonomousDatabaseNationalCharacterSet_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDbVersions": { + "get": { + "operationId": "AutonomousDatabaseVersions_ListByLocation", + "tags": [ + "AutonomousDatabaseVersions" + ], + "description": "List AutonomousDbVersion resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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/AutonomousDbVersionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List an autonomous versions by location": { + "$ref": "./examples/autonomousDatabaseVersion_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDbVersions/{autonomousdbversionsname}": { + "get": { + "operationId": "AutonomousDatabaseVersions_Get", + "tags": [ + "AutonomousDatabaseVersions" + ], + "description": "Get a AutonomousDbVersion", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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": "autonomousdbversionsname", + "in": "path", + "description": "AutonomousDbVersion name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDbVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get an autonomous version": { + "$ref": "./examples/autonomousDatabaseVersion_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dbSystemShapes": { + "get": { + "operationId": "DbSystemShapes_ListByLocation", + "tags": [ + "DbSystemShapes" + ], + "description": "List DbSystemShape resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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/DbSystemShapeListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List DbSystemShapes by location": { + "$ref": "./examples/dbSystemShapes_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dbSystemShapes/{dbsystemshapename}": { + "get": { + "operationId": "DbSystemShapes_Get", + "tags": [ + "DbSystemShapes" + ], + "description": "Get a DbSystemShape", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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": "dbsystemshapename", + "in": "path", + "description": "DbSystemShape name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbSystemShape" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a DbSystemShape by name": { + "$ref": "./examples/dbSystemShapes_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dnsPrivateViews": { + "get": { + "operationId": "DnsPrivateViews_ListByLocation", + "tags": [ + "DnsPrivateViews" + ], + "description": "List DnsPrivateView resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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/DnsPrivateViewListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List DnsPrivateViews by location": { + "$ref": "./examples/dnsPrivateViews_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dnsPrivateViews/{dnsprivateviewocid}": { + "get": { + "operationId": "DnsPrivateViews_Get", + "tags": [ + "DnsPrivateViews" + ], + "description": "Get a DnsPrivateView", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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": "dnsprivateviewocid", + "in": "path", + "description": "DnsPrivateView OCID", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DnsPrivateView" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a DnsPrivateView by name": { + "$ref": "./examples/dnsPrivateViews_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dnsPrivateZones": { + "get": { + "operationId": "DnsPrivateZones_ListByLocation", + "tags": [ + "DnsPrivateZones" + ], + "description": "List DnsPrivateZone resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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/DnsPrivateZoneListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List DnsPrivateZones by location": { + "$ref": "./examples/dnsPrivateZones_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dnsPrivateZones/{dnsprivatezonename}": { + "get": { + "operationId": "DnsPrivateZones_Get", + "tags": [ + "DnsPrivateZones" + ], + "description": "Get a DnsPrivateZone", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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": "dnsprivatezonename", + "in": "path", + "description": "DnsPrivateZone name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DnsPrivateZone" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a DnsPrivateZone by name": { + "$ref": "./examples/dnsPrivateZones_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/giVersions": { + "get": { + "operationId": "GiVersions_ListByLocation", + "tags": [ + "GiVersions" + ], + "description": "List GiVersion resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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/GiVersionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List GiVersions by location": { + "$ref": "./examples/giVersions_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/giVersions/{giversionname}": { + "get": { + "operationId": "GiVersions_Get", + "tags": [ + "GiVersions" + ], + "description": "Get a GiVersion", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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": "giversionname", + "in": "path", + "description": "GiVersion name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GiVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a GiVersion by name": { + "$ref": "./examples/giVersions_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/systemVersions": { + "get": { + "operationId": "SystemVersions_ListByLocation", + "tags": [ + "SystemVersions" + ], + "description": "List SystemVersion resources by Location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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/SystemVersionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Exadata System Versions by the provided filter": { + "$ref": "./examples/systemVersions_listByLocation.json" + }, + "systemVersions_listByLocation": { + "$ref": "./examples/systemVersions_listByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/systemVersions/{systemversionname}": { + "get": { + "operationId": "SystemVersions_Get", + "tags": [ + "SystemVersions" + ], + "description": "Get a SystemVersion", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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": "systemversionname", + "in": "path", + "description": "SystemVersion name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SystemVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Exadata System Version": { + "$ref": "./examples/systemVersions_get.json" + }, + "systemVersions_listSystemVersions": { + "$ref": "./examples/systemVersions_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions": { + "get": { + "operationId": "OracleSubscriptions_ListBySubscription", + "tags": [ + "OracleSubscriptions" + ], + "description": "List OracleSubscription 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/OracleSubscriptionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Oracle Subscriptions by subscription": { + "$ref": "./examples/oracleSubscriptions_listBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default": { + "get": { + "operationId": "OracleSubscriptions_Get", + "tags": [ + "OracleSubscriptions" + ], + "description": "Get a OracleSubscription", + "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/OracleSubscription" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_get.json" + } + } + }, + "put": { + "operationId": "OracleSubscriptions_CreateOrUpdate", + "tags": [ + "OracleSubscriptions" + ], + "description": "Create a OracleSubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/OracleSubscription" + } + } + ], + "responses": { + "200": { + "description": "Resource 'OracleSubscription' update operation succeeded", + "schema": { + "$ref": "#/definitions/OracleSubscription" + } + }, + "201": { + "description": "Resource 'OracleSubscription' create operation succeeded", + "schema": { + "$ref": "#/definitions/OracleSubscription" + }, + "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": { + "Create or Update Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "OracleSubscriptions_Update", + "tags": [ + "OracleSubscriptions" + ], + "description": "Update a OracleSubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/OracleSubscriptionUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OracleSubscription" + } + }, + "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": { + "Patch Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_patch.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "OracleSubscriptions_Delete", + "tags": [ + "OracleSubscriptions" + ], + "description": "Delete a OracleSubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "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 Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default/addAzureSubscriptions": { + "post": { + "operationId": "OracleSubscriptions_AddAzureSubscriptions", + "tags": [ + "OracleSubscriptions" + ], + "description": "Add Azure Subscriptions", + "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 content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/AzureSubscriptions" + } + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Add Azure Subscriptions to the OracleSubscription": { + "$ref": "./examples/oracleSubscriptions_addAzureSubscriptions.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default/listActivationLinks": { + "post": { + "operationId": "OracleSubscriptions_ListActivationLinks", + "tags": [ + "OracleSubscriptions" + ], + "description": "List Activation Links", + "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/ActivationLinks" + } + }, + "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": { + "List Activation Links for the Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_listActivationLinks.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default/listCloudAccountDetails": { + "post": { + "operationId": "OracleSubscriptions_ListCloudAccountDetails", + "tags": [ + "OracleSubscriptions" + ], + "description": "List Cloud Account Details", + "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/CloudAccountDetails" + } + }, + "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": { + "List Cloud Account details for the Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_listCloudAccountDetails.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default/listSaasSubscriptionDetails": { + "post": { + "operationId": "OracleSubscriptions_ListSaasSubscriptionDetails", + "tags": [ + "OracleSubscriptions" + ], + "description": "List Saas Subscription Details", + "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/SaasSubscriptionDetails" + } + }, + "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": { + "List Saas Subscription details for the Oracle Subscription": { + "$ref": "./examples/oracleSubscriptions_listSaasSubscriptionDetails.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases": { + "get": { + "operationId": "AutonomousDatabases_ListByResourceGroup", + "tags": [ + "AutonomousDatabases" + ], + "description": "List AutonomousDatabase 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/AutonomousDatabaseListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Autonomous Database by resource group": { + "$ref": "./examples/autonomousDatabase_listByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}": { + "get": { + "operationId": "AutonomousDatabases_Get", + "tags": [ + "AutonomousDatabases" + ], + "description": "Get a AutonomousDatabase", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabases_Get": { + "$ref": "./examples/autonomousDatabase_get.json" + }, + "Get Autonomous Database": { + "$ref": "./examples/autonomousDatabase_get.json" + } + } + }, + "put": { + "operationId": "AutonomousDatabases_CreateOrUpdate", + "tags": [ + "AutonomousDatabases" + ], + "description": "Create a AutonomousDatabase", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AutonomousDatabase' update operation succeeded", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "201": { + "description": "Resource 'AutonomousDatabase' create operation succeeded", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + }, + "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": { + "AutonomousDatabases_CreateOrUpdate": { + "$ref": "./examples/autonomousDatabase_create.json" + }, + "AutonomousDatabases_CreateOrUpdate_clone": { + "$ref": "./examples/autonomousDatabaseClone_create.json" + }, + "Create Autonomous Database": { + "$ref": "./examples/autonomousDatabase_create.json" + }, + "Create clone Autonomous Database": { + "$ref": "./examples/autonomousDatabaseClone_create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "AutonomousDatabases_Update", + "tags": [ + "AutonomousDatabases" + ], + "description": "Update a AutonomousDatabase", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AutonomousDatabaseUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "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": { + "Patch Autonomous Database": { + "$ref": "./examples/autonomousDatabase_patch.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "AutonomousDatabases_Delete", + "tags": [ + "AutonomousDatabases" + ], + "description": "Delete a AutonomousDatabase", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + } + ], + "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 Autonomous Database": { + "$ref": "./examples/autonomousDatabase_delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/autonomousDatabaseBackups": { + "get": { + "operationId": "AutonomousDatabaseBackups_ListByAutonomousDatabase", + "tags": [ + "AutonomousDatabaseBackups" + ], + "description": "List AutonomousDatabaseBackup resources by AutonomousDatabase", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabaseBackups_ListByAutonomousDatabase": { + "$ref": "./examples/autonomousDatabaseBackup_listByParent.json" + }, + "List Autonomous Database Backups by Autonomous Database.": { + "$ref": "./examples/autonomousDatabaseBackup_listByParent.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/autonomousDatabaseBackups/{adbbackupid}": { + "get": { + "operationId": "AutonomousDatabaseBackups_Get", + "tags": [ + "AutonomousDatabaseBackups" + ], + "description": "Get a AutonomousDatabaseBackup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "adbbackupid", + "in": "path", + "description": "AutonomousDatabaseBackup id", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutonomousDatabaseBackups_Get": { + "$ref": "./examples/autonomousDatabaseBackup_get.json" + }, + "Get Autonomous Database Backup.": { + "$ref": "./examples/autonomousDatabaseBackup_get.json" + } + } + }, + "put": { + "operationId": "AutonomousDatabaseBackups_CreateOrUpdate", + "tags": [ + "AutonomousDatabaseBackups" + ], + "description": "Create a AutonomousDatabaseBackup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "adbbackupid", + "in": "path", + "description": "AutonomousDatabaseBackup id", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackup" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AutonomousDatabaseBackup' update operation succeeded", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackup" + } + }, + "201": { + "description": "Resource 'AutonomousDatabaseBackup' create operation succeeded", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackup" + }, + "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": { + "AutonomousDatabaseBackups_CreateOrUpdate": { + "$ref": "./examples/autonomousDatabaseBackup_create.json" + }, + "Create Autonomous Database Backup.": { + "$ref": "./examples/autonomousDatabaseBackup_create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "AutonomousDatabaseBackups_Update", + "tags": [ + "AutonomousDatabaseBackups" + ], + "description": "Update a AutonomousDatabaseBackup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "adbbackupid", + "in": "path", + "description": "AutonomousDatabaseBackup id", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackupUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseBackup" + } + }, + "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": { + "AutonomousDatabaseBackups_Update": { + "$ref": "./examples/autonomousDatabaseBackup_patch.json" + }, + "Patch Autonomous Database Backup.": { + "$ref": "./examples/autonomousDatabaseBackup_patch.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "AutonomousDatabaseBackups_Delete", + "tags": [ + "AutonomousDatabaseBackups" + ], + "description": "Delete a AutonomousDatabaseBackup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "adbbackupid", + "in": "path", + "description": "AutonomousDatabaseBackup id", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "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": { + "AutonomousDatabaseBackups_Delete": { + "$ref": "./examples/autonomousDatabaseBackup_delete.json" + }, + "Delete Autonomous Database Backup.": { + "$ref": "./examples/autonomousDatabaseBackup_delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/failover": { + "post": { + "operationId": "AutonomousDatabases_Failover", + "tags": [ + "AutonomousDatabases" + ], + "description": "Perform failover action on Autonomous Database", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/PeerDbDetails" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "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": { + "AutonomousDatabases_Failover": { + "$ref": "./examples/autonomousDatabase_failover.json" + }, + "Perform failover action on Autonomous Database": { + "$ref": "./examples/autonomousDatabase_failover.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/generateWallet": { + "post": { + "operationId": "AutonomousDatabases_GenerateWallet", + "tags": [ + "AutonomousDatabases" + ], + "description": "Generate wallet action on Autonomous Database", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/GenerateAutonomousDatabaseWalletDetails" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabaseWalletFile" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Generate wallet action on Autonomous Database": { + "$ref": "./examples/autonomousDatabase_generateWallet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/restore": { + "post": { + "operationId": "AutonomousDatabases_Restore", + "tags": [ + "AutonomousDatabases" + ], + "description": "Restores an Autonomous Database based on the provided request parameters.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/RestoreAutonomousDatabaseDetails" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "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": { + "AutonomousDatabases_Restore": { + "$ref": "./examples/autonomousDatabase_restore.json" + }, + "Perform restore action on Autonomous Database": { + "$ref": "./examples/autonomousDatabase_restore.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/shrink": { + "post": { + "operationId": "AutonomousDatabases_Shrink", + "tags": [ + "AutonomousDatabases" + ], + "description": "This operation shrinks the current allocated storage down to the current actual used data storage.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "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": { + "Perform shrink action on Autonomous Database": { + "$ref": "./examples/autonomousDatabase_shrink.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/switchover": { + "post": { + "operationId": "AutonomousDatabases_Switchover", + "tags": [ + "AutonomousDatabases" + ], + "description": "Perform switchover action on Autonomous Database", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "autonomousdatabasename", + "in": "path", + "description": "The database name.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/PeerDbDetails" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "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": { + "AutonomousDatabases_Switchover": { + "$ref": "./examples/autonomousDatabase_switchover.json" + }, + "Perform switchover action on Autonomous Database": { + "$ref": "./examples/autonomousDatabase_switchover.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures": { + "get": { + "operationId": "CloudExadataInfrastructures_ListByResourceGroup", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "List CloudExadataInfrastructure 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/CloudExadataInfrastructureListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Exadata Infrastructure by resource group": { + "$ref": "./examples/exaInfra_listByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures/{cloudexadatainfrastructurename}": { + "get": { + "operationId": "CloudExadataInfrastructures_Get", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "Get a CloudExadataInfrastructure", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructure" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Exadata Infrastructure": { + "$ref": "./examples/exaInfra_get.json" + } + } + }, + "put": { + "operationId": "CloudExadataInfrastructures_CreateOrUpdate", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "Create a CloudExadataInfrastructure", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructure" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CloudExadataInfrastructure' update operation succeeded", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructure" + } + }, + "201": { + "description": "Resource 'CloudExadataInfrastructure' create operation succeeded", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructure" + }, + "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": { + "Create Exadata Infrastructure": { + "$ref": "./examples/exaInfra_create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "CloudExadataInfrastructures_Update", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "Update a CloudExadataInfrastructure", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructureUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructure" + } + }, + "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": { + "Patch Exadata Infrastructure": { + "$ref": "./examples/exaInfra_patch.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "CloudExadataInfrastructures_Delete", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "Delete a CloudExadataInfrastructure", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "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 Exadata Infrastructure": { + "$ref": "./examples/exaInfra_delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures/{cloudexadatainfrastructurename}/addStorageCapacity": { + "post": { + "operationId": "CloudExadataInfrastructures_AddStorageCapacity", + "tags": [ + "CloudExadataInfrastructures" + ], + "description": "Perform add storage capacity on exadata infra", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudExadataInfrastructure" + } + }, + "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": { + "Perform add storage capacity on exadata infra": { + "$ref": "./examples/exaInfra_addStorageCapacity.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures/{cloudexadatainfrastructurename}/dbServers": { + "get": { + "operationId": "DbServers_ListByCloudExadataInfrastructure", + "tags": [ + "DbServers" + ], + "description": "List DbServer resources by CloudExadataInfrastructure", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbServerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List DbServers by Exadata Infrastructure": { + "$ref": "./examples/dbServers_listByParent.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures/{cloudexadatainfrastructurename}/dbServers/{dbserverocid}": { + "get": { + "operationId": "DbServers_Get", + "tags": [ + "DbServers" + ], + "description": "Get a DbServer", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudexadatainfrastructurename", + "in": "path", + "description": "CloudExadataInfrastructure name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "dbserverocid", + "in": "path", + "description": "DbServer OCID.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbServer" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get DbServer by parent": { + "$ref": "./examples/dbServers_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters": { + "get": { + "operationId": "CloudVmClusters_ListByResourceGroup", + "tags": [ + "CloudVmClusters" + ], + "description": "List CloudVmCluster 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/CloudVmClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List VM Clusters by resource group": { + "$ref": "./examples/vmClusters_listByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}": { + "get": { + "operationId": "CloudVmClusters_Get", + "tags": [ + "CloudVmClusters" + ], + "description": "Get a CloudVmCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudVmCluster" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get VM Cluster": { + "$ref": "./examples/vmClusters_get.json" + } + } + }, + "put": { + "operationId": "CloudVmClusters_CreateOrUpdate", + "tags": [ + "CloudVmClusters" + ], + "description": "Create a CloudVmCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudVmCluster" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CloudVmCluster' update operation succeeded", + "schema": { + "$ref": "#/definitions/CloudVmCluster" + } + }, + "201": { + "description": "Resource 'CloudVmCluster' create operation succeeded", + "schema": { + "$ref": "#/definitions/CloudVmCluster" + }, + "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": { + "Create VM Cluster": { + "$ref": "./examples/vmClusters_create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "CloudVmClusters_Update", + "tags": [ + "CloudVmClusters" + ], + "description": "Update a CloudVmCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudVmClusterUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudVmCluster" + } + }, + "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": { + "Patch VM Cluster": { + "$ref": "./examples/vmClusters_patch.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "CloudVmClusters_Delete", + "tags": [ + "CloudVmClusters" + ], + "description": "Delete a CloudVmCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "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 VM Cluster": { + "$ref": "./examples/vmClusters_delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/addVms": { + "post": { + "operationId": "CloudVmClusters_AddVms", + "tags": [ + "CloudVmClusters" + ], + "description": "Add VMs to the VM Cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/AddRemoveDbNode" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudVmCluster" + } + }, + "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": { + "Add VMs to VM Cluster": { + "$ref": "./examples/vmClusters_addVms.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/dbNodes": { + "get": { + "operationId": "DbNodes_ListByCloudVmCluster", + "tags": [ + "DbNodes" + ], + "description": "List DbNode resources by CloudVmCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbNodeListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List DbNodes by VM Cluster": { + "$ref": "./examples/dbNodes_listByParent.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/dbNodes/{dbnodeocid}": { + "get": { + "operationId": "DbNodes_Get", + "tags": [ + "DbNodes" + ], + "description": "Get a DbNode", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "dbnodeocid", + "in": "path", + "description": "DbNode OCID.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbNode" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get DbNode": { + "$ref": "./examples/dbNodes_get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/dbNodes/{dbnodeocid}/action": { + "post": { + "operationId": "DbNodes_Action", + "tags": [ + "DbNodes" + ], + "description": "VM actions on DbNode of VM Cluster by the provided filter", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "dbnodeocid", + "in": "path", + "description": "DbNode OCID.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DbNodeAction" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DbNode" + } + }, + "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": { + "DbNodes_Action": { + "$ref": "./examples/dbNodes_action.json" + }, + "VM actions on DbNodes of VM Cluster": { + "$ref": "./examples/dbNodes_action.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/listPrivateIpAddresses": { + "post": { + "operationId": "CloudVmClusters_ListPrivateIpAddresses", + "tags": [ + "CloudVmClusters" + ], + "description": "List Private IP Addresses by the provided filter", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateIpAddressesFilter" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateIpAddressProperties" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Private IP Addresses for VM Cluster": { + "$ref": "./examples/vmClusters_listPrivateIpAddresses.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/removeVms": { + "post": { + "operationId": "CloudVmClusters_RemoveVms", + "tags": [ + "CloudVmClusters" + ], + "description": "Remove VMs from the VM Cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/AddRemoveDbNode" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudVmCluster" + } + }, + "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": { + "Remove VMs from VM Cluster": { + "$ref": "./examples/vmClusters_removeVms.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/virtualNetworkAddresses": { + "get": { + "operationId": "VirtualNetworkAddresses_ListByCloudVmCluster", + "tags": [ + "VirtualNetworkAddresses" + ], + "description": "List VirtualNetworkAddress resources by CloudVmCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualNetworkAddressListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Virtual Network Addresses by VM Cluster": { + "$ref": "./examples/virtualNetworkAddresses_listByParent.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/virtualNetworkAddresses/{virtualnetworkaddressname}": { + "get": { + "operationId": "VirtualNetworkAddresses_Get", + "tags": [ + "VirtualNetworkAddresses" + ], + "description": "Get a VirtualNetworkAddress", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "virtualnetworkaddressname", + "in": "path", + "description": "Virtual IP address hostname.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": ".*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualNetworkAddress" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Virtual Network Address": { + "$ref": "./examples/virtualNetworkAddresses_get.json" + } + } + }, + "put": { + "operationId": "VirtualNetworkAddresses_CreateOrUpdate", + "tags": [ + "VirtualNetworkAddresses" + ], + "description": "Create a VirtualNetworkAddress", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "virtualnetworkaddressname", + "in": "path", + "description": "Virtual IP address hostname.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": ".*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkAddress" + } + } + ], + "responses": { + "200": { + "description": "Resource 'VirtualNetworkAddress' update operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualNetworkAddress" + } + }, + "201": { + "description": "Resource 'VirtualNetworkAddress' create operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualNetworkAddress" + }, + "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": { + "Create Virtual Network Address": { + "$ref": "./examples/virtualNetworkAddresses_create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VirtualNetworkAddresses_Delete", + "tags": [ + "VirtualNetworkAddresses" + ], + "description": "Delete a VirtualNetworkAddress", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudvmclustername", + "in": "path", + "description": "CloudVmCluster name", + "required": true, + "type": "string", + "pattern": ".*" + }, + { + "name": "virtualnetworkaddressname", + "in": "path", + "description": "Virtual IP address hostname.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": ".*" + } + ], + "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 Virtual Network Address": { + "$ref": "./examples/virtualNetworkAddresses_delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "ActivationLinks": { + "type": "object", + "description": "Activation Links model", + "properties": { + "newCloudAccountActivationLink": { + "type": "string", + "description": "New Cloud Account Activation Link", + "readOnly": true + }, + "existingCloudAccountActivationLink": { + "type": "string", + "description": "Existing Cloud Account Activation Link", + "readOnly": true + } + } + }, + "AddRemoveDbNode": { + "type": "object", + "description": "Add/Remove (Virtual Machine) DbNode model", + "properties": { + "dbServers": { + "type": "array", + "description": "Db servers ocids", + "items": { + "$ref": "#/definitions/Ocid" + } + } + }, + "required": [ + "dbServers" + ] + }, + "AddSubscriptionOperationState": { + "type": "string", + "description": "Add Subscription Operation state enum", + "enum": [ + "Succeeded", + "Updating", + "Failed" + ], + "x-ms-enum": { + "name": "AddSubscriptionOperationState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Succeeded - State when Add Subscription operation succeeded" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Updating - State when Add Subscription operation is being Updated" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed - State when Add Subscription operation failed" + } + ] + }, + "readOnly": true + }, + "AllConnectionStringType": { + "type": "object", + "description": "The connection string profile to allow clients to group, filter and select connection string values based on structured metadata.", + "properties": { + "high": { + "type": "string", + "description": "The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + }, + "low": { + "type": "string", + "description": "The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + }, + "medium": { + "type": "string", + "description": "The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + } + } + }, + "ApexDetailsType": { + "type": "object", + "description": "Information about Oracle APEX Application Development.", + "properties": { + "apexVersion": { + "type": "string", + "description": "The Oracle APEX Application Development version." + }, + "ordsVersion": { + "type": "string", + "description": "The Oracle REST Data Services (ORDS) version." + } + } + }, + "AutonomousDatabase": { + "type": "object", + "description": "Autonomous Database resource model.", + "properties": { + "properties": { + "$ref": "#/definitions/AutonomousDatabaseBaseProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "AutonomousDatabaseBackup": { + "type": "object", + "description": "AutonomousDatabaseBackup resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/AutonomousDatabaseBackupProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AutonomousDatabaseBackupLifecycleState": { + "type": "string", + "description": "Autonomous database backup lifecycle state enum", + "enum": [ + "Creating", + "Active", + "Deleting", + "Failed", + "Updating" + ], + "x-ms-enum": { + "name": "AutonomousDatabaseBackupLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Creating", + "value": "Creating", + "description": "AutonomousDatabase backup is creating" + }, + { + "name": "Active", + "value": "Active", + "description": "AutonomousDatabase backup is active" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "AutonomousDatabase backup is deleting" + }, + { + "name": "Failed", + "value": "Failed", + "description": "AutonomousDatabase backup is failed" + }, + { + "name": "Updating", + "value": "Updating", + "description": "AutonomousDatabase backup is updating" + } + ] + } + }, + "AutonomousDatabaseBackupListResult": { + "type": "object", + "description": "The response of a AutonomousDatabaseBackup list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AutonomousDatabaseBackup items on this page", + "items": { + "$ref": "#/definitions/AutonomousDatabaseBackup" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AutonomousDatabaseBackupProperties": { + "type": "object", + "description": "AutonomousDatabaseBackup resource model", + "properties": { + "autonomousDatabaseOcid": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the Autonomous Database.", + "readOnly": true + }, + "databaseSizeInTbs": { + "type": "number", + "format": "double", + "description": "The size of the database in terabytes at the time the backup was taken.", + "readOnly": true + }, + "dbVersion": { + "type": "string", + "description": "A valid Oracle Database version for Autonomous Database.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The user-friendly name for the backup. The name does not have to be unique.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the Autonomous Database backup.", + "readOnly": true + }, + "isAutomatic": { + "type": "boolean", + "description": "Indicates whether the backup is user-initiated or automatic.", + "readOnly": true + }, + "isRestorable": { + "type": "boolean", + "description": "Indicates whether the backup can be used to restore the associated Autonomous Database.", + "readOnly": true + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycle state.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/AutonomousDatabaseBackupLifecycleState", + "description": "The current state of the backup.", + "readOnly": true + }, + "retentionPeriodInDays": { + "type": "integer", + "format": "int32", + "description": "Retention period, in days, for long-term backups.", + "minimum": 60, + "maximum": 3650, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "sizeInTbs": { + "type": "number", + "format": "double", + "description": "The backup size in terabytes (TB).", + "readOnly": true + }, + "timeAvailableTil": { + "type": "string", + "format": "date-time", + "description": "Timestamp until when the backup will be available.", + "readOnly": true + }, + "timeStarted": { + "type": "string", + "description": "The date and time the backup started.", + "readOnly": true + }, + "timeEnded": { + "type": "string", + "description": "The date and time the backup completed.", + "readOnly": true + }, + "backupType": { + "$ref": "#/definitions/AutonomousDatabaseBackupType", + "description": "The type of backup.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/AzureResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + } + } + }, + "AutonomousDatabaseBackupType": { + "type": "string", + "description": "Autonomous database backup type enum", + "enum": [ + "Incremental", + "Full", + "LongTerm" + ], + "x-ms-enum": { + "name": "AutonomousDatabaseBackupType", + "modelAsString": true, + "values": [ + { + "name": "Incremental", + "value": "Incremental", + "description": "Incremental backup" + }, + { + "name": "Full", + "value": "Full", + "description": "Full backup" + }, + { + "name": "LongTerm", + "value": "LongTerm", + "description": "LongTerm backup" + } + ] + } + }, + "AutonomousDatabaseBackupUpdate": { + "type": "object", + "description": "The type used for update operations of the AutonomousDatabaseBackup.", + "properties": { + "properties": { + "$ref": "#/definitions/AutonomousDatabaseBackupUpdateProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + } + }, + "AutonomousDatabaseBackupUpdateProperties": { + "type": "object", + "description": "The updatable properties of the AutonomousDatabaseBackup.", + "properties": { + "retentionPeriodInDays": { + "type": "integer", + "format": "int32", + "description": "Retention period, in days, for long-term backups.", + "minimum": 60, + "maximum": 3650, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + } + }, + "AutonomousDatabaseBaseProperties": { + "type": "object", + "description": "Autonomous Database base resource model.", + "properties": { + "adminPassword": { + "$ref": "#/definitions/Password", + "description": "Admin password.", + "minLength": 12, + "maxLength": 30, + "x-ms-mutability": [ + "update", + "create" + ] + }, + "dataBaseType": { + "$ref": "#/definitions/DataBaseType", + "description": "Database type to be created.", + "x-ms-mutability": [ + "create" + ] + }, + "autonomousMaintenanceScheduleType": { + "$ref": "#/definitions/AutonomousMaintenanceScheduleType", + "description": "The maintenance schedule type of the Autonomous Database Serverless.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "characterSet": { + "type": "string", + "description": "The character set for the autonomous database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "computeCount": { + "type": "number", + "format": "float", + "description": "The compute amount (CPUs) available to the database.", + "minimum": 0.1, + "maximum": 512, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "computeModel": { + "$ref": "#/definitions/ComputeModel", + "description": "The compute model of the Autonomous Database.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "cpuCoreCount": { + "type": "integer", + "format": "int32", + "description": "The number of CPU cores to be made available to the database.", + "minimum": 1, + "maximum": 128, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "customerContacts": { + "type": "array", + "description": "Customer Contacts.", + "items": { + "$ref": "#/definitions/CustomerContact" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "dataStorageSizeInTbs": { + "type": "integer", + "format": "int32", + "description": "The quantity of data in the database, in terabytes.", + "minimum": 1, + "maximum": 384, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "dataStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The size, in gigabytes, of the data volume that will be created and attached to the database.", + "minimum": 20, + "maximum": 393216, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "dbVersion": { + "type": "string", + "description": "A valid Oracle Database version for Autonomous Database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "dbWorkload": { + "$ref": "#/definitions/WorkloadType", + "description": "The Autonomous Database workload type", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "displayName": { + "type": "string", + "description": "The user-friendly name for the Autonomous Database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isAutoScalingEnabled": { + "type": "boolean", + "description": "Indicates if auto scaling is enabled for the Autonomous Database CPU core count.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isAutoScalingForStorageEnabled": { + "type": "boolean", + "description": "Indicates if auto scaling is enabled for the Autonomous Database storage.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "peerDbIds": { + "type": "array", + "description": "The list of [OCIDs](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for Autonomous Database Serverless instances, standby databases located in the same region as the source primary database do not have OCIDs.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "peerDbId": { + "type": "string", + "description": "The database OCID of the Disaster Recovery peer database, which is located in a different region from the current peer database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "update" + ] + }, + "isLocalDataGuardEnabled": { + "type": "boolean", + "description": "Indicates whether the Autonomous Database has local or called in-region Data Guard enabled.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isRemoteDataGuardEnabled": { + "type": "boolean", + "description": "Indicates whether the Autonomous Database has Cross Region Data Guard enabled.", + "readOnly": true + }, + "localDisasterRecoveryType": { + "$ref": "#/definitions/DisasterRecoveryType", + "description": "Indicates the local disaster recovery (DR) type of the Autonomous Database Serverless instance.Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover.Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover.", + "readOnly": true + }, + "localStandbyDb": { + "$ref": "#/definitions/AutonomousDatabaseStandbySummary", + "description": "Local Autonomous Disaster Recovery standby database details.", + "readOnly": true + }, + "failedDataRecoveryInSeconds": { + "type": "integer", + "format": "int32", + "description": "Indicates the number of seconds of data loss for a Data Guard failover.", + "readOnly": true + }, + "isMtlsConnectionRequired": { + "type": "boolean", + "description": "Specifies if the Autonomous Database requires mTLS connections.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isPreviewVersionWithServiceTermsAccepted": { + "type": "boolean", + "description": "Specifies if the Autonomous Database preview version is being provisioned.", + "x-ms-mutability": [ + "create" + ] + }, + "licenseModel": { + "$ref": "#/definitions/LicenseModel", + "description": "The Oracle license model that applies to the Oracle Autonomous Database. The default is LICENSE_INCLUDED.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "ncharacterSet": { + "type": "string", + "description": "The character set for the Autonomous Database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycle state.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/AzureResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/AutonomousDatabaseLifecycleState", + "description": "Views lifecycleState", + "readOnly": true + }, + "scheduledOperations": { + "$ref": "#/definitions/ScheduledOperationsType", + "description": "The list of scheduled operations.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "privateEndpointIp": { + "type": "string", + "description": "The private endpoint Ip address for the resource.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "privateEndpointLabel": { + "type": "string", + "description": "The resource's private endpoint label.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ociUrl": { + "type": "string", + "description": "HTTPS link to OCI resources exposed to Azure Customer via Azure Interface.", + "readOnly": true + }, + "subnetId": { + "$ref": "#/definitions/SubnetId", + "description": "Client subnet", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "vnetId": { + "$ref": "#/definitions/VnetId", + "description": "VNET for network connectivity", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "The date and time that the database was created.", + "readOnly": true + }, + "timeMaintenanceBegin": { + "type": "string", + "format": "date-time", + "description": "The date and time when maintenance will begin.", + "readOnly": true + }, + "timeMaintenanceEnd": { + "type": "string", + "format": "date-time", + "description": "The date and time when maintenance will end.", + "readOnly": true + }, + "actualUsedDataStorageSizeInTbs": { + "type": "number", + "format": "double", + "description": "The current amount of storage in use for user and system data, in terabytes (TB).", + "readOnly": true + }, + "allocatedStorageSizeInTbs": { + "type": "number", + "format": "double", + "description": "The amount of storage currently allocated for the database tables and billed for, rounded up.", + "readOnly": true + }, + "apexDetails": { + "$ref": "#/definitions/ApexDetailsType", + "description": "Information about Oracle APEX Application Development.", + "readOnly": true + }, + "availableUpgradeVersions": { + "type": "array", + "description": "List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "connectionStrings": { + "$ref": "#/definitions/ConnectionStringType", + "description": "The connection string used to connect to the Autonomous Database.", + "readOnly": true + }, + "connectionUrls": { + "$ref": "#/definitions/ConnectionUrlType", + "description": "The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN. ", + "readOnly": true + }, + "dataSafeStatus": { + "$ref": "#/definitions/DataSafeStatusType", + "description": "Status of the Data Safe registration for this Autonomous Database.", + "readOnly": true + }, + "databaseEdition": { + "$ref": "#/definitions/DatabaseEditionType", + "description": "The Oracle Database Edition that applies to the Autonomous databases.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "autonomousDatabaseId": { + "$ref": "#/definitions/AutonomousDatabaseId", + "description": "Autonomous Database ID", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "inMemoryAreaInGbs": { + "type": "integer", + "format": "int32", + "description": "The area assigned to In-Memory tables in Autonomous Database.", + "readOnly": true + }, + "nextLongTermBackupTimeStamp": { + "type": "string", + "format": "date-time", + "description": "The date and time when the next long-term backup would be created.", + "readOnly": true + }, + "longTermBackupSchedule": { + "$ref": "#/definitions/LongTermBackUpScheduleDetails", + "description": "Details for the long-term backup schedule.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "isPreview": { + "type": "boolean", + "description": "Indicates if the Autonomous Database version is a preview version.", + "readOnly": true + }, + "localAdgAutoFailoverMaxDataLossLimit": { + "type": "integer", + "format": "int32", + "description": "Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard", + "minimum": 0, + "maximum": 3600, + "x-ms-mutability": [ + "read", + "update" + ] + }, + "memoryPerOracleComputeUnitInGbs": { + "type": "integer", + "format": "int32", + "description": "The amount of memory (in GBs) enabled per ECPU or OCPU.", + "readOnly": true + }, + "openMode": { + "$ref": "#/definitions/OpenModeType", + "description": "Indicates the Autonomous Database mode.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "operationsInsightsStatus": { + "$ref": "#/definitions/OperationsInsightsStatusType", + "description": "Status of Operations Insights for this Autonomous Database.", + "readOnly": true + }, + "permissionLevel": { + "$ref": "#/definitions/PermissionLevelType", + "description": "The Autonomous Database permission level.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "privateEndpoint": { + "type": "string", + "description": "The private endpoint for the resource.", + "readOnly": true + }, + "provisionableCpus": { + "type": "array", + "description": "An array of CPU values that an Autonomous Database can be scaled to.", + "items": { + "type": "integer", + "format": "int32" + }, + "readOnly": true + }, + "role": { + "$ref": "#/definitions/RoleType", + "description": "The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "serviceConsoleUrl": { + "type": "string", + "description": "The URL of the Service Console for the Autonomous Database.", + "minLength": 10, + "maxLength": 255, + "readOnly": true + }, + "sqlWebDeveloperUrl": { + "type": "string", + "description": "The SQL Web Developer URL for the Oracle Autonomous Database.", + "minLength": 10, + "maxLength": 2048, + "readOnly": true + }, + "supportedRegionsToCloneTo": { + "type": "array", + "description": "The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database.", + "maxItems": 50, + "items": { + "type": "string" + }, + "readOnly": true + }, + "timeDataGuardRoleChanged": { + "type": "string", + "description": "The date and time the Autonomous Data Guard role was switched for the Autonomous Database.", + "readOnly": true + }, + "timeDeletionOfFreeAutonomousDatabase": { + "type": "string", + "description": "The date and time the Always Free database will be automatically deleted because of inactivity.", + "readOnly": true + }, + "timeLocalDataGuardEnabled": { + "type": "string", + "description": "The date and time that Autonomous Data Guard was enabled for an Autonomous Database where the standby was provisioned in the same region as the primary database.", + "readOnly": true + }, + "timeOfLastFailover": { + "type": "string", + "description": "The timestamp of the last failover operation.", + "readOnly": true + }, + "timeOfLastRefresh": { + "type": "string", + "description": "The date and time when last refresh happened.", + "readOnly": true + }, + "timeOfLastRefreshPoint": { + "type": "string", + "description": "The refresh point timestamp (UTC).", + "readOnly": true + }, + "timeOfLastSwitchover": { + "type": "string", + "description": "The timestamp of the last switchover operation for the Autonomous Database.", + "readOnly": true + }, + "timeReclamationOfFreeAutonomousDatabase": { + "type": "string", + "description": "The date and time the Always Free database will be stopped because of inactivity.", + "readOnly": true + }, + "usedDataStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The storage space consumed by Autonomous Database in GBs.", + "readOnly": true + }, + "usedDataStorageSizeInTbs": { + "type": "integer", + "format": "int32", + "description": "The amount of storage that has been used, in terabytes.", + "readOnly": true + }, + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "Database ocid", + "readOnly": true + }, + "backupRetentionPeriodInDays": { + "type": "integer", + "format": "int32", + "description": "Retention period, in days, for long-term backups", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "whitelistedIps": { + "type": "array", + "description": "The client IP access control list (ACL). This is an array of CIDR notations and/or IP addresses. Values should be separate strings, separated by commas. Example: ['1.1.1.1','1.1.1.0/24','1.1.2.25']", + "items": { + "$ref": "#/definitions/aclString" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + }, + "discriminator": "dataBaseType", + "required": [ + "dataBaseType" + ] + }, + "AutonomousDatabaseCharacterSet": { + "type": "object", + "description": "AutonomousDatabaseCharacterSets resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/AutonomousDatabaseCharacterSetProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AutonomousDatabaseCharacterSetListResult": { + "type": "object", + "description": "The response of a AutonomousDatabaseCharacterSet list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AutonomousDatabaseCharacterSet items on this page", + "items": { + "$ref": "#/definitions/AutonomousDatabaseCharacterSet" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AutonomousDatabaseCharacterSetProperties": { + "type": "object", + "description": "AutonomousDatabaseCharacterSet resource model", + "properties": { + "characterSet": { + "type": "string", + "description": "The Oracle Autonomous Database supported character sets.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + } + } + }, + "AutonomousDatabaseCloneProperties": { + "type": "object", + "description": "Autonomous Database clone resource model.", + "properties": { + "source": { + "$ref": "#/definitions/SourceType", + "description": "The source of the database.", + "x-ms-mutability": [ + "create" + ] + }, + "sourceId": { + "$ref": "#/definitions/AutonomousDatabaseId", + "description": "The Azure ID of the Autonomous Database that was cloned to create the current Autonomous Database.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "cloneType": { + "$ref": "#/definitions/CloneType", + "description": "The Autonomous Database clone type.", + "x-ms-mutability": [ + "create" + ] + }, + "isReconnectCloneEnabled": { + "type": "boolean", + "description": "Indicates if the refreshable clone can be reconnected to its source database.", + "readOnly": true + }, + "isRefreshableClone": { + "type": "boolean", + "description": "Indicates if the Autonomous Database is a refreshable clone.", + "readOnly": true + }, + "refreshableModel": { + "$ref": "#/definitions/RefreshableModelType", + "description": "The refresh mode of the clone.", + "x-ms-mutability": [ + "create" + ] + }, + "refreshableStatus": { + "$ref": "#/definitions/RefreshableStatusType", + "description": "The refresh status of the clone.", + "readOnly": true + }, + "timeUntilReconnectCloneEnabled": { + "type": "string", + "description": "The time and date as an RFC3339 formatted string, e.g., 2022-01-01T12:00:00.000Z, to set the limit for a refreshable clone to be reconnected to its source database.", + "x-ms-mutability": [ + "read", + "update" + ] + } + }, + "required": [ + "sourceId", + "cloneType" + ], + "allOf": [ + { + "$ref": "#/definitions/AutonomousDatabaseBaseProperties" + } + ], + "x-ms-discriminator-value": "Clone" + }, + "AutonomousDatabaseId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Oracle.Database/autonomousDatabases" + } + ] + } + }, + "AutonomousDatabaseLifecycleState": { + "type": "string", + "description": "Autonomous database lifecycle state enum", + "enum": [ + "Provisioning", + "Available", + "Stopping", + "Stopped", + "Starting", + "Terminating", + "Terminated", + "Unavailable", + "RestoreInProgress", + "RestoreFailed", + "BackupInProgress", + "ScaleInProgress", + "AvailableNeedsAttention", + "Updating", + "MaintenanceInProgress", + "Restarting", + "Recreating", + "RoleChangeInProgress", + "Upgrading", + "Inaccessible", + "Standby" + ], + "x-ms-enum": { + "name": "AutonomousDatabaseLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Indicates that resource in Provisioning state" + }, + { + "name": "Available", + "value": "Available", + "description": "Indicates that resource in Available state" + }, + { + "name": "Stopping", + "value": "Stopping", + "description": "Indicates that resource in Stopping state" + }, + { + "name": "Stopped", + "value": "Stopped", + "description": "Indicates that resource in Stopped state" + }, + { + "name": "Starting", + "value": "Starting", + "description": "Indicates that resource in Starting state" + }, + { + "name": "Terminating", + "value": "Terminating", + "description": "Indicates that resource in Terminating state" + }, + { + "name": "Terminated", + "value": "Terminated", + "description": "Indicates that resource in Terminated state" + }, + { + "name": "Unavailable", + "value": "Unavailable", + "description": "Indicates that resource in Unavailable state" + }, + { + "name": "RestoreInProgress", + "value": "RestoreInProgress", + "description": "Indicates that resource in RestoreInProgress state" + }, + { + "name": "RestoreFailed", + "value": "RestoreFailed", + "description": "Indicates that resource in RestoreFailed state" + }, + { + "name": "BackupInProgress", + "value": "BackupInProgress", + "description": "Indicates that resource in BackupInProgress state" + }, + { + "name": "ScaleInProgress", + "value": "ScaleInProgress", + "description": "Indicates that resource in ScaleInProgress state" + }, + { + "name": "AvailableNeedsAttention", + "value": "AvailableNeedsAttention", + "description": "Indicates that resource is available but needs attention" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Indicates that resource in Updating state" + }, + { + "name": "MaintenanceInProgress", + "value": "MaintenanceInProgress", + "description": "Indicates that resource maintenance in progress state" + }, + { + "name": "Restarting", + "value": "Restarting", + "description": "Indicates that resource in Restarting state" + }, + { + "name": "Recreating", + "value": "Recreating", + "description": "Indicates that resource in Recreating state" + }, + { + "name": "RoleChangeInProgress", + "value": "RoleChangeInProgress", + "description": "Indicates that resource role change in progress state" + }, + { + "name": "Upgrading", + "value": "Upgrading", + "description": "Indicates that resource in Upgrading state" + }, + { + "name": "Inaccessible", + "value": "Inaccessible", + "description": "IIndicates that resource in Inaccessible state" + }, + { + "name": "Standby", + "value": "Standby", + "description": "Indicates that resource in Standby state" + } + ] + } + }, + "AutonomousDatabaseListResult": { + "type": "object", + "description": "The response of a AutonomousDatabase list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AutonomousDatabase items on this page", + "items": { + "$ref": "#/definitions/AutonomousDatabase" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AutonomousDatabaseNationalCharacterSet": { + "type": "object", + "description": "AutonomousDatabaseNationalCharacterSets resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/AutonomousDatabaseNationalCharacterSetProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AutonomousDatabaseNationalCharacterSetListResult": { + "type": "object", + "description": "The response of a AutonomousDatabaseNationalCharacterSet list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AutonomousDatabaseNationalCharacterSet items on this page", + "items": { + "$ref": "#/definitions/AutonomousDatabaseNationalCharacterSet" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AutonomousDatabaseNationalCharacterSetProperties": { + "type": "object", + "description": "AutonomousDatabaseNationalCharacterSet resource model", + "properties": { + "characterSet": { + "type": "string", + "description": "The Oracle Autonomous Database supported national character sets.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + } + } + }, + "AutonomousDatabaseProperties": { + "type": "object", + "description": "Autonomous Database resource model.", + "allOf": [ + { + "$ref": "#/definitions/AutonomousDatabaseBaseProperties" + } + ], + "x-ms-discriminator-value": "Regular" + }, + "AutonomousDatabaseStandbySummary": { + "type": "object", + "description": "Autonomous Disaster Recovery standby database details.", + "properties": { + "lagTimeInSeconds": { + "type": "integer", + "format": "int32", + "description": "The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover." + }, + "lifecycleState": { + "$ref": "#/definitions/AutonomousDatabaseLifecycleState", + "description": "The current state of the Autonomous Database." + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycle state." + }, + "timeDataGuardRoleChanged": { + "type": "string", + "description": "The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database." + }, + "timeDisasterRecoveryRoleChanged": { + "type": "string", + "description": "The date and time the Disaster Recovery role was switched for the standby Autonomous Database." + } + } + }, + "AutonomousDatabaseUpdate": { + "type": "object", + "description": "The type used for update operations of the AutonomousDatabase.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/AutonomousDatabaseUpdateProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + } + }, + "AutonomousDatabaseUpdateProperties": { + "type": "object", + "description": "The updatable properties of the AutonomousDatabase.", + "properties": { + "adminPassword": { + "$ref": "#/definitions/Password", + "description": "Admin password.", + "minLength": 12, + "maxLength": 30, + "x-ms-mutability": [ + "update", + "create" + ] + }, + "autonomousMaintenanceScheduleType": { + "$ref": "#/definitions/AutonomousMaintenanceScheduleType", + "description": "The maintenance schedule type of the Autonomous Database Serverless.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "computeCount": { + "type": "number", + "format": "float", + "description": "The compute amount (CPUs) available to the database.", + "minimum": 0.1, + "maximum": 512, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "cpuCoreCount": { + "type": "integer", + "format": "int32", + "description": "The number of CPU cores to be made available to the database.", + "minimum": 1, + "maximum": 128, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "customerContacts": { + "type": "array", + "description": "Customer Contacts.", + "items": { + "$ref": "#/definitions/CustomerContact" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "dataStorageSizeInTbs": { + "type": "integer", + "format": "int32", + "description": "The quantity of data in the database, in terabytes.", + "minimum": 1, + "maximum": 384, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "dataStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The size, in gigabytes, of the data volume that will be created and attached to the database.", + "minimum": 20, + "maximum": 393216, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "displayName": { + "type": "string", + "description": "The user-friendly name for the Autonomous Database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isAutoScalingEnabled": { + "type": "boolean", + "description": "Indicates if auto scaling is enabled for the Autonomous Database CPU core count.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isAutoScalingForStorageEnabled": { + "type": "boolean", + "description": "Indicates if auto scaling is enabled for the Autonomous Database storage.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "peerDbId": { + "type": "string", + "description": "The database OCID of the Disaster Recovery peer database, which is located in a different region from the current peer database.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "update" + ] + }, + "isLocalDataGuardEnabled": { + "type": "boolean", + "description": "Indicates whether the Autonomous Database has local or called in-region Data Guard enabled.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isMtlsConnectionRequired": { + "type": "boolean", + "description": "Specifies if the Autonomous Database requires mTLS connections.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "licenseModel": { + "$ref": "#/definitions/LicenseModel", + "description": "The Oracle license model that applies to the Oracle Autonomous Database. The default is LICENSE_INCLUDED.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "scheduledOperations": { + "$ref": "#/definitions/ScheduledOperationsTypeUpdate", + "description": "The list of scheduled operations.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "databaseEdition": { + "$ref": "#/definitions/DatabaseEditionType", + "description": "The Oracle Database Edition that applies to the Autonomous databases.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "longTermBackupSchedule": { + "$ref": "#/definitions/LongTermBackUpScheduleDetails", + "description": "Details for the long-term backup schedule.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "localAdgAutoFailoverMaxDataLossLimit": { + "type": "integer", + "format": "int32", + "description": "Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard", + "minimum": 0, + "maximum": 3600, + "x-ms-mutability": [ + "read", + "update" + ] + }, + "openMode": { + "$ref": "#/definitions/OpenModeType", + "description": "Indicates the Autonomous Database mode.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "permissionLevel": { + "$ref": "#/definitions/PermissionLevelType", + "description": "The Autonomous Database permission level.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "role": { + "$ref": "#/definitions/RoleType", + "description": "The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "backupRetentionPeriodInDays": { + "type": "integer", + "format": "int32", + "description": "Retention period, in days, for long-term backups", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "whitelistedIps": { + "type": "array", + "description": "The client IP access control list (ACL). This is an array of CIDR notations and/or IP addresses. Values should be separate strings, separated by commas. Example: ['1.1.1.1','1.1.1.0/24','1.1.2.25']", + "items": { + "$ref": "#/definitions/aclString" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + } + }, + "AutonomousDatabaseWalletFile": { + "type": "object", + "description": "Autonomous Database Wallet File resource model.", + "properties": { + "walletFiles": { + "type": "string", + "description": "The base64 encoded wallet files" + } + }, + "required": [ + "walletFiles" + ] + }, + "AutonomousDbVersion": { + "type": "object", + "description": "AutonomousDbVersion resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/AutonomousDbVersionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AutonomousDbVersionListResult": { + "type": "object", + "description": "The response of a AutonomousDbVersion list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AutonomousDbVersion items on this page", + "items": { + "$ref": "#/definitions/AutonomousDbVersion" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AutonomousDbVersionProperties": { + "type": "object", + "description": "AutonomousDbVersion resource model", + "properties": { + "version": { + "type": "string", + "description": "Supported Autonomous Db versions.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "dbWorkload": { + "$ref": "#/definitions/WorkloadType", + "description": "The Autonomous Database workload type", + "readOnly": true + }, + "isDefaultForFree": { + "type": "boolean", + "description": "True if this version of the Oracle Database software's default is free.", + "readOnly": true + }, + "isDefaultForPaid": { + "type": "boolean", + "description": "True if this version of the Oracle Database software's default is paid.", + "readOnly": true + }, + "isFreeTierEnabled": { + "type": "boolean", + "description": "True if this version of the Oracle Database software can be used for Always-Free Autonomous Databases.", + "readOnly": true + }, + "isPaidEnabled": { + "type": "boolean", + "description": "True if this version of the Oracle Database software has payments enabled.", + "readOnly": true + } + } + }, + "AutonomousMaintenanceScheduleType": { + "type": "string", + "description": "Autonomous database maintenance schedule type enum.", + "enum": [ + "Early", + "Regular" + ], + "x-ms-enum": { + "name": "AutonomousMaintenanceScheduleType", + "modelAsString": true, + "values": [ + { + "name": "Early", + "value": "Early", + "description": "Early maintenance schedule" + }, + { + "name": "Regular", + "value": "Regular", + "description": "Regular maintenance schedule" + } + ] + } + }, + "Azure.ResourceManager.ResourceProvisioningState": { + "type": "string", + "description": "The provisioning state of a resource type.", + "enum": [ + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ResourceProvisioningState", + "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." + } + ] + }, + "readOnly": true + }, + "AzureResourceProvisioningState": { + "type": "string", + "description": "Azure Resource Provisioning State enum", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning" + ], + "x-ms-enum": { + "name": "AzureResourceProvisioningState", + "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": "Indicates that resource in Provisioning state" + } + ] + }, + "readOnly": true + }, + "AzureSubscriptions": { + "type": "object", + "description": "Azure Subscriptions model", + "properties": { + "azureSubscriptionIds": { + "type": "array", + "description": "Azure Subscription Ids to be updated", + "items": { + "type": "string" + } + } + }, + "required": [ + "azureSubscriptionIds" + ] + }, + "CloneType": { + "type": "string", + "description": "Clone type enum", + "enum": [ + "Full", + "Metadata" + ], + "x-ms-enum": { + "name": "CloneType", + "modelAsString": true, + "values": [ + { + "name": "Full", + "value": "Full", + "description": "Full clone" + }, + { + "name": "Metadata", + "value": "Metadata", + "description": "Metadata only" + } + ] + } + }, + "CloudAccountDetails": { + "type": "object", + "description": "Cloud Account Details model", + "properties": { + "cloudAccountName": { + "type": "string", + "description": "Cloud Account name", + "readOnly": true + }, + "cloudAccountHomeRegion": { + "type": "string", + "description": "Cloud Account Home region", + "readOnly": true + } + } + }, + "CloudAccountProvisioningState": { + "type": "string", + "description": "CloudAccountProvisioningState enum", + "enum": [ + "Pending", + "Provisioning", + "Available" + ], + "x-ms-enum": { + "name": "CloudAccountProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Pending", + "value": "Pending", + "description": "Pending - Initial state when Oracle cloud account is not configured" + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Provisioning - State when Oracle cloud account is being provisioned" + }, + { + "name": "Available", + "value": "Available", + "description": "Available - State when Oracle cloud account cloud linking is complete and it is available" + } + ] + } + }, + "CloudExadataInfrastructure": { + "type": "object", + "description": "CloudExadataInfrastructure resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/CloudExadataInfrastructureProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "zones": { + "type": "array", + "description": "CloudExadataInfrastructure zones", + "items": { + "type": "string" + } + } + }, + "required": [ + "zones" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "CloudExadataInfrastructureId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Oracle.Database/cloudExadataInfrastructures" + } + ] + } + }, + "CloudExadataInfrastructureLifecycleState": { + "type": "string", + "description": "CloudExadataInfrastructureLifecycleState enum", + "enum": [ + "Provisioning", + "Available", + "Updating", + "Terminating", + "Terminated", + "MaintenanceInProgress", + "Failed" + ], + "x-ms-enum": { + "name": "CloudExadataInfrastructureLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Indicates that resource in Provisioning state" + }, + { + "name": "Available", + "value": "Available", + "description": "Indicates that resource in Available state" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Indicates that resource in Updating state" + }, + { + "name": "Terminating", + "value": "Terminating", + "description": "Indicates that resource in Terminating state" + }, + { + "name": "Terminated", + "value": "Terminated", + "description": "Indicates that resource in Terminated state" + }, + { + "name": "MaintenanceInProgress", + "value": "MaintenanceInProgress", + "description": "Indicates that resource maintenance in progress state" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Indicates that resource in Failed state" + } + ] + } + }, + "CloudExadataInfrastructureListResult": { + "type": "object", + "description": "The response of a CloudExadataInfrastructure list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CloudExadataInfrastructure items on this page", + "items": { + "$ref": "#/definitions/CloudExadataInfrastructure" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CloudExadataInfrastructureProperties": { + "type": "object", + "description": "CloudExadataInfrastructure resource model", + "properties": { + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "Exadata infra ocid", + "readOnly": true + }, + "computeCount": { + "type": "integer", + "format": "int32", + "description": "The number of compute servers for the cloud Exadata infrastructure.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "storageCount": { + "type": "integer", + "format": "int32", + "description": "The number of storage servers for the cloud Exadata infrastructure.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "totalStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The total storage allocated to the cloud Exadata infrastructure resource, in gigabytes (GB).", + "readOnly": true + }, + "availableStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The available storage can be allocated to the cloud Exadata infrastructure resource, in gigabytes (GB).", + "readOnly": true + }, + "timeCreated": { + "type": "string", + "description": "The date and time the cloud Exadata infrastructure resource was created.", + "readOnly": true + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycle state.", + "readOnly": true + }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "description": "maintenanceWindow property", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "estimatedPatchingTime": { + "$ref": "#/definitions/EstimatedPatchingTime", + "description": "The estimated total time required in minutes for all patching operations (database server, storage server, and network switch patching).", + "readOnly": true + }, + "customerContacts": { + "type": "array", + "description": "The list of customer email addresses that receive information from Oracle about the specified OCI Database service resource. Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. Up to 10 email addresses can be added to the customer contacts for a cloud Exadata infrastructure instance. ", + "items": { + "$ref": "#/definitions/CustomerContact" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "provisioningState": { + "$ref": "#/definitions/AzureResourceProvisioningState", + "description": "CloudExadataInfrastructure provisioning state", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/CloudExadataInfrastructureLifecycleState", + "description": "CloudExadataInfrastructure lifecycle state", + "readOnly": true + }, + "shape": { + "type": "string", + "description": "The model name of the cloud Exadata infrastructure resource.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ociUrl": { + "type": "string", + "format": "uri", + "description": "HTTPS link to OCI resources exposed to Azure Customer via Azure Interface.", + "readOnly": true + }, + "cpuCount": { + "type": "integer", + "format": "int32", + "description": "The total number of CPU cores allocated.", + "readOnly": true + }, + "maxCpuCount": { + "type": "integer", + "format": "int32", + "description": "The total number of CPU cores available.", + "readOnly": true + }, + "memorySizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The memory allocated in GBs.", + "readOnly": true + }, + "maxMemoryInGbs": { + "type": "integer", + "format": "int32", + "description": "The total memory available in GBs.", + "readOnly": true + }, + "dbNodeStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The local node storage to be allocated in GBs.", + "readOnly": true + }, + "maxDbNodeStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The total local node storage available in GBs.", + "readOnly": true + }, + "dataStorageSizeInTbs": { + "type": "number", + "format": "double", + "description": "The quantity of data in the database, in terabytes.", + "readOnly": true + }, + "maxDataStorageInTbs": { + "type": "number", + "format": "double", + "description": "The total available DATA disk group size.", + "readOnly": true + }, + "dbServerVersion": { + "type": "string", + "description": "The software version of the database servers (dom0) in the Exadata infrastructure.", + "readOnly": true + }, + "storageServerVersion": { + "type": "string", + "description": "The software version of the storage servers (cells) in the Exadata infrastructure.", + "readOnly": true + }, + "activatedStorageCount": { + "type": "integer", + "format": "int32", + "description": "The requested number of additional storage servers activated for the Exadata infrastructure.", + "readOnly": true + }, + "additionalStorageCount": { + "type": "integer", + "format": "int32", + "description": "The requested number of additional storage servers for the Exadata infrastructure.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The name for the Exadata infrastructure.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "lastMaintenanceRunId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the last maintenance run.", + "readOnly": true + }, + "nextMaintenanceRunId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the next maintenance run.", + "readOnly": true + }, + "monthlyDbServerVersion": { + "type": "string", + "description": "Monthly Db Server version", + "readOnly": true + }, + "monthlyStorageServerVersion": { + "type": "string", + "description": "Monthly Storage Server version", + "readOnly": true + } + }, + "required": [ + "shape", + "displayName" + ] + }, + "CloudExadataInfrastructureUpdate": { + "type": "object", + "description": "The type used for update operations of the CloudExadataInfrastructure.", + "properties": { + "zones": { + "type": "array", + "description": "CloudExadataInfrastructure zones", + "items": { + "type": "string" + } + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/CloudExadataInfrastructureUpdateProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + } + }, + "CloudExadataInfrastructureUpdateProperties": { + "type": "object", + "description": "The updatable properties of the CloudExadataInfrastructure.", + "properties": { + "computeCount": { + "type": "integer", + "format": "int32", + "description": "The number of compute servers for the cloud Exadata infrastructure.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "storageCount": { + "type": "integer", + "format": "int32", + "description": "The number of storage servers for the cloud Exadata infrastructure.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "description": "maintenanceWindow property", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "customerContacts": { + "type": "array", + "description": "The list of customer email addresses that receive information from Oracle about the specified OCI Database service resource. Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. Up to 10 email addresses can be added to the customer contacts for a cloud Exadata infrastructure instance. ", + "items": { + "$ref": "#/definitions/CustomerContact" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "displayName": { + "type": "string", + "description": "The name for the Exadata infrastructure.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + } + }, + "CloudVmCluster": { + "type": "object", + "description": "CloudVmCluster resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/CloudVmClusterProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "CloudVmClusterLifecycleState": { + "type": "string", + "description": "Cloud VM Cluster lifecycle state enum", + "enum": [ + "Provisioning", + "Available", + "Updating", + "Terminating", + "Terminated", + "MaintenanceInProgress", + "Failed" + ], + "x-ms-enum": { + "name": "CloudVmClusterLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Indicates that resource in Provisioning state" + }, + { + "name": "Available", + "value": "Available", + "description": "Indicates that resource in Available state" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Indicates that resource in Updating state" + }, + { + "name": "Terminating", + "value": "Terminating", + "description": "Indicates that resource in Terminating state" + }, + { + "name": "Terminated", + "value": "Terminated", + "description": "Indicates that resource in Terminated state" + }, + { + "name": "MaintenanceInProgress", + "value": "MaintenanceInProgress", + "description": "Indicates that resource Maintenance in progress state" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Indicates that resource in Failed state" + } + ] + } + }, + "CloudVmClusterListResult": { + "type": "object", + "description": "The response of a CloudVmCluster list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CloudVmCluster items on this page", + "items": { + "$ref": "#/definitions/CloudVmCluster" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CloudVmClusterProperties": { + "type": "object", + "description": "CloudVmCluster resource model", + "properties": { + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "Cloud VM Cluster ocid", + "readOnly": true + }, + "listenerPort": { + "type": "integer", + "format": "int64", + "description": "The port number configured for the listener on the cloud VM cluster.", + "readOnly": true + }, + "nodeCount": { + "type": "integer", + "format": "int32", + "description": "The number of nodes in the cloud VM cluster. ", + "readOnly": true + }, + "storageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The data disk group size to be allocated in GBs per VM.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "dataStorageSizeInTbs": { + "type": "number", + "format": "double", + "description": "The data disk group size to be allocated in TBs." + }, + "dbNodeStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The local node storage to be allocated in GBs." + }, + "memorySizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The memory to be allocated in GBs." + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "The date and time that the cloud VM cluster was created.", + "readOnly": true + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycle state.", + "readOnly": true + }, + "timeZone": { + "type": "string", + "description": "The time zone of the cloud VM cluster. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm).", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "zoneId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the zone the cloud VM cluster is associated with.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "hostname": { + "type": "string", + "description": "The hostname for the cloud VM cluster.", + "minLength": 1, + "maxLength": 23, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "domain": { + "type": "string", + "description": "The domain name for the cloud VM cluster.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "cpuCoreCount": { + "type": "integer", + "format": "int32", + "description": "The number of CPU cores enabled on the cloud VM cluster." + }, + "ocpuCount": { + "type": "number", + "format": "float", + "description": "The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part." + }, + "clusterName": { + "type": "string", + "description": "The cluster name for cloud VM cluster. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. ", + "minLength": 1, + "maxLength": 11, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "dataStoragePercentage": { + "type": "integer", + "format": "int32", + "description": "The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 35, 40, 60 and 80. The default is 80 percent assigned to DATA storage. See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "isLocalBackupEnabled": { + "type": "boolean", + "description": "If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster. ", + "default": false, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "cloudExadataInfrastructureId": { + "$ref": "#/definitions/CloudExadataInfrastructureId", + "description": "Cloud Exadata Infrastructure ID", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "isSparseDiskgroupEnabled": { + "type": "boolean", + "description": "If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created. ", + "default": false, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "systemVersion": { + "type": "string", + "description": "Operating system version of the image.", + "minLength": 1, + "maxLength": 255, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "sshPublicKeys": { + "type": "array", + "description": "The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.", + "items": { + "type": "string" + } + }, + "licenseModel": { + "$ref": "#/definitions/LicenseModel", + "description": "The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED. " + }, + "diskRedundancy": { + "$ref": "#/definitions/DiskRedundancy", + "description": "The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy. ", + "readOnly": true + }, + "scanIpIds": { + "type": "array", + "description": "The Single Client Access Name (SCAN) IP addresses associated with the cloud VM cluster. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster. **Note:** For a single-node DB system, this list is empty.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "vipIds": { + "type": "array", + "description": "The virtual IP (VIP) addresses associated with the cloud VM cluster. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "scanDnsName": { + "type": "string", + "description": "The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. ", + "minLength": 1, + "maxLength": 72, + "readOnly": true + }, + "scanListenerPortTcp": { + "type": "integer", + "format": "int32", + "description": "The TCP Single Client Access Name (SCAN) port. The default port is 1521.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "scanListenerPortTcpSsl": { + "type": "integer", + "format": "int32", + "description": "The TCPS Single Client Access Name (SCAN) port. The default port is 2484.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "scanDnsRecordId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.", + "readOnly": true + }, + "shape": { + "type": "string", + "description": "The model name of the Exadata hardware running the cloud VM cluster.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/AzureResourceProvisioningState", + "description": "CloudVmCluster provisioning state", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/CloudVmClusterLifecycleState", + "description": "CloudVmCluster lifecycle state", + "readOnly": true + }, + "vnetId": { + "$ref": "#/definitions/VnetId", + "description": "VNET for network connectivity", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "giVersion": { + "type": "string", + "description": "Oracle Grid Infrastructure (GI) software version", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ociUrl": { + "type": "string", + "format": "uri", + "description": "HTTPS link to OCI resources exposed to Azure Customer via Azure Interface.", + "readOnly": true + }, + "nsgUrl": { + "type": "string", + "format": "uri", + "description": "HTTPS link to OCI Network Security Group exposed to Azure Customer via the Azure Interface.", + "readOnly": true + }, + "subnetId": { + "$ref": "#/definitions/SubnetId", + "description": "Client subnet", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "backupSubnetCidr": { + "type": "string", + "description": "Client OCI backup subnet CIDR, default is 192.168.252.0/22", + "minLength": 1, + "maxLength": 32, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "nsgCidrs": { + "type": "array", + "description": "CIDR blocks for additional NSG ingress rules. The VNET CIDRs used to provision the VM Cluster will be added by default.", + "items": { + "$ref": "#/definitions/NsgCidr" + }, + "x-ms-identifiers": [], + "x-ms-mutability": [ + "read", + "create" + ] + }, + "dataCollectionOptions": { + "$ref": "#/definitions/DataCollectionOptions", + "description": "Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS." + }, + "displayName": { + "type": "string", + "description": "Display Name", + "minLength": 1, + "maxLength": 255 + }, + "computeNodes": { + "type": "array", + "description": "The list of compute servers to be added to the cloud VM cluster.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "x-ms-mutability": [ + "update" + ] + }, + "iormConfigCache": { + "$ref": "#/definitions/ExadataIormConfig", + "description": "iormConfigCache details for cloud VM cluster.", + "readOnly": true + }, + "lastUpdateHistoryEntryId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the last maintenance update history entry.", + "readOnly": true + }, + "dbServers": { + "type": "array", + "description": "The list of DB servers.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "compartmentId": { + "$ref": "#/definitions/Ocid", + "description": "Cluster compartmentId", + "readOnly": true + }, + "subnetOcid": { + "$ref": "#/definitions/Ocid", + "description": "Cluster subnet ocid", + "readOnly": true + } + }, + "required": [ + "hostname", + "cpuCoreCount", + "cloudExadataInfrastructureId", + "sshPublicKeys", + "vnetId", + "giVersion", + "subnetId", + "displayName" + ] + }, + "CloudVmClusterUpdate": { + "type": "object", + "description": "The type used for update operations of the CloudVmCluster.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/CloudVmClusterUpdateProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + } + }, + "CloudVmClusterUpdateProperties": { + "type": "object", + "description": "The updatable properties of the CloudVmCluster.", + "properties": { + "storageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The data disk group size to be allocated in GBs per VM.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "dataStorageSizeInTbs": { + "type": "number", + "format": "double", + "description": "The data disk group size to be allocated in TBs." + }, + "dbNodeStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The local node storage to be allocated in GBs." + }, + "memorySizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The memory to be allocated in GBs." + }, + "cpuCoreCount": { + "type": "integer", + "format": "int32", + "description": "The number of CPU cores enabled on the cloud VM cluster." + }, + "ocpuCount": { + "type": "number", + "format": "float", + "description": "The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part." + }, + "sshPublicKeys": { + "type": "array", + "description": "The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.", + "items": { + "type": "string" + } + }, + "licenseModel": { + "$ref": "#/definitions/LicenseModel", + "description": "The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED. " + }, + "dataCollectionOptions": { + "$ref": "#/definitions/DataCollectionOptions", + "description": "Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS." + }, + "displayName": { + "type": "string", + "description": "Display Name", + "minLength": 1, + "maxLength": 255 + }, + "computeNodes": { + "type": "array", + "description": "The list of compute servers to be added to the cloud VM cluster.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "x-ms-mutability": [ + "update" + ] + } + } + }, + "ComputeModel": { + "type": "string", + "description": "Compute model enum", + "enum": [ + "ECPU", + "OCPU" + ], + "x-ms-enum": { + "name": "ComputeModel", + "modelAsString": true, + "values": [ + { + "name": "ECPU", + "value": "ECPU", + "description": "ECPU model type" + }, + { + "name": "OCPU", + "value": "OCPU", + "description": "OCPU model type" + } + ] + } + }, + "ConnectionStringType": { + "type": "object", + "description": "Connection strings to connect to an Oracle Autonomous Database.", + "properties": { + "allConnectionStrings": { + "$ref": "#/definitions/AllConnectionStringType", + "description": "Returns all connection strings that can be used to connect to the Autonomous Database." + }, + "dedicated": { + "type": "string", + "description": "The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + }, + "high": { + "type": "string", + "description": "The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + }, + "low": { + "type": "string", + "description": "The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + }, + "medium": { + "type": "string", + "description": "The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements.", + "minLength": 10, + "maxLength": 255 + }, + "profiles": { + "type": "array", + "description": "A list of connection string profiles to allow clients to group, filter and select connection string values based on structured metadata.", + "items": { + "$ref": "#/definitions/ProfileType" + }, + "x-ms-identifiers": [] + } + } + }, + "ConnectionUrlType": { + "type": "object", + "description": "The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN.", + "properties": { + "apexUrl": { + "type": "string", + "description": "Oracle Application Express (APEX) URL.", + "minLength": 10, + "maxLength": 512 + }, + "databaseTransformsUrl": { + "type": "string", + "description": "The URL of the Database Transforms for the Autonomous Database.", + "minLength": 10, + "maxLength": 512 + }, + "graphStudioUrl": { + "type": "string", + "description": "The URL of the Graph Studio for the Autonomous Database.", + "minLength": 10, + "maxLength": 512 + }, + "machineLearningNotebookUrl": { + "type": "string", + "description": "The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database.", + "minLength": 10, + "maxLength": 512 + }, + "mongoDbUrl": { + "type": "string", + "description": "The URL of the MongoDB API for the Autonomous Database.", + "minLength": 10, + "maxLength": 512 + }, + "ordsUrl": { + "type": "string", + "description": "The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database.", + "minLength": 10, + "maxLength": 512 + }, + "sqlDevWebUrl": { + "type": "string", + "description": "Oracle SQL Developer Web URL.", + "minLength": 10, + "maxLength": 512 + } + } + }, + "ConsumerGroup": { + "type": "string", + "description": "Consumer group enum.", + "enum": [ + "High", + "Medium", + "Low", + "Tp", + "Tpurgent" + ], + "x-ms-enum": { + "name": "ConsumerGroup", + "modelAsString": true, + "values": [ + { + "name": "High", + "value": "High", + "description": "High group" + }, + { + "name": "Medium", + "value": "Medium", + "description": "Medium group" + }, + { + "name": "Low", + "value": "Low", + "description": "Low group" + }, + { + "name": "Tp", + "value": "Tp", + "description": "TP group" + }, + { + "name": "Tpurgent", + "value": "Tpurgent", + "description": "TPurgent group" + } + ] + } + }, + "CustomerContact": { + "type": "object", + "description": "CustomerContact resource properties", + "properties": { + "email": { + "type": "string", + "description": "The email address used by Oracle to send notifications regarding databases and infrastructure.", + "minLength": 1, + "maxLength": 320 + } + }, + "required": [ + "email" + ] + }, + "DataBaseType": { + "type": "string", + "description": "Database type enum", + "enum": [ + "Regular", + "Clone" + ], + "x-ms-enum": { + "name": "DataBaseType", + "modelAsString": true, + "values": [ + { + "name": "Regular", + "value": "Regular", + "description": "Regular DB" + }, + { + "name": "Clone", + "value": "Clone", + "description": "Clone DB" + } + ] + } + }, + "DataCollectionOptions": { + "type": "object", + "description": "DataCollectionOptions resource properties", + "properties": { + "isDiagnosticsEventsEnabled": { + "type": "boolean", + "description": "Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS.", + "default": false + }, + "isHealthMonitoringEnabled": { + "type": "boolean", + "description": "Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS.", + "default": false + }, + "isIncidentLogsEnabled": { + "type": "boolean", + "description": "Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS.", + "default": false + } + } + }, + "DataSafeStatusType": { + "type": "string", + "description": "DataSafe status type enum.", + "enum": [ + "Registering", + "Registered", + "Deregistering", + "NotRegistered", + "Failed" + ], + "x-ms-enum": { + "name": "DataSafeStatusType", + "modelAsString": true, + "values": [ + { + "name": "Registering", + "value": "Registering", + "description": "Registering status" + }, + { + "name": "Registered", + "value": "Registered", + "description": "Registered status" + }, + { + "name": "Deregistering", + "value": "Deregistering", + "description": "Deregistering status" + }, + { + "name": "NotRegistered", + "value": "NotRegistered", + "description": "NotRegistered status" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed status" + } + ] + } + }, + "DatabaseEditionType": { + "type": "string", + "description": "Database edition type enum.", + "enum": [ + "StandardEdition", + "EnterpriseEdition" + ], + "x-ms-enum": { + "name": "DatabaseEditionType", + "modelAsString": true, + "values": [ + { + "name": "StandardEdition", + "value": "StandardEdition", + "description": "Standard edition" + }, + { + "name": "EnterpriseEdition", + "value": "EnterpriseEdition", + "description": "Enterprise edition" + } + ] + } + }, + "DayOfWeek": { + "type": "object", + "description": "DayOfWeek resource properties", + "properties": { + "name": { + "$ref": "#/definitions/DayOfWeekName", + "description": "Name of the day of the week." + } + }, + "required": [ + "name" + ] + }, + "DayOfWeekName": { + "type": "string", + "description": "DayOfWeekName enum", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "x-ms-enum": { + "name": "DayOfWeekName", + "modelAsString": true, + "values": [ + { + "name": "Monday", + "value": "Monday", + "description": "Monday value" + }, + { + "name": "Tuesday", + "value": "Tuesday", + "description": "Tuesday value" + }, + { + "name": "Wednesday", + "value": "Wednesday", + "description": "Wednesday value" + }, + { + "name": "Thursday", + "value": "Thursday", + "description": "Thursday value" + }, + { + "name": "Friday", + "value": "Friday", + "description": "Friday value" + }, + { + "name": "Saturday", + "value": "Saturday", + "description": "Saturday value" + }, + { + "name": "Sunday", + "value": "Sunday", + "description": "Sunday value" + } + ] + } + }, + "DayOfWeekUpdate": { + "type": "object", + "description": "DayOfWeek resource properties", + "properties": { + "name": { + "$ref": "#/definitions/DayOfWeekName", + "description": "Name of the day of the week." + } + } + }, + "DbIormConfig": { + "type": "object", + "description": "DbIormConfig for cloud vm cluster", + "properties": { + "dbName": { + "type": "string", + "description": "The database name. For the default DbPlan, the dbName is default." + }, + "flashCacheLimit": { + "type": "string", + "description": "The flash cache limit for this database. This value is internally configured based on the share value assigned to the database." + }, + "share": { + "type": "integer", + "format": "int32", + "description": "The relative priority of this database.", + "minimum": 1, + "maximum": 32 + } + } + }, + "DbNode": { + "type": "object", + "description": "The DbNode resource belonging to vmCluster", + "properties": { + "properties": { + "$ref": "#/definitions/DbNodeProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DbNodeAction": { + "type": "object", + "description": "DbNode action object", + "properties": { + "action": { + "$ref": "#/definitions/DbNodeActionEnum", + "description": "Db action" + } + }, + "required": [ + "action" + ] + }, + "DbNodeActionEnum": { + "type": "string", + "description": "DbNode action enum", + "enum": [ + "Start", + "Stop", + "SoftReset", + "Reset" + ], + "x-ms-enum": { + "name": "DbNodeActionEnum", + "modelAsString": true, + "values": [ + { + "name": "Start", + "value": "Start", + "description": "Start DbNode" + }, + { + "name": "Stop", + "value": "Stop", + "description": "Stop DbNode" + }, + { + "name": "SoftReset", + "value": "SoftReset", + "description": "Soft reset DbNode" + }, + { + "name": "Reset", + "value": "Reset", + "description": "Reset DbNode" + } + ] + } + }, + "DbNodeListResult": { + "type": "object", + "description": "The response of a DbNode list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DbNode items on this page", + "items": { + "$ref": "#/definitions/DbNode" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DbNodeMaintenanceType": { + "type": "string", + "description": "The type of database node maintenance.", + "enum": [ + "VmdbRebootMigration" + ], + "x-ms-enum": { + "name": "DbNodeMaintenanceType", + "modelAsString": true, + "values": [ + { + "name": "VmdbRebootMigration", + "value": "VmdbRebootMigration", + "description": "VMDB reboot migration maintenance type" + } + ] + } + }, + "DbNodeProperties": { + "type": "object", + "description": "The properties of DbNodeResource", + "properties": { + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "DbNode OCID", + "readOnly": true + }, + "additionalDetails": { + "type": "string", + "description": "Additional information about the planned maintenance.", + "readOnly": true + }, + "backupIpId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the backup IP address associated with the database node.", + "readOnly": true + }, + "backupVnic2Id": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the second backup VNIC.", + "readOnly": true + }, + "backupVnicId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the backup VNIC.", + "readOnly": true + }, + "cpuCoreCount": { + "type": "integer", + "format": "int32", + "description": "The number of CPU cores enabled on the Db node.", + "readOnly": true + }, + "dbNodeStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The allocated local node storage in GBs on the Db node.", + "readOnly": true + }, + "dbServerId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the Exacc Db server associated with the database node.", + "readOnly": true + }, + "dbSystemId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the DB system.", + "readOnly": true + }, + "faultDomain": { + "type": "string", + "description": "The name of the Fault Domain the instance is contained in.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "hostIpId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the host IP address associated with the database node.", + "readOnly": true + }, + "hostname": { + "type": "string", + "description": "The host name for the database node.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/DbNodeProvisioningState", + "description": "The current state of the database node.", + "readOnly": true + }, + "lifecycleDetails": { + "type": "string", + "description": "Lifecycle details of Db Node.", + "readOnly": true + }, + "maintenanceType": { + "$ref": "#/definitions/DbNodeMaintenanceType", + "description": "The type of database node maintenance.", + "readOnly": true + }, + "memorySizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The allocated memory in GBs on the Db node.", + "readOnly": true + }, + "softwareStorageSizeInGb": { + "type": "integer", + "format": "int32", + "description": "The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems.", + "readOnly": true + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "The date and time that the database node was created.", + "readOnly": true + }, + "timeMaintenanceWindowEnd": { + "type": "string", + "format": "date-time", + "description": "End date and time of maintenance window.", + "readOnly": true + }, + "timeMaintenanceWindowStart": { + "type": "string", + "format": "date-time", + "description": "Start date and time of maintenance window.", + "readOnly": true + }, + "vnic2Id": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the second VNIC.", + "readOnly": true + }, + "vnicId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the VNIC.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + } + } + }, + "DbNodeProvisioningState": { + "type": "string", + "description": "DnNode provisioning state enum", + "enum": [ + "Provisioning", + "Available", + "Updating", + "Stopping", + "Stopped", + "Starting", + "Terminating", + "Terminated", + "Failed" + ], + "x-ms-enum": { + "name": "DbNodeProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Indicates that resource in Provisioning state" + }, + { + "name": "Available", + "value": "Available", + "description": "Indicates that resource in Available state" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Indicates that resource in Updating state" + }, + { + "name": "Stopping", + "value": "Stopping", + "description": "Indicates that resource in Stopping state" + }, + { + "name": "Stopped", + "value": "Stopped", + "description": "Indicates that resource in Stopped state" + }, + { + "name": "Starting", + "value": "Starting", + "description": "Indicates that resource in Starting state" + }, + { + "name": "Terminating", + "value": "Terminating", + "description": "Indicates that resource in Terminating state" + }, + { + "name": "Terminated", + "value": "Terminated", + "description": "Indicates that resource in Terminated state" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Indicates that resource in Failed state" + } + ] + } + }, + "DbServer": { + "type": "object", + "description": "DbServer resource model", + "properties": { + "properties": { + "$ref": "#/definitions/DbServerProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DbServerListResult": { + "type": "object", + "description": "The response of a DbServer list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DbServer items on this page", + "items": { + "$ref": "#/definitions/DbServer" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DbServerPatchingDetails": { + "type": "object", + "description": "DbServer Patching Properties", + "properties": { + "estimatedPatchDuration": { + "type": "integer", + "format": "int32", + "description": "Estimated Patch Duration", + "minimum": 1, + "maximum": 3000, + "readOnly": true + }, + "patchingStatus": { + "$ref": "#/definitions/DbServerPatchingStatus", + "description": "Patching Status", + "readOnly": true + }, + "timePatchingEnded": { + "type": "string", + "format": "date-time", + "description": "Time Patching Ended", + "readOnly": true + }, + "timePatchingStarted": { + "type": "string", + "format": "date-time", + "description": "Time Patching Started", + "readOnly": true + } + } + }, + "DbServerPatchingStatus": { + "type": "string", + "description": "DB Server patching status enum", + "enum": [ + "Scheduled", + "MaintenanceInProgress", + "Failed", + "Complete" + ], + "x-ms-enum": { + "name": "DbServerPatchingStatus", + "modelAsString": true, + "values": [ + { + "name": "Scheduled", + "value": "Scheduled", + "description": "Patching scheduled" + }, + { + "name": "MaintenanceInProgress", + "value": "MaintenanceInProgress", + "description": "Patching in progress" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Patching failed" + }, + { + "name": "Complete", + "value": "Complete", + "description": "Patching completed" + } + ] + } + }, + "DbServerProperties": { + "type": "object", + "description": "DbServer resource properties", + "properties": { + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "Db server name.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The name for the Db Server.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "compartmentId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the compartment.", + "readOnly": true + }, + "exadataInfrastructureId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the Exadata infrastructure.", + "readOnly": true + }, + "cpuCoreCount": { + "type": "integer", + "format": "int32", + "description": "The number of CPU cores enabled on the Db server.", + "readOnly": true + }, + "dbServerPatchingDetails": { + "$ref": "#/definitions/DbServerPatchingDetails", + "description": "dbServerPatching details of the Db server.", + "readOnly": true + }, + "maxMemoryInGbs": { + "type": "integer", + "format": "int32", + "description": "The total memory available in GBs.", + "readOnly": true + }, + "dbNodeStorageSizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The allocated local node storage in GBs on the Db server.", + "readOnly": true + }, + "vmClusterIds": { + "type": "array", + "description": "The OCID of the VM Clusters associated with the Db server.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "readOnly": true + }, + "dbNodeIds": { + "type": "array", + "description": "The OCID of the Db nodes associated with the Db server.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "readOnly": true + }, + "lifecycleDetails": { + "type": "string", + "description": "Lifecycle details of dbServer.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/DbServerProvisioningState", + "description": "DbServer provisioning state.", + "readOnly": true + }, + "maxCpuCount": { + "type": "integer", + "format": "int32", + "description": "The total number of CPU cores available.", + "readOnly": true + }, + "autonomousVmClusterIds": { + "type": "array", + "description": "The list of OCIDs of the Autonomous VM Clusters associated with the Db server.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "readOnly": true + }, + "autonomousVirtualMachineIds": { + "type": "array", + "description": "The list of OCIDs of the Autonomous Virtual Machines associated with the Db server.", + "items": { + "$ref": "#/definitions/Ocid" + }, + "readOnly": true + }, + "maxDbNodeStorageInGbs": { + "type": "integer", + "format": "int32", + "description": "The total max dbNode storage in GBs.", + "readOnly": true + }, + "memorySizeInGbs": { + "type": "integer", + "format": "int32", + "description": "The total memory size in GBs.", + "readOnly": true + }, + "shape": { + "type": "string", + "description": "The shape of the Db server. The shape determines the amount of CPU, storage, and memory resources available.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "The date and time that the Db Server was created.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + } + } + }, + "DbServerProvisioningState": { + "type": "string", + "description": "DbServerProvisioningState enum", + "enum": [ + "Creating", + "Available", + "Unavailable", + "Deleting", + "Deleted", + "MaintenanceInProgress" + ], + "x-ms-enum": { + "name": "DbServerProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Creating", + "value": "Creating", + "description": "Indicates that resource in Creating state" + }, + { + "name": "Available", + "value": "Available", + "description": "Indicates that resource in Available state" + }, + { + "name": "Unavailable", + "value": "Unavailable", + "description": "Indicates that resource in Unavailable state" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Indicates that resource in Deleting state" + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "Indicates that resource in Deleted state" + }, + { + "name": "MaintenanceInProgress", + "value": "MaintenanceInProgress", + "description": "Indicates that resource maintenance in progress state" + } + ] + } + }, + "DbSystemShape": { + "type": "object", + "description": "DbSystemShape resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/DbSystemShapeProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DbSystemShapeListResult": { + "type": "object", + "description": "The response of a DbSystemShape list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DbSystemShape items on this page", + "items": { + "$ref": "#/definitions/DbSystemShape" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DbSystemShapeProperties": { + "type": "object", + "description": "DbSystemShape resource model", + "properties": { + "shapeFamily": { + "type": "string", + "description": "The family of the shape used for the DB system.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + }, + "availableCoreCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of CPU cores that can be enabled on the DB system for this shape.", + "readOnly": true + }, + "minimumCoreCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of CPU cores that can be enabled on the DB system for this shape.", + "readOnly": true + }, + "runtimeMinimumCoreCount": { + "type": "integer", + "format": "int32", + "description": "The runtime minimum number of CPU cores that can be enabled on the DB system for this shape.", + "readOnly": true + }, + "coreCountIncrement": { + "type": "integer", + "format": "int32", + "description": "The discrete number by which the CPU core count for this shape can be increased or decreased.", + "readOnly": true + }, + "minStorageCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of Exadata storage servers available for the Exadata infrastructure.", + "readOnly": true + }, + "maxStorageCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of Exadata storage servers available for the Exadata infrastructure.", + "readOnly": true + }, + "availableDataStoragePerServerInTbs": { + "type": "number", + "format": "double", + "description": "The maximum data storage available per storage server for this shape. Only applicable to ExaCC Elastic shapes.", + "readOnly": true + }, + "availableMemoryPerNodeInGbs": { + "type": "integer", + "format": "int32", + "description": "The maximum memory available per database node for this shape. Only applicable to ExaCC Elastic shapes.", + "readOnly": true + }, + "availableDbNodePerNodeInGbs": { + "type": "integer", + "format": "int32", + "description": "The maximum Db Node storage available per database node for this shape. Only applicable to ExaCC Elastic shapes.", + "readOnly": true + }, + "minCoreCountPerNode": { + "type": "integer", + "format": "int32", + "description": "The minimum number of CPU cores that can be enabled per node for this shape.", + "readOnly": true + }, + "availableMemoryInGbs": { + "type": "integer", + "format": "int32", + "description": "The maximum memory that can be enabled for this shape.", + "readOnly": true + }, + "minMemoryPerNodeInGbs": { + "type": "integer", + "format": "int32", + "description": "The minimum memory that need be allocated per node for this shape.", + "readOnly": true + }, + "availableDbNodeStorageInGbs": { + "type": "integer", + "format": "int32", + "description": "The maximum Db Node storage that can be enabled for this shape.", + "readOnly": true + }, + "minDbNodeStoragePerNodeInGbs": { + "type": "integer", + "format": "int32", + "description": "The minimum Db Node storage that need be allocated per node for this shape.", + "readOnly": true + }, + "availableDataStorageInTbs": { + "type": "integer", + "format": "int32", + "description": "The maximum DATA storage that can be enabled for this shape.", + "readOnly": true + }, + "minDataStorageInTbs": { + "type": "integer", + "format": "int32", + "description": "The minimum data storage that need be allocated for this shape.", + "readOnly": true + }, + "minimumNodeCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of database nodes available for this shape.", + "readOnly": true + }, + "maximumNodeCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of database nodes available for this shape.", + "readOnly": true + }, + "availableCoreCountPerNode": { + "type": "integer", + "format": "int32", + "description": "The maximum number of CPU cores per database node that can be enabled for this shape. Only applicable to the flex Exadata shape and ExaCC Elastic shapes.", + "readOnly": true + } + } + }, + "DisasterRecoveryType": { + "type": "string", + "description": "Disaster recovery type enum.", + "enum": [ + "Adg", + "BackupBased" + ], + "x-ms-enum": { + "name": "DisasterRecoveryType", + "modelAsString": true, + "values": [ + { + "name": "Adg", + "value": "Adg", + "description": "ADG type" + }, + { + "name": "BackupBased", + "value": "BackupBased", + "description": "Backup based type" + } + ] + } + }, + "DiskRedundancy": { + "type": "string", + "description": "Disk redundancy enum", + "enum": [ + "High", + "Normal" + ], + "x-ms-enum": { + "name": "DiskRedundancy", + "modelAsString": true, + "values": [ + { + "name": "High", + "value": "High", + "description": "High redundancy" + }, + { + "name": "Normal", + "value": "Normal", + "description": "Normal redundancy" + } + ] + } + }, + "DnsPrivateView": { + "type": "object", + "description": "DnsPrivateView resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/DnsPrivateViewProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DnsPrivateViewListResult": { + "type": "object", + "description": "The response of a DnsPrivateView list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DnsPrivateView items on this page", + "items": { + "$ref": "#/definitions/DnsPrivateView" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DnsPrivateViewProperties": { + "type": "object", + "description": "Views resource model", + "properties": { + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the view", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The display name of the view resource", + "readOnly": true + }, + "isProtected": { + "type": "boolean", + "description": "A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/DnsPrivateViewsLifecycleState", + "description": "Views lifecycleState", + "readOnly": true + }, + "self": { + "type": "string", + "description": "The canonical absolute URL of the resource.", + "readOnly": true + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "views timeCreated", + "readOnly": true + }, + "timeUpdated": { + "type": "string", + "format": "date-time", + "description": "views timeCreated", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + } + } + }, + "DnsPrivateViewsLifecycleState": { + "type": "string", + "description": "DNS Private Views lifecycle state enum", + "enum": [ + "Active", + "Deleted", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "DnsPrivateViewsLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "DNS Private View is active" + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "DNS Private View is deleted" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "DNS Private View is deleting" + }, + { + "name": "Updating", + "value": "Updating", + "description": "DNS Private View is updating" + } + ] + } + }, + "DnsPrivateZone": { + "type": "object", + "description": "DnsPrivateZone resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/DnsPrivateZoneProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DnsPrivateZoneListResult": { + "type": "object", + "description": "The response of a DnsPrivateZone list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DnsPrivateZone items on this page", + "items": { + "$ref": "#/definitions/DnsPrivateZone" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DnsPrivateZoneProperties": { + "type": "object", + "description": "Zones resource model", + "properties": { + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the Zone", + "readOnly": true + }, + "isProtected": { + "type": "boolean", + "description": "A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/DnsPrivateZonesLifecycleState", + "description": "Zones lifecycleState", + "readOnly": true + }, + "self": { + "type": "string", + "description": "The canonical absolute URL of the resource.", + "readOnly": true + }, + "serial": { + "type": "integer", + "format": "int32", + "description": "The current serial of the zone. As seen in the zone's SOA record.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone's SOA record is derived.", + "readOnly": true + }, + "viewId": { + "$ref": "#/definitions/Ocid", + "description": "The OCID of the private view containing the zone. This value will be null for zones in the global DNS, which are publicly resolvable and not part of a private view.", + "readOnly": true + }, + "zoneType": { + "$ref": "#/definitions/ZoneType", + "description": "The type of the zone. Must be either PRIMARY or SECONDARY. SECONDARY is only supported for GLOBAL zones.", + "readOnly": true + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "Zones timeCreated", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + } + } + }, + "DnsPrivateZonesLifecycleState": { + "type": "string", + "description": "DNS Private Zones lifecycle state enum", + "enum": [ + "Active", + "Creating", + "Deleted", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "DnsPrivateZonesLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "DNS Private Zones is active" + }, + { + "name": "Creating", + "value": "Creating", + "description": "DNS Private Zones is creating" + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "DNS Private Zones is deleted" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "DNS Private Zones is deleting" + }, + { + "name": "Updating", + "value": "Updating", + "description": "DNS Private Zones is updating" + } + ] + } + }, + "EstimatedPatchingTime": { + "type": "object", + "description": "The estimated total time required in minutes for all patching operations (database server, storage server, and network switch patching).", + "properties": { + "estimatedDbServerPatchingTime": { + "type": "integer", + "format": "int32", + "description": "The estimated time required in minutes for database server patching.", + "minimum": 1, + "maximum": 3000, + "readOnly": true + }, + "estimatedNetworkSwitchesPatchingTime": { + "type": "integer", + "format": "int32", + "description": "The estimated time required in minutes for network switch patching.", + "minimum": 1, + "maximum": 3000, + "readOnly": true + }, + "estimatedStorageServerPatchingTime": { + "type": "integer", + "format": "int32", + "description": "The estimated time required in minutes for storage server patching.", + "minimum": 1, + "maximum": 3000, + "readOnly": true + }, + "totalEstimatedPatchingTime": { + "type": "integer", + "format": "int32", + "description": "The estimated total time required in minutes for all patching operations.", + "minimum": 1, + "maximum": 3000, + "readOnly": true + } + } + }, + "ExadataIormConfig": { + "type": "object", + "description": "ExadataIormConfig for cloud vm cluster", + "properties": { + "dbPlans": { + "type": "array", + "description": "An array of IORM settings for all the database in the Exadata DB system.", + "items": { + "$ref": "#/definitions/DbIormConfig" + }, + "x-ms-identifiers": [] + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycleState." + }, + "lifecycleState": { + "$ref": "#/definitions/IormLifecycleState", + "description": "The current state of IORM configuration for the Exadata DB system." + }, + "objective": { + "$ref": "#/definitions/Objective", + "description": "The current value for the IORM objective. The default is AUTO." + } + } + }, + "GenerateAutonomousDatabaseWalletDetails": { + "type": "object", + "description": "Autonomous Database Generate Wallet resource model.", + "properties": { + "generateType": { + "$ref": "#/definitions/GenerateType", + "description": "The type of wallet to generate." + }, + "isRegional": { + "type": "boolean", + "description": "True when requesting regional connection strings in PDB connect info, applicable to cross-region DG only." + }, + "password": { + "$ref": "#/definitions/Password", + "description": "The password to encrypt the keys inside the wallet", + "minLength": 8 + } + }, + "required": [ + "password" + ] + }, + "GenerateType": { + "type": "string", + "description": "Generate type enum", + "enum": [ + "Single", + "All" + ], + "x-ms-enum": { + "name": "GenerateType", + "modelAsString": true, + "values": [ + { + "name": "Single", + "value": "Single", + "description": "Generate single" + }, + { + "name": "All", + "value": "All", + "description": "Generate all" + } + ] + } + }, + "GiVersion": { + "type": "object", + "description": "GiVersion resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/GiVersionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "GiVersionListResult": { + "type": "object", + "description": "The response of a GiVersion list operation.", + "properties": { + "value": { + "type": "array", + "description": "The GiVersion items on this page", + "items": { + "$ref": "#/definitions/GiVersion" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "GiVersionProperties": { + "type": "object", + "description": "GiVersion resource model", + "properties": { + "version": { + "type": "string", + "description": "A valid Oracle Grid Infrastructure (GI) software version.", + "minLength": 1, + "maxLength": 255, + "readOnly": true + } + } + }, + "HostFormatType": { + "type": "string", + "description": "Host format type enum.", + "enum": [ + "Fqdn", + "Ip" + ], + "x-ms-enum": { + "name": "HostFormatType", + "modelAsString": true, + "values": [ + { + "name": "Fqdn", + "value": "Fqdn", + "description": "FQDN format" + }, + { + "name": "Ip", + "value": "Ip", + "description": "IP format" + } + ] + } + }, + "Intent": { + "type": "string", + "description": "Intent enum", + "enum": [ + "Retain", + "Reset" + ], + "x-ms-enum": { + "name": "Intent", + "modelAsString": true, + "values": [ + { + "name": "Retain", + "value": "Retain", + "description": "Retain intent" + }, + { + "name": "Reset", + "value": "Reset", + "description": "Reset intent" + } + ] + } + }, + "IormLifecycleState": { + "type": "string", + "description": "ORM lifecycle state enum", + "enum": [ + "BootStrapping", + "Enabled", + "Disabled", + "Updating", + "Failed" + ], + "x-ms-enum": { + "name": "IormLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "BootStrapping", + "value": "BootStrapping", + "description": "Indicates that resource in Provisioning state" + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "Indicates that resource in Enabled state" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Indicates that resource in Disabled state" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Indicates that resource in Updating state" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Indicates that resource in Failed state" + } + ] + } + }, + "LicenseModel": { + "type": "string", + "description": "LicenseModel enum", + "enum": [ + "LicenseIncluded", + "BringYourOwnLicense" + ], + "x-ms-enum": { + "name": "LicenseModel", + "modelAsString": true, + "values": [ + { + "name": "LicenseIncluded", + "value": "LicenseIncluded", + "description": "License included" + }, + { + "name": "BringYourOwnLicense", + "value": "BringYourOwnLicense", + "description": "Bring Your Own License" + } + ] + } + }, + "LongTermBackUpScheduleDetails": { + "type": "object", + "description": "Details for the long-term backup schedule.", + "properties": { + "repeatCadence": { + "$ref": "#/definitions/RepeatCadenceType", + "description": "The frequency of the long-term backup schedule" + }, + "timeOfBackup": { + "type": "string", + "format": "date-time", + "description": "The timestamp for the long-term backup schedule. For a MONTHLY cadence, months having fewer days than the provided date will have the backup taken on the last day of that month." + }, + "retentionPeriodInDays": { + "$ref": "#/definitions/RetentionPeriod", + "description": "Retention period, in days, for backups." + }, + "isDisabled": { + "type": "boolean", + "description": "Indicates if the long-term backup schedule should be deleted. The default value is `FALSE`." + } + } + }, + "MaintenanceWindow": { + "type": "object", + "description": "MaintenanceWindow resource properties", + "properties": { + "preference": { + "$ref": "#/definitions/Preference", + "description": "The maintenance window scheduling preference." + }, + "months": { + "type": "array", + "description": "Months during the year when maintenance should be performed.", + "items": { + "$ref": "#/definitions/Month" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "weeksOfMonth": { + "type": "array", + "description": "Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. ", + "items": { + "type": "integer", + "format": "int32" + } + }, + "daysOfWeek": { + "type": "array", + "description": "Days during the week when maintenance should be performed.", + "items": { + "$ref": "#/definitions/DayOfWeek" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "hoursOfDay": { + "type": "array", + "description": "The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC", + "items": { + "type": "integer", + "format": "int32" + } + }, + "leadTimeInWeeks": { + "type": "integer", + "format": "int32", + "description": "Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. " + }, + "patchingMode": { + "$ref": "#/definitions/PatchingMode", + "description": "Cloud Exadata infrastructure node patching method." + }, + "customActionTimeoutInMins": { + "type": "integer", + "format": "int32", + "description": "Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).", + "minimum": 0, + "maximum": 120 + }, + "isCustomActionTimeoutEnabled": { + "type": "boolean", + "description": "If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations." + }, + "isMonthlyPatchingEnabled": { + "type": "boolean", + "description": "is Monthly Patching Enabled" + } + } + }, + "Month": { + "type": "object", + "description": "Month resource properties", + "properties": { + "name": { + "$ref": "#/definitions/MonthName", + "description": "Name of the month of the year." + } + }, + "required": [ + "name" + ] + }, + "MonthName": { + "type": "string", + "description": "MonthName enum", + "enum": [ + "January", + "February", + "March", + "April", + "May", + "June", + "July", + "August", + "September", + "October", + "November", + "December" + ], + "x-ms-enum": { + "name": "MonthName", + "modelAsString": true, + "values": [ + { + "name": "January", + "value": "January", + "description": "January value" + }, + { + "name": "February", + "value": "February", + "description": "February value" + }, + { + "name": "March", + "value": "March", + "description": "March value" + }, + { + "name": "April", + "value": "April", + "description": "April value" + }, + { + "name": "May", + "value": "May", + "description": "May value" + }, + { + "name": "June", + "value": "June", + "description": "June value" + }, + { + "name": "July", + "value": "July", + "description": "July value" + }, + { + "name": "August", + "value": "August", + "description": "August value" + }, + { + "name": "September", + "value": "September", + "description": "September value" + }, + { + "name": "October", + "value": "October", + "description": "October value" + }, + { + "name": "November", + "value": "November", + "description": "November value" + }, + { + "name": "December", + "value": "December", + "description": "December value" + } + ] + } + }, + "MsRpaasNewResourceHeader": { + "type": "object", + "description": "Header to distinguish between resource creation or update" + }, + "NsgCidr": { + "type": "object", + "description": "A rule for allowing inbound (INGRESS) IP packets", + "properties": { + "source": { + "type": "string", + "description": "Conceptually, this is the range of IP addresses that a packet coming into the instance can come from.", + "minLength": 1, + "maxLength": 128 + }, + "destinationPortRange": { + "$ref": "#/definitions/PortRange", + "description": "Destination port range to specify particular destination ports for TCP rules." + } + }, + "required": [ + "source" + ] + }, + "Objective": { + "type": "string", + "description": "Objective enum", + "enum": [ + "LowLatency", + "HighThroughput", + "Balanced", + "Auto", + "Basic" + ], + "x-ms-enum": { + "name": "Objective", + "modelAsString": true, + "values": [ + { + "name": "LowLatency", + "value": "LowLatency", + "description": "Low latency objective" + }, + { + "name": "HighThroughput", + "value": "HighThroughput", + "description": "High throughput objective" + }, + { + "name": "Balanced", + "value": "Balanced", + "description": "Balanced objective" + }, + { + "name": "Auto", + "value": "Auto", + "description": "Auto objective" + }, + { + "name": "Basic", + "value": "Basic", + "description": "Basic objective" + } + ] + } + }, + "Ocid": { + "type": "string", + "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the resource.", + "minLength": 1, + "maxLength": 255 + }, + "OpenModeType": { + "type": "string", + "description": "Open mode type enum.", + "enum": [ + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "OpenModeType", + "modelAsString": true, + "values": [ + { + "name": "ReadOnly", + "value": "ReadOnly", + "description": "ReadOnly mode" + }, + { + "name": "ReadWrite", + "value": "ReadWrite", + "description": "ReadWrite mode" + } + ] + } + }, + "OperationsInsightsStatusType": { + "type": "string", + "description": "Operations Insights status type enum.", + "enum": [ + "Enabling", + "Enabled", + "Disabling", + "NotEnabled", + "FailedEnabling", + "FailedDisabling" + ], + "x-ms-enum": { + "name": "OperationsInsightsStatusType", + "modelAsString": true, + "values": [ + { + "name": "Enabling", + "value": "Enabling", + "description": "Enabling status" + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled status" + }, + { + "name": "Disabling", + "value": "Disabling", + "description": "Disabling status" + }, + { + "name": "NotEnabled", + "value": "NotEnabled", + "description": "NotEnabled status" + }, + { + "name": "FailedEnabling", + "value": "FailedEnabling", + "description": "FailedEnabling status" + }, + { + "name": "FailedDisabling", + "value": "FailedDisabling", + "description": "FailedDisabling status" + } + ] + } + }, + "OracleSubscription": { + "type": "object", + "description": "OracleSubscription resource definition", + "properties": { + "properties": { + "$ref": "#/definitions/OracleSubscriptionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "plan": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Plan", + "description": "Details of the resource plan." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "OracleSubscriptionListResult": { + "type": "object", + "description": "The response of a OracleSubscription list operation.", + "properties": { + "value": { + "type": "array", + "description": "The OracleSubscription items on this page", + "items": { + "$ref": "#/definitions/OracleSubscription" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "OracleSubscriptionProperties": { + "type": "object", + "description": "Oracle Subscription resource model", + "properties": { + "provisioningState": { + "$ref": "#/definitions/OracleSubscriptionProvisioningState", + "description": "OracleSubscriptionProvisioningState provisioning state", + "readOnly": true + }, + "saasSubscriptionId": { + "type": "string", + "description": "SAAS subscription ID generated by Marketplace", + "readOnly": true + }, + "cloudAccountId": { + "$ref": "#/definitions/Ocid", + "description": "Cloud Account Id", + "readOnly": true + }, + "cloudAccountState": { + "$ref": "#/definitions/CloudAccountProvisioningState", + "description": "Cloud Account provisioning state.", + "readOnly": true + }, + "termUnit": { + "type": "string", + "description": "Term Unit. P1Y, P3Y, etc, see Durations https://en.wikipedia.org/wiki/ISO_8601", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "productCode": { + "type": "string", + "description": "Product code for the term unit", + "x-ms-mutability": [ + "update" + ] + }, + "intent": { + "$ref": "#/definitions/Intent", + "description": "Intent for the update operation", + "x-ms-mutability": [ + "update" + ] + }, + "azureSubscriptionIds": { + "type": "array", + "description": "Azure subscriptions associated with this OracleSubscription", + "items": { + "type": "string" + }, + "readOnly": true + }, + "addSubscriptionOperationState": { + "$ref": "#/definitions/AddSubscriptionOperationState", + "description": "State of the add Azure subscription operation on Oracle subscription", + "readOnly": true + }, + "lastOperationStatusDetail": { + "type": "string", + "description": "Status details of the last operation on Oracle subscription", + "readOnly": true + } + } + }, + "OracleSubscriptionProvisioningState": { + "type": "string", + "description": "OracleSubscriptionProvisioningState enum", + "enum": [ + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "OracleSubscriptionProvisioningState", + "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." + } + ] + }, + "readOnly": true + }, + "OracleSubscriptionUpdate": { + "type": "object", + "description": "The type used for update operations of the OracleSubscription.", + "properties": { + "plan": { + "$ref": "#/definitions/PlanUpdate", + "description": "Details of the resource plan." + }, + "properties": { + "$ref": "#/definitions/OracleSubscriptionUpdateProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + } + }, + "OracleSubscriptionUpdateProperties": { + "type": "object", + "description": "The updatable properties of the OracleSubscription.", + "properties": { + "productCode": { + "type": "string", + "description": "Product code for the term unit", + "x-ms-mutability": [ + "update" + ] + }, + "intent": { + "$ref": "#/definitions/Intent", + "description": "Intent for the update operation", + "x-ms-mutability": [ + "update" + ] + } + } + }, + "Password": { + "type": "string", + "format": "password", + "description": "Password string.", + "x-ms-secret": true + }, + "PatchingMode": { + "type": "string", + "description": "Patching mode enum", + "enum": [ + "Rolling", + "NonRolling" + ], + "x-ms-enum": { + "name": "PatchingMode", + "modelAsString": true, + "values": [ + { + "name": "Rolling", + "value": "Rolling", + "description": "Rolling patching" + }, + { + "name": "NonRolling", + "value": "NonRolling", + "description": "Non Rolling patching" + } + ] + } + }, + "PeerDbDetails": { + "type": "object", + "description": "PeerDb Details", + "properties": { + "peerDbId": { + "type": "string", + "description": "The database OCID of the Disaster Recovery peer database, which is located in a different region from the current peer database.", + "minLength": 1, + "maxLength": 255 + } + } + }, + "PermissionLevelType": { + "type": "string", + "description": "Permission level type enum.", + "enum": [ + "Restricted", + "Unrestricted" + ], + "x-ms-enum": { + "name": "PermissionLevelType", + "modelAsString": true, + "values": [ + { + "name": "Restricted", + "value": "Restricted", + "description": "Restricted permission level" + }, + { + "name": "Unrestricted", + "value": "Unrestricted", + "description": "Unrestricted permission level" + } + ] + } + }, + "PlanUpdate": { + "type": "object", + "description": "ResourcePlanTypeUpdate model definition", + "properties": { + "name": { + "type": "string", + "description": "A user defined name of the 3rd Party Artifact that is being procured." + }, + "publisher": { + "type": "string", + "description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic" + }, + "product": { + "type": "string", + "description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. " + }, + "promotionCode": { + "type": "string", + "description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact." + }, + "version": { + "type": "string", + "description": "The version of the desired product/artifact." + } + } + }, + "PortRange": { + "type": "object", + "description": "Port Range to specify particular destination ports for TCP rules.", + "properties": { + "min": { + "type": "integer", + "format": "int32", + "description": "The minimum port number, which must not be greater than the maximum port number.", + "minimum": 1, + "maximum": 65535 + }, + "max": { + "type": "integer", + "format": "int32", + "description": "The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.", + "minimum": 1, + "maximum": 65535 + } + }, + "required": [ + "min", + "max" + ] + }, + "Preference": { + "type": "string", + "description": "Preference enum", + "enum": [ + "NoPreference", + "CustomPreference" + ], + "x-ms-enum": { + "name": "Preference", + "modelAsString": true, + "values": [ + { + "name": "NoPreference", + "value": "NoPreference", + "description": "No preference" + }, + { + "name": "CustomPreference", + "value": "CustomPreference", + "description": "Custom preference" + } + ] + } + }, + "PrivateIpAddressProperties": { + "type": "object", + "description": "PrivateIpAddress resource properties", + "properties": { + "displayName": { + "type": "string", + "description": "PrivateIpAddresses displayName" + }, + "hostnameLabel": { + "type": "string", + "description": "PrivateIpAddresses hostnameLabel" + }, + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "PrivateIpAddresses Id" + }, + "ipAddress": { + "type": "string", + "description": "PrivateIpAddresses ipAddress" + }, + "subnetId": { + "$ref": "#/definitions/Ocid", + "description": "PrivateIpAddresses subnetId" + } + }, + "required": [ + "displayName", + "hostnameLabel", + "ocid", + "ipAddress", + "subnetId" + ] + }, + "PrivateIpAddressesFilter": { + "type": "object", + "description": "Private Ip Addresses filter", + "properties": { + "subnetId": { + "$ref": "#/definitions/Ocid", + "description": "Subnet OCID" + }, + "vnicId": { + "$ref": "#/definitions/Ocid", + "description": "VCN OCID" + } + }, + "required": [ + "subnetId", + "vnicId" + ] + }, + "ProfileType": { + "type": "object", + "description": "The connection string profile to allow clients to group, filter and select connection string values based on structured metadata.", + "properties": { + "consumerGroup": { + "$ref": "#/definitions/ConsumerGroup", + "description": "Consumer group used by the connection." + }, + "displayName": { + "type": "string", + "description": "A user-friendly name for the connection.", + "minLength": 1, + "maxLength": 255 + }, + "hostFormat": { + "$ref": "#/definitions/HostFormatType", + "description": "Host format used in connection string." + }, + "isRegional": { + "type": "boolean", + "description": "True for a regional connection string, applicable to cross-region DG only." + }, + "protocol": { + "$ref": "#/definitions/ProtocolType", + "description": "Protocol used by the connection." + }, + "sessionMode": { + "$ref": "#/definitions/SessionModeType", + "description": "Specifies whether the listener performs a direct hand-off of the session, or redirects the session." + }, + "syntaxFormat": { + "$ref": "#/definitions/SyntaxFormatType", + "description": "Specifies whether the connection string is using the long (LONG), Easy Connect (EZCONNECT), or Easy Connect Plus (EZCONNECTPLUS) format." + }, + "tlsAuthentication": { + "$ref": "#/definitions/TlsAuthenticationType", + "description": "Specifies whether the TLS handshake is using one-way (SERVER) or mutual (MUTUAL) authentication." + }, + "value": { + "type": "string", + "description": "Connection string value." + } + }, + "required": [ + "displayName", + "hostFormat", + "protocol", + "sessionMode", + "syntaxFormat", + "value" + ] + }, + "ProtocolType": { + "type": "string", + "description": "Protocol type enum.", + "enum": [ + "TCP", + "TCPS" + ], + "x-ms-enum": { + "name": "ProtocolType", + "modelAsString": true, + "values": [ + { + "name": "TCP", + "value": "TCP", + "description": "TCP protocol" + }, + { + "name": "TCPS", + "value": "TCPS", + "description": "TCPS protocol" + } + ] + } + }, + "RefreshableModelType": { + "type": "string", + "description": "Refreshable model type enum", + "enum": [ + "Automatic", + "Manual" + ], + "x-ms-enum": { + "name": "RefreshableModelType", + "modelAsString": true, + "values": [ + { + "name": "Automatic", + "value": "Automatic", + "description": "Automatic refreshable model type" + }, + { + "name": "Manual", + "value": "Manual", + "description": "Manual refreshable model type" + } + ] + } + }, + "RefreshableStatusType": { + "type": "string", + "description": "Refreshable status type enum.", + "enum": [ + "Refreshing", + "NotRefreshing" + ], + "x-ms-enum": { + "name": "RefreshableStatusType", + "modelAsString": true, + "values": [ + { + "name": "Refreshing", + "value": "Refreshing", + "description": "Refreshing status" + }, + { + "name": "NotRefreshing", + "value": "NotRefreshing", + "description": "NotRefreshing status" + } + ] + } + }, + "RepeatCadenceType": { + "type": "string", + "description": "Repeat cadence type enum", + "enum": [ + "OneTime", + "Weekly", + "Monthly", + "Yearly" + ], + "x-ms-enum": { + "name": "RepeatCadenceType", + "modelAsString": true, + "values": [ + { + "name": "OneTime", + "value": "OneTime", + "description": "Repeat one time" + }, + { + "name": "Weekly", + "value": "Weekly", + "description": "Repeat weekly" + }, + { + "name": "Monthly", + "value": "Monthly", + "description": "Repeat monthly" + }, + { + "name": "Yearly", + "value": "Yearly", + "description": "Repeat yearly" + } + ] + } + }, + "RestoreAutonomousDatabaseDetails": { + "type": "object", + "description": "Details to restore an Oracle Autonomous Database.", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The time to restore the database to." + } + }, + "required": [ + "timestamp" + ] + }, + "RetentionPeriod": { + "type": "integer", + "format": "int32", + "description": "Retention period, in days, for backups.", + "minimum": 90, + "maximum": 2558 + }, + "RoleType": { + "type": "string", + "description": "Role type enum.", + "enum": [ + "Primary", + "Standby", + "DisabledStandby", + "BackupCopy", + "SnapshotStandby" + ], + "x-ms-enum": { + "name": "RoleType", + "modelAsString": true, + "values": [ + { + "name": "Primary", + "value": "Primary", + "description": "Primary role" + }, + { + "name": "Standby", + "value": "Standby", + "description": "Standby role" + }, + { + "name": "DisabledStandby", + "value": "DisabledStandby", + "description": "DisabledStandby role" + }, + { + "name": "BackupCopy", + "value": "BackupCopy", + "description": "BackupCopy role" + }, + { + "name": "SnapshotStandby", + "value": "SnapshotStandby", + "description": "SnapshotStandby role" + } + ] + } + }, + "SaasSubscriptionDetails": { + "type": "object", + "description": "SaaS Subscription Details model", + "properties": { + "id": { + "type": "string", + "description": "Purchased SaaS subscription ID", + "readOnly": true + }, + "subscriptionName": { + "type": "string", + "description": "SaaS subscription name", + "readOnly": true + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "Creation Date and Time", + "readOnly": true + }, + "offerId": { + "type": "string", + "description": "Purchased offer ID", + "readOnly": true + }, + "planId": { + "type": "string", + "description": "Purchased offer's plan ID", + "readOnly": true + }, + "saasSubscriptionStatus": { + "type": "string", + "description": "Indicates the status of the Subscription.", + "readOnly": true + }, + "publisherId": { + "type": "string", + "description": "Publisher ID", + "readOnly": true + }, + "purchaserEmailId": { + "type": "string", + "description": "Purchaser Email ID", + "readOnly": true + }, + "purchaserTenantId": { + "type": "string", + "description": "Purchaser Tenant ID", + "readOnly": true + }, + "termUnit": { + "type": "string", + "description": "Purchase Term Unit", + "readOnly": true + }, + "isAutoRenew": { + "type": "boolean", + "description": "AutoRenew flag", + "readOnly": true + }, + "isFreeTrial": { + "type": "boolean", + "description": "FreeTrial flag", + "readOnly": true + } + } + }, + "ScheduledOperationsType": { + "type": "object", + "description": "The list of scheduled operations.", + "properties": { + "dayOfWeek": { + "$ref": "#/definitions/DayOfWeek", + "description": "Day of week" + }, + "scheduledStartTime": { + "type": "string", + "description": "auto start time. value must be of ISO-8601 format HH:mm", + "minLength": 1, + "maxLength": 50 + }, + "scheduledStopTime": { + "type": "string", + "description": "auto stop time. value must be of ISO-8601 format HH:mm", + "minLength": 1, + "maxLength": 50 + } + }, + "required": [ + "dayOfWeek" + ] + }, + "ScheduledOperationsTypeUpdate": { + "type": "object", + "description": "The list of scheduled operations.", + "properties": { + "dayOfWeek": { + "$ref": "#/definitions/DayOfWeekUpdate", + "description": "Day of week" + }, + "scheduledStartTime": { + "type": "string", + "description": "auto start time. value must be of ISO-8601 format HH:mm", + "minLength": 1, + "maxLength": 50 + }, + "scheduledStopTime": { + "type": "string", + "description": "auto stop time. value must be of ISO-8601 format HH:mm", + "minLength": 1, + "maxLength": 50 + } + } + }, + "SessionModeType": { + "type": "string", + "description": "Session mode type enum.", + "enum": [ + "Direct", + "Redirect" + ], + "x-ms-enum": { + "name": "SessionModeType", + "modelAsString": true, + "values": [ + { + "name": "Direct", + "value": "Direct", + "description": "Direct session mode" + }, + { + "name": "Redirect", + "value": "Redirect", + "description": "Redirect session mode" + } + ] + } + }, + "SourceType": { + "type": "string", + "description": "Source type enum.", + "enum": [ + "None", + "Database", + "BackupFromId", + "BackupFromTimestamp", + "CloneToRefreshable", + "CrossRegionDataguard", + "CrossRegionDisasterRecovery" + ], + "x-ms-enum": { + "name": "SourceType", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "None source" + }, + { + "name": "Database", + "value": "Database", + "description": "Database source" + }, + { + "name": "BackupFromId", + "value": "BackupFromId", + "description": "Backup from ID source" + }, + { + "name": "BackupFromTimestamp", + "value": "BackupFromTimestamp", + "description": "Backup from timestamp source" + }, + { + "name": "CloneToRefreshable", + "value": "CloneToRefreshable", + "description": "Clone to refreshable source" + }, + { + "name": "CrossRegionDataguard", + "value": "CrossRegionDataguard", + "description": "Cross region dataguard source" + }, + { + "name": "CrossRegionDisasterRecovery", + "value": "CrossRegionDisasterRecovery", + "description": "cross region disaster recovery source" + } + ] + } + }, + "SubnetId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + } + }, + "SyntaxFormatType": { + "type": "string", + "description": "Syntax format type enum.", + "enum": [ + "Long", + "Ezconnect", + "Ezconnectplus" + ], + "x-ms-enum": { + "name": "SyntaxFormatType", + "modelAsString": true, + "values": [ + { + "name": "Long", + "value": "Long", + "description": "Long format" + }, + { + "name": "Ezconnect", + "value": "Ezconnect", + "description": "Ezconnect format" + }, + { + "name": "Ezconnectplus", + "value": "Ezconnectplus", + "description": "Ezconnectplus format" + } + ] + } + }, + "SystemVersion": { + "type": "object", + "description": "SystemVersion resource Definition", + "properties": { + "properties": { + "$ref": "#/definitions/SystemVersionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "SystemVersionListResult": { + "type": "object", + "description": "The response of a SystemVersion list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SystemVersion items on this page", + "items": { + "$ref": "#/definitions/SystemVersion" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SystemVersionProperties": { + "type": "object", + "description": "System Version Resource model", + "properties": { + "systemVersion": { + "type": "string", + "description": "A valid Oracle System Version", + "readOnly": true + } + } + }, + "SystemVersionsFilter": { + "type": "object", + "description": "SystemVersions filter", + "properties": { + "giVersion": { + "type": "string", + "description": "Grid Infrastructure version" + }, + "shape": { + "type": "string", + "description": "Exadata shape" + }, + "isLatestVersion": { + "type": "boolean", + "description": "Check If we have to list only latest versions" + } + }, + "required": [ + "giVersion", + "shape" + ] + }, + "TlsAuthenticationType": { + "type": "string", + "description": "TLS authentication type enum.", + "enum": [ + "Server", + "Mutual" + ], + "x-ms-enum": { + "name": "TlsAuthenticationType", + "modelAsString": true, + "values": [ + { + "name": "Server", + "value": "Server", + "description": "Server authentication" + }, + { + "name": "Mutual", + "value": "Mutual", + "description": "Mutual TLS" + } + ] + } + }, + "UpdateAction": { + "type": "string", + "description": "Update action enum", + "enum": [ + "RollingApply", + "NonRollingApply", + "PreCheck", + "RollBack" + ], + "x-ms-enum": { + "name": "UpdateAction", + "modelAsString": true, + "values": [ + { + "name": "RollingApply", + "value": "RollingApply", + "description": "Rolling apply action" + }, + { + "name": "NonRollingApply", + "value": "NonRollingApply", + "description": "Non rolling apply action" + }, + { + "name": "PreCheck", + "value": "PreCheck", + "description": "Pre-check action" + }, + { + "name": "RollBack", + "value": "RollBack", + "description": "Rollback action" + } + ] + } + }, + "ValidationError": { + "type": "object", + "description": "validation error", + "properties": { + "code": { + "type": "string", + "description": "error code" + }, + "message": { + "type": "string", + "description": "error message" + } + }, + "required": [ + "code", + "message" + ] + }, + "ValidationResult": { + "type": "object", + "description": "validation result", + "properties": { + "status": { + "$ref": "#/definitions/ValidationStatus", + "description": "validation status" + }, + "error": { + "$ref": "#/definitions/ValidationError", + "description": "validation error" + } + }, + "required": [ + "status", + "error" + ] + }, + "ValidationStatus": { + "type": "string", + "description": "validation status", + "enum": [ + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "ValidationStatus", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Validation succeeded" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Validation failed" + } + ] + }, + "readOnly": true + }, + "VirtualNetworkAddress": { + "type": "object", + "description": "Virtual IP resource belonging to a vm cluster resource.", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualNetworkAddressProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "VirtualNetworkAddressLifecycleState": { + "type": "string", + "description": "VirtualNetworkAddressLifecycleState enum", + "enum": [ + "Provisioning", + "Available", + "Terminating", + "Terminated", + "Failed" + ], + "x-ms-enum": { + "name": "VirtualNetworkAddressLifecycleState", + "modelAsString": true, + "values": [ + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Indicates that resource in Provisioning state" + }, + { + "name": "Available", + "value": "Available", + "description": "Indicates that resource in Available state" + }, + { + "name": "Terminating", + "value": "Terminating", + "description": "Indicates that resource in Terminating state" + }, + { + "name": "Terminated", + "value": "Terminated", + "description": "Indicates that resource in Terminated state" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Indicates that resource in Failed state" + } + ] + } + }, + "VirtualNetworkAddressListResult": { + "type": "object", + "description": "The response of a VirtualNetworkAddress list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VirtualNetworkAddress items on this page", + "items": { + "$ref": "#/definitions/VirtualNetworkAddress" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VirtualNetworkAddressProperties": { + "type": "object", + "description": "virtualNetworkAddress resource properties", + "properties": { + "ipAddress": { + "type": "string", + "description": "Virtual network Address address.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "vmOcid": { + "$ref": "#/definitions/Ocid", + "description": "Virtual Machine OCID.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ocid": { + "$ref": "#/definitions/Ocid", + "description": "Application VIP OCID.", + "readOnly": true + }, + "domain": { + "type": "string", + "description": "Virtual network address fully qualified domain name.", + "readOnly": true + }, + "lifecycleDetails": { + "type": "string", + "description": "Additional information about the current lifecycle state of the application virtual IP (VIP) address.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/AzureResourceProvisioningState", + "description": "Azure resource provisioning state.", + "readOnly": true + }, + "lifecycleState": { + "$ref": "#/definitions/VirtualNetworkAddressLifecycleState", + "description": "virtual network address lifecycle state.", + "readOnly": true + }, + "timeAssigned": { + "type": "string", + "format": "date-time", + "description": "The date and time when the create operation for the application virtual IP (VIP) address completed.", + "readOnly": true + } + } + }, + "VnetId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks" + } + ] + } + }, + "WorkloadType": { + "type": "string", + "description": "WorkloadType enum", + "enum": [ + "OLTP", + "DW", + "AJD", + "APEX" + ], + "x-ms-enum": { + "name": "WorkloadType", + "modelAsString": true, + "values": [ + { + "name": "OLTP", + "value": "OLTP", + "description": "OLTP - indicates an Autonomous Transaction Processing database" + }, + { + "name": "DW", + "value": "DW", + "description": "DW - indicates an Autonomous Data Warehouse database" + }, + { + "name": "AJD", + "value": "AJD", + "description": "AJD - indicates an Autonomous JSON Database" + }, + { + "name": "APEX", + "value": "APEX", + "description": "APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type." + } + ] + } + }, + "ZoneType": { + "type": "string", + "description": "Zone type enum", + "enum": [ + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "ZoneType", + "modelAsString": true, + "values": [ + { + "name": "Primary", + "value": "Primary", + "description": "Primary zone" + }, + { + "name": "Secondary", + "value": "Secondary", + "description": "Secondary zone" + } + ] + } + }, + "aclString": { + "type": "string", + "description": "The client IP access control list (ACL). This is an array of CIDR notations and/or IP addresses. Values should be separate strings, separated by commas. Example: ['1.1.1.1','1.1.1.0/24','1.1.2.25']", + "minLength": 1, + "maxLength": 1024 + } + }, + "parameters": {} +} diff --git a/specification/oracle/resource-manager/readme.md b/specification/oracle/resource-manager/readme.md index 56be976c7689..a51771bffeb7 100644 --- a/specification/oracle/resource-manager/readme.md +++ b/specification/oracle/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for the Oracle.Database. ```yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2023-09-01 +tag: package-2024-06-01 ``` ``` yaml @@ -53,6 +53,24 @@ input-file: - Oracle.Database/stable/2023-09-01/openapi.json ``` +### Tag: package-2024-06-01-preview + +These settings apply only when `--tag=package-2024-06-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-06-01-preview' +input-file: + - Oracle.Database/preview/2024-06-01-preview/openapi.json +``` + +### Tag: package-2024-06-01 + +These settings apply only when `--tag=package-2024-06-01` is specified on the command line. + +```yaml $(tag) == 'package-2024-06-01' +input-file: + - Oracle.Database/stable/2024-06-01/openapi.json +``` + --- # Code Generation diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/aodg.json b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/aodg.json index 51b68b154330..bf1995795c80 100644 --- a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/aodg.json +++ b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/aodg.json @@ -1049,45 +1049,6 @@ "nextLinkName": "nextLink" } } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Orbital/globalCommunicationsSites/{globalCommunicationsSiteName}": { - "get": { - "tags": [ - "Global Communications Site" - ], - "operationId": "GlobalCommunicationsSites_Get", - "description": "Gets the specified global communications site in a specified resource group.", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/globalCommunicationsSiteNameParameter" - } - ], - "responses": { - "200": { - "description": "Request successful. The operation returns the resulting GlobalCommunicationsSite.", - "schema": { - "$ref": "#/definitions/GlobalCommunicationsSite" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get Global Communications Site": { - "$ref": "./examples/GlobalCommunicationsSiteGet.json" - } - } - } } }, "definitions": { @@ -1650,17 +1611,6 @@ "maxLength": 64, "x-ms-parameter-location": "method" }, - "globalCommunicationsSiteNameParameter": { - "name": "globalCommunicationsSiteName", - "in": "path", - "description": "Global communications Site name.", - "required": true, - "type": "string", - "pattern": "^[A-Za-z][A-Za-z0-9-_]+$", - "minLength": 2, - "maxLength": 64, - "x-ms-parameter-location": "method" - }, "skipTokenParameter": { "name": "$skiptoken", "description": "An opaque string that the resource provider uses to skip over previously-returned results. This is used when a previous list operation call returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GlobalCommunicationsSiteGet.json b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GlobalCommunicationsSiteGet.json deleted file mode 100644 index ec7b99c81636..000000000000 --- a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GlobalCommunicationsSiteGet.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "api-version": "2024-03-01-preview", - "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", - "resourceGroupName": "rg1", - "globalCommunicationsSiteName": "contoso-Vernon" - }, - "responses": { - "200": { - "body": { - "name": "contoso-Vernon", - "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/globalCommunicationsSites/contoso-Vernon", - "type": "Microsoft.Orbital/globalCommunicationsSites", - "properties": { - "locationData": { - "city": "Vernon", - "district": "Texas", - "country": "United States of America", - "extra": "Zip code: 76384", - "closestAzureRegion": "southcentralus" - }, - "globalCommunicationsSiteType": "GroundStation", - "partnerRouters": [ - { - "name": "contoso-pr1" - }, - { - "name": "contoso-pr2" - } - ], - "partnerSiteBandwidth": 100000000 - } - } - } - } -} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/stable/2024-03-01/aodg.json b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/stable/2024-03-01/aodg.json index 4df27effb4cc..b2b17c20be03 100644 --- a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/stable/2024-03-01/aodg.json +++ b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/stable/2024-03-01/aodg.json @@ -1049,45 +1049,6 @@ "nextLinkName": "nextLink" } } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Orbital/globalCommunicationsSites/{globalCommunicationsSiteName}": { - "get": { - "tags": [ - "Global Communications Site" - ], - "operationId": "GlobalCommunicationsSites_Get", - "description": "Gets the specified global communications site in a specified resource group.", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/globalCommunicationsSiteNameParameter" - } - ], - "responses": { - "200": { - "description": "Request successful. The operation returns the resulting GlobalCommunicationsSite.", - "schema": { - "$ref": "#/definitions/GlobalCommunicationsSite" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get Global Communications Site": { - "$ref": "./examples/GlobalCommunicationsSiteGet.json" - } - } - } } }, "definitions": { @@ -1650,17 +1611,6 @@ "maxLength": 64, "x-ms-parameter-location": "method" }, - "globalCommunicationsSiteNameParameter": { - "name": "globalCommunicationsSiteName", - "in": "path", - "description": "Global communications Site name.", - "required": true, - "type": "string", - "pattern": "^[A-Za-z][A-Za-z0-9-_]+$", - "minLength": 2, - "maxLength": 64, - "x-ms-parameter-location": "method" - }, "skipTokenParameter": { "name": "$skiptoken", "description": "An opaque string that the resource provider uses to skip over previously-returned results. This is used when a previous list operation call returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/stable/2024-03-01/examples/GlobalCommunicationsSiteGet.json b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/stable/2024-03-01/examples/GlobalCommunicationsSiteGet.json deleted file mode 100644 index 3be10d9e758e..000000000000 --- a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/stable/2024-03-01/examples/GlobalCommunicationsSiteGet.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "api-version": "2024-03-01", - "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", - "resourceGroupName": "rg1", - "globalCommunicationsSiteName": "contoso-Vernon" - }, - "responses": { - "200": { - "body": { - "name": "contoso-Vernon", - "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/globalCommunicationsSites/contoso-Vernon", - "type": "Microsoft.Orbital/globalCommunicationsSites", - "properties": { - "locationData": { - "city": "Vernon", - "district": "Texas", - "country": "United States of America", - "extra": "Zip code: 76384", - "closestAzureRegion": "southcentralus" - }, - "globalCommunicationsSiteType": "GroundStation", - "partnerRouters": [ - { - "name": "contoso-pr1" - }, - { - "name": "contoso-pr2" - } - ], - "partnerSiteBandwidth": 100000000 - } - } - } - } -} diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/tspconfig.yaml b/specification/playwrighttesting/PlaywrightTesting.Management/tspconfig.yaml index c098a1fb5df9..dc3d55e97378 100644 --- a/specification/playwrighttesting/PlaywrightTesting.Management/tspconfig.yaml +++ b/specification/playwrighttesting/PlaywrightTesting.Management/tspconfig.yaml @@ -12,6 +12,9 @@ parameters: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true emitter-output-dir: "{project-root}/.." examples-directory: "{project-root}/examples" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/playwrighttesting.json" diff --git a/specification/playwrighttesting/PlaywrightTesting/main.tsp b/specification/playwrighttesting/PlaywrightTesting/main.tsp index 2fa9a3c2bb27..a3de6db5573b 100644 --- a/specification/playwrighttesting/PlaywrightTesting/main.tsp +++ b/specification/playwrighttesting/PlaywrightTesting/main.tsp @@ -191,25 +191,28 @@ interface AccessTokens { // AccessToken Operations @doc("Creates an access-token with given access-token id in guid format.") - @example( + @Autorest.example( "./AccessTokens_CreateAccessToken.json", "AccessTokens_CreateAccessToken" ) createAccessToken is Operations.ResourceCreateOrReplace; @doc("Get an access-token for given access-token id in guid format.") - @example("./AccessTokens_GetAccessToken.json", "AccessTokens_GetAccessToken") + @Autorest.example( + "./AccessTokens_GetAccessToken.json", + "AccessTokens_GetAccessToken" + ) getAccessToken is Operations.ResourceRead; @doc("Revoke an access-token with given access-token id in guid format.") - @example( + @Autorest.example( "./AccessTokens_DeleteAccessToken.json", "AccessTokens_DeleteAccessToken" ) deleteAccessToken is Operations.ResourceDelete; @doc("List access-tokens for a given accountId.") - @example( + @Autorest.example( "./AccessTokens_ListAccessTokens.json", "AccessTokens_ListAccessTokens" ) @@ -219,6 +222,6 @@ interface AccessTokens { interface Accounts { // Accounts Operations @doc("Get details of the ARM resource mapped to an account for the given accountId.") - @example("./Accounts_GetAccount.json", "Accounts_GetAccount") + @Autorest.example("./Accounts_GetAccount.json", "Accounts_GetAccount") getAccount is Operations.ResourceRead; } diff --git a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/playwrighttesting.json b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/playwrighttesting.json index b6f9d850e114..5778df418378 100644 --- a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/playwrighttesting.json +++ b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/playwrighttesting.json @@ -931,6 +931,7 @@ }, "properties": { "$ref": "#/definitions/AccountUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } diff --git a/specification/portalservices/CopilotSettings.Management/CopilotSettings.tsp b/specification/portalservices/CopilotSettings.Management/CopilotSettings.tsp index af1f8fce56c1..d69ab1c7918d 100644 --- a/specification/portalservices/CopilotSettings.Management/CopilotSettings.tsp +++ b/specification/portalservices/CopilotSettings.Management/CopilotSettings.tsp @@ -24,9 +24,12 @@ model CopilotSettingsResource is ProxyResource { interface CopilotSettings { get is ArmResourceRead; createOrUpdate is ArmResourceCreateOrReplaceSync; - update is ArmResourcePatchSync< + update is ArmCustomPatchSync< CopilotSettingsResource, - CopilotSettingsProperties + Azure.ResourceManager.Foundations.ResourceUpdateModel< + CopilotSettingsResource, + CopilotSettingsProperties + > >; delete is ArmResourceDeleteSync; } diff --git a/specification/portalservices/CopilotSettings.Management/tspconfig.yaml b/specification/portalservices/CopilotSettings.Management/tspconfig.yaml index ff9efcfc1ac9..94374b3ae07f 100644 --- a/specification/portalservices/CopilotSettings.Management/tspconfig.yaml +++ b/specification/portalservices/CopilotSettings.Management/tspconfig.yaml @@ -3,6 +3,9 @@ emit: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true emitter-output-dir: "{project-root}/.." examples-directory: "{project-root}/examples" omit-unreachable-types: true diff --git a/specification/portalservices/Extension.Management/tspconfig.yaml b/specification/portalservices/Extension.Management/tspconfig.yaml index 6c555b4341c3..ff15f5936504 100644 --- a/specification/portalservices/Extension.Management/tspconfig.yaml +++ b/specification/portalservices/Extension.Management/tspconfig.yaml @@ -5,6 +5,9 @@ options: use-read-only-status-schema: true emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/extensions/{version-status}/{version}/extensions.json" examples-directory: "{project-root}/examples" omit-unreachable-types: true diff --git a/specification/portalservices/resource-manager/Microsoft.PortalServices/copilotSettings/preview/2024-04-01-preview/copilotSettings.json b/specification/portalservices/resource-manager/Microsoft.PortalServices/copilotSettings/preview/2024-04-01-preview/copilotSettings.json index cf8c28b43cbd..5f9fa432468a 100644 --- a/specification/portalservices/resource-manager/Microsoft.PortalServices/copilotSettings/preview/2024-04-01-preview/copilotSettings.json +++ b/specification/portalservices/resource-manager/Microsoft.PortalServices/copilotSettings/preview/2024-04-01-preview/copilotSettings.json @@ -306,6 +306,7 @@ "properties": { "properties": { "$ref": "#/definitions/CopilotSettingsResourceUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } diff --git a/specification/powerbidedicated/resource-manager/Microsoft.PowerBIdedicated/stable/2017-10-01/powerbidedicated.json b/specification/powerbidedicated/resource-manager/Microsoft.PowerBIdedicated/stable/2017-10-01/powerbidedicated.json index d71673d707bb..0492b227b712 100644 --- a/specification/powerbidedicated/resource-manager/Microsoft.PowerBIdedicated/stable/2017-10-01/powerbidedicated.json +++ b/specification/powerbidedicated/resource-manager/Microsoft.PowerBIdedicated/stable/2017-10-01/powerbidedicated.json @@ -86,7 +86,7 @@ } }, "put": { - "description": "Provisions the specified Dedicated capacity based on the configuration specified in the request.", + "description": "Provisions the specified dedicated capacity based on the configuration specified in the request. You can’t create a capacity with a name that’s used by another capacity in another tenant in the target location.", "x-ms-examples": { "Create capacity": { "$ref": "./examples/createCapacity.json" @@ -568,7 +568,7 @@ "Capacities" ], "operationId": "Capacities_CheckNameAvailability", - "description": "Check the name availability in the target location.", + "description": "Check the name availability in the target location. The name isn’t available if it’s used by another capacity in another tenant in the target location.", "parameters": [ { "name": "location", diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZoneDelete.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZoneDelete.json new file mode 100644 index 000000000000..293b3da1fa54 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZoneDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsOperationResults/asyncOperationId?api-version=2024-06-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsOperationStatuses/asyncOperationId?api-version=2024-06-01", + "Retry-After": "60" + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZoneGet.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZoneGet.json new file mode 100644 index 000000000000..a17f37baf68c --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZoneGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com", + "name": "privatezone1.com", + "type": "Microsoft.Network/privateDnsZones", + "location": "global", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "maxNumberOfRecordSets": 5000, + "numberOfRecordSets": 1, + "maxNumberOfVirtualNetworkLinks": 100, + "numberOfVirtualNetworkLinks": 0, + "maxNumberOfVirtualNetworkLinksWithRegistration": 50, + "numberOfVirtualNetworkLinksWithRegistration": 0, + "provisioningState": "Succeeded" + }, + "tags": { + "key1": "value1" + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZoneListInResourceGroup.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZoneListInResourceGroup.json new file mode 100644 index 000000000000..c078c96d3893 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZoneListInResourceGroup.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones?api-version=2024-06-01&$skipToken=skipToken", + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com", + "name": "privatezone1.com", + "type": "Microsoft.Network/privateDnsZones", + "location": "global", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "maxNumberOfRecordSets": 5000, + "numberOfRecordSets": 1, + "maxNumberOfVirtualNetworkLinks": 100, + "numberOfVirtualNetworkLinks": 0, + "maxNumberOfVirtualNetworkLinksWithRegistration": 50, + "numberOfVirtualNetworkLinksWithRegistration": 0, + "provisioningState": "Succeeded" + }, + "tags": { + "key1": "value1" + } + }, + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone2.com", + "name": "privatezone2.com", + "type": "Microsoft.Network/privateDnsZones", + "location": "global", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "maxNumberOfRecordSets": 5000, + "numberOfRecordSets": 1, + "maxNumberOfVirtualNetworkLinks": 100, + "numberOfVirtualNetworkLinks": 0, + "maxNumberOfVirtualNetworkLinksWithRegistration": 50, + "numberOfVirtualNetworkLinksWithRegistration": 0, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZoneListInSubscription.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZoneListInSubscription.json new file mode 100644 index 000000000000..2d50019ad46d --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZoneListInSubscription.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.Network/privateDnsZones?api-version=2024-06-01&$skipToken=skipToken", + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com", + "name": "privatezone1.com", + "type": "Microsoft.Network/privateDnsZones", + "location": "global", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "maxNumberOfRecordSets": 5000, + "numberOfRecordSets": 1, + "maxNumberOfVirtualNetworkLinks": 100, + "numberOfVirtualNetworkLinks": 0, + "maxNumberOfVirtualNetworkLinksWithRegistration": 50, + "numberOfVirtualNetworkLinksWithRegistration": 0, + "provisioningState": "Succeeded" + }, + "tags": { + "key1": "value1" + } + }, + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateDnsZones/privatezone2.com", + "name": "privatezone2.com", + "type": "Microsoft.Network/privateDnsZones", + "location": "global", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "maxNumberOfRecordSets": 5000, + "numberOfRecordSets": 1, + "maxNumberOfVirtualNetworkLinks": 100, + "numberOfVirtualNetworkLinks": 0, + "maxNumberOfVirtualNetworkLinksWithRegistration": 50, + "numberOfVirtualNetworkLinksWithRegistration": 0, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZonePatch.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZonePatch.json new file mode 100644 index 000000000000..63d772233814 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZonePatch.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "tags": { + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com", + "name": "privatezone1.com", + "type": "Microsoft.Network/privateDnsZones", + "location": "global", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "maxNumberOfRecordSets": 5000, + "numberOfRecordSets": 1, + "maxNumberOfVirtualNetworkLinks": 100, + "numberOfVirtualNetworkLinks": 0, + "maxNumberOfVirtualNetworkLinksWithRegistration": 50, + "numberOfVirtualNetworkLinksWithRegistration": 0, + "provisioningState": "Succeeded" + }, + "tags": { + "key2": "value2" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsOperationResults/asyncOperationId?api-version=2024-06-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsOperationStatuses/asyncOperationId?api-version=2024-06-01", + "Retry-After": "60" + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZonePut.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZonePut.json new file mode 100644 index 000000000000..00262b80d9e4 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/PrivateZonePut.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "location": "Global", + "tags": { + "key1": "value1" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com", + "name": "privatezone1.com", + "type": "Microsoft.Network/privateDnsZones", + "location": "global", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "maxNumberOfRecordSets": 5000, + "numberOfRecordSets": 1, + "maxNumberOfVirtualNetworkLinks": 100, + "numberOfVirtualNetworkLinks": 0, + "maxNumberOfVirtualNetworkLinksWithRegistration": 50, + "numberOfVirtualNetworkLinksWithRegistration": 0, + "provisioningState": "Succeeded" + }, + "tags": { + "key1": "value1" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com", + "name": "privatezone1.com", + "type": "Microsoft.Network/privateDnsZones", + "location": "global", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "maxNumberOfRecordSets": 5000, + "numberOfRecordSets": 1, + "maxNumberOfVirtualNetworkLinks": 100, + "numberOfVirtualNetworkLinks": 0, + "maxNumberOfVirtualNetworkLinksWithRegistration": 50, + "numberOfVirtualNetworkLinksWithRegistration": 0, + "provisioningState": "Succeeded" + }, + "tags": { + "key1": "value1" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsOperationResults/asyncOperationId?api-version=2024-06-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsOperationStatuses/asyncOperationId?api-version=2024-06-01", + "Retry-After": "60" + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAADelete.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAADelete.json new file mode 100644 index 000000000000..ac4526f77c52 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAADelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "AAAA", + "relativeRecordSetName": "recordAAAA", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAAGet.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAAGet.json new file mode 100644 index 000000000000..c634d9dbfd16 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAAGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "AAAA", + "relativeRecordSetName": "recordAAAA", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/AAAA/recordaaaa", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordaaaa", + "type": "Microsoft.Network/privateDnsZones/AAAA", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordaaaa.privatezone1.com.", + "isAutoRegistered": false, + "aaaaRecords": [ + { + "ipv6Address": "::1" + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAAList.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAAList.json new file mode 100644 index 000000000000..ca5f657beab5 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAAList.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "AAAA", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/AAAA?api-version=2024-06-01&$skipToken=skipToken", + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/AAAA/recordaaaa1", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordaaaa1", + "type": "Microsoft.Network/privateDnsZones/AAAA", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordaaaa1.privatezone1.com.", + "isAutoRegistered": false, + "aaaaRecords": [ + { + "ipv6Address": "::1" + } + ] + } + }, + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/AAAA/recordaaaa2", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordaaaa2", + "type": "Microsoft.Network/privateDnsZones/AAAA", + "properties": { + "ttl": 3600, + "fqdn": "recordaaaa2.privatezone1.com.", + "isAutoRegistered": false, + "aaaaRecords": [ + { + "ipv6Address": "::1" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAAPatch.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAAPatch.json new file mode 100644 index 000000000000..a884ebaeef40 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAAPatch.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "AAAA", + "relativeRecordSetName": "recordAAAA", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/AAAA/recordaaaa", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordaaaa", + "type": "Microsoft.Network/privateDnsZones/AAAA", + "properties": { + "metadata": { + "key2": "value2" + }, + "ttl": 3600, + "fqdn": "recordaaaa.privatezone1.com.", + "isAutoRegistered": false, + "aaaaRecords": [ + { + "ipv6Address": "::1" + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAAPut.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAAPut.json new file mode 100644 index 000000000000..65221307b3f8 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAAAAPut.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "AAAA", + "relativeRecordSetName": "recordAAAA", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "aaaaRecords": [ + { + "ipv6Address": "::1" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/AAAA/recordaaaa", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordaaaa", + "type": "Microsoft.Network/privateDnsZones/AAAA", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordaaaa.privatezone1.com.", + "isAutoRegistered": false, + "aaaaRecords": [ + { + "ipv6Address": "::1" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/AAAA/recordaaaa", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordaaaa", + "type": "Microsoft.Network/privateDnsZones/AAAA", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordaaaa.privatezone1.com.", + "isAutoRegistered": false, + "aaaaRecords": [ + { + "ipv6Address": "::1" + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetADelete.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetADelete.json new file mode 100644 index 000000000000..fe40553dfbf5 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetADelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "A", + "relativeRecordSetName": "recordA", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAGet.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAGet.json new file mode 100644 index 000000000000..d79dac05d54c --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "A", + "relativeRecordSetName": "recordA", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/A/recorda", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recorda", + "type": "Microsoft.Network/privateDnsZones/A", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recorda.privatezone1.com.", + "isAutoRegistered": false, + "aRecords": [ + { + "ipv4Address": "1.2.3.4" + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetALLList.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetALLList.json new file mode 100644 index 000000000000..b7f9ab5fd704 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetALLList.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/ALL?api-version=2024-06-01&$skipToken=skipToken", + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/A/recorda", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recorda", + "type": "Microsoft.Network/privateDnsZones/A", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recorda.privatezone1.com.", + "isAutoRegistered": false, + "aRecords": [ + { + "ipv4Address": "1.2.3.4" + } + ] + } + }, + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/CNAME/recordcname", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordcname", + "type": "Microsoft.Network/privateDnsZones/CNAME", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordcname.privatezone1.com.", + "isAutoRegistered": false, + "cnameRecord": { + "cname": "contoso.com" + } + } + }, + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/MX/recordmx", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordmx", + "type": "Microsoft.Network/privateDnsZones/MX", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordmx.privatezone1.com.", + "isAutoRegistered": false, + "mxRecords": [ + { + "preference": 0, + "exchange": "mail.contoso1.com" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAList.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAList.json new file mode 100644 index 000000000000..29aa487d5ea0 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAList.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "A", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/A?api-version=2024-06-01&$skipToken=skipToken", + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/A/recorda1", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recorda1", + "type": "Microsoft.Network/privateDnsZones/A", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recorda1.privatezone1.com.", + "isAutoRegistered": false, + "aRecords": [ + { + "ipv4Address": "1.2.3.4" + } + ] + } + }, + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/A/recorda2", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recorda2", + "type": "Microsoft.Network/privateDnsZones/A", + "properties": { + "ttl": 3600, + "fqdn": "recorda2.privatezone1.com.", + "isAutoRegistered": false, + "aRecords": [ + { + "ipv4Address": "5.6.7.8" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAPatch.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAPatch.json new file mode 100644 index 000000000000..ecb5a9e7c6a0 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAPatch.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "A", + "relativeRecordSetName": "recordA", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/A/recorda", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recorda", + "type": "Microsoft.Network/privateDnsZones/A", + "properties": { + "metadata": { + "key2": "value2" + }, + "ttl": 3600, + "fqdn": "recorda.privatezone1.com.", + "isAutoRegistered": false, + "aRecords": [ + { + "ipv4Address": "1.2.3.4" + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAPut.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAPut.json new file mode 100644 index 000000000000..0c23419d77f4 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetAPut.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "A", + "relativeRecordSetName": "recordA", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "aRecords": [ + { + "ipv4Address": "1.2.3.4" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/A/recorda", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recorda", + "type": "Microsoft.Network/privateDnsZones/A", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recorda.privatezone1.com.", + "isAutoRegistered": false, + "aRecords": [ + { + "ipv4Address": "1.2.3.4" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/A/recorda", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recorda", + "type": "Microsoft.Network/privateDnsZones/A", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recorda.privatezone1.com.", + "isAutoRegistered": false, + "aRecords": [ + { + "ipv4Address": "1.2.3.4" + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEDelete.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEDelete.json new file mode 100644 index 000000000000..f57b7524c7c0 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "CNAME", + "relativeRecordSetName": "recordCNAME", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEGet.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEGet.json new file mode 100644 index 000000000000..2df8df7a4ba8 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "CNAME", + "relativeRecordSetName": "recordCNAME", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/CNAME/recordcname", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordcname", + "type": "Microsoft.Network/privateDnsZones/CNAME", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordcname.privatezone1.com.", + "isAutoRegistered": false, + "cnameRecord": { + "cname": "contoso.com" + } + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEList.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEList.json new file mode 100644 index 000000000000..170d3eb94b16 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "CNAME", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/CNAME/recordcname", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordcname", + "type": "Microsoft.Network/privateDnsZones/CNAME", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordcname.privatezone1.com.", + "isAutoRegistered": false, + "cnameRecord": { + "cname": "contoso.com" + } + } + } + ] + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEPatch.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEPatch.json new file mode 100644 index 000000000000..bce3da0a9512 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEPatch.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "CNAME", + "relativeRecordSetName": "recordCNAME", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/CNAME/recordcname", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordcname", + "type": "Microsoft.Network/privateDnsZones/CNAME", + "properties": { + "metadata": { + "key2": "value2" + }, + "ttl": 3600, + "fqdn": "recordcname.privatezone1.com.", + "isAutoRegistered": false, + "cnameRecord": { + "cname": "contoso.com" + } + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEPut.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEPut.json new file mode 100644 index 000000000000..64ea5d4375ed --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetCNAMEPut.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "CNAME", + "relativeRecordSetName": "recordCNAME", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "cnameRecord": { + "cname": "contoso.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/CNAME/recordcname", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordcname", + "type": "Microsoft.Network/privateDnsZones/CNAME", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordcname.privatezone1.com.", + "isAutoRegistered": false, + "cnameRecord": { + "cname": "contoso.com" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/CNAME/recordcname", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordcname", + "type": "Microsoft.Network/privateDnsZones/CNAME", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordcname.privatezone1.com.", + "isAutoRegistered": false, + "cnameRecord": { + "cname": "contoso.com" + } + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXDelete.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXDelete.json new file mode 100644 index 000000000000..2fe802130034 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "MX", + "relativeRecordSetName": "recordMX", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXGet.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXGet.json new file mode 100644 index 000000000000..38b48dc703e4 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "MX", + "relativeRecordSetName": "recordMX", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/MX/recordmx", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordmx", + "type": "Microsoft.Network/privateDnsZones/MX", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordmx.privatezone1.com.", + "isAutoRegistered": false, + "mxRecords": [ + { + "preference": 0, + "exchange": "mail.privatezone1.com" + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXList.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXList.json new file mode 100644 index 000000000000..1400f59ae0be --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXList.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "MX", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/MX?api-version=2024-06-01&$skipToken=skipToken", + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/MX/recordmx1", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordmx1", + "type": "Microsoft.Network/privateDnsZones/MX", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordmx1.privatezone1.com.", + "isAutoRegistered": false, + "mxRecords": [ + { + "preference": 0, + "exchange": "mail.contoso1.com" + } + ] + } + }, + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/MX/recordmx2", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordmx2", + "type": "Microsoft.Network/privateDnsZones/MX", + "properties": { + "ttl": 3600, + "fqdn": "recordmx2.privatezone1.com.", + "isAutoRegistered": false, + "mxRecords": [ + { + "preference": 0, + "exchange": "mail.contoso2.com" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXPatch.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXPatch.json new file mode 100644 index 000000000000..588fc80fa15d --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXPatch.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "MX", + "relativeRecordSetName": "recordMX", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/MX/recordmx", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordmx", + "type": "Microsoft.Network/privateDnsZones/MX", + "properties": { + "metadata": { + "key2": "value2" + }, + "ttl": 3600, + "fqdn": "recordmx.privatezone1.com.", + "isAutoRegistered": false, + "mxRecords": [ + { + "preference": 0, + "exchange": "mail.privatezone1.com" + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXPut.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXPut.json new file mode 100644 index 000000000000..cea14eedec2a --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetMXPut.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "MX", + "relativeRecordSetName": "recordMX", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "mxRecords": [ + { + "preference": 0, + "exchange": "mail.privatezone1.com" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/MX/recordmx", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordmx", + "type": "Microsoft.Network/privateDnsZones/MX", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordmx.privatezone1.com.", + "isAutoRegistered": false, + "mxRecords": [ + { + "preference": 0, + "exchange": "mail.privatezone1.com" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/MX/recordmx", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordmx", + "type": "Microsoft.Network/privateDnsZones/MX", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordmx.privatezone1.com.", + "isAutoRegistered": false, + "mxRecords": [ + { + "preference": 0, + "exchange": "mail.privatezone1.com" + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRDelete.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRDelete.json new file mode 100644 index 000000000000..acb596137da3 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "0.0.127.in-addr.arpa", + "recordType": "PTR", + "relativeRecordSetName": "1", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRGet.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRGet.json new file mode 100644 index 000000000000..ef8fd5f4e5a6 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "0.0.127.in-addr.arpa", + "recordType": "PTR", + "relativeRecordSetName": "1", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/0.0.127.in-addr.arpa/PTR/1", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "1", + "type": "Microsoft.Network/privateDnsZones/PTR", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "1.0.0.127.in-addr.arpa.", + "isAutoRegistered": false, + "ptrRecords": [ + { + "ptrdname": "localhost" + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRList.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRList.json new file mode 100644 index 000000000000..a2eb197968c6 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "0.0.127.in-addr.arpa", + "recordType": "PTR", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/PTR?api-version=2024-06-01&$skipToken=skipToken", + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/0.0.127.in-addr.arpa/PTR/1", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "1", + "type": "Microsoft.Network/privateDnsZones/PTR", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "1.0.0.127.in-addr.arpa.", + "isAutoRegistered": false, + "ptrRecords": [ + { + "ptrdname": "localhost" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRPatch.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRPatch.json new file mode 100644 index 000000000000..69c9e435ed16 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRPatch.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "0.0.127.in-addr.arpa", + "recordType": "PTR", + "relativeRecordSetName": "1", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/0.0.127.in-addr.arpa/PTR/1", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "1", + "type": "Microsoft.Network/privateDnsZones/PTR", + "properties": { + "metadata": { + "key2": "value2" + }, + "ttl": 3600, + "fqdn": "1.0.0.127.in-addr.arpa.", + "isAutoRegistered": false, + "ptrRecords": [ + { + "ptrdname": "localhost" + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRPut.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRPut.json new file mode 100644 index 000000000000..612453585f6b --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetPTRPut.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "0.0.127.in-addr.arpa", + "recordType": "PTR", + "relativeRecordSetName": "1", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "ptrRecords": [ + { + "ptrdname": "localhost" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/0.0.127.in-addr.arpa/PTR/1", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "1", + "type": "Microsoft.Network/privateDnsZones/PTR", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "1.0.0.127.in-addr.arpa.", + "isAutoRegistered": false, + "ptrRecords": [ + { + "ptrdname": "localhost" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/0.0.127.in-addr.arpa/PTR/1", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "1", + "type": "Microsoft.Network/privateDnsZones/PTR", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "1.0.0.127.in-addr.arpa.", + "isAutoRegistered": false, + "ptrRecords": [ + { + "ptrdname": "localhost" + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSOAGet.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSOAGet.json new file mode 100644 index 000000000000..15419db68f02 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSOAGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "SOA", + "relativeRecordSetName": "@", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/SOA/@", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "@", + "type": "Microsoft.Network/privateDnsZones/SOA", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "privatezone1.com.", + "isAutoRegistered": false, + "soaRecord": { + "host": "azureprivatedns.net", + "email": "azureprivatedns-hostmaster.microsoft.com", + "serialNumber": 1, + "refreshTime": 3600, + "retryTime": 300, + "expireTime": 2419200, + "minimumTtl": 300 + } + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSOAList.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSOAList.json new file mode 100644 index 000000000000..c9123b755074 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSOAList.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "SOA", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/SOA/@", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "@", + "type": "Microsoft.Network/privateDnsZones/SOA", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "privatezone1.com.", + "isAutoRegistered": false, + "soaRecord": { + "host": "azureprivatedns.net", + "email": "azureprivatedns-hostmaster.microsoft.com", + "serialNumber": 1, + "refreshTime": 3600, + "retryTime": 300, + "expireTime": 2419200, + "minimumTtl": 300 + } + } + } + ] + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSOAPatch.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSOAPatch.json new file mode 100644 index 000000000000..8159ae2e8d53 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSOAPatch.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "SOA", + "relativeRecordSetName": "@", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/SOA/@", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "@", + "type": "Microsoft.Network/privateDnsZones/SOA", + "properties": { + "metadata": { + "key2": "value2" + }, + "ttl": 3600, + "fqdn": "privatezone1.com.", + "isAutoRegistered": false, + "soaRecord": { + "host": "azureprivatedns.net", + "email": "azureprivatedns-hostmaster.microsoft.com", + "serialNumber": 1, + "refreshTime": 3600, + "retryTime": 300, + "expireTime": 2419200, + "minimumTtl": 300 + } + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSOAPut.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSOAPut.json new file mode 100644 index 000000000000..0a774dc7c39a --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSOAPut.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "SOA", + "relativeRecordSetName": "@", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "soaRecord": { + "host": "azureprivatedns.net", + "email": "azureprivatedns-hostmaster.microsoft.com", + "serialNumber": 1, + "refreshTime": 3600, + "retryTime": 300, + "expireTime": 2419200, + "minimumTtl": 300 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/SOA/@", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "@", + "type": "Microsoft.Network/privateDnsZones/SOA", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "privatezone1.com.", + "isAutoRegistered": false, + "soaRecord": { + "host": "azureprivatedns.net", + "email": "azureprivatedns-hostmaster.microsoft.com", + "serialNumber": 1, + "refreshTime": 3600, + "retryTime": 300, + "expireTime": 2419200, + "minimumTtl": 300 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/SOA/@", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "@", + "type": "Microsoft.Network/privateDnsZones/SOA", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "privatezone1.com.", + "isAutoRegistered": false, + "soaRecord": { + "host": "azureprivatedns.net", + "email": "azureprivatedns-hostmaster.microsoft.com", + "serialNumber": 1, + "refreshTime": 3600, + "retryTime": 300, + "expireTime": 2419200, + "minimumTtl": 300 + } + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVDelete.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVDelete.json new file mode 100644 index 000000000000..48d5e5e92f8d --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "SRV", + "relativeRecordSetName": "recordSRV", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVGet.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVGet.json new file mode 100644 index 000000000000..0f2118490b0b --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "SRV", + "relativeRecordSetName": "recordSRV", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/SRV/recordsrv", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordsrv", + "type": "Microsoft.Network/privateDnsZones/SRV", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordsrv.privatezone1.com.", + "isAutoRegistered": false, + "srvRecords": [ + { + "priority": 0, + "weight": 10, + "port": 80, + "target": "contoso.com" + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVList.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVList.json new file mode 100644 index 000000000000..6031c9ed75c8 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVList.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "SRV", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/SRV?api-version=2024-06-01&$skipToken=skipToken", + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/SRV/recordsrv", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordsrv", + "type": "Microsoft.Network/privateDnsZones/SRV", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordsrv.privatezone1.com.", + "isAutoRegistered": false, + "srvRecords": [ + { + "priority": 0, + "weight": 10, + "port": 80, + "target": "contoso.com" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVPatch.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVPatch.json new file mode 100644 index 000000000000..6bc99f37b1b2 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVPatch.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "SRV", + "relativeRecordSetName": "recordSRV", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/SRV/recordsrv", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordsrv", + "type": "Microsoft.Network/privateDnsZones/SRV", + "properties": { + "metadata": { + "key2": "value2" + }, + "ttl": 3600, + "fqdn": "recordsrv.privatezone1.com.", + "isAutoRegistered": false, + "srvRecords": [ + { + "priority": 0, + "weight": 10, + "port": 80, + "target": "contoso.com" + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVPut.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVPut.json new file mode 100644 index 000000000000..7df086e6153f --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetSRVPut.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "SRV", + "relativeRecordSetName": "recordSRV", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "srvRecords": [ + { + "priority": 0, + "weight": 10, + "port": 80, + "target": "contoso.com" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/SRV/recordsrv", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordsrv", + "type": "Microsoft.Network/privateDnsZones/SRV", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordsrv.privatezone1.com.", + "isAutoRegistered": false, + "srvRecords": [ + { + "priority": 0, + "weight": 10, + "port": 80, + "target": "contoso.com" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/SRV/recordsrv", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordsrv", + "type": "Microsoft.Network/privateDnsZones/SRV", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordsrv.privatezone1.com.", + "isAutoRegistered": false, + "srvRecords": [ + { + "priority": 0, + "weight": 10, + "port": 80, + "target": "contoso.com" + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTDelete.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTDelete.json new file mode 100644 index 000000000000..9b976a8d6e0d --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "TXT", + "relativeRecordSetName": "recordTXT", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTGet.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTGet.json new file mode 100644 index 000000000000..74ed545530ad --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "TXT", + "relativeRecordSetName": "recordTXT", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/TXT/recordtxt", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordtxt", + "type": "Microsoft.Network/privateDnsZones/TXT", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordtxt.privatezone1.com.", + "isAutoRegistered": false, + "txtRecords": [ + { + "value": [ + "string1", + "string2" + ] + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTList.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTList.json new file mode 100644 index 000000000000..7b2d4e4f0340 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTList.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "TXT", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/TXT?api-version=2024-06-01&$skipToken=skipToken", + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/TXT/recordtxt", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordtxt", + "type": "Microsoft.Network/privateDnsZones/TXT", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordtxt.privatezone1.com.", + "isAutoRegistered": false, + "txtRecords": [ + { + "value": [ + "string1", + "string2" + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTPatch.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTPatch.json new file mode 100644 index 000000000000..f9bfcad40248 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTPatch.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "TXT", + "relativeRecordSetName": "recordTXT", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/TXT/recordtxt", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordtxt", + "type": "Microsoft.Network/privateDnsZones/TXT", + "properties": { + "metadata": { + "key2": "value2" + }, + "ttl": 3600, + "fqdn": "recordtxt.privatezone1.com.", + "isAutoRegistered": false, + "txtRecords": [ + { + "value": [ + "string1", + "string2" + ] + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTPut.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTPut.json new file mode 100644 index 000000000000..000b10b521fb --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/RecordSetTXTPut.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "recordType": "TXT", + "relativeRecordSetName": "recordTXT", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "txtRecords": [ + { + "value": [ + "string1", + "string2" + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/TXT/recordtxt", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordtxt", + "type": "Microsoft.Network/privateDnsZones/TXT", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordtxt.privatezone1.com.", + "isAutoRegistered": false, + "txtRecords": [ + { + "value": [ + "string1", + "string2" + ] + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/TXT/recordtxt", + "etag": "00000000-0000-0000-0000-000000000000", + "name": "recordtxt", + "type": "Microsoft.Network/privateDnsZones/TXT", + "properties": { + "metadata": { + "key1": "value1" + }, + "ttl": 3600, + "fqdn": "recordtxt.privatezone1.com.", + "isAutoRegistered": false, + "txtRecords": [ + { + "value": [ + "string1", + "string2" + ] + } + ] + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkDelete.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkDelete.json new file mode 100644 index 000000000000..97d8f034483e --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "virtualNetworkLinkName": "virtualNetworkLink1", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsOperationResults/asyncOperationId?api-version=2024-06-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsOperationStatuses/asyncOperationId?api-version=2024-06-01", + "Retry-After": "60" + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkGet.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkGet.json new file mode 100644 index 000000000000..da23d99350d1 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "virtualNetworkLinkName": "virtualNetworkLink1", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/virtualNetworkLinks/virtualNetworkLink1", + "name": "virtualNetworkLink1", + "type": "Microsoft.Network/privateDnsZones/virtualNetworkLinks", + "location": "global", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/virtualNetworkSubscriptionId/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/virtualNetworkName" + }, + "registrationEnabled": false, + "virtualNetworkLinkState": "Completed", + "provisioningState": "Succeeded" + }, + "tags": { + "key1": "value1" + } + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkList.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkList.json new file mode 100644 index 000000000000..a01c5a1e4851 --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkList.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatelink.contoso.com", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/virtualNetworkLinks?api-version=2024-06-01&$skipToken=skipToken", + "value": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatelink.contoso.com/virtualNetworkLinks/virtualNetworkLink1", + "name": "virtualNetworkLink1", + "type": "Microsoft.Network/privateDnsZones/virtualNetworkLinks", + "location": "global", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/virtualNetworkSubscriptionId/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/virtualNetworkName" + }, + "registrationEnabled": false, + "resolutionPolicy": "NxDomainRedirect", + "virtualNetworkLinkState": "Completed", + "provisioningState": "Succeeded" + }, + "tags": { + "key1": "value1" + } + }, + { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatelink.contoso.com/virtualNetworkLinks/virtualNetworkLink2", + "name": "virtualNetworkLink2", + "type": "Microsoft.Network/privateDnsZones/virtualNetworkLinks", + "location": "global", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/virtualNetworkSubscriptionId/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/virtualNetworkName" + }, + "registrationEnabled": true, + "resolutionPolicy": "Default", + "virtualNetworkLinkState": "InProgress", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkPatch.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkPatch.json new file mode 100644 index 000000000000..0000939541ae --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkPatch.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatelink.contoso.com", + "virtualNetworkLinkName": "virtualNetworkLink1", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "tags": { + "key2": "value2" + }, + "properties": { + "registrationEnabled": true, + "resolutionPolicy": "NxDomainRedirect" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatelink.contoso.com/virtualNetworkLinks/virtualNetworkLink1", + "name": "virtualNetworkLink1", + "type": "Microsoft.Network/privateDnsZones/virtualNetworkLinks", + "location": "global", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/virtualNetworkSubscriptionId/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/virtualNetworkName" + }, + "registrationEnabled": true, + "resolutionPolicy": "NxDomainRedirect", + "virtualNetworkLinkState": "Completed", + "provisioningState": "Succeeded" + }, + "tags": { + "key2": "value2" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsOperationResults/asyncOperationId?api-version=2024-06-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsOperationStatuses/asyncOperationId?api-version=2024-06-01", + "Retry-After": "60" + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkPut.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkPut.json new file mode 100644 index 000000000000..45be026b032f --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/examples/VirtualNetworkLinkPut.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "resourceGroupName": "resourceGroup1", + "privateZoneName": "privatezone1.com", + "virtualNetworkLinkName": "virtualNetworkLink1", + "api-version": "2024-06-01", + "subscriptionId": "subscriptionId", + "parameters": { + "location": "Global", + "tags": { + "key1": "value1" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/virtualNetworkSubscriptionId/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/virtualNetworkName" + }, + "registrationEnabled": false + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/virtualNetworkLinks/virtualNetworkLink1", + "name": "virtualNetworkLink1", + "type": "Microsoft.Network/privateDnsZones/virtualNetworkLinks", + "location": "global", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/virtualNetworkSubscriptionId/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/virtualNetworkName" + }, + "registrationEnabled": false, + "virtualNetworkLinkState": "Completed", + "provisioningState": "Succeeded" + }, + "tags": { + "key1": "value1" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/virtualNetworkLinks/virtualNetworkLink1", + "name": "virtualNetworkLink1", + "type": "Microsoft.Network/privateDnsZones/virtualNetworkLinks", + "location": "global", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/virtualNetworkSubscriptionId/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/virtualNetworkName" + }, + "registrationEnabled": false, + "virtualNetworkLinkState": "Completed", + "provisioningState": "Succeeded" + }, + "tags": { + "key1": "value1" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsOperationResults/asyncOperationId?api-version=2024-06-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsOperationStatuses/asyncOperationId?api-version=2024-06-01", + "Retry-After": "60" + } + } + } +} diff --git a/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/privatedns.json b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/privatedns.json new file mode 100644 index 000000000000..25e214a28caa --- /dev/null +++ b/specification/privatedns/resource-manager/Microsoft.Network/stable/2024-06-01/privatedns.json @@ -0,0 +1,1949 @@ +{ + "swagger": "2.0", + "info": { + "title": "PrivateDnsManagementClient", + "description": "The Private DNS Management Client.", + "version": "2024-06-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}": { + "put": { + "tags": [ + "PrivateZones" + ], + "operationId": "PrivateZones_CreateOrUpdate", + "description": "Creates or updates a Private DNS zone. Does not modify Links to virtual networks or DNS records within the zone.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateZoneName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Private DNS zone (without a terminating dot)." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateZone" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the Private DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes." + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfNoneMatch", + "description": "Set to '*' to allow a new Private DNS zone to be created, but to prevent updating an existing zone. Other values will be ignored." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The Private DNS zone has been created.", + "schema": { + "$ref": "#/definitions/PrivateZone" + } + }, + "200": { + "description": "The Private DNS zone has been updated.", + "schema": { + "$ref": "#/definitions/PrivateZone" + } + }, + "202": { + "description": "The Private DNS zone upsert operation has been accepted and will complete asynchronously." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PUT Private DNS Zone": { + "$ref": "./examples/PrivateZonePut.json" + } + } + }, + "patch": { + "tags": [ + "PrivateZones" + ], + "operationId": "PrivateZones_Update", + "description": "Updates a Private DNS zone. Does not modify virtual network links or DNS records within the zone.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateZoneName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Private DNS zone (without a terminating dot)." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateZone" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the Private DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Private DNS zone has been updated.", + "schema": { + "$ref": "#/definitions/PrivateZone" + } + }, + "202": { + "description": "The Private DNS zone update operation has been accepted and will complete asynchronously." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PATCH Private DNS Zone": { + "$ref": "./examples/PrivateZonePatch.json" + } + } + }, + "delete": { + "tags": [ + "PrivateZones" + ], + "operationId": "PrivateZones_Delete", + "description": "Deletes a Private DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone. Private DNS zone cannot be deleted unless all virtual network links to it are removed.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateZoneName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Private DNS zone (without a terminating dot)." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the Private DNS zone. Omit this value to always delete the current zone. Specify the last-seen ETag value to prevent accidentally deleting any concurrent changes." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Private DNS zone has been deleted." + }, + "202": { + "description": "The Private DNS zone delete operation has been accepted and will complete asynchronously." + }, + "204": { + "description": "The Private DNS zone was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DELETE Private DNS Zone": { + "$ref": "./examples/PrivateZoneDelete.json" + } + } + }, + "get": { + "tags": [ + "PrivateZones" + ], + "operationId": "PrivateZones_Get", + "description": "Gets a Private DNS zone. Retrieves the zone properties, but not the virtual networks links or the record sets within the zone.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateZoneName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Private DNS zone (without a terminating dot)." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/PrivateZone" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GET Private DNS Zone": { + "$ref": "./examples/PrivateZoneGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/privateDnsZones": { + "get": { + "tags": [ + "PrivateZones" + ], + "operationId": "PrivateZones_List", + "description": "Lists the Private DNS zones in all resource groups in a subscription.", + "parameters": [ + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of Private DNS zones to return. If not specified, returns up to 100 zones." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/PrivateZoneListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GET Private DNS Zone by Subscription": { + "$ref": "./examples/PrivateZoneListInSubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones": { + "get": { + "tags": [ + "PrivateZones" + ], + "operationId": "PrivateZones_ListByResourceGroup", + "description": "Lists the Private DNS zones within a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of record sets to return. If not specified, returns up to 100 record sets." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/PrivateZoneListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GET Private DNS Zone by Resource Group": { + "$ref": "./examples/PrivateZoneListInResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/virtualNetworkLinks/{virtualNetworkLinkName}": { + "put": { + "tags": [ + "VirtualNetworkLinks" + ], + "operationId": "VirtualNetworkLinks_CreateOrUpdate", + "description": "Creates or updates a virtual network link to the specified Private DNS zone.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateZoneName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Private DNS zone (without a terminating dot)." + }, + { + "name": "virtualNetworkLinkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network link." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkLink" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the virtual network link to the Private DNS zone. Omit this value to always overwrite the current virtual network link. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes." + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfNoneMatch", + "description": "Set to '*' to allow a new virtual network link to the Private DNS zone to be created, but to prevent updating an existing link. Other values will be ignored." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The virtual network link to the Private DNS zone has been created.", + "schema": { + "$ref": "#/definitions/VirtualNetworkLink" + } + }, + "200": { + "description": "The virtual network link to the Private DNS zone has been updated.", + "schema": { + "$ref": "#/definitions/VirtualNetworkLink" + } + }, + "202": { + "description": "The operation to upsert virtual network link to the Private DNS zone has been accepted and will complete asynchronously." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PUT Private DNS Zone Virtual Network Link": { + "$ref": "./examples/VirtualNetworkLinkPut.json" + } + } + }, + "patch": { + "tags": [ + "VirtualNetworkLinks" + ], + "operationId": "VirtualNetworkLinks_Update", + "description": "Updates a virtual network link to the specified Private DNS zone.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateZoneName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Private DNS zone (without a terminating dot)." + }, + { + "name": "virtualNetworkLinkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network link." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkLink" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the virtual network link to the Private DNS zone. Omit this value to always overwrite the current virtual network link. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The virtual network link to the Private DNS zone has been updated.", + "schema": { + "$ref": "#/definitions/VirtualNetworkLink" + } + }, + "202": { + "description": "The operation to link virtual network link to Private DNS zone has been accepted and will complete asynchronously." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PATCH Private DNS Zone Virtual Network Link": { + "$ref": "./examples/VirtualNetworkLinkPatch.json" + } + } + }, + "delete": { + "tags": [ + "VirtualNetworkLinks" + ], + "operationId": "VirtualNetworkLinks_Delete", + "description": "Deletes a virtual network link to the specified Private DNS zone. WARNING: In case of a registration virtual network, all auto-registered DNS records in the zone for the virtual network will also be deleted. This operation cannot be undone.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateZoneName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Private DNS zone (without a terminating dot)." + }, + { + "name": "virtualNetworkLinkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network link." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the virtual network link to the Private DNS zone. Omit this value to always delete the current zone. Specify the last-seen ETag value to prevent accidentally deleting any concurrent changes." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The virtual network link to the Private DNS zone has been deleted." + }, + "202": { + "description": "The operation to delete virtual network link to the Private DNS zone has been accepted and will complete asynchronously." + }, + "204": { + "description": "The virtual network link to the Private DNS zone was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DELETE Private DNS Zone Virtual Network Link": { + "$ref": "./examples/VirtualNetworkLinkDelete.json" + } + } + }, + "get": { + "tags": [ + "VirtualNetworkLinks" + ], + "operationId": "VirtualNetworkLinks_Get", + "description": "Gets a virtual network link to the specified Private DNS zone.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateZoneName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Private DNS zone (without a terminating dot)." + }, + { + "name": "virtualNetworkLinkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network link." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/VirtualNetworkLink" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GET Private DNS Zone Virtual Network Link": { + "$ref": "./examples/VirtualNetworkLinkGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/virtualNetworkLinks": { + "get": { + "tags": [ + "VirtualNetworkLinks" + ], + "operationId": "VirtualNetworkLinks_List", + "description": "Lists the virtual network links to the specified Private DNS zone.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateZoneName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Private DNS zone (without a terminating dot)." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of virtual network links to return. If not specified, returns up to 100 virtual network links." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/VirtualNetworkLinkListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Private DNS Zone Virtual Network Links": { + "$ref": "./examples/VirtualNetworkLinkList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/{recordType}/{relativeRecordSetName}": { + "put": { + "tags": [ + "RecordSets" + ], + "operationId": "RecordSets_CreateOrUpdate", + "description": "Creates or updates a record set within a Private DNS zone.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateZoneName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Private DNS zone (without a terminating dot)." + }, + { + "name": "recordType", + "in": "path", + "required": true, + "type": "string", + "description": "The type of DNS record in this record set. Record sets of type SOA can be updated but not created (they are created when the Private DNS zone is created).", + "enum": [ + "A", + "AAAA", + "CNAME", + "MX", + "PTR", + "SOA", + "SRV", + "TXT" + ], + "x-ms-enum": { + "name": "RecordType", + "modelAsString": false + } + }, + { + "name": "relativeRecordSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the record set, relative to the name of the zone.", + "x-ms-skip-url-encoding": true + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RecordSet" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes." + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfNoneMatch", + "description": "Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will be ignored." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The record set has been created.", + "schema": { + "$ref": "#/definitions/RecordSet" + } + }, + "200": { + "description": "The record set has been updated.", + "schema": { + "$ref": "#/definitions/RecordSet" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "PUT Private DNS Zone A Record Set": { + "$ref": "./examples/RecordSetAPut.json" + }, + "PUT Private DNS Zone AAAA Record Set": { + "$ref": "./examples/RecordSetAAAAPut.json" + }, + "PUT Private DNS Zone CNAME Record Set": { + "$ref": "./examples/RecordSetCNAMEPut.json" + }, + "PUT Private DNS Zone MX Record Set": { + "$ref": "./examples/RecordSetMXPut.json" + }, + "PUT Private DNS Zone PTR Record Set": { + "$ref": "./examples/RecordSetPTRPut.json" + }, + "PUT Private DNS Zone SOA Record Set": { + "$ref": "./examples/RecordSetSOAPut.json" + }, + "PUT Private DNS Zone SRV Record Set": { + "$ref": "./examples/RecordSetSRVPut.json" + }, + "PUT Private DNS Zone TXT Record Set": { + "$ref": "./examples/RecordSetTXTPut.json" + } + } + }, + "patch": { + "tags": [ + "RecordSets" + ], + "operationId": "RecordSets_Update", + "description": "Updates a record set within a Private DNS zone.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateZoneName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Private DNS zone (without a terminating dot)." + }, + { + "name": "recordType", + "in": "path", + "required": true, + "type": "string", + "description": "The type of DNS record in this record set.", + "enum": [ + "A", + "AAAA", + "CNAME", + "MX", + "PTR", + "SOA", + "SRV", + "TXT" + ], + "x-ms-enum": { + "name": "RecordType", + "modelAsString": false + } + }, + { + "name": "relativeRecordSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the record set, relative to the name of the zone.", + "x-ms-skip-url-encoding": true + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RecordSet" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The record set has been updated.", + "schema": { + "$ref": "#/definitions/RecordSet" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "PATCH Private DNS Zone A Record Set": { + "$ref": "./examples/RecordSetAPatch.json" + }, + "PATCH Private DNS Zone AAAA Record Set": { + "$ref": "./examples/RecordSetAAAAPatch.json" + }, + "PATCH Private DNS Zone CNAME Record Set": { + "$ref": "./examples/RecordSetCNAMEPatch.json" + }, + "PATCH Private DNS Zone MX Record Set": { + "$ref": "./examples/RecordSetMXPatch.json" + }, + "PATCH Private DNS Zone PTR Record Set": { + "$ref": "./examples/RecordSetPTRPatch.json" + }, + "PATCH Private DNS Zone SOA Record Set": { + "$ref": "./examples/RecordSetSOAPatch.json" + }, + "PATCH Private DNS Zone SRV Record Set": { + "$ref": "./examples/RecordSetSRVPatch.json" + }, + "PATCH Private DNS Zone TXT Record Set": { + "$ref": "./examples/RecordSetTXTPatch.json" + } + } + }, + "delete": { + "tags": [ + "RecordSets" + ], + "operationId": "RecordSets_Delete", + "description": "Deletes a record set from a Private DNS zone. This operation cannot be undone.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateZoneName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Private DNS zone (without a terminating dot)." + }, + { + "name": "recordType", + "in": "path", + "required": true, + "type": "string", + "description": "The type of DNS record in this record set. Record sets of type SOA cannot be deleted (they are deleted when the Private DNS zone is deleted).", + "enum": [ + "A", + "AAAA", + "CNAME", + "MX", + "PTR", + "SOA", + "SRV", + "TXT" + ], + "x-ms-enum": { + "name": "RecordType", + "modelAsString": false + } + }, + { + "name": "relativeRecordSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the record set, relative to the name of the zone.", + "x-ms-skip-url-encoding": true + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the record set. Omit this value to always delete the current record set. Specify the last-seen ETag value to prevent accidentally deleting any concurrent changes." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The record set has been deleted." + }, + "204": { + "description": "The record set was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DELETE Private DNS Zone A Record Set": { + "$ref": "./examples/RecordSetADelete.json" + }, + "DELETE Private DNS Zone AAAA Record Set": { + "$ref": "./examples/RecordSetAAAADelete.json" + }, + "DELETE Private DNS Zone CNAME Record Set": { + "$ref": "./examples/RecordSetCNAMEDelete.json" + }, + "DELETE Private DNS Zone MX Record Set": { + "$ref": "./examples/RecordSetMXDelete.json" + }, + "DELETE Private DNS Zone PTR Record Set": { + "$ref": "./examples/RecordSetPTRDelete.json" + }, + "DELETE Private DNS Zone SRV Record Set": { + "$ref": "./examples/RecordSetSRVDelete.json" + }, + "DELETE Private DNS Zone TXT Record Set": { + "$ref": "./examples/RecordSetTXTDelete.json" + } + } + }, + "get": { + "tags": [ + "RecordSets" + ], + "operationId": "RecordSets_Get", + "description": "Gets a record set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateZoneName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Private DNS zone (without a terminating dot)." + }, + { + "name": "recordType", + "in": "path", + "required": true, + "type": "string", + "description": "The type of DNS record in this record set.", + "enum": [ + "A", + "AAAA", + "CNAME", + "MX", + "PTR", + "SOA", + "SRV", + "TXT" + ], + "x-ms-enum": { + "name": "RecordType", + "modelAsString": false + } + }, + { + "name": "relativeRecordSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the record set, relative to the name of the zone.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/RecordSet" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GET Private DNS Zone A Record Set": { + "$ref": "./examples/RecordSetAGet.json" + }, + "GET Private DNS Zone AAAA Record Set": { + "$ref": "./examples/RecordSetAAAAGet.json" + }, + "GET Private DNS Zone CNAME Record Set": { + "$ref": "./examples/RecordSetCNAMEGet.json" + }, + "GET Private DNS Zone MX Record Set": { + "$ref": "./examples/RecordSetMXGet.json" + }, + "GET Private DNS Zone PTR Record Set": { + "$ref": "./examples/RecordSetPTRGet.json" + }, + "GET Private DNS Zone SOA Record Set": { + "$ref": "./examples/RecordSetSOAGet.json" + }, + "GET Private DNS Zone SRV Record Set": { + "$ref": "./examples/RecordSetSRVGet.json" + }, + "GET Private DNS Zone TXT Record Set": { + "$ref": "./examples/RecordSetTXTGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/{recordType}": { + "get": { + "tags": [ + "RecordSets" + ], + "operationId": "RecordSets_ListByType", + "description": "Lists the record sets of a specified type in a Private DNS zone.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateZoneName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Private DNS zone (without a terminating dot)." + }, + { + "name": "recordType", + "in": "path", + "required": true, + "type": "string", + "description": "The type of record sets to enumerate.", + "enum": [ + "A", + "AAAA", + "CNAME", + "MX", + "PTR", + "SOA", + "SRV", + "TXT" + ], + "x-ms-enum": { + "name": "RecordType", + "modelAsString": false + } + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of record sets to return. If not specified, returns up to 100 record sets." + }, + { + "name": "$recordsetnamesuffix", + "in": "query", + "required": false, + "type": "string", + "description": "The suffix label of the record set name to be used to filter the record set enumeration. If this parameter is specified, the returned enumeration will only contain records that end with \".\"." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/RecordSetListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GET Private DNS Zone A Record Sets": { + "$ref": "./examples/RecordSetAList.json" + }, + "GET Private DNS Zone AAAA Record Sets": { + "$ref": "./examples/RecordSetAAAAList.json" + }, + "GET Private DNS Zone CNAME Record Sets": { + "$ref": "./examples/RecordSetCNAMEList.json" + }, + "GET Private DNS Zone MX Record Sets": { + "$ref": "./examples/RecordSetMXList.json" + }, + "GET Private DNS Zone PTR Record Sets": { + "$ref": "./examples/RecordSetPTRList.json" + }, + "GET Private DNS Zone SOA Record Sets": { + "$ref": "./examples/RecordSetSOAList.json" + }, + "GET Private DNS Zone SRV Record Sets": { + "$ref": "./examples/RecordSetSRVList.json" + }, + "GET Private DNS Zone TXT Record Sets": { + "$ref": "./examples/RecordSetTXTList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/ALL": { + "get": { + "tags": [ + "RecordSets" + ], + "operationId": "RecordSets_List", + "description": "Lists all record sets in a Private DNS zone.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateZoneName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Private DNS zone (without a terminating dot)." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of record sets to return. If not specified, returns up to 100 record sets." + }, + { + "name": "$recordsetnamesuffix", + "in": "query", + "required": false, + "type": "string", + "description": "The suffix label of the record set name to be used to filter the record set enumeration. If this parameter is specified, the returned enumeration will only contain records that end with \".\"." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/RecordSetListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GET Private DNS Zone ALL Record Sets": { + "$ref": "./examples/RecordSetALLList.json" + } + } + } + } + }, + "definitions": { + "PrivateZoneProperties": { + "properties": { + "maxNumberOfRecordSets": { + "type": "integer", + "format": "int64", + "description": "The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.", + "readOnly": true + }, + "numberOfRecordSets": { + "type": "integer", + "format": "int64", + "description": "The current number of record sets in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.", + "readOnly": true + }, + "maxNumberOfVirtualNetworkLinks": { + "type": "integer", + "format": "int64", + "description": "The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.", + "readOnly": true + }, + "numberOfVirtualNetworkLinks": { + "type": "integer", + "format": "int64", + "description": "The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.", + "readOnly": true + }, + "maxNumberOfVirtualNetworkLinksWithRegistration": { + "type": "integer", + "format": "int64", + "description": "The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.", + "readOnly": true + }, + "numberOfVirtualNetworkLinksWithRegistration": { + "type": "integer", + "format": "int64", + "description": "The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.", + "readOnly": true + }, + "provisioningState": { + "type": "string", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "description": "The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored.", + "readOnly": true + }, + "internalId": { + "type": "string", + "description": "Private zone internal Id", + "readOnly": true + } + }, + "description": "Represents the properties of the Private DNS zone." + }, + "PrivateZone": { + "properties": { + "etag": { + "type": "string", + "description": "The ETag of the zone." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateZoneProperties", + "description": "Properties of the Private DNS zone." + } + }, + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "description": "Describes a Private DNS zone." + }, + "PrivateZoneListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateZone" + }, + "description": "Information about the Private DNS zones." + }, + "nextLink": { + "type": "string", + "description": "The continuation token for the next page of results.", + "readOnly": true + } + }, + "description": "The response to a Private DNS zone list operation." + }, + "VirtualNetworkLinkProperties": { + "properties": { + "virtualNetwork": { + "$ref": "#/definitions/SubResource", + "description": "The reference of the virtual network." + }, + "registrationEnabled": { + "type": "boolean", + "description": "Is auto-registration of virtual machine records in the virtual network in the Private DNS zone enabled?" + }, + "resolutionPolicy": { + "type": "string", + "description": "The resolution policy on the virtual network link. Only applicable for virtual network links to privatelink zones, and for A,AAAA,CNAME queries. When set to 'NxDomainRedirect', Azure DNS resolver falls back to public resolution if private dns query resolution results in non-existent domain response.", + "enum": [ + "Default", + "NxDomainRedirect" + ], + "x-ms-enum": { + "name": "resolutionPolicy", + "modelAsString": true + } + }, + "virtualNetworkLinkState": { + "type": "string", + "description": "The status of the virtual network link to the Private DNS zone. Possible values are 'InProgress' and 'Done'. This is a read-only property and any attempt to set this value will be ignored.", + "enum": [ + "InProgress", + "Completed" + ], + "x-ms-enum": { + "name": "VirtualNetworkLinkState", + "modelAsString": true + }, + "readOnly": true + }, + "provisioningState": { + "type": "string", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "description": "The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored.", + "readOnly": true + } + }, + "description": "Represents the properties of the Private DNS zone." + }, + "VirtualNetworkLink": { + "properties": { + "etag": { + "type": "string", + "description": "The ETag of the virtual network link." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkLinkProperties", + "description": "Properties of the virtual network link to the Private DNS zone." + } + }, + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "description": "Describes a link to virtual network for a Private DNS zone." + }, + "VirtualNetworkLinkListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkLink" + }, + "description": "Information about the virtual network links to the Private DNS zones." + }, + "nextLink": { + "type": "string", + "description": "The continuation token for the next page of results.", + "readOnly": true + } + }, + "description": "The response to a list virtual network link to Private DNS zone operation." + }, + "ARecord": { + "properties": { + "ipv4Address": { + "type": "string", + "description": "The IPv4 address of this A record." + } + }, + "description": "An A record." + }, + "AaaaRecord": { + "properties": { + "ipv6Address": { + "type": "string", + "description": "The IPv6 address of this AAAA record." + } + }, + "description": "An AAAA record." + }, + "CnameRecord": { + "properties": { + "cname": { + "type": "string", + "description": "The canonical name for this CNAME record." + } + }, + "description": "A CNAME record." + }, + "MxRecord": { + "properties": { + "preference": { + "type": "integer", + "format": "int32", + "description": "The preference value for this MX record." + }, + "exchange": { + "type": "string", + "description": "The domain name of the mail host for this MX record." + } + }, + "description": "An MX record." + }, + "PtrRecord": { + "properties": { + "ptrdname": { + "type": "string", + "description": "The PTR target domain name for this PTR record." + } + }, + "description": "A PTR record." + }, + "SoaRecord": { + "properties": { + "host": { + "type": "string", + "description": "The domain name of the authoritative name server for this SOA record." + }, + "email": { + "type": "string", + "description": "The email contact for this SOA record." + }, + "serialNumber": { + "type": "integer", + "format": "int64", + "description": "The serial number for this SOA record." + }, + "refreshTime": { + "type": "integer", + "format": "int64", + "description": "The refresh value for this SOA record." + }, + "retryTime": { + "type": "integer", + "format": "int64", + "description": "The retry time for this SOA record." + }, + "expireTime": { + "type": "integer", + "format": "int64", + "description": "The expire time for this SOA record." + }, + "minimumTtl": { + "type": "integer", + "format": "int64", + "description": "The minimum value for this SOA record. By convention this is used to determine the negative caching duration." + } + }, + "description": "An SOA record." + }, + "SrvRecord": { + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority value for this SRV record." + }, + "weight": { + "type": "integer", + "format": "int32", + "description": "The weight value for this SRV record." + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The port value for this SRV record." + }, + "target": { + "type": "string", + "description": "The target domain name for this SRV record." + } + }, + "description": "An SRV record." + }, + "TxtRecord": { + "properties": { + "value": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The text value of this TXT record." + } + }, + "description": "A TXT record." + }, + "RecordSetProperties": { + "properties": { + "metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The metadata attached to the record set." + }, + "ttl": { + "type": "integer", + "format": "int64", + "description": "The TTL (time-to-live) of the records in the record set." + }, + "fqdn": { + "type": "string", + "description": "Fully qualified domain name of the record set.", + "readOnly": true + }, + "isAutoRegistered": { + "type": "boolean", + "description": "Is the record set auto-registered in the Private DNS zone through a virtual network link?", + "readOnly": true + }, + "aRecords": { + "type": "array", + "items": { + "$ref": "#/definitions/ARecord" + }, + "x-ms-identifiers": [ + "ipv4Address" + ], + "description": "The list of A records in the record set." + }, + "aaaaRecords": { + "type": "array", + "items": { + "$ref": "#/definitions/AaaaRecord" + }, + "x-ms-identifiers": [ + "ipv6Address" + ], + "description": "The list of AAAA records in the record set." + }, + "cnameRecord": { + "$ref": "#/definitions/CnameRecord", + "description": "The CNAME record in the record set." + }, + "mxRecords": { + "type": "array", + "items": { + "$ref": "#/definitions/MxRecord" + }, + "x-ms-identifiers": [], + "description": "The list of MX records in the record set." + }, + "ptrRecords": { + "type": "array", + "items": { + "$ref": "#/definitions/PtrRecord" + }, + "x-ms-identifiers": [], + "description": "The list of PTR records in the record set." + }, + "soaRecord": { + "$ref": "#/definitions/SoaRecord", + "description": "The SOA record in the record set." + }, + "srvRecords": { + "type": "array", + "items": { + "$ref": "#/definitions/SrvRecord" + }, + "x-ms-identifiers": [], + "description": "The list of SRV records in the record set." + }, + "txtRecords": { + "type": "array", + "items": { + "$ref": "#/definitions/TxtRecord" + }, + "x-ms-identifiers": [], + "description": "The list of TXT records in the record set." + } + }, + "description": "Represents the properties of the records in the record set." + }, + "RecordSet": { + "properties": { + "id": { + "type": "string", + "description": "The ID of the record set.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of the record set.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "The type of the record set.", + "readOnly": true + }, + "etag": { + "type": "string", + "description": "The ETag of the record set." + }, + "properties": { + "$ref": "#/definitions/RecordSetProperties", + "x-ms-client-flatten": true, + "description": "The properties of the record set." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Describes a DNS record set (a collection of DNS records with the same name and type) in a Private DNS zone." + }, + "RecordSetListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RecordSet" + }, + "description": "Information about the record sets in the response." + }, + "nextLink": { + "type": "string", + "description": "The continuation token for the next page of results.", + "readOnly": true + } + }, + "description": "The response to a record set list operation." + }, + "Resource": { + "description": "The core properties of ARM resources", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Fully qualified resource Id for the resource. Example - '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}'." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the resource" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The type of the resource. Example - 'Microsoft.Network/privateDnsZones'." + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The Azure Region where the resource lives" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ProxyResource": { + "description": "The resource model definition for an ARM proxy resource.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "SubResource": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + }, + "description": "Reference to another subresource.", + "x-ms-azure-resource": true + }, + "CloudError": { + "type": "object", + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "Cloud error body." + } + }, + "description": "An error response from the service." + }, + "CloudErrorBody": { + "type": "object", + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "x-ms-identifiers": [ + "code" + ], + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the service." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } +} diff --git a/specification/privatedns/resource-manager/readme.go.md b/specification/privatedns/resource-manager/readme.go.md index fda918b8f833..befe899c4cd3 100644 --- a/specification/privatedns/resource-manager/readme.go.md +++ b/specification/privatedns/resource-manager/readme.go.md @@ -19,11 +19,21 @@ azure-arm: true ### Go multi-api -``` yaml $(go) && $(multiapi) +``` yaml $(go) && $(multiapi) batch: + - tag: package-2024-06 - tag: package-2018-09 ``` +### Tag: package-2024-06 and go + +These settings apply only when `--tag=package-2024-06 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2024-06' && $(go) +output-folder: $(go-sdk-folder)/services/privatedns/mgmt/2024-06-01/privatedns +``` + ### Tag: package-2018-09 and go These settings apply only when `--tag=package-2018-09 --go` is specified on the command line. diff --git a/specification/privatedns/resource-manager/readme.md b/specification/privatedns/resource-manager/readme.md index 55eef147509e..a55ac17b280a 100644 --- a/specification/privatedns/resource-manager/readme.md +++ b/specification/privatedns/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the Private DNS API. ``` yaml openapi-type: arm -tag: package-2020-06 +tag: package-2024-06 ``` ### Tag: package-2018-09 @@ -56,6 +56,15 @@ input-file: - Microsoft.Network/stable/2020-06-01/privatedns.json ``` +### Tag: package-2024-06 + +These settings apply only when `--tag=package-2024-06` is specified on the command line. + +``` yaml $(tag) == 'package-2024-06' +input-file: + - Microsoft.Network/stable/2024-06-01/privatedns.json +``` + # Code Generation ## Swagger to SDK @@ -129,6 +138,11 @@ batch: - tag: package-2020-06 ``` +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2024-06 +``` + ### Tag: package-2018-09 and java These settings apply only when `--tag=package-2018-09 --java` is specified on the command line. @@ -171,6 +185,20 @@ generate-interface: true fconfig: '{"moduleName": "privatedns"}' ``` +### Tag: package-2024-06 and java + +These settings apply only when `--tag=package-2024-06 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2024-06' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.privatedns.v2024_06_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/privatedns/mgmt-v2024_06_01 +regenerate-manager: true +generate-interface: true +fconfig: '{"moduleName": "privatedns"}' +``` + ## Suppression ``` yaml @@ -196,6 +224,3 @@ directive: suppress: DescriptionAndTitleMissing reason: Common types warning. ``` - - - diff --git a/specification/privatedns/resource-manager/readme.nodejs.md b/specification/privatedns/resource-manager/readme.nodejs.md new file mode 100644 index 000000000000..19ed26788d52 --- /dev/null +++ b/specification/privatedns/resource-manager/readme.nodejs.md @@ -0,0 +1,14 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + azure-arm: true + package-name: azure-arm-privatedns + output-folder: $(node-sdks-folder)/lib/services/privatednsManagement + generate-license-txt: true + generate-package-json: true + generate-readme-md: true +``` diff --git a/specification/privatedns/resource-manager/readme.python.md b/specification/privatedns/resource-manager/readme.python.md index 845e3cf448bb..752c68007741 100644 --- a/specification/privatedns/resource-manager/readme.python.md +++ b/specification/privatedns/resource-manager/readme.python.md @@ -4,7 +4,6 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - ``` yaml $(python) azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION @@ -18,4 +17,3 @@ clear-output-folder: true no-namespace-folders: true output-folder: $(python-sdks-folder)/network/azure-mgmt-privatedns/azure/mgmt/privatedns ``` - diff --git a/specification/privatedns/resource-manager/readme.ruby.md b/specification/privatedns/resource-manager/readme.ruby.md index 88b668230fc5..30bae7002192 100644 --- a/specification/privatedns/resource-manager/readme.ruby.md +++ b/specification/privatedns/resource-manager/readme.ruby.md @@ -4,7 +4,7 @@ These settings apply only when `--ruby` is specified on the command line. ``` yaml package-name: azure_mgmt_privatedns -package-version: "0.16.0" +package-version: "0.16.1" azure-arm: true ``` @@ -12,9 +12,20 @@ azure-arm: true ``` yaml $(ruby) && $(multiapi) batch: + - tag: package-2024-06 - tag: package-2018-09 ``` +### Tag: package-2024-06 and ruby + +These settings apply only when `--tag=package-2024-06 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2024-06' && $(ruby) +namespace: "Azure::PrivateDns::Mgmt::V2024_06_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_privatedns/lib +``` + ### Tag: package-2018-09 and ruby These settings apply only when `--tag=package-2018-09 --ruby` is specified on the command line. diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 7dd2a7fb5645..3b6a8429d588 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -116,7 +116,7 @@ interface Entity { """) @query collectionId?: string; - } & AtlasEntityWithExtInfo, + } & BodyParameter, EntityMutationResult, AtlasApiVersionParameterTraits >; @@ -174,7 +174,7 @@ interface Entity { """) @query businessAttributeUpdateBehavior?: BusinessAttributeUpdateBehavior; - } & AtlasEntitiesWithExtInfo, + } & BodyParameter, EntityMutationResult, AtlasApiVersionParameterTraits >; @@ -205,7 +205,11 @@ interface Entity { @doc("Associate a classification to multiple entities in bulk.") @route("/atlas/v2/entity/bulk/classification") @post - addClassification is AtlasOperation; + addClassification is AtlasOperation< + BodyParameter, + void, + {} + >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @@ -447,7 +451,7 @@ interface Entity { """) @query("attr:qualifiedName") attribute?: string; - } & AtlasEntityWithExtInfo, + } & BodyParameter, EntityMutationResult, {} >; @@ -576,7 +580,7 @@ interface Entity { @route("/atlas/v2/entity/bulk/setClassifications") @post bulkSetClassifications is AtlasOperation< - AtlasEntityHeaders, + BodyParameter, OkResponse, {} >; @@ -765,7 +769,7 @@ interface Entity { @route("/atlas/v2/entity/businessmetadata/import") @post importBusinessMetadata is AtlasImportOperation< - BusinessMetadataOptions, + BodyParameter, BulkImportResult, MultipartFormDataRequestHeadersTraits >; @@ -966,7 +970,7 @@ interface Entity { @doc("The collection where entities will be moved to.") @query collectionId: string; - } & MoveEntitiesOptions, + } & BodyParameter, EntityMutationResult, {}, AtlasErrorResponse @@ -1011,7 +1015,7 @@ interface Glossary { @doc("Create a glossary.") @route("/atlas/v2/glossary") @post - create is AtlasOperation; + create is AtlasOperation, AtlasGlossary, {}>; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1035,7 +1039,7 @@ interface Glossary { @route("/atlas/v2/glossary/category") @post createCategory is AtlasOperation< - AtlasGlossaryCategory, + BodyParameter, AtlasGlossaryCategory, {} >; @@ -1065,7 +1069,7 @@ interface Glossary { @doc("The globally unique identifier of the category.") @path categoryId: string; - } & AtlasGlossaryCategory, + } & BodyParameter, AtlasGlossaryCategory, {} >; @@ -1178,7 +1182,7 @@ interface Glossary { @doc("Whether include term hierarchy") @query includeTermHierarchy?: boolean; - } & AtlasGlossaryTerm, + } & BodyParameter, AtlasGlossaryTerm, {} >; @@ -1210,7 +1214,7 @@ interface Glossary { @doc("Whether include term hierarchy") @query includeTermHierarchy?: boolean; - } & AtlasGlossaryTerm, + } & BodyParameter, AtlasGlossaryTerm, AtlasApiVersionParameterTraits >; @@ -1412,7 +1416,7 @@ interface Glossary { @doc("Whether ignore terms and categories") @query ignoreTermsAndCategories?: boolean; - } & AtlasGlossary, + } & BodyParameter, AtlasGlossary, AtlasApiVersionParameterTraits >; @@ -1673,7 +1677,7 @@ interface Lineage { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" @doc("Return immediate next page lineage info about entity with pagination") - @route("/lineage/{guid}/next/") + @route("/lineage/{guid}/next") @get getNextPage is Azure.Core.Foundations.Operation< { @@ -1752,14 +1756,22 @@ interface Relationship { @doc("Create a new relationship between entities.") @route("/atlas/v2/relationship") @post - create is AtlasOperation; + create is AtlasOperation< + BodyParameter, + AtlasRelationship, + {} + >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Update an existing relationship between entities.") @route("/atlas/v2/relationship") @put - update is AtlasOperation; + update is AtlasOperation< + BodyParameter, + AtlasRelationship, + {} + >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @@ -2051,7 +2063,7 @@ interface Type { """) @route("/atlas/v2/types/typedefs") @post - bulkCreate is AtlasOperation; + bulkCreate is AtlasOperation, AtlasTypesDef, {}>; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @@ -2061,14 +2073,14 @@ interface Type { """) @route("/atlas/v2/types/typedefs") @put - bulkUpdate is AtlasOperation; + bulkUpdate is AtlasOperation, AtlasTypesDef, {}>; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Delete API for all types in bulk.") @route("/atlas/v2/types/typedefs") @delete - bulkDelete is AtlasOperation; + bulkDelete is AtlasOperation, void, {}>; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("List all type definitions returned as a list of minimal information header.") 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 2d8ab19b2b35..4acce1bf0f2f 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 @@ -101,6 +101,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AtlasEntityWithExtInfo" @@ -241,6 +242,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AtlasEntitiesWithExtInfo" @@ -312,6 +314,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/ClassificationAssociateOptions" @@ -344,6 +347,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AtlasEntityHeaders" @@ -438,7 +442,11 @@ ], "parameters": [ { - "$ref": "#/parameters/BusinessMetadataOptions" + "name": "file", + "in": "formData", + "description": "InputStream of file", + "required": true, + "type": "file" } ], "responses": { @@ -1237,6 +1245,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AtlasEntityWithExtInfo" @@ -1671,6 +1680,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AtlasGlossary" @@ -1755,6 +1765,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AtlasGlossary" @@ -2203,6 +2214,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AtlasGlossaryCategory" @@ -2277,6 +2289,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AtlasGlossaryCategory" @@ -2519,6 +2532,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AtlasGlossaryTerm" @@ -2612,6 +2626,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AtlasGlossaryTerm" @@ -3156,6 +3171,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AtlasRelationship" @@ -3189,6 +3205,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AtlasRelationship" @@ -3915,6 +3932,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AtlasTypesDef" @@ -3948,6 +3966,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AtlasTypesDef" @@ -3984,6 +4003,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AtlasTypesDef" @@ -4142,6 +4162,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/MoveEntitiesOptions" @@ -8241,14 +8262,6 @@ "minLength": 1, "x-ms-parameter-location": "method", "x-ms-client-name": "apiVersion" - }, - "BusinessMetadataOptions": { - "name": "file", - "in": "formData", - "description": "InputStream of file", - "required": true, - "type": "file", - "x-ms-parameter-location": "method" } } } diff --git a/specification/purviewpolicy/PurviewPolicy.Management/tspconfig.yaml b/specification/purviewpolicy/PurviewPolicy.Management/tspconfig.yaml index 0d7967535c7d..43ee6d370679 100644 --- a/specification/purviewpolicy/PurviewPolicy.Management/tspconfig.yaml +++ b/specification/purviewpolicy/PurviewPolicy.Management/tspconfig.yaml @@ -4,6 +4,9 @@ options: "@azure-tools/typespec-autorest": emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/policy.json" examples-directory: "{project-root}/examples" omit-unreachable-types: true diff --git a/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/readme.python.md b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/readme.python.md index 3da9db0dfc5a..eca631530d0e 100644 --- a/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/readme.python.md +++ b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/readme.python.md @@ -16,9 +16,10 @@ no-namespace-folders: true Generate all API versions currently shipped for this package ```yaml $(python) -default-api-version: "2023-09-04" +default-api-version: "2023-11-22" multiapi: true batch: + - tag: package-2023-11 - tag: package-2020-04-30 - tag: package-2021-09-01-preview - tag: package-2022-04-01 @@ -96,4 +97,15 @@ Please also specify `--python-sdks-folder=`. + + +``` yaml $(tag) == 'package-2023-11' && $(python) +namespace: azure.mgmt.redhatopenshift.v2023_11_22 +output-folder: $(python-sdks-folder)/redhatopenshift/azure-mgmt-redhatopenshift/azure/mgmt/redhatopenshift/v2023_11_22 +``` diff --git a/specification/riskiq/Easm/routes.tsp b/specification/riskiq/Easm/routes.tsp index f8220b541bfb..3d0749b5b354 100644 --- a/specification/riskiq/Easm/routes.tsp +++ b/specification/riskiq/Easm/routes.tsp @@ -30,7 +30,7 @@ interface Assets { @updatesResource(AssetResource) @post updateAssets is Foundations.Operation< - AssetsUpdateParameter & AssetUpdateData, + AssetsUpdateParameter & BodyParameter, Task >; @doc("Retrieve an asset by assetId.") @@ -136,7 +136,7 @@ interface DiscoveryGroups { @clientName("CreateOrReplaceDiscoveryGroup", "csharp") createOrReplaceDiscoGroup is Foundations.ResourceOperation< DiscoGroup, - DiscoGroupData, + BodyParameter, DiscoGroup >; @doc("Run a discovery group with a given groupName.") @@ -242,7 +242,7 @@ interface SavedFilters { @put createOrReplaceSavedFilter is Foundations.ResourceOperation< SavedFilter, - SavedFilterData, + BodyParameter, SavedFilter >; @doc("Delete a saved filter with a given filterName.") diff --git a/specification/riskiq/Easm/tspconfig.yaml b/specification/riskiq/Easm/tspconfig.yaml index 2f6eaacb276e..15aadb491724 100644 --- a/specification/riskiq/Easm/tspconfig.yaml +++ b/specification/riskiq/Easm/tspconfig.yaml @@ -31,3 +31,4 @@ options: namespace: com.azure.analytics.defender.easm partial-update: true flavor: azure + api-version: "2023-03-01-preview" diff --git a/specification/riskiq/data-plane/Microsoft.Easm/preview/2023-03-01-preview/easm.json b/specification/riskiq/data-plane/Microsoft.Easm/preview/2023-03-01-preview/easm.json index dd82cf71c089..47473755a586 100644 --- a/specification/riskiq/data-plane/Microsoft.Easm/preview/2023-03-01-preview/easm.json +++ b/specification/riskiq/data-plane/Microsoft.Easm/preview/2023-03-01-preview/easm.json @@ -145,6 +145,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AssetUpdateData" @@ -576,6 +577,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/DiscoGroupData" @@ -1102,6 +1104,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/SavedFilterData" diff --git a/specification/riskiq/data-plane/Microsoft.Easm/preview/2024-03-01-preview/easm.json b/specification/riskiq/data-plane/Microsoft.Easm/preview/2024-03-01-preview/easm.json index d6f807a38604..28fe10ab0078 100644 --- a/specification/riskiq/data-plane/Microsoft.Easm/preview/2024-03-01-preview/easm.json +++ b/specification/riskiq/data-plane/Microsoft.Easm/preview/2024-03-01-preview/easm.json @@ -157,6 +157,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/AssetUpdateData" @@ -893,6 +894,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/DiscoGroupData" @@ -1604,6 +1606,7 @@ { "name": "body", "in": "body", + "description": "Body parameter.", "required": true, "schema": { "$ref": "#/definitions/SavedFilterData" diff --git a/specification/scvmm/ScVmm.Management/VirtualMachineInstance.tsp b/specification/scvmm/ScVmm.Management/VirtualMachineInstance.tsp index 2fc0b9c11303..385dee8d15ee 100644 --- a/specification/scvmm/ScVmm.Management/VirtualMachineInstance.tsp +++ b/specification/scvmm/ScVmm.Management/VirtualMachineInstance.tsp @@ -97,7 +97,7 @@ interface VirtualMachineInstances { >; /** Lists all of the virtual machine instances within the specified parent resource. */ @summary("Implements List virtual machine instances.") - listByArm is ArmResourceListByParent; + list is ArmResourceListByParent; /** The operation to power off (stop) a virtual machine instance. */ @summary("Implements the operation to stop a virtual machine.") stop is ArmResourceActionNoResponseContentAsync< diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_CreateOrUpdate_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..91089ab0eeee --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,85 @@ +{ + "title": "AvailabilitySets_CreateOrUpdate_MaximumSet", + "operationId": "AvailabilitySets_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "availabilitySetResourceName": "-", + "resource": { + "properties": { + "availabilitySetName": "njrpftunzo", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key5701": "cldtxloqh" + }, + "location": "jelevilan" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "availabilitySetName": "njrpftunzo", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key5701": "cldtxloqh" + }, + "location": "jelevilan", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "dibfuxyuidzxcfik", + "type": "xwzjruksexpuqgtreexm", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "availabilitySetName": "njrpftunzo", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key5701": "cldtxloqh" + }, + "location": "jelevilan", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "dibfuxyuidzxcfik", + "type": "xwzjruksexpuqgtreexm", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_CreateOrUpdate_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..3d66333e44db --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "AvailabilitySets_CreateOrUpdate_MinimumSet", + "operationId": "AvailabilitySets_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "availabilitySetResourceName": "_", + "resource": { + "extendedLocation": {}, + "location": "jelevilan" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "extendedLocation": {}, + "location": "jelevilan" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "extendedLocation": {}, + "location": "jelevilan" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_Delete_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..2a1a6258d92e --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "AvailabilitySets_Delete_MaximumSet", + "operationId": "AvailabilitySets_Delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "force": "true", + "availabilitySetResourceName": "_" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_Delete_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..02f0574906b3 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "AvailabilitySets_Delete_MinimumSet", + "operationId": "AvailabilitySets_Delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "availabilitySetResourceName": "6" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_Get_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..e994660c820b --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_Get_MaximumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "title": "AvailabilitySets_Get_MaximumSet", + "operationId": "AvailabilitySets_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "availabilitySetResourceName": "-" + }, + "responses": { + "200": { + "body": { + "properties": { + "availabilitySetName": "njrpftunzo", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key5701": "cldtxloqh" + }, + "location": "jelevilan", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "dibfuxyuidzxcfik", + "type": "xwzjruksexpuqgtreexm", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_Get_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..ab8d9833ef0e --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "AvailabilitySets_Get_MinimumSet", + "operationId": "AvailabilitySets_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "availabilitySetResourceName": "V" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "extendedLocation": {}, + "location": "jelevilan" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_ListByResourceGroup_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..db93ccbd5807 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,44 @@ +{ + "title": "AvailabilitySets_ListByResourceGroup_MaximumSet", + "operationId": "AvailabilitySets_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "availabilitySetName": "njrpftunzo", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key5701": "cldtxloqh" + }, + "location": "jelevilan", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "dibfuxyuidzxcfik", + "type": "xwzjruksexpuqgtreexm", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_ListByResourceGroup_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..13d72d3df9e0 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "AvailabilitySets_ListByResourceGroup_MinimumSet", + "operationId": "AvailabilitySets_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "extendedLocation": {}, + "location": "jelevilan" + } + ] + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_ListBySubscription_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..2f01ed4e4796 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,43 @@ +{ + "title": "AvailabilitySets_ListBySubscription_MaximumSet", + "operationId": "AvailabilitySets_ListBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "availabilitySetName": "njrpftunzo", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key5701": "cldtxloqh" + }, + "location": "jelevilan", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "dibfuxyuidzxcfik", + "type": "xwzjruksexpuqgtreexm", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_ListBySubscription_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_ListBySubscription_MinimumSet_Gen.json new file mode 100644 index 000000000000..8c191ea51c26 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_ListBySubscription_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "AvailabilitySets_ListBySubscription_MinimumSet", + "operationId": "AvailabilitySets_ListBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "extendedLocation": {}, + "location": "jelevilan" + } + ] + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_Update_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..09110162fb56 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_Update_MaximumSet_Gen.json @@ -0,0 +1,50 @@ +{ + "title": "AvailabilitySets_Update_MaximumSet", + "operationId": "AvailabilitySets_Update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "availabilitySetResourceName": "-", + "properties": { + "tags": { + "key1460": "vcbwibkvr" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "availabilitySetName": "njrpftunzo", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key5701": "cldtxloqh" + }, + "location": "jelevilan", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "dibfuxyuidzxcfik", + "type": "xwzjruksexpuqgtreexm", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_Update_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..ec9a90e8ef9d --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/AvailabilitySets_Update_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "AvailabilitySets_Update_MinimumSet", + "operationId": "AvailabilitySets_Update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "availabilitySetResourceName": "1", + "properties": {} + }, + "responses": { + "200": { + "body": { + "extendedLocation": {}, + "location": "jelevilan" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_CreateOrUpdate_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..4946a09dfc87 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,121 @@ +{ + "title": "Clouds_CreateOrUpdate_MaximumSet", + "operationId": "Clouds_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "cloudResourceName": "2", + "resource": { + "properties": { + "inventoryItemId": "qjd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudCapacity": {} + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4295": "wngosgcbdifaxdobufuuqxtho" + }, + "location": "khwsdmaxfhmbu" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "qjd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudName": "menarjsplhcqvnkjdwieroir", + "cloudCapacity": { + "cpuCount": 4, + "memoryMB": 19, + "vmCount": 28 + }, + "storageQoSPolicies": [ + { + "name": "hvqcentnbwcunxhzfavyewhwlo", + "id": "oclhgkydaw", + "iopsMaximum": 6, + "iopsMinimum": 25, + "bandwidthLimit": 26, + "policyId": "lvcylbmxrqjgarvhfny" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4295": "wngosgcbdifaxdobufuuqxtho" + }, + "location": "khwsdmaxfhmbu", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "name": "wwcwalpiufsfbnydxpr", + "type": "qnaaimszbuokldohwrdfuiitpy", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "inventoryItemId": "qjd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudName": "menarjsplhcqvnkjdwieroir", + "cloudCapacity": { + "cpuCount": 4, + "memoryMB": 19, + "vmCount": 28 + }, + "storageQoSPolicies": [ + { + "name": "hvqcentnbwcunxhzfavyewhwlo", + "id": "oclhgkydaw", + "iopsMaximum": 6, + "iopsMinimum": 25, + "bandwidthLimit": 26, + "policyId": "lvcylbmxrqjgarvhfny" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4295": "wngosgcbdifaxdobufuuqxtho" + }, + "location": "khwsdmaxfhmbu", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "name": "wwcwalpiufsfbnydxpr", + "type": "qnaaimszbuokldohwrdfuiitpy", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_CreateOrUpdate_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..d3badc32ca59 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "Clouds_CreateOrUpdate_MinimumSet", + "operationId": "Clouds_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "cloudResourceName": "-", + "resource": { + "extendedLocation": {}, + "location": "khwsdmaxfhmbu" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "extendedLocation": {}, + "location": "khwsdmaxfhmbu" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "extendedLocation": {}, + "location": "khwsdmaxfhmbu" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_Delete_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..8de32b1dadbf --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "Clouds_Delete_MaximumSet", + "operationId": "Clouds_Delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "force": "true", + "cloudResourceName": "-" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_Delete_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..60bfd42032d4 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "Clouds_Delete_MinimumSet", + "operationId": "Clouds_Delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "cloudResourceName": "1" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_Get_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..f2553754bbbd --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_Get_MaximumSet_Gen.json @@ -0,0 +1,57 @@ +{ + "title": "Clouds_Get_MaximumSet", + "operationId": "Clouds_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "cloudResourceName": "_" + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "qjd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudName": "menarjsplhcqvnkjdwieroir", + "cloudCapacity": { + "cpuCount": 4, + "memoryMB": 19, + "vmCount": 28 + }, + "storageQoSPolicies": [ + { + "name": "hvqcentnbwcunxhzfavyewhwlo", + "id": "oclhgkydaw", + "iopsMaximum": 6, + "iopsMinimum": 25, + "bandwidthLimit": 26, + "policyId": "lvcylbmxrqjgarvhfny" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4295": "wngosgcbdifaxdobufuuqxtho" + }, + "location": "khwsdmaxfhmbu", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "name": "wwcwalpiufsfbnydxpr", + "type": "qnaaimszbuokldohwrdfuiitpy", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_Get_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..cc97e09b072e --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "Clouds_Get_MinimumSet", + "operationId": "Clouds_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "cloudResourceName": "i" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "extendedLocation": {}, + "location": "khwsdmaxfhmbu" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_ListByResourceGroup_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..c834954c188b --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,61 @@ +{ + "title": "Clouds_ListByResourceGroup_MaximumSet", + "operationId": "Clouds_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "inventoryItemId": "qjd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudName": "menarjsplhcqvnkjdwieroir", + "cloudCapacity": { + "cpuCount": 4, + "memoryMB": 19, + "vmCount": 28 + }, + "storageQoSPolicies": [ + { + "name": "hvqcentnbwcunxhzfavyewhwlo", + "id": "oclhgkydaw", + "iopsMaximum": 6, + "iopsMinimum": 25, + "bandwidthLimit": 26, + "policyId": "lvcylbmxrqjgarvhfny" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4295": "wngosgcbdifaxdobufuuqxtho" + }, + "location": "khwsdmaxfhmbu", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "name": "wwcwalpiufsfbnydxpr", + "type": "qnaaimszbuokldohwrdfuiitpy", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/aplbh" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_ListByResourceGroup_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..3af9ecb48303 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "Clouds_ListByResourceGroup_MinimumSet", + "operationId": "Clouds_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "extendedLocation": {}, + "location": "khwsdmaxfhmbu" + } + ] + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_ListBySubscription_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..17695f29cb85 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,60 @@ +{ + "title": "Clouds_ListBySubscription_MaximumSet", + "operationId": "Clouds_ListBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "inventoryItemId": "qjd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudName": "menarjsplhcqvnkjdwieroir", + "cloudCapacity": { + "cpuCount": 4, + "memoryMB": 19, + "vmCount": 28 + }, + "storageQoSPolicies": [ + { + "name": "hvqcentnbwcunxhzfavyewhwlo", + "id": "oclhgkydaw", + "iopsMaximum": 6, + "iopsMinimum": 25, + "bandwidthLimit": 26, + "policyId": "lvcylbmxrqjgarvhfny" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4295": "wngosgcbdifaxdobufuuqxtho" + }, + "location": "khwsdmaxfhmbu", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "name": "wwcwalpiufsfbnydxpr", + "type": "qnaaimszbuokldohwrdfuiitpy", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/aplbh" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_ListBySubscription_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_ListBySubscription_MinimumSet_Gen.json new file mode 100644 index 000000000000..66b167b76ffb --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_ListBySubscription_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "Clouds_ListBySubscription_MinimumSet", + "operationId": "Clouds_ListBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "extendedLocation": {}, + "location": "khwsdmaxfhmbu" + } + ] + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_Update_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..d3fde6da7ecf --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_Update_MaximumSet_Gen.json @@ -0,0 +1,67 @@ +{ + "title": "Clouds_Update_MaximumSet", + "operationId": "Clouds_Update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "cloudResourceName": "P", + "properties": { + "tags": { + "key5266": "hjpcnwmpnixsolrxnbl" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "qjd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudName": "menarjsplhcqvnkjdwieroir", + "cloudCapacity": { + "cpuCount": 4, + "memoryMB": 19, + "vmCount": 28 + }, + "storageQoSPolicies": [ + { + "name": "hvqcentnbwcunxhzfavyewhwlo", + "id": "oclhgkydaw", + "iopsMaximum": 6, + "iopsMinimum": 25, + "bandwidthLimit": 26, + "policyId": "lvcylbmxrqjgarvhfny" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4295": "wngosgcbdifaxdobufuuqxtho" + }, + "location": "khwsdmaxfhmbu", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "name": "wwcwalpiufsfbnydxpr", + "type": "qnaaimszbuokldohwrdfuiitpy", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_Update_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..df2fb9e0a66d --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/Clouds_Update_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "Clouds_Update_MinimumSet", + "operationId": "Clouds_Update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "cloudResourceName": "_", + "properties": {} + }, + "responses": { + "200": { + "body": { + "extendedLocation": {}, + "location": "khwsdmaxfhmbu" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/GuestAgents_Create_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/GuestAgents_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..e6cf063945d6 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/GuestAgents_Create_MaximumSet_Gen.json @@ -0,0 +1,83 @@ +{ + "title": "GuestAgents_Create_MaximumSet", + "operationId": "GuestAgents_Create", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "resource": { + "properties": { + "credentials": { + "username": "jqxuwirrcpfv", + "password": "gkvbnmuahumuoibvscoxzfdqwvfuf" + }, + "httpProxyConfig": { + "httpsProxy": "uoyzyticmohohomlkwct" + }, + "provisioningAction": "install" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "uuid": "hbsgztyakewtgbuxbesezncnzu", + "credentials": { + "username": "jqxuwirrcpfv" + }, + "httpProxyConfig": { + "httpsProxy": "uoyzyticmohohomlkwct" + }, + "provisioningAction": "install", + "status": "jpoukrzfenzrmjdahimkl", + "customResourceName": "mhqymxkapuvsugd", + "provisioningState": "Succeeded", + "privateLinkScopeResourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkResourceName" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default", + "name": "rwecpthzyt", + "type": "dkcgcbtlwtsedxzhvtu", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "uuid": "hbsgztyakewtgbuxbesezncnzu", + "credentials": { + "username": "jqxuwirrcpfv" + }, + "httpProxyConfig": { + "httpsProxy": "uoyzyticmohohomlkwct" + }, + "provisioningAction": "install", + "status": "jpoukrzfenzrmjdahimkl", + "customResourceName": "mhqymxkapuvsugd", + "provisioningState": "Succeeded", + "privateLinkScopeResourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkResourceName" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default", + "name": "rwecpthzyt", + "type": "dkcgcbtlwtsedxzhvtu", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/GuestAgents_Create_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/GuestAgents_Create_MinimumSet_Gen.json new file mode 100644 index 000000000000..7cb8e3931fc4 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/GuestAgents_Create_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "GuestAgents_Create_MinimumSet", + "operationId": "GuestAgents_Create", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "resource": {} + }, + "responses": { + "200": { + "body": {} + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": {} + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/GuestAgents_Delete_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/GuestAgents_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..309107300290 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/GuestAgents_Delete_MaximumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "GuestAgents_Delete_MaximumSet", + "operationId": "GuestAgents_Delete", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/GuestAgents_Delete_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/GuestAgents_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..573e9ca61a1a --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/GuestAgents_Delete_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "GuestAgents_Delete_MinimumSet", + "operationId": "GuestAgents_Delete", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/GuestAgents_Get_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/GuestAgents_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..068b87a20cc3 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/GuestAgents_Get_MaximumSet_Gen.json @@ -0,0 +1,39 @@ +{ + "title": "GuestAgents_Get_MaximumSet", + "operationId": "GuestAgents_Get", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "properties": { + "uuid": "hbsgztyakewtgbuxbesezncnzu", + "credentials": { + "username": "jqxuwirrcpfv" + }, + "httpProxyConfig": { + "httpsProxy": "uoyzyticmohohomlkwct" + }, + "provisioningAction": "install", + "status": "jpoukrzfenzrmjdahimkl", + "customResourceName": "mhqymxkapuvsugd", + "provisioningState": "Succeeded", + "privateLinkScopeResourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkResourceName" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default", + "name": "rwecpthzyt", + "type": "dkcgcbtlwtsedxzhvtu", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/GuestAgents_Get_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/GuestAgents_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..a1374390a317 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/GuestAgents_Get_MinimumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "title": "GuestAgents_Get_MinimumSet", + "operationId": "GuestAgents_Get", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/GuestAgents_ListByVirtualMachineInstance_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/GuestAgents_ListByVirtualMachineInstance_MaximumSet_Gen.json new file mode 100644 index 000000000000..3d09b2f57d75 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/GuestAgents_ListByVirtualMachineInstance_MaximumSet_Gen.json @@ -0,0 +1,44 @@ +{ + "title": "GuestAgents_ListByVirtualMachineInstance_MaximumSet", + "operationId": "GuestAgents_ListByVirtualMachineInstance", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "uuid": "hbsgztyakewtgbuxbesezncnzu", + "credentials": { + "username": "jqxuwirrcpfv" + }, + "httpProxyConfig": { + "httpsProxy": "uoyzyticmohohomlkwct" + }, + "provisioningAction": "install", + "status": "jpoukrzfenzrmjdahimkl", + "customResourceName": "mhqymxkapuvsugd", + "provisioningState": "Succeeded", + "privateLinkScopeResourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkResourceName" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default", + "name": "rwecpthzyt", + "type": "dkcgcbtlwtsedxzhvtu", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/GuestAgents_ListByVirtualMachineInstance_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/GuestAgents_ListByVirtualMachineInstance_MinimumSet_Gen.json new file mode 100644 index 000000000000..4b0b67066b37 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/GuestAgents_ListByVirtualMachineInstance_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "GuestAgents_ListByVirtualMachineInstance_MinimumSet", + "operationId": "GuestAgents_ListByVirtualMachineInstance", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default" + } + ] + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/InventoryItems_Create_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/InventoryItems_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..1942300e5d19 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/InventoryItems_Create_MaximumSet_Gen.json @@ -0,0 +1,65 @@ +{ + "title": "InventoryItems_Create_MaximumSet", + "operationId": "InventoryItems_Create", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "O", + "inventoryItemResourceName": "1BdDc2Ab-bDd9-Ebd6-bfdb-C0dbbdB5DEDf", + "resource": { + "properties": { + "inventoryType": "InventoryItemProperties" + }, + "kind": "M\\d_,V." + } + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryType": "InventoryItemProperties", + "managedResourceId": "ictxvjzvurnkdgwabqyyfyckkkdx", + "uuid": "jolmoxfopwfoje", + "inventoryItemName": "kspgdhmlmycalwrepfmshoaoumna", + "provisioningState": "Succeeded" + }, + "kind": "M\\d_,V.", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}/inventoryItems/inventoryItemResourceName", + "name": "oimmcgxagnhmasgsmhdaigznub", + "type": "lfhuayaplzxdqzubmjvtgcan", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "body": { + "properties": { + "inventoryType": "InventoryItemProperties", + "managedResourceId": "ictxvjzvurnkdgwabqyyfyckkkdx", + "uuid": "jolmoxfopwfoje", + "inventoryItemName": "kspgdhmlmycalwrepfmshoaoumna", + "provisioningState": "Succeeded" + }, + "kind": "M\\d_,V.", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}/inventoryItems/inventoryItemResourceName", + "name": "oimmcgxagnhmasgsmhdaigznub", + "type": "lfhuayaplzxdqzubmjvtgcan", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/InventoryItems_Create_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/InventoryItems_Create_MinimumSet_Gen.json new file mode 100644 index 000000000000..d5dad74381bd --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/InventoryItems_Create_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "InventoryItems_Create_MinimumSet", + "operationId": "InventoryItems_Create", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": ".", + "inventoryItemResourceName": "bbFb0cBb-50ce-4bfc-3eeD-bC26AbCC257a", + "resource": {} + }, + "responses": { + "200": { + "body": {} + }, + "201": { + "body": {} + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/InventoryItems_Delete_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/InventoryItems_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..6384aa2aa74a --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/InventoryItems_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "InventoryItems_Delete_MaximumSet", + "operationId": "InventoryItems_Delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "b", + "inventoryItemResourceName": "EcECadfd-Eaaa-e5Ce-ebdA-badeEd3c6af1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/InventoryItems_Delete_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/InventoryItems_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..82ac191a2249 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/InventoryItems_Delete_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "InventoryItems_Delete_MinimumSet", + "operationId": "InventoryItems_Delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "_", + "inventoryItemResourceName": "cDBcbae6-BC3d-52fe-CedC-7eFeaBFabb82" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/InventoryItems_Get_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/InventoryItems_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..6111ae55a4e0 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/InventoryItems_Get_MaximumSet_Gen.json @@ -0,0 +1,36 @@ +{ + "title": "InventoryItems_Get_MaximumSet", + "operationId": "InventoryItems_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "1", + "inventoryItemResourceName": "2bFBede6-EEf8-becB-dBbd-B96DbBFdB3f3" + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryType": "InventoryItemProperties", + "managedResourceId": "ictxvjzvurnkdgwabqyyfyckkkdx", + "uuid": "jolmoxfopwfoje", + "inventoryItemName": "kspgdhmlmycalwrepfmshoaoumna", + "provisioningState": "Succeeded" + }, + "kind": "M\\d_,V.", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}/inventoryItems/inventoryItemResourceName", + "name": "oimmcgxagnhmasgsmhdaigznub", + "type": "lfhuayaplzxdqzubmjvtgcan", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/InventoryItems_Get_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/InventoryItems_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..dfc6abb7f342 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/InventoryItems_Get_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "InventoryItems_Get_MinimumSet", + "operationId": "InventoryItems_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "_", + "inventoryItemResourceName": "cacb8Ceb-efAC-bebb-ae7C-dec8C5Bb7100" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/InventoryItems_ListByVmmServer_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/InventoryItems_ListByVmmServer_MaximumSet_Gen.json new file mode 100644 index 000000000000..d6bd4a565636 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/InventoryItems_ListByVmmServer_MaximumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "title": "InventoryItems_ListByVmmServer_MaximumSet", + "operationId": "InventoryItems_ListByVmmServer", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "X" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "inventoryType": "InventoryItemProperties", + "managedResourceId": "ictxvjzvurnkdgwabqyyfyckkkdx", + "uuid": "jolmoxfopwfoje", + "inventoryItemName": "kspgdhmlmycalwrepfmshoaoumna", + "provisioningState": "Succeeded" + }, + "kind": "M\\d_,V.", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}/inventoryItems/inventoryItemResourceName", + "name": "oimmcgxagnhmasgsmhdaigznub", + "type": "lfhuayaplzxdqzubmjvtgcan", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/InventoryItems_ListByVmmServer_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/InventoryItems_ListByVmmServer_MinimumSet_Gen.json new file mode 100644 index 000000000000..19de391b259c --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/InventoryItems_ListByVmmServer_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "InventoryItems_ListByVmmServer_MinimumSet", + "operationId": "InventoryItems_ListByVmmServer", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "H" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}/inventoryItems/inventoryItemResourceName" + } + ] + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/Operations_List_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..59b479ac5792 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List_MaximumSet", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rieknsh", + "isDataAction": true, + "display": { + "provider": "avkabpzrbafrbnubspbrsippj", + "resource": "qojushhvjhkwwmboofogcky", + "operation": "v", + "description": "fmwevntnynhgzoksqpjidn" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/Operations_List_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/Operations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..005f377bdb67 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/Operations_List_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Operations_List_MinimumSet", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-06-01" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_CreateCheckpoint_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_CreateCheckpoint_MaximumSet_Gen.json new file mode 100644 index 000000000000..f97003160138 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_CreateCheckpoint_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VirtualMachineInstances_CreateCheckpoint_MaximumSet", + "operationId": "VirtualMachineInstances_CreateCheckpoint", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "body": { + "name": "ilvltf", + "description": "zoozhfbepldrgpjqsbhpqebtodrhvy" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_CreateCheckpoint_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_CreateCheckpoint_MinimumSet_Gen.json new file mode 100644 index 000000000000..1a722077d627 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_CreateCheckpoint_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_CreateCheckpoint_MinimumSet", + "operationId": "VirtualMachineInstances_CreateCheckpoint", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_CreateOrUpdate_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..162884134e75 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,333 @@ +{ + "title": "VirtualMachineInstances_CreateOrUpdate_MaximumSet", + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "resource": { + "properties": { + "availabilitySets": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "lwbhaseo" + } + ], + "osProfile": { + "adminPassword": "vavtppmmhlspydtkzxda", + "computerName": "uuxpcxuxcufllc", + "osType": "Windows", + "domainName": "vblzsoqxzlrygdulnefexjdezo", + "domainUsername": "sn", + "domainPassword": "ixbwja", + "workgroup": "bsqftibgcnnjpvmuxligk", + "productKey": "12345-12345-12345-12345-12345", + "timezone": 4, + "runOnceCommands": "byxpnluptiwxycbbybsf;qwerty" + }, + "hardwareProfile": { + "memoryMB": 5, + "cpuCount": 22, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "dynamicMemoryMaxMB": 2, + "dynamicMemoryMinMB": 30, + "isHighlyAvailable": "true" + }, + "networkProfile": { + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ] + }, + "storageProfile": { + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ] + }, + "infrastructureProfile": { + "inventoryItemId": "ihkkqmg", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "templateId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "vmName": "qovpayfydhcvfrhe", + "uuid": "hrpw", + "lastRestoredVMCheckpoint": { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + }, + "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz", + "generation": 28, + "biosGuid": "xixivxifyql" + } + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "availabilitySets": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "lwbhaseo" + } + ], + "osProfile": { + "computerName": "uuxpcxuxcufllc", + "osType": "Windows", + "osSku": "cxqnjxgkts", + "osVersion": "djt", + "domainName": "vblzsoqxzlrygdulnefexjdezo", + "domainUsername": "sn", + "workgroup": "bsqftibgcnnjpvmuxligk", + "timezone": 4, + "runOnceCommands": "byxpnluptiwxycbbybsf;qwerty" + }, + "hardwareProfile": { + "memoryMB": 5, + "cpuCount": 22, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "dynamicMemoryMaxMB": 2, + "dynamicMemoryMinMB": 30, + "isHighlyAvailable": "true" + }, + "networkProfile": { + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ] + }, + "storageProfile": { + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ] + }, + "infrastructureProfile": { + "inventoryItemId": "ihkkqmg", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "templateId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "vmName": "qovpayfydhcvfrhe", + "uuid": "hrpw", + "lastRestoredVMCheckpoint": { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + }, + "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz", + "generation": 28, + "biosGuid": "xixivxifyql", + "checkpoints": [ + { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "kz" + } + ] + }, + "powerState": "dbqyxewvrbqcifpwfvxyllwyaffmvm", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "name": "uuqpsdoiyvedvqtrwop", + "type": "zculorteltpvthtzgnpgdpoe", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "availabilitySets": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "lwbhaseo" + } + ], + "osProfile": { + "computerName": "uuxpcxuxcufllc", + "osType": "Windows", + "osSku": "cxqnjxgkts", + "osVersion": "djt", + "domainName": "vblzsoqxzlrygdulnefexjdezo", + "domainUsername": "sn", + "workgroup": "bsqftibgcnnjpvmuxligk", + "timezone": 4, + "runOnceCommands": "byxpnluptiwxycbbybsf;qwerty" + }, + "hardwareProfile": { + "memoryMB": 5, + "cpuCount": 22, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "dynamicMemoryMaxMB": 2, + "dynamicMemoryMinMB": 30, + "isHighlyAvailable": "true" + }, + "networkProfile": { + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ] + }, + "storageProfile": { + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ] + }, + "infrastructureProfile": { + "inventoryItemId": "ihkkqmg", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "templateId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "vmName": "qovpayfydhcvfrhe", + "uuid": "hrpw", + "lastRestoredVMCheckpoint": { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + }, + "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz", + "generation": 28, + "biosGuid": "xixivxifyql", + "checkpoints": [ + { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "kz" + } + ] + }, + "powerState": "dbqyxewvrbqcifpwfvxyllwyaffmvm", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "name": "uuqpsdoiyvedvqtrwop", + "type": "zculorteltpvthtzgnpgdpoe", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_CreateOrUpdate_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..545f533831c7 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "VirtualMachineInstances_CreateOrUpdate_MinimumSet", + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "resource": { + "extendedLocation": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "extendedLocation": {} + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "extendedLocation": {} + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_DeleteCheckpoint_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_DeleteCheckpoint_MaximumSet_Gen.json new file mode 100644 index 000000000000..df11a812a562 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_DeleteCheckpoint_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "VirtualMachineInstances_DeleteCheckpoint_MaximumSet", + "operationId": "VirtualMachineInstances_DeleteCheckpoint", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "body": { + "id": "eenfflimcbgqfsebdusophahjpk" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_DeleteCheckpoint_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_DeleteCheckpoint_MinimumSet_Gen.json new file mode 100644 index 000000000000..b77954f75c90 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_DeleteCheckpoint_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_DeleteCheckpoint_MinimumSet", + "operationId": "VirtualMachineInstances_DeleteCheckpoint", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Delete_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..d22d28d65bac --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "VirtualMachineInstances_Delete_MaximumSet", + "operationId": "VirtualMachineInstances_Delete", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "force": "true", + "deleteFromHost": "true" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Delete_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..de2edaf2c2db --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Delete_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_Delete_MinimumSet", + "operationId": "VirtualMachineInstances_Delete", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Get_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..aed3ea1c16c7 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Get_MaximumSet_Gen.json @@ -0,0 +1,128 @@ +{ + "title": "VirtualMachineInstances_Get_MaximumSet", + "operationId": "VirtualMachineInstances_Get", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "properties": { + "availabilitySets": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "lwbhaseo" + } + ], + "osProfile": { + "computerName": "uuxpcxuxcufllc", + "osType": "Windows", + "osSku": "cxqnjxgkts", + "osVersion": "djt", + "domainName": "vblzsoqxzlrygdulnefexjdezo", + "domainUsername": "sn", + "workgroup": "bsqftibgcnnjpvmuxligk", + "timezone": 4, + "runOnceCommands": "byxpnluptiwxycbbybsf;qwerty" + }, + "hardwareProfile": { + "memoryMB": 5, + "cpuCount": 22, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "dynamicMemoryMaxMB": 2, + "dynamicMemoryMinMB": 30, + "isHighlyAvailable": "true" + }, + "networkProfile": { + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ] + }, + "storageProfile": { + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ] + }, + "infrastructureProfile": { + "inventoryItemId": "ihkkqmg", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "templateId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "vmName": "qovpayfydhcvfrhe", + "uuid": "hrpw", + "lastRestoredVMCheckpoint": { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + }, + "checkpoints": [ + { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + } + ], + "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz", + "generation": 28, + "biosGuid": "xixivxifyql" + }, + "powerState": "dbqyxewvrbqcifpwfvxyllwyaffmvm", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "name": "uuqpsdoiyvedvqtrwop", + "type": "zculorteltpvthtzgnpgdpoe", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Get_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..a132ec979f71 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Get_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_Get_MinimumSet", + "operationId": "VirtualMachineInstances_Get", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "extendedLocation": {} + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_List_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..424023fc1b16 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_List_MaximumSet_Gen.json @@ -0,0 +1,133 @@ +{ + "title": "VirtualMachineInstances_List_MaximumSet", + "operationId": "VirtualMachineInstances_List", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "availabilitySets": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "lwbhaseo" + } + ], + "osProfile": { + "computerName": "uuxpcxuxcufllc", + "osType": "Windows", + "osSku": "cxqnjxgkts", + "osVersion": "djt", + "domainName": "vblzsoqxzlrygdulnefexjdezo", + "domainUsername": "sn", + "workgroup": "bsqftibgcnnjpvmuxligk", + "timezone": 4, + "runOnceCommands": "byxpnluptiwxycbbybsf;qwerty" + }, + "hardwareProfile": { + "memoryMB": 5, + "cpuCount": 22, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "dynamicMemoryMaxMB": 2, + "dynamicMemoryMinMB": 30, + "isHighlyAvailable": "true" + }, + "networkProfile": { + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ] + }, + "storageProfile": { + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ] + }, + "infrastructureProfile": { + "inventoryItemId": "ihkkqmg", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "templateId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "vmName": "qovpayfydhcvfrhe", + "uuid": "hrpw", + "lastRestoredVMCheckpoint": { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + }, + "checkpoints": [ + { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + } + ], + "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz", + "generation": 28, + "biosGuid": "xixivxifyql" + }, + "powerState": "dbqyxewvrbqcifpwfvxyllwyaffmvm", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "name": "uuqpsdoiyvedvqtrwop", + "type": "zculorteltpvthtzgnpgdpoe", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_List_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..79f68092531b --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_List_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "VirtualMachineInstances_List_MinimumSet", + "operationId": "VirtualMachineInstances_List", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "extendedLocation": {} + } + ] + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Restart_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Restart_MaximumSet_Gen.json new file mode 100644 index 000000000000..950cd5b03913 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Restart_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_Restart_MaximumSet", + "operationId": "VirtualMachineInstances_Restart", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Restart_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Restart_MinimumSet_Gen.json new file mode 100644 index 000000000000..747a523bb698 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Restart_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_Restart_MinimumSet", + "operationId": "VirtualMachineInstances_Restart", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_RestoreCheckpoint_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_RestoreCheckpoint_MaximumSet_Gen.json new file mode 100644 index 000000000000..9efaf2d50d79 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_RestoreCheckpoint_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "VirtualMachineInstances_RestoreCheckpoint_MaximumSet", + "operationId": "VirtualMachineInstances_RestoreCheckpoint", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "body": { + "id": "rweqduwzsn" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_RestoreCheckpoint_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_RestoreCheckpoint_MinimumSet_Gen.json new file mode 100644 index 000000000000..59f947f49a99 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_RestoreCheckpoint_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_RestoreCheckpoint_MinimumSet", + "operationId": "VirtualMachineInstances_RestoreCheckpoint", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Start_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Start_MaximumSet_Gen.json new file mode 100644 index 000000000000..bf7a5553445a --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Start_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_Start_MaximumSet", + "operationId": "VirtualMachineInstances_Start", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Start_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Start_MinimumSet_Gen.json new file mode 100644 index 000000000000..6398321eb642 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Start_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_Start_MinimumSet", + "operationId": "VirtualMachineInstances_Start", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Stop_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Stop_MaximumSet_Gen.json new file mode 100644 index 000000000000..f8ae7f2830d6 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Stop_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "VirtualMachineInstances_Stop_MaximumSet", + "operationId": "VirtualMachineInstances_Stop", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "body": { + "skipShutdown": "true" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Stop_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Stop_MinimumSet_Gen.json new file mode 100644 index 000000000000..b238cc83da74 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Stop_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_Stop_MinimumSet", + "operationId": "VirtualMachineInstances_Stop", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Update_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..7ade97b15235 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Update_MaximumSet_Gen.json @@ -0,0 +1,179 @@ +{ + "title": "VirtualMachineInstances_Update_MaximumSet", + "operationId": "VirtualMachineInstances_Update", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "properties": { + "properties": { + "availabilitySets": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "lwbhaseo" + } + ], + "hardwareProfile": { + "memoryMB": 5, + "cpuCount": 22, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "dynamicMemoryMaxMB": 2, + "dynamicMemoryMinMB": 30 + }, + "networkProfile": { + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ] + }, + "storageProfile": { + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + } + } + ] + }, + "infrastructureProfile": { + "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "availabilitySets": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "lwbhaseo" + } + ], + "osProfile": { + "computerName": "uuxpcxuxcufllc", + "osType": "Windows", + "osSku": "cxqnjxgkts", + "osVersion": "djt" + }, + "hardwareProfile": { + "memoryMB": 5, + "cpuCount": 22, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "dynamicMemoryMaxMB": 2, + "dynamicMemoryMinMB": 30, + "isHighlyAvailable": "true" + }, + "networkProfile": { + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ] + }, + "storageProfile": { + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ] + }, + "infrastructureProfile": { + "inventoryItemId": "ihkkqmg", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "templateId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "vmName": "qovpayfydhcvfrhe", + "uuid": "hrpw", + "lastRestoredVMCheckpoint": { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + }, + "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz", + "generation": 28, + "biosGuid": "xixivxifyql", + "checkpoints": [ + { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "kz" + } + ] + }, + "powerState": "dbqyxewvrbqcifpwfvxyllwyaffmvm", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "name": "uuqpsdoiyvedvqtrwop", + "type": "zculorteltpvthtzgnpgdpoe", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Update_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..d52a9a067c95 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineInstances_Update_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "VirtualMachineInstances_Update_MinimumSet", + "operationId": "VirtualMachineInstances_Update", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "properties": {} + }, + "responses": { + "200": { + "body": { + "extendedLocation": {} + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_CreateOrUpdate_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..4b14474a71cd --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,197 @@ +{ + "title": "VirtualMachineTemplates_CreateOrUpdate_MaximumSet", + "operationId": "VirtualMachineTemplates_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualMachineTemplateName": "6", + "resource": { + "properties": { + "inventoryItemId": "qjrykoogccwlgkd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "osType": "Windows", + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "isCustomizable": "true", + "isHighlyAvailable": "true" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key9494": "kkbmfpwhmvlobm" + }, + "location": "ayxsyduviotylbojh" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "qjrykoogccwlgkd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "osType": "Windows", + "osName": "qcbolnbisklo", + "computerName": "asxghqngsojdsdptpirbz", + "memoryMB": 24, + "cpuCount": 23, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "isCustomizable": "true", + "dynamicMemoryMaxMB": 21, + "dynamicMemoryMinMB": 21, + "isHighlyAvailable": "true", + "generation": 16, + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ], + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key9494": "kkbmfpwhmvlobm" + }, + "location": "ayxsyduviotylbojh", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "name": "ioeuwaznkaayvhpqbnrwbr", + "type": "egfzqiscydkyddksvsjujdlee", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "inventoryItemId": "qjrykoogccwlgkd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "osType": "Windows", + "osName": "qcbolnbisklo", + "computerName": "asxghqngsojdsdptpirbz", + "memoryMB": 24, + "cpuCount": 23, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "isCustomizable": "true", + "dynamicMemoryMaxMB": 21, + "dynamicMemoryMinMB": 21, + "isHighlyAvailable": "true", + "generation": 16, + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ], + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key9494": "kkbmfpwhmvlobm" + }, + "location": "ayxsyduviotylbojh", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "name": "ioeuwaznkaayvhpqbnrwbr", + "type": "egfzqiscydkyddksvsjujdlee", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_CreateOrUpdate_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..4f442d131ff2 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "VirtualMachineTemplates_CreateOrUpdate_MinimumSet", + "operationId": "VirtualMachineTemplates_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualMachineTemplateName": "P", + "resource": { + "extendedLocation": {}, + "location": "ayxsyduviotylbojh" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "extendedLocation": {}, + "location": "ayxsyduviotylbojh" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "extendedLocation": {}, + "location": "ayxsyduviotylbojh" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_Delete_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..0a8029f47a63 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VirtualMachineTemplates_Delete_MaximumSet", + "operationId": "VirtualMachineTemplates_Delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "force": "true", + "virtualMachineTemplateName": "6" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_Delete_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..666e4bc342d2 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "VirtualMachineTemplates_Delete_MinimumSet", + "operationId": "VirtualMachineTemplates_Delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualMachineTemplateName": "5" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_Get_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..8fbddf0ec5cb --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_Get_MaximumSet_Gen.json @@ -0,0 +1,93 @@ +{ + "title": "VirtualMachineTemplates_Get_MaximumSet", + "operationId": "VirtualMachineTemplates_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualMachineTemplateName": "4" + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "qjrykoogccwlgkd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "osType": "Windows", + "osName": "qcbolnbisklo", + "computerName": "asxghqngsojdsdptpirbz", + "memoryMB": 24, + "cpuCount": 23, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "isCustomizable": "true", + "dynamicMemoryMaxMB": 21, + "dynamicMemoryMinMB": 21, + "isHighlyAvailable": "true", + "generation": 16, + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ], + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key9494": "kkbmfpwhmvlobm" + }, + "location": "ayxsyduviotylbojh", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "name": "ioeuwaznkaayvhpqbnrwbr", + "type": "egfzqiscydkyddksvsjujdlee", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_Get_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..eb12b77825ae --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VirtualMachineTemplates_Get_MinimumSet", + "operationId": "VirtualMachineTemplates_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualMachineTemplateName": "m" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "extendedLocation": {}, + "location": "ayxsyduviotylbojh" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_ListByResourceGroup_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..bea4d467c20f --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,97 @@ +{ + "title": "VirtualMachineTemplates_ListByResourceGroup_MaximumSet", + "operationId": "VirtualMachineTemplates_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "inventoryItemId": "qjrykoogccwlgkd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "osType": "Windows", + "osName": "qcbolnbisklo", + "computerName": "asxghqngsojdsdptpirbz", + "memoryMB": 24, + "cpuCount": 23, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "isCustomizable": "true", + "dynamicMemoryMaxMB": 21, + "dynamicMemoryMinMB": 21, + "isHighlyAvailable": "true", + "generation": 16, + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ], + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key9494": "kkbmfpwhmvlobm" + }, + "location": "ayxsyduviotylbojh", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "name": "ioeuwaznkaayvhpqbnrwbr", + "type": "egfzqiscydkyddksvsjujdlee", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/atbdyyso" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_ListByResourceGroup_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..46c98ad664d1 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "VirtualMachineTemplates_ListByResourceGroup_MinimumSet", + "operationId": "VirtualMachineTemplates_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "extendedLocation": {}, + "location": "ayxsyduviotylbojh" + } + ] + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_ListBySubscription_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..a093dbb330e7 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,96 @@ +{ + "title": "VirtualMachineTemplates_ListBySubscription_MaximumSet", + "operationId": "VirtualMachineTemplates_ListBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "inventoryItemId": "qjrykoogccwlgkd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "osType": "Windows", + "osName": "qcbolnbisklo", + "computerName": "asxghqngsojdsdptpirbz", + "memoryMB": 24, + "cpuCount": 23, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "isCustomizable": "true", + "dynamicMemoryMaxMB": 21, + "dynamicMemoryMinMB": 21, + "isHighlyAvailable": "true", + "generation": 16, + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ], + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key9494": "kkbmfpwhmvlobm" + }, + "location": "ayxsyduviotylbojh", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "name": "ioeuwaznkaayvhpqbnrwbr", + "type": "egfzqiscydkyddksvsjujdlee", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/atbdyyso" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_ListBySubscription_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_ListBySubscription_MinimumSet_Gen.json new file mode 100644 index 000000000000..2cb3c76e9ef0 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_ListBySubscription_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "VirtualMachineTemplates_ListBySubscription_MinimumSet", + "operationId": "VirtualMachineTemplates_ListBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "extendedLocation": {}, + "location": "ayxsyduviotylbojh" + } + ] + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_Update_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..473c74d5951b --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_Update_MaximumSet_Gen.json @@ -0,0 +1,103 @@ +{ + "title": "VirtualMachineTemplates_Update_MaximumSet", + "operationId": "VirtualMachineTemplates_Update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualMachineTemplateName": "g", + "properties": { + "tags": { + "key6634": "wwfhrg" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "qjrykoogccwlgkd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "osType": "Windows", + "osName": "qcbolnbisklo", + "computerName": "asxghqngsojdsdptpirbz", + "memoryMB": 24, + "cpuCount": 23, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "isCustomizable": "true", + "dynamicMemoryMaxMB": 21, + "dynamicMemoryMinMB": 21, + "isHighlyAvailable": "true", + "generation": 16, + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ], + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key9494": "kkbmfpwhmvlobm" + }, + "location": "ayxsyduviotylbojh", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "name": "ioeuwaznkaayvhpqbnrwbr", + "type": "egfzqiscydkyddksvsjujdlee", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_Update_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..e4cba90d0fec --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualMachineTemplates_Update_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "VirtualMachineTemplates_Update_MinimumSet", + "operationId": "VirtualMachineTemplates_Update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualMachineTemplateName": "-", + "properties": {} + }, + "responses": { + "200": { + "body": { + "extendedLocation": {}, + "location": "ayxsyduviotylbojh" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_CreateOrUpdate_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..50a4c76d3e46 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,90 @@ +{ + "title": "VirtualNetworks_CreateOrUpdate_MaximumSet", + "operationId": "VirtualNetworks_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualNetworkName": "_", + "resource": { + "properties": { + "inventoryItemId": "bxn", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key705": "apgplvjdyocx" + }, + "location": "fky" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "bxn", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "networkName": "eeqahvnbblsdeeqezqdinggretyeg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key705": "apgplvjdyocx" + }, + "location": "fky", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "name": "sbeiflgxwzkgt", + "type": "oinkkqcuemmcvugnhebckmxeluuulw", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "inventoryItemId": "bxn", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "networkName": "eeqahvnbblsdeeqezqdinggretyeg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key705": "apgplvjdyocx" + }, + "location": "fky", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "name": "sbeiflgxwzkgt", + "type": "oinkkqcuemmcvugnhebckmxeluuulw", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_CreateOrUpdate_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..6e4c4f88cac9 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "VirtualNetworks_CreateOrUpdate_MinimumSet", + "operationId": "VirtualNetworks_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualNetworkName": "-", + "resource": { + "extendedLocation": {}, + "location": "fky" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "extendedLocation": {}, + "location": "fky" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "extendedLocation": {}, + "location": "fky" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_Delete_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..1f093205119a --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VirtualNetworks_Delete_MaximumSet", + "operationId": "VirtualNetworks_Delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "force": "true", + "virtualNetworkName": "." + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_Delete_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..66164a63b81a --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "VirtualNetworks_Delete_MinimumSet", + "operationId": "VirtualNetworks_Delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualNetworkName": "1" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_Get_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..ca58f2432a4a --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_Get_MaximumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "VirtualNetworks_Get_MaximumSet", + "operationId": "VirtualNetworks_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualNetworkName": "2" + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "bxn", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "networkName": "eeqahvnbblsdeeqezqdinggretyeg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key705": "apgplvjdyocx" + }, + "location": "fky", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "name": "sbeiflgxwzkgt", + "type": "oinkkqcuemmcvugnhebckmxeluuulw", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_Get_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..c7ac1c76d8f2 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VirtualNetworks_Get_MinimumSet", + "operationId": "VirtualNetworks_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualNetworkName": "-" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "extendedLocation": {}, + "location": "fky" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_ListByResourceGroup_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..a8debb547a79 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "VirtualNetworks_ListByResourceGroup_MaximumSet", + "operationId": "VirtualNetworks_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "inventoryItemId": "bxn", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "networkName": "eeqahvnbblsdeeqezqdinggretyeg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key705": "apgplvjdyocx" + }, + "location": "fky", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "name": "sbeiflgxwzkgt", + "type": "oinkkqcuemmcvugnhebckmxeluuulw", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_ListByResourceGroup_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..e10c7c21f7bb --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "VirtualNetworks_ListByResourceGroup_MinimumSet", + "operationId": "VirtualNetworks_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "extendedLocation": {}, + "location": "fky" + } + ] + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_ListBySubscription_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..a86703dfd4aa --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "title": "VirtualNetworks_ListBySubscription_MaximumSet", + "operationId": "VirtualNetworks_ListBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "inventoryItemId": "bxn", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "networkName": "eeqahvnbblsdeeqezqdinggretyeg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key705": "apgplvjdyocx" + }, + "location": "fky", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "name": "sbeiflgxwzkgt", + "type": "oinkkqcuemmcvugnhebckmxeluuulw", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_ListBySubscription_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_ListBySubscription_MinimumSet_Gen.json new file mode 100644 index 000000000000..8497ea0d2d90 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_ListBySubscription_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "VirtualNetworks_ListBySubscription_MinimumSet", + "operationId": "VirtualNetworks_ListBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "extendedLocation": {}, + "location": "fky" + } + ] + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_Update_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..20769733c10e --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_Update_MaximumSet_Gen.json @@ -0,0 +1,52 @@ +{ + "title": "VirtualNetworks_Update_MaximumSet", + "operationId": "VirtualNetworks_Update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualNetworkName": "S", + "properties": { + "tags": { + "key9516": "oxduo" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "bxn", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "networkName": "eeqahvnbblsdeeqezqdinggretyeg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key705": "apgplvjdyocx" + }, + "location": "fky", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "name": "sbeiflgxwzkgt", + "type": "oinkkqcuemmcvugnhebckmxeluuulw", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_Update_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..da457a67e881 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VirtualNetworks_Update_MinimumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "title": "VirtualNetworks_Update_MinimumSet", + "operationId": "VirtualNetworks_Update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualNetworkName": "-", + "properties": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "extendedLocation": {}, + "location": "fky" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmInstanceHybridIdentityMetadatas_Get_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmInstanceHybridIdentityMetadatas_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..f846564c6be5 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmInstanceHybridIdentityMetadatas_Get_MaximumSet_Gen.json @@ -0,0 +1,30 @@ +{ + "title": "VmInstanceHybridIdentityMetadatas_Get_MaximumSet", + "operationId": "VmInstanceHybridIdentityMetadatas_Get", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "properties": { + "resourceUid": "mikbntobifeiouinvsalnu", + "publicKey": "hijhfxcdjuzidfjjztoh", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/hybridIdentityMetadata/default", + "name": "rxvpcegqc", + "type": "ixqhymswessvylnqgti", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmInstanceHybridIdentityMetadatas_Get_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmInstanceHybridIdentityMetadatas_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..a7641b7ee237 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmInstanceHybridIdentityMetadatas_Get_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "VmInstanceHybridIdentityMetadatas_Get_MinimumSet", + "operationId": "VmInstanceHybridIdentityMetadatas_Get", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/hybridIdentityMetadata/default" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MaximumSet_Gen.json new file mode 100644 index 000000000000..370524a42038 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MaximumSet_Gen.json @@ -0,0 +1,35 @@ +{ + "title": "VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MaximumSet", + "operationId": "VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "resourceUid": "mikbntobifeiouinvsalnu", + "publicKey": "hijhfxcdjuzidfjjztoh", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/hybridIdentityMetadata/default", + "name": "rxvpcegqc", + "type": "ixqhymswessvylnqgti", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MinimumSet_Gen.json new file mode 100644 index 000000000000..fc77460f89ff --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MinimumSet", + "operationId": "VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/hybridIdentityMetadata/default" + } + ] + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_CreateOrUpdate_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..e220fbd33872 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,103 @@ +{ + "title": "VmmServers_CreateOrUpdate_MaximumSet", + "operationId": "VmmServers_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "-", + "resource": { + "properties": { + "credentials": { + "username": "jbuoltypmrgqfi", + "password": "gaecsnkjr" + }, + "fqdn": "pvzcjaqrswbvptgx", + "port": 4 + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4834": "vycgfkzjcyyuotwwq" + }, + "location": "hslxkyzktvwpqbypvs" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "credentials": { + "username": "jbuoltypmrgqfi" + }, + "fqdn": "pvzcjaqrswbvptgx", + "port": 4, + "connectionStatus": "vlmrrigzmutgbzrgjtolnamfxm", + "errorMessage": "ndkzeiipz", + "uuid": "vmwbukuqbuz", + "version": "tawfjzbqrlkqzqyomxiahnfqg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4834": "vycgfkzjcyyuotwwq" + }, + "location": "hslxkyzktvwpqbypvs", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "name": "gyoxmcbnbbfajvzygtffpaufxxjzs", + "type": "nwiimbcjryiggdcbpvrqdnlrklcwbr", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "credentials": { + "username": "jbuoltypmrgqfi" + }, + "fqdn": "pvzcjaqrswbvptgx", + "port": 4, + "connectionStatus": "vlmrrigzmutgbzrgjtolnamfxm", + "errorMessage": "ndkzeiipz", + "uuid": "vmwbukuqbuz", + "version": "tawfjzbqrlkqzqyomxiahnfqg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4834": "vycgfkzjcyyuotwwq" + }, + "location": "hslxkyzktvwpqbypvs", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "name": "gyoxmcbnbbfajvzygtffpaufxxjzs", + "type": "nwiimbcjryiggdcbpvrqdnlrklcwbr", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_CreateOrUpdate_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..4b62a316f61b --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "VmmServers_CreateOrUpdate_MinimumSet", + "operationId": "VmmServers_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "w", + "resource": { + "extendedLocation": {}, + "location": "hslxkyzktvwpqbypvs" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "extendedLocation": {}, + "location": "hslxkyzktvwpqbypvs" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "extendedLocation": {}, + "location": "hslxkyzktvwpqbypvs" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_Delete_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..f2ade0051551 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VmmServers_Delete_MaximumSet", + "operationId": "VmmServers_Delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "force": "true", + "vmmServerName": "." + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_Delete_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..61b90ad02df8 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "VmmServers_Delete_MinimumSet", + "operationId": "VmmServers_Delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "8" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_Get_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..4df33afdb0ab --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_Get_MaximumSet_Gen.json @@ -0,0 +1,47 @@ +{ + "title": "VmmServers_Get_MaximumSet", + "operationId": "VmmServers_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "." + }, + "responses": { + "200": { + "body": { + "properties": { + "credentials": { + "username": "jbuoltypmrgqfi" + }, + "fqdn": "pvzcjaqrswbvptgx", + "port": 4, + "connectionStatus": "vlmrrigzmutgbzrgjtolnamfxm", + "errorMessage": "ndkzeiipz", + "uuid": "vmwbukuqbuz", + "version": "tawfjzbqrlkqzqyomxiahnfqg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4834": "vycgfkzjcyyuotwwq" + }, + "location": "hslxkyzktvwpqbypvs", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "name": "gyoxmcbnbbfajvzygtffpaufxxjzs", + "type": "nwiimbcjryiggdcbpvrqdnlrklcwbr", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_Get_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..332cfecda737 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VmmServers_Get_MinimumSet", + "operationId": "VmmServers_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "D" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "extendedLocation": {}, + "location": "hslxkyzktvwpqbypvs" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_ListByResourceGroup_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..2c16af5b71b2 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,51 @@ +{ + "title": "VmmServers_ListByResourceGroup_MaximumSet", + "operationId": "VmmServers_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "credentials": { + "username": "jbuoltypmrgqfi" + }, + "fqdn": "pvzcjaqrswbvptgx", + "port": 4, + "connectionStatus": "vlmrrigzmutgbzrgjtolnamfxm", + "errorMessage": "ndkzeiipz", + "uuid": "vmwbukuqbuz", + "version": "tawfjzbqrlkqzqyomxiahnfqg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4834": "vycgfkzjcyyuotwwq" + }, + "location": "hslxkyzktvwpqbypvs", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "name": "gyoxmcbnbbfajvzygtffpaufxxjzs", + "type": "nwiimbcjryiggdcbpvrqdnlrklcwbr", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_ListByResourceGroup_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..e6c4e2aa604f --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "VmmServers_ListByResourceGroup_MinimumSet", + "operationId": "VmmServers_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "extendedLocation": {}, + "location": "hslxkyzktvwpqbypvs" + } + ] + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_ListBySubscription_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..ab6c2ef0bf1a --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,50 @@ +{ + "title": "VmmServers_ListBySubscription_MaximumSet", + "operationId": "VmmServers_ListBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "credentials": { + "username": "jbuoltypmrgqfi" + }, + "fqdn": "pvzcjaqrswbvptgx", + "port": 4, + "connectionStatus": "vlmrrigzmutgbzrgjtolnamfxm", + "errorMessage": "ndkzeiipz", + "uuid": "vmwbukuqbuz", + "version": "tawfjzbqrlkqzqyomxiahnfqg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4834": "vycgfkzjcyyuotwwq" + }, + "location": "hslxkyzktvwpqbypvs", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "name": "gyoxmcbnbbfajvzygtffpaufxxjzs", + "type": "nwiimbcjryiggdcbpvrqdnlrklcwbr", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_ListBySubscription_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_ListBySubscription_MinimumSet_Gen.json new file mode 100644 index 000000000000..f6ca575eabd9 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_ListBySubscription_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "VmmServers_ListBySubscription_MinimumSet", + "operationId": "VmmServers_ListBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "extendedLocation": {}, + "location": "hslxkyzktvwpqbypvs" + } + ] + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_Update_MaximumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..60dbf4d2dc3e --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_Update_MaximumSet_Gen.json @@ -0,0 +1,57 @@ +{ + "title": "VmmServers_Update_MaximumSet", + "operationId": "VmmServers_Update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "Y", + "properties": { + "tags": { + "key7187": "oktnfvklfchnquelzzdagtpwfskzc" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "credentials": { + "username": "jbuoltypmrgqfi" + }, + "fqdn": "pvzcjaqrswbvptgx", + "port": 4, + "connectionStatus": "vlmrrigzmutgbzrgjtolnamfxm", + "errorMessage": "ndkzeiipz", + "uuid": "vmwbukuqbuz", + "version": "tawfjzbqrlkqzqyomxiahnfqg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4834": "vycgfkzjcyyuotwwq" + }, + "location": "hslxkyzktvwpqbypvs", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "name": "gyoxmcbnbbfajvzygtffpaufxxjzs", + "type": "nwiimbcjryiggdcbpvrqdnlrklcwbr", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_Update_MinimumSet_Gen.json b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..056ba609f838 --- /dev/null +++ b/specification/scvmm/ScVmm.Management/examples/2024-06-01/VmmServers_Update_MinimumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "title": "VmmServers_Update_MinimumSet", + "operationId": "VmmServers_Update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "_", + "properties": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "extendedLocation": {}, + "location": "hslxkyzktvwpqbypvs" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/ScVmm.Management/main.tsp b/specification/scvmm/ScVmm.Management/main.tsp index acdf29788a24..0495ea0a5b84 100644 --- a/specification/scvmm/ScVmm.Management/main.tsp +++ b/specification/scvmm/ScVmm.Management/main.tsp @@ -35,4 +35,10 @@ enum Versions { @useDependency(Azure.Core.Versions.v1_0_Preview_1) @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) v2023_10_07: "2023-10-07", + + /** Service version 2024-06-01. */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(Azure.Core.Versions.v1_0_Preview_1) + @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) + v2024_06_01: "2024-06-01", } diff --git a/specification/scvmm/ScVmm.Management/models.tsp b/specification/scvmm/ScVmm.Management/models.tsp index 74022dcb1eca..45377020ed29 100644 --- a/specification/scvmm/ScVmm.Management/models.tsp +++ b/specification/scvmm/ScVmm.Management/models.tsp @@ -1,11 +1,14 @@ import "@typespec/rest"; import "@typespec/http"; import "@typespec/openapi"; +import "@typespec/versioning"; +import "./main.tsp"; import "@azure-tools/typespec-azure-resource-manager"; using TypeSpec.Rest; using TypeSpec.Http; using TypeSpec.OpenAPI; +using TypeSpec.Versioning; using Azure.ResourceManager; namespace Microsoft.ScVmm; @@ -640,6 +643,38 @@ model OsProfileForVmInstance { /** Gets os version. */ @visibility("read") osVersion?: string; + + /** Gets or sets the domain name. */ + @added(Versions.v2024_06_01) + domainName?: string; + + /** Gets or sets the domain username. */ + @added(Versions.v2024_06_01) + domainUsername?: string; + + /** Password of the domain the VM has to join. */ + @visibility("create", "update") + @secret + @added(Versions.v2024_06_01) + domainPassword?: string; + + /** Gets or sets the workgroup. */ + @added(Versions.v2024_06_01) + workgroup?: string; + + /** Gets or sets the product key.Input format xxxxx-xxxxx-xxxxx-xxxxx-xxxxx */ + @visibility("create") + @secret + @added(Versions.v2024_06_01) + productKey?: string; + + /** Gets or sets the index value of the timezone. */ + @added(Versions.v2024_06_01) + timezone?: int32; + + /** Get or sets the commands to be run once at the time of creation separated by semicolons. */ + @added(Versions.v2024_06_01) + runOnceCommands?: string; } /** Defines the resource properties. */ @@ -849,6 +884,14 @@ model GuestAgentProperties { /** Provisioning state of the resource. */ @visibility("read") provisioningState?: ProvisioningState; + + /** The resource id of the private link scope this machine is assigned to, if any. */ + @added(Versions.v2024_06_01) + privateLinkScopeResourceId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.HybridCompute/privateLinkScopes"; + } + ]>; } /** Username / Password Credentials to connect to guest. */ diff --git a/specification/scvmm/ScVmm.Management/tspconfig.yaml b/specification/scvmm/ScVmm.Management/tspconfig.yaml index 21d2a3394ac8..bbe18b1a1a1f 100644 --- a/specification/scvmm/ScVmm.Management/tspconfig.yaml +++ b/specification/scvmm/ScVmm.Management/tspconfig.yaml @@ -9,6 +9,9 @@ options: omit-unreachable-types: true emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/scvmm.json" examples-directory: "{project-root}/examples" linter: diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_CreateOrUpdate_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..91089ab0eeee --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,85 @@ +{ + "title": "AvailabilitySets_CreateOrUpdate_MaximumSet", + "operationId": "AvailabilitySets_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "availabilitySetResourceName": "-", + "resource": { + "properties": { + "availabilitySetName": "njrpftunzo", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key5701": "cldtxloqh" + }, + "location": "jelevilan" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "availabilitySetName": "njrpftunzo", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key5701": "cldtxloqh" + }, + "location": "jelevilan", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "dibfuxyuidzxcfik", + "type": "xwzjruksexpuqgtreexm", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "availabilitySetName": "njrpftunzo", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key5701": "cldtxloqh" + }, + "location": "jelevilan", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "dibfuxyuidzxcfik", + "type": "xwzjruksexpuqgtreexm", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_CreateOrUpdate_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..3d66333e44db --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "AvailabilitySets_CreateOrUpdate_MinimumSet", + "operationId": "AvailabilitySets_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "availabilitySetResourceName": "_", + "resource": { + "extendedLocation": {}, + "location": "jelevilan" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "extendedLocation": {}, + "location": "jelevilan" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "extendedLocation": {}, + "location": "jelevilan" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_Delete_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..2a1a6258d92e --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "AvailabilitySets_Delete_MaximumSet", + "operationId": "AvailabilitySets_Delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "force": "true", + "availabilitySetResourceName": "_" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_Delete_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..02f0574906b3 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "AvailabilitySets_Delete_MinimumSet", + "operationId": "AvailabilitySets_Delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "availabilitySetResourceName": "6" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_Get_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..e994660c820b --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_Get_MaximumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "title": "AvailabilitySets_Get_MaximumSet", + "operationId": "AvailabilitySets_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "availabilitySetResourceName": "-" + }, + "responses": { + "200": { + "body": { + "properties": { + "availabilitySetName": "njrpftunzo", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key5701": "cldtxloqh" + }, + "location": "jelevilan", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "dibfuxyuidzxcfik", + "type": "xwzjruksexpuqgtreexm", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_Get_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..ab8d9833ef0e --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "AvailabilitySets_Get_MinimumSet", + "operationId": "AvailabilitySets_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "availabilitySetResourceName": "V" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "extendedLocation": {}, + "location": "jelevilan" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_ListByResourceGroup_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..db93ccbd5807 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,44 @@ +{ + "title": "AvailabilitySets_ListByResourceGroup_MaximumSet", + "operationId": "AvailabilitySets_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "availabilitySetName": "njrpftunzo", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key5701": "cldtxloqh" + }, + "location": "jelevilan", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "dibfuxyuidzxcfik", + "type": "xwzjruksexpuqgtreexm", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_ListByResourceGroup_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..13d72d3df9e0 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "AvailabilitySets_ListByResourceGroup_MinimumSet", + "operationId": "AvailabilitySets_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "extendedLocation": {}, + "location": "jelevilan" + } + ] + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_ListBySubscription_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..2f01ed4e4796 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,43 @@ +{ + "title": "AvailabilitySets_ListBySubscription_MaximumSet", + "operationId": "AvailabilitySets_ListBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "availabilitySetName": "njrpftunzo", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key5701": "cldtxloqh" + }, + "location": "jelevilan", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "dibfuxyuidzxcfik", + "type": "xwzjruksexpuqgtreexm", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_ListBySubscription_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_ListBySubscription_MinimumSet_Gen.json new file mode 100644 index 000000000000..8c191ea51c26 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_ListBySubscription_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "AvailabilitySets_ListBySubscription_MinimumSet", + "operationId": "AvailabilitySets_ListBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "extendedLocation": {}, + "location": "jelevilan" + } + ] + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_Update_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..09110162fb56 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_Update_MaximumSet_Gen.json @@ -0,0 +1,50 @@ +{ + "title": "AvailabilitySets_Update_MaximumSet", + "operationId": "AvailabilitySets_Update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "availabilitySetResourceName": "-", + "properties": { + "tags": { + "key1460": "vcbwibkvr" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "availabilitySetName": "njrpftunzo", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key5701": "cldtxloqh" + }, + "location": "jelevilan", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "dibfuxyuidzxcfik", + "type": "xwzjruksexpuqgtreexm", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_Update_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..ec9a90e8ef9d --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/AvailabilitySets_Update_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "AvailabilitySets_Update_MinimumSet", + "operationId": "AvailabilitySets_Update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "availabilitySetResourceName": "1", + "properties": {} + }, + "responses": { + "200": { + "body": { + "extendedLocation": {}, + "location": "jelevilan" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_CreateOrUpdate_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..4946a09dfc87 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,121 @@ +{ + "title": "Clouds_CreateOrUpdate_MaximumSet", + "operationId": "Clouds_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "cloudResourceName": "2", + "resource": { + "properties": { + "inventoryItemId": "qjd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudCapacity": {} + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4295": "wngosgcbdifaxdobufuuqxtho" + }, + "location": "khwsdmaxfhmbu" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "qjd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudName": "menarjsplhcqvnkjdwieroir", + "cloudCapacity": { + "cpuCount": 4, + "memoryMB": 19, + "vmCount": 28 + }, + "storageQoSPolicies": [ + { + "name": "hvqcentnbwcunxhzfavyewhwlo", + "id": "oclhgkydaw", + "iopsMaximum": 6, + "iopsMinimum": 25, + "bandwidthLimit": 26, + "policyId": "lvcylbmxrqjgarvhfny" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4295": "wngosgcbdifaxdobufuuqxtho" + }, + "location": "khwsdmaxfhmbu", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "name": "wwcwalpiufsfbnydxpr", + "type": "qnaaimszbuokldohwrdfuiitpy", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "inventoryItemId": "qjd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudName": "menarjsplhcqvnkjdwieroir", + "cloudCapacity": { + "cpuCount": 4, + "memoryMB": 19, + "vmCount": 28 + }, + "storageQoSPolicies": [ + { + "name": "hvqcentnbwcunxhzfavyewhwlo", + "id": "oclhgkydaw", + "iopsMaximum": 6, + "iopsMinimum": 25, + "bandwidthLimit": 26, + "policyId": "lvcylbmxrqjgarvhfny" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4295": "wngosgcbdifaxdobufuuqxtho" + }, + "location": "khwsdmaxfhmbu", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "name": "wwcwalpiufsfbnydxpr", + "type": "qnaaimszbuokldohwrdfuiitpy", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_CreateOrUpdate_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..d3badc32ca59 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "Clouds_CreateOrUpdate_MinimumSet", + "operationId": "Clouds_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "cloudResourceName": "-", + "resource": { + "extendedLocation": {}, + "location": "khwsdmaxfhmbu" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "extendedLocation": {}, + "location": "khwsdmaxfhmbu" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "extendedLocation": {}, + "location": "khwsdmaxfhmbu" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_Delete_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..8de32b1dadbf --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "Clouds_Delete_MaximumSet", + "operationId": "Clouds_Delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "force": "true", + "cloudResourceName": "-" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_Delete_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..60bfd42032d4 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "Clouds_Delete_MinimumSet", + "operationId": "Clouds_Delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "cloudResourceName": "1" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_Get_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..f2553754bbbd --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_Get_MaximumSet_Gen.json @@ -0,0 +1,57 @@ +{ + "title": "Clouds_Get_MaximumSet", + "operationId": "Clouds_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "cloudResourceName": "_" + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "qjd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudName": "menarjsplhcqvnkjdwieroir", + "cloudCapacity": { + "cpuCount": 4, + "memoryMB": 19, + "vmCount": 28 + }, + "storageQoSPolicies": [ + { + "name": "hvqcentnbwcunxhzfavyewhwlo", + "id": "oclhgkydaw", + "iopsMaximum": 6, + "iopsMinimum": 25, + "bandwidthLimit": 26, + "policyId": "lvcylbmxrqjgarvhfny" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4295": "wngosgcbdifaxdobufuuqxtho" + }, + "location": "khwsdmaxfhmbu", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "name": "wwcwalpiufsfbnydxpr", + "type": "qnaaimszbuokldohwrdfuiitpy", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_Get_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..cc97e09b072e --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "Clouds_Get_MinimumSet", + "operationId": "Clouds_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "cloudResourceName": "i" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "extendedLocation": {}, + "location": "khwsdmaxfhmbu" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_ListByResourceGroup_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..c834954c188b --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,61 @@ +{ + "title": "Clouds_ListByResourceGroup_MaximumSet", + "operationId": "Clouds_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "inventoryItemId": "qjd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudName": "menarjsplhcqvnkjdwieroir", + "cloudCapacity": { + "cpuCount": 4, + "memoryMB": 19, + "vmCount": 28 + }, + "storageQoSPolicies": [ + { + "name": "hvqcentnbwcunxhzfavyewhwlo", + "id": "oclhgkydaw", + "iopsMaximum": 6, + "iopsMinimum": 25, + "bandwidthLimit": 26, + "policyId": "lvcylbmxrqjgarvhfny" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4295": "wngosgcbdifaxdobufuuqxtho" + }, + "location": "khwsdmaxfhmbu", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "name": "wwcwalpiufsfbnydxpr", + "type": "qnaaimszbuokldohwrdfuiitpy", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/aplbh" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_ListByResourceGroup_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..3af9ecb48303 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "Clouds_ListByResourceGroup_MinimumSet", + "operationId": "Clouds_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "extendedLocation": {}, + "location": "khwsdmaxfhmbu" + } + ] + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_ListBySubscription_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..17695f29cb85 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,60 @@ +{ + "title": "Clouds_ListBySubscription_MaximumSet", + "operationId": "Clouds_ListBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "inventoryItemId": "qjd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudName": "menarjsplhcqvnkjdwieroir", + "cloudCapacity": { + "cpuCount": 4, + "memoryMB": 19, + "vmCount": 28 + }, + "storageQoSPolicies": [ + { + "name": "hvqcentnbwcunxhzfavyewhwlo", + "id": "oclhgkydaw", + "iopsMaximum": 6, + "iopsMinimum": 25, + "bandwidthLimit": 26, + "policyId": "lvcylbmxrqjgarvhfny" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4295": "wngosgcbdifaxdobufuuqxtho" + }, + "location": "khwsdmaxfhmbu", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "name": "wwcwalpiufsfbnydxpr", + "type": "qnaaimszbuokldohwrdfuiitpy", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/aplbh" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_ListBySubscription_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_ListBySubscription_MinimumSet_Gen.json new file mode 100644 index 000000000000..66b167b76ffb --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_ListBySubscription_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "Clouds_ListBySubscription_MinimumSet", + "operationId": "Clouds_ListBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "extendedLocation": {}, + "location": "khwsdmaxfhmbu" + } + ] + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_Update_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..d3fde6da7ecf --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_Update_MaximumSet_Gen.json @@ -0,0 +1,67 @@ +{ + "title": "Clouds_Update_MaximumSet", + "operationId": "Clouds_Update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "cloudResourceName": "P", + "properties": { + "tags": { + "key5266": "hjpcnwmpnixsolrxnbl" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "qjd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudName": "menarjsplhcqvnkjdwieroir", + "cloudCapacity": { + "cpuCount": 4, + "memoryMB": 19, + "vmCount": 28 + }, + "storageQoSPolicies": [ + { + "name": "hvqcentnbwcunxhzfavyewhwlo", + "id": "oclhgkydaw", + "iopsMaximum": 6, + "iopsMinimum": 25, + "bandwidthLimit": 26, + "policyId": "lvcylbmxrqjgarvhfny" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4295": "wngosgcbdifaxdobufuuqxtho" + }, + "location": "khwsdmaxfhmbu", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "name": "wwcwalpiufsfbnydxpr", + "type": "qnaaimszbuokldohwrdfuiitpy", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_Update_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..df2fb9e0a66d --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Clouds_Update_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "Clouds_Update_MinimumSet", + "operationId": "Clouds_Update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "cloudResourceName": "_", + "properties": {} + }, + "responses": { + "200": { + "body": { + "extendedLocation": {}, + "location": "khwsdmaxfhmbu" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/GuestAgents_Create_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/GuestAgents_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..e6cf063945d6 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/GuestAgents_Create_MaximumSet_Gen.json @@ -0,0 +1,83 @@ +{ + "title": "GuestAgents_Create_MaximumSet", + "operationId": "GuestAgents_Create", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "resource": { + "properties": { + "credentials": { + "username": "jqxuwirrcpfv", + "password": "gkvbnmuahumuoibvscoxzfdqwvfuf" + }, + "httpProxyConfig": { + "httpsProxy": "uoyzyticmohohomlkwct" + }, + "provisioningAction": "install" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "uuid": "hbsgztyakewtgbuxbesezncnzu", + "credentials": { + "username": "jqxuwirrcpfv" + }, + "httpProxyConfig": { + "httpsProxy": "uoyzyticmohohomlkwct" + }, + "provisioningAction": "install", + "status": "jpoukrzfenzrmjdahimkl", + "customResourceName": "mhqymxkapuvsugd", + "provisioningState": "Succeeded", + "privateLinkScopeResourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkResourceName" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default", + "name": "rwecpthzyt", + "type": "dkcgcbtlwtsedxzhvtu", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "uuid": "hbsgztyakewtgbuxbesezncnzu", + "credentials": { + "username": "jqxuwirrcpfv" + }, + "httpProxyConfig": { + "httpsProxy": "uoyzyticmohohomlkwct" + }, + "provisioningAction": "install", + "status": "jpoukrzfenzrmjdahimkl", + "customResourceName": "mhqymxkapuvsugd", + "provisioningState": "Succeeded", + "privateLinkScopeResourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkResourceName" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default", + "name": "rwecpthzyt", + "type": "dkcgcbtlwtsedxzhvtu", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/GuestAgents_Create_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/GuestAgents_Create_MinimumSet_Gen.json new file mode 100644 index 000000000000..7cb8e3931fc4 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/GuestAgents_Create_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "GuestAgents_Create_MinimumSet", + "operationId": "GuestAgents_Create", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "resource": {} + }, + "responses": { + "200": { + "body": {} + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": {} + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/GuestAgents_Delete_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/GuestAgents_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..309107300290 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/GuestAgents_Delete_MaximumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "GuestAgents_Delete_MaximumSet", + "operationId": "GuestAgents_Delete", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/GuestAgents_Delete_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/GuestAgents_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..573e9ca61a1a --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/GuestAgents_Delete_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "GuestAgents_Delete_MinimumSet", + "operationId": "GuestAgents_Delete", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/GuestAgents_Get_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/GuestAgents_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..068b87a20cc3 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/GuestAgents_Get_MaximumSet_Gen.json @@ -0,0 +1,39 @@ +{ + "title": "GuestAgents_Get_MaximumSet", + "operationId": "GuestAgents_Get", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "properties": { + "uuid": "hbsgztyakewtgbuxbesezncnzu", + "credentials": { + "username": "jqxuwirrcpfv" + }, + "httpProxyConfig": { + "httpsProxy": "uoyzyticmohohomlkwct" + }, + "provisioningAction": "install", + "status": "jpoukrzfenzrmjdahimkl", + "customResourceName": "mhqymxkapuvsugd", + "provisioningState": "Succeeded", + "privateLinkScopeResourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkResourceName" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default", + "name": "rwecpthzyt", + "type": "dkcgcbtlwtsedxzhvtu", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/GuestAgents_Get_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/GuestAgents_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..a1374390a317 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/GuestAgents_Get_MinimumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "title": "GuestAgents_Get_MinimumSet", + "operationId": "GuestAgents_Get", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/GuestAgents_ListByVirtualMachineInstance_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/GuestAgents_ListByVirtualMachineInstance_MaximumSet_Gen.json new file mode 100644 index 000000000000..3d09b2f57d75 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/GuestAgents_ListByVirtualMachineInstance_MaximumSet_Gen.json @@ -0,0 +1,44 @@ +{ + "title": "GuestAgents_ListByVirtualMachineInstance_MaximumSet", + "operationId": "GuestAgents_ListByVirtualMachineInstance", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "uuid": "hbsgztyakewtgbuxbesezncnzu", + "credentials": { + "username": "jqxuwirrcpfv" + }, + "httpProxyConfig": { + "httpsProxy": "uoyzyticmohohomlkwct" + }, + "provisioningAction": "install", + "status": "jpoukrzfenzrmjdahimkl", + "customResourceName": "mhqymxkapuvsugd", + "provisioningState": "Succeeded", + "privateLinkScopeResourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkResourceName" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default", + "name": "rwecpthzyt", + "type": "dkcgcbtlwtsedxzhvtu", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/GuestAgents_ListByVirtualMachineInstance_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/GuestAgents_ListByVirtualMachineInstance_MinimumSet_Gen.json new file mode 100644 index 000000000000..4b0b67066b37 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/GuestAgents_ListByVirtualMachineInstance_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "GuestAgents_ListByVirtualMachineInstance_MinimumSet", + "operationId": "GuestAgents_ListByVirtualMachineInstance", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default" + } + ] + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/InventoryItems_Create_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/InventoryItems_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..1942300e5d19 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/InventoryItems_Create_MaximumSet_Gen.json @@ -0,0 +1,65 @@ +{ + "title": "InventoryItems_Create_MaximumSet", + "operationId": "InventoryItems_Create", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "O", + "inventoryItemResourceName": "1BdDc2Ab-bDd9-Ebd6-bfdb-C0dbbdB5DEDf", + "resource": { + "properties": { + "inventoryType": "InventoryItemProperties" + }, + "kind": "M\\d_,V." + } + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryType": "InventoryItemProperties", + "managedResourceId": "ictxvjzvurnkdgwabqyyfyckkkdx", + "uuid": "jolmoxfopwfoje", + "inventoryItemName": "kspgdhmlmycalwrepfmshoaoumna", + "provisioningState": "Succeeded" + }, + "kind": "M\\d_,V.", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}/inventoryItems/inventoryItemResourceName", + "name": "oimmcgxagnhmasgsmhdaigznub", + "type": "lfhuayaplzxdqzubmjvtgcan", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "body": { + "properties": { + "inventoryType": "InventoryItemProperties", + "managedResourceId": "ictxvjzvurnkdgwabqyyfyckkkdx", + "uuid": "jolmoxfopwfoje", + "inventoryItemName": "kspgdhmlmycalwrepfmshoaoumna", + "provisioningState": "Succeeded" + }, + "kind": "M\\d_,V.", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}/inventoryItems/inventoryItemResourceName", + "name": "oimmcgxagnhmasgsmhdaigznub", + "type": "lfhuayaplzxdqzubmjvtgcan", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/InventoryItems_Create_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/InventoryItems_Create_MinimumSet_Gen.json new file mode 100644 index 000000000000..d5dad74381bd --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/InventoryItems_Create_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "InventoryItems_Create_MinimumSet", + "operationId": "InventoryItems_Create", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": ".", + "inventoryItemResourceName": "bbFb0cBb-50ce-4bfc-3eeD-bC26AbCC257a", + "resource": {} + }, + "responses": { + "200": { + "body": {} + }, + "201": { + "body": {} + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/InventoryItems_Delete_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/InventoryItems_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..6384aa2aa74a --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/InventoryItems_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "InventoryItems_Delete_MaximumSet", + "operationId": "InventoryItems_Delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "b", + "inventoryItemResourceName": "EcECadfd-Eaaa-e5Ce-ebdA-badeEd3c6af1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/InventoryItems_Delete_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/InventoryItems_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..82ac191a2249 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/InventoryItems_Delete_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "InventoryItems_Delete_MinimumSet", + "operationId": "InventoryItems_Delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "_", + "inventoryItemResourceName": "cDBcbae6-BC3d-52fe-CedC-7eFeaBFabb82" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/InventoryItems_Get_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/InventoryItems_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..6111ae55a4e0 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/InventoryItems_Get_MaximumSet_Gen.json @@ -0,0 +1,36 @@ +{ + "title": "InventoryItems_Get_MaximumSet", + "operationId": "InventoryItems_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "1", + "inventoryItemResourceName": "2bFBede6-EEf8-becB-dBbd-B96DbBFdB3f3" + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryType": "InventoryItemProperties", + "managedResourceId": "ictxvjzvurnkdgwabqyyfyckkkdx", + "uuid": "jolmoxfopwfoje", + "inventoryItemName": "kspgdhmlmycalwrepfmshoaoumna", + "provisioningState": "Succeeded" + }, + "kind": "M\\d_,V.", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}/inventoryItems/inventoryItemResourceName", + "name": "oimmcgxagnhmasgsmhdaigznub", + "type": "lfhuayaplzxdqzubmjvtgcan", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/InventoryItems_Get_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/InventoryItems_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..dfc6abb7f342 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/InventoryItems_Get_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "InventoryItems_Get_MinimumSet", + "operationId": "InventoryItems_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "_", + "inventoryItemResourceName": "cacb8Ceb-efAC-bebb-ae7C-dec8C5Bb7100" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/InventoryItems_ListByVmmServer_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/InventoryItems_ListByVmmServer_MaximumSet_Gen.json new file mode 100644 index 000000000000..d6bd4a565636 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/InventoryItems_ListByVmmServer_MaximumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "title": "InventoryItems_ListByVmmServer_MaximumSet", + "operationId": "InventoryItems_ListByVmmServer", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "X" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "inventoryType": "InventoryItemProperties", + "managedResourceId": "ictxvjzvurnkdgwabqyyfyckkkdx", + "uuid": "jolmoxfopwfoje", + "inventoryItemName": "kspgdhmlmycalwrepfmshoaoumna", + "provisioningState": "Succeeded" + }, + "kind": "M\\d_,V.", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}/inventoryItems/inventoryItemResourceName", + "name": "oimmcgxagnhmasgsmhdaigznub", + "type": "lfhuayaplzxdqzubmjvtgcan", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/InventoryItems_ListByVmmServer_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/InventoryItems_ListByVmmServer_MinimumSet_Gen.json new file mode 100644 index 000000000000..19de391b259c --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/InventoryItems_ListByVmmServer_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "InventoryItems_ListByVmmServer_MinimumSet", + "operationId": "InventoryItems_ListByVmmServer", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "H" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}/inventoryItems/inventoryItemResourceName" + } + ] + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Operations_List_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..59b479ac5792 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List_MaximumSet", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rieknsh", + "isDataAction": true, + "display": { + "provider": "avkabpzrbafrbnubspbrsippj", + "resource": "qojushhvjhkwwmboofogcky", + "operation": "v", + "description": "fmwevntnynhgzoksqpjidn" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Operations_List_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Operations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..005f377bdb67 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/Operations_List_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Operations_List_MinimumSet", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-06-01" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_CreateCheckpoint_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_CreateCheckpoint_MaximumSet_Gen.json new file mode 100644 index 000000000000..f97003160138 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_CreateCheckpoint_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VirtualMachineInstances_CreateCheckpoint_MaximumSet", + "operationId": "VirtualMachineInstances_CreateCheckpoint", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "body": { + "name": "ilvltf", + "description": "zoozhfbepldrgpjqsbhpqebtodrhvy" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_CreateCheckpoint_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_CreateCheckpoint_MinimumSet_Gen.json new file mode 100644 index 000000000000..1a722077d627 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_CreateCheckpoint_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_CreateCheckpoint_MinimumSet", + "operationId": "VirtualMachineInstances_CreateCheckpoint", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_CreateOrUpdate_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..162884134e75 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,333 @@ +{ + "title": "VirtualMachineInstances_CreateOrUpdate_MaximumSet", + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "resource": { + "properties": { + "availabilitySets": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "lwbhaseo" + } + ], + "osProfile": { + "adminPassword": "vavtppmmhlspydtkzxda", + "computerName": "uuxpcxuxcufllc", + "osType": "Windows", + "domainName": "vblzsoqxzlrygdulnefexjdezo", + "domainUsername": "sn", + "domainPassword": "ixbwja", + "workgroup": "bsqftibgcnnjpvmuxligk", + "productKey": "12345-12345-12345-12345-12345", + "timezone": 4, + "runOnceCommands": "byxpnluptiwxycbbybsf;qwerty" + }, + "hardwareProfile": { + "memoryMB": 5, + "cpuCount": 22, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "dynamicMemoryMaxMB": 2, + "dynamicMemoryMinMB": 30, + "isHighlyAvailable": "true" + }, + "networkProfile": { + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ] + }, + "storageProfile": { + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ] + }, + "infrastructureProfile": { + "inventoryItemId": "ihkkqmg", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "templateId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "vmName": "qovpayfydhcvfrhe", + "uuid": "hrpw", + "lastRestoredVMCheckpoint": { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + }, + "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz", + "generation": 28, + "biosGuid": "xixivxifyql" + } + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "availabilitySets": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "lwbhaseo" + } + ], + "osProfile": { + "computerName": "uuxpcxuxcufllc", + "osType": "Windows", + "osSku": "cxqnjxgkts", + "osVersion": "djt", + "domainName": "vblzsoqxzlrygdulnefexjdezo", + "domainUsername": "sn", + "workgroup": "bsqftibgcnnjpvmuxligk", + "timezone": 4, + "runOnceCommands": "byxpnluptiwxycbbybsf;qwerty" + }, + "hardwareProfile": { + "memoryMB": 5, + "cpuCount": 22, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "dynamicMemoryMaxMB": 2, + "dynamicMemoryMinMB": 30, + "isHighlyAvailable": "true" + }, + "networkProfile": { + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ] + }, + "storageProfile": { + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ] + }, + "infrastructureProfile": { + "inventoryItemId": "ihkkqmg", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "templateId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "vmName": "qovpayfydhcvfrhe", + "uuid": "hrpw", + "lastRestoredVMCheckpoint": { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + }, + "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz", + "generation": 28, + "biosGuid": "xixivxifyql", + "checkpoints": [ + { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "kz" + } + ] + }, + "powerState": "dbqyxewvrbqcifpwfvxyllwyaffmvm", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "name": "uuqpsdoiyvedvqtrwop", + "type": "zculorteltpvthtzgnpgdpoe", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "availabilitySets": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "lwbhaseo" + } + ], + "osProfile": { + "computerName": "uuxpcxuxcufllc", + "osType": "Windows", + "osSku": "cxqnjxgkts", + "osVersion": "djt", + "domainName": "vblzsoqxzlrygdulnefexjdezo", + "domainUsername": "sn", + "workgroup": "bsqftibgcnnjpvmuxligk", + "timezone": 4, + "runOnceCommands": "byxpnluptiwxycbbybsf;qwerty" + }, + "hardwareProfile": { + "memoryMB": 5, + "cpuCount": 22, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "dynamicMemoryMaxMB": 2, + "dynamicMemoryMinMB": 30, + "isHighlyAvailable": "true" + }, + "networkProfile": { + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ] + }, + "storageProfile": { + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ] + }, + "infrastructureProfile": { + "inventoryItemId": "ihkkqmg", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "templateId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "vmName": "qovpayfydhcvfrhe", + "uuid": "hrpw", + "lastRestoredVMCheckpoint": { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + }, + "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz", + "generation": 28, + "biosGuid": "xixivxifyql", + "checkpoints": [ + { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "kz" + } + ] + }, + "powerState": "dbqyxewvrbqcifpwfvxyllwyaffmvm", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "name": "uuqpsdoiyvedvqtrwop", + "type": "zculorteltpvthtzgnpgdpoe", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_CreateOrUpdate_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..545f533831c7 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "VirtualMachineInstances_CreateOrUpdate_MinimumSet", + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "resource": { + "extendedLocation": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "extendedLocation": {} + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "extendedLocation": {} + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_DeleteCheckpoint_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_DeleteCheckpoint_MaximumSet_Gen.json new file mode 100644 index 000000000000..df11a812a562 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_DeleteCheckpoint_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "VirtualMachineInstances_DeleteCheckpoint_MaximumSet", + "operationId": "VirtualMachineInstances_DeleteCheckpoint", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "body": { + "id": "eenfflimcbgqfsebdusophahjpk" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_DeleteCheckpoint_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_DeleteCheckpoint_MinimumSet_Gen.json new file mode 100644 index 000000000000..b77954f75c90 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_DeleteCheckpoint_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_DeleteCheckpoint_MinimumSet", + "operationId": "VirtualMachineInstances_DeleteCheckpoint", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Delete_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..d22d28d65bac --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "VirtualMachineInstances_Delete_MaximumSet", + "operationId": "VirtualMachineInstances_Delete", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "force": "true", + "deleteFromHost": "true" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Delete_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..de2edaf2c2db --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Delete_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_Delete_MinimumSet", + "operationId": "VirtualMachineInstances_Delete", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Get_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..aed3ea1c16c7 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Get_MaximumSet_Gen.json @@ -0,0 +1,128 @@ +{ + "title": "VirtualMachineInstances_Get_MaximumSet", + "operationId": "VirtualMachineInstances_Get", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "properties": { + "availabilitySets": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "lwbhaseo" + } + ], + "osProfile": { + "computerName": "uuxpcxuxcufllc", + "osType": "Windows", + "osSku": "cxqnjxgkts", + "osVersion": "djt", + "domainName": "vblzsoqxzlrygdulnefexjdezo", + "domainUsername": "sn", + "workgroup": "bsqftibgcnnjpvmuxligk", + "timezone": 4, + "runOnceCommands": "byxpnluptiwxycbbybsf;qwerty" + }, + "hardwareProfile": { + "memoryMB": 5, + "cpuCount": 22, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "dynamicMemoryMaxMB": 2, + "dynamicMemoryMinMB": 30, + "isHighlyAvailable": "true" + }, + "networkProfile": { + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ] + }, + "storageProfile": { + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ] + }, + "infrastructureProfile": { + "inventoryItemId": "ihkkqmg", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "templateId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "vmName": "qovpayfydhcvfrhe", + "uuid": "hrpw", + "lastRestoredVMCheckpoint": { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + }, + "checkpoints": [ + { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + } + ], + "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz", + "generation": 28, + "biosGuid": "xixivxifyql" + }, + "powerState": "dbqyxewvrbqcifpwfvxyllwyaffmvm", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "name": "uuqpsdoiyvedvqtrwop", + "type": "zculorteltpvthtzgnpgdpoe", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Get_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..a132ec979f71 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Get_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_Get_MinimumSet", + "operationId": "VirtualMachineInstances_Get", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "extendedLocation": {} + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_List_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..424023fc1b16 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_List_MaximumSet_Gen.json @@ -0,0 +1,133 @@ +{ + "title": "VirtualMachineInstances_List_MaximumSet", + "operationId": "VirtualMachineInstances_List", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "availabilitySets": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "lwbhaseo" + } + ], + "osProfile": { + "computerName": "uuxpcxuxcufllc", + "osType": "Windows", + "osSku": "cxqnjxgkts", + "osVersion": "djt", + "domainName": "vblzsoqxzlrygdulnefexjdezo", + "domainUsername": "sn", + "workgroup": "bsqftibgcnnjpvmuxligk", + "timezone": 4, + "runOnceCommands": "byxpnluptiwxycbbybsf;qwerty" + }, + "hardwareProfile": { + "memoryMB": 5, + "cpuCount": 22, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "dynamicMemoryMaxMB": 2, + "dynamicMemoryMinMB": 30, + "isHighlyAvailable": "true" + }, + "networkProfile": { + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ] + }, + "storageProfile": { + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ] + }, + "infrastructureProfile": { + "inventoryItemId": "ihkkqmg", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "templateId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "vmName": "qovpayfydhcvfrhe", + "uuid": "hrpw", + "lastRestoredVMCheckpoint": { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + }, + "checkpoints": [ + { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + } + ], + "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz", + "generation": 28, + "biosGuid": "xixivxifyql" + }, + "powerState": "dbqyxewvrbqcifpwfvxyllwyaffmvm", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "name": "uuqpsdoiyvedvqtrwop", + "type": "zculorteltpvthtzgnpgdpoe", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_List_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..79f68092531b --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_List_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "VirtualMachineInstances_List_MinimumSet", + "operationId": "VirtualMachineInstances_List", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "extendedLocation": {} + } + ] + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Restart_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Restart_MaximumSet_Gen.json new file mode 100644 index 000000000000..950cd5b03913 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Restart_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_Restart_MaximumSet", + "operationId": "VirtualMachineInstances_Restart", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Restart_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Restart_MinimumSet_Gen.json new file mode 100644 index 000000000000..747a523bb698 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Restart_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_Restart_MinimumSet", + "operationId": "VirtualMachineInstances_Restart", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_RestoreCheckpoint_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_RestoreCheckpoint_MaximumSet_Gen.json new file mode 100644 index 000000000000..9efaf2d50d79 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_RestoreCheckpoint_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "VirtualMachineInstances_RestoreCheckpoint_MaximumSet", + "operationId": "VirtualMachineInstances_RestoreCheckpoint", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "body": { + "id": "rweqduwzsn" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_RestoreCheckpoint_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_RestoreCheckpoint_MinimumSet_Gen.json new file mode 100644 index 000000000000..59f947f49a99 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_RestoreCheckpoint_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_RestoreCheckpoint_MinimumSet", + "operationId": "VirtualMachineInstances_RestoreCheckpoint", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Start_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Start_MaximumSet_Gen.json new file mode 100644 index 000000000000..bf7a5553445a --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Start_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_Start_MaximumSet", + "operationId": "VirtualMachineInstances_Start", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Start_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Start_MinimumSet_Gen.json new file mode 100644 index 000000000000..6398321eb642 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Start_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_Start_MinimumSet", + "operationId": "VirtualMachineInstances_Start", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Stop_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Stop_MaximumSet_Gen.json new file mode 100644 index 000000000000..f8ae7f2830d6 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Stop_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "VirtualMachineInstances_Stop_MaximumSet", + "operationId": "VirtualMachineInstances_Stop", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "body": { + "skipShutdown": "true" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Stop_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Stop_MinimumSet_Gen.json new file mode 100644 index 000000000000..b238cc83da74 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Stop_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "VirtualMachineInstances_Stop_MinimumSet", + "operationId": "VirtualMachineInstances_Stop", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Update_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..7ade97b15235 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Update_MaximumSet_Gen.json @@ -0,0 +1,179 @@ +{ + "title": "VirtualMachineInstances_Update_MaximumSet", + "operationId": "VirtualMachineInstances_Update", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "properties": { + "properties": { + "availabilitySets": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "lwbhaseo" + } + ], + "hardwareProfile": { + "memoryMB": 5, + "cpuCount": 22, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "dynamicMemoryMaxMB": 2, + "dynamicMemoryMinMB": 30 + }, + "networkProfile": { + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ] + }, + "storageProfile": { + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + } + } + ] + }, + "infrastructureProfile": { + "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "availabilitySets": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName", + "name": "lwbhaseo" + } + ], + "osProfile": { + "computerName": "uuxpcxuxcufllc", + "osType": "Windows", + "osSku": "cxqnjxgkts", + "osVersion": "djt" + }, + "hardwareProfile": { + "memoryMB": 5, + "cpuCount": 22, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "dynamicMemoryMaxMB": 2, + "dynamicMemoryMinMB": 30, + "isHighlyAvailable": "true" + }, + "networkProfile": { + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ] + }, + "storageProfile": { + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ] + }, + "infrastructureProfile": { + "inventoryItemId": "ihkkqmg", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "cloudId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName", + "templateId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "vmName": "qovpayfydhcvfrhe", + "uuid": "hrpw", + "lastRestoredVMCheckpoint": { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "qurzfrgyflrh" + }, + "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz", + "generation": 28, + "biosGuid": "xixivxifyql", + "checkpoints": [ + { + "parentCheckpointID": "hqhhzikoxunuqguouw", + "checkpointID": "wsqmrje", + "name": "keqn", + "description": "kz" + } + ] + }, + "powerState": "dbqyxewvrbqcifpwfvxyllwyaffmvm", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default", + "name": "uuqpsdoiyvedvqtrwop", + "type": "zculorteltpvthtzgnpgdpoe", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Update_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..d52a9a067c95 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineInstances_Update_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "VirtualMachineInstances_Update_MinimumSet", + "operationId": "VirtualMachineInstances_Update", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave", + "properties": {} + }, + "responses": { + "200": { + "body": { + "extendedLocation": {} + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_CreateOrUpdate_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..4b14474a71cd --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,197 @@ +{ + "title": "VirtualMachineTemplates_CreateOrUpdate_MaximumSet", + "operationId": "VirtualMachineTemplates_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualMachineTemplateName": "6", + "resource": { + "properties": { + "inventoryItemId": "qjrykoogccwlgkd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "osType": "Windows", + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "isCustomizable": "true", + "isHighlyAvailable": "true" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key9494": "kkbmfpwhmvlobm" + }, + "location": "ayxsyduviotylbojh" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "qjrykoogccwlgkd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "osType": "Windows", + "osName": "qcbolnbisklo", + "computerName": "asxghqngsojdsdptpirbz", + "memoryMB": 24, + "cpuCount": 23, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "isCustomizable": "true", + "dynamicMemoryMaxMB": 21, + "dynamicMemoryMinMB": 21, + "isHighlyAvailable": "true", + "generation": 16, + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ], + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key9494": "kkbmfpwhmvlobm" + }, + "location": "ayxsyduviotylbojh", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "name": "ioeuwaznkaayvhpqbnrwbr", + "type": "egfzqiscydkyddksvsjujdlee", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "inventoryItemId": "qjrykoogccwlgkd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "osType": "Windows", + "osName": "qcbolnbisklo", + "computerName": "asxghqngsojdsdptpirbz", + "memoryMB": 24, + "cpuCount": 23, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "isCustomizable": "true", + "dynamicMemoryMaxMB": 21, + "dynamicMemoryMinMB": 21, + "isHighlyAvailable": "true", + "generation": 16, + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ], + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key9494": "kkbmfpwhmvlobm" + }, + "location": "ayxsyduviotylbojh", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "name": "ioeuwaznkaayvhpqbnrwbr", + "type": "egfzqiscydkyddksvsjujdlee", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_CreateOrUpdate_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..4f442d131ff2 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "VirtualMachineTemplates_CreateOrUpdate_MinimumSet", + "operationId": "VirtualMachineTemplates_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualMachineTemplateName": "P", + "resource": { + "extendedLocation": {}, + "location": "ayxsyduviotylbojh" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "extendedLocation": {}, + "location": "ayxsyduviotylbojh" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "extendedLocation": {}, + "location": "ayxsyduviotylbojh" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_Delete_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..0a8029f47a63 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VirtualMachineTemplates_Delete_MaximumSet", + "operationId": "VirtualMachineTemplates_Delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "force": "true", + "virtualMachineTemplateName": "6" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_Delete_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..666e4bc342d2 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "VirtualMachineTemplates_Delete_MinimumSet", + "operationId": "VirtualMachineTemplates_Delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualMachineTemplateName": "5" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_Get_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..8fbddf0ec5cb --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_Get_MaximumSet_Gen.json @@ -0,0 +1,93 @@ +{ + "title": "VirtualMachineTemplates_Get_MaximumSet", + "operationId": "VirtualMachineTemplates_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualMachineTemplateName": "4" + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "qjrykoogccwlgkd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "osType": "Windows", + "osName": "qcbolnbisklo", + "computerName": "asxghqngsojdsdptpirbz", + "memoryMB": 24, + "cpuCount": 23, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "isCustomizable": "true", + "dynamicMemoryMaxMB": 21, + "dynamicMemoryMinMB": 21, + "isHighlyAvailable": "true", + "generation": 16, + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ], + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key9494": "kkbmfpwhmvlobm" + }, + "location": "ayxsyduviotylbojh", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "name": "ioeuwaznkaayvhpqbnrwbr", + "type": "egfzqiscydkyddksvsjujdlee", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_Get_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..eb12b77825ae --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VirtualMachineTemplates_Get_MinimumSet", + "operationId": "VirtualMachineTemplates_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualMachineTemplateName": "m" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "extendedLocation": {}, + "location": "ayxsyduviotylbojh" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_ListByResourceGroup_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..bea4d467c20f --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,97 @@ +{ + "title": "VirtualMachineTemplates_ListByResourceGroup_MaximumSet", + "operationId": "VirtualMachineTemplates_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "inventoryItemId": "qjrykoogccwlgkd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "osType": "Windows", + "osName": "qcbolnbisklo", + "computerName": "asxghqngsojdsdptpirbz", + "memoryMB": 24, + "cpuCount": 23, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "isCustomizable": "true", + "dynamicMemoryMaxMB": 21, + "dynamicMemoryMinMB": 21, + "isHighlyAvailable": "true", + "generation": 16, + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ], + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key9494": "kkbmfpwhmvlobm" + }, + "location": "ayxsyduviotylbojh", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "name": "ioeuwaznkaayvhpqbnrwbr", + "type": "egfzqiscydkyddksvsjujdlee", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/atbdyyso" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_ListByResourceGroup_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..46c98ad664d1 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "VirtualMachineTemplates_ListByResourceGroup_MinimumSet", + "operationId": "VirtualMachineTemplates_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "extendedLocation": {}, + "location": "ayxsyduviotylbojh" + } + ] + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_ListBySubscription_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..a093dbb330e7 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,96 @@ +{ + "title": "VirtualMachineTemplates_ListBySubscription_MaximumSet", + "operationId": "VirtualMachineTemplates_ListBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "inventoryItemId": "qjrykoogccwlgkd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "osType": "Windows", + "osName": "qcbolnbisklo", + "computerName": "asxghqngsojdsdptpirbz", + "memoryMB": 24, + "cpuCount": 23, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "isCustomizable": "true", + "dynamicMemoryMaxMB": 21, + "dynamicMemoryMinMB": 21, + "isHighlyAvailable": "true", + "generation": 16, + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ], + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key9494": "kkbmfpwhmvlobm" + }, + "location": "ayxsyduviotylbojh", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "name": "ioeuwaznkaayvhpqbnrwbr", + "type": "egfzqiscydkyddksvsjujdlee", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/atbdyyso" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_ListBySubscription_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_ListBySubscription_MinimumSet_Gen.json new file mode 100644 index 000000000000..2cb3c76e9ef0 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_ListBySubscription_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "VirtualMachineTemplates_ListBySubscription_MinimumSet", + "operationId": "VirtualMachineTemplates_ListBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "extendedLocation": {}, + "location": "ayxsyduviotylbojh" + } + ] + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_Update_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..473c74d5951b --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_Update_MaximumSet_Gen.json @@ -0,0 +1,103 @@ +{ + "title": "VirtualMachineTemplates_Update_MaximumSet", + "operationId": "VirtualMachineTemplates_Update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualMachineTemplateName": "g", + "properties": { + "tags": { + "key6634": "wwfhrg" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "qjrykoogccwlgkd", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "osType": "Windows", + "osName": "qcbolnbisklo", + "computerName": "asxghqngsojdsdptpirbz", + "memoryMB": 24, + "cpuCount": 23, + "limitCpuForMigration": "true", + "dynamicMemoryEnabled": "true", + "isCustomizable": "true", + "dynamicMemoryMaxMB": 21, + "dynamicMemoryMinMB": 21, + "isHighlyAvailable": "true", + "generation": 16, + "networkInterfaces": [ + { + "name": "kvofzqulbjlbtt", + "displayName": "yoayfd", + "ipv4Addresses": [ + "eeunirpkpqazzxhsqonkxcfuks" + ], + "ipv6Addresses": [ + "pk" + ], + "macAddress": "oaeqqegt", + "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "networkName": "lqbm", + "ipv4AddressType": "Dynamic", + "ipv6AddressType": "Dynamic", + "macAddressType": "Dynamic", + "nicId": "roxpsvlo" + } + ], + "disks": [ + { + "name": "fgnckfymwdsqnfxkdvexuaobe", + "displayName": "fgladknawlgjodo", + "diskId": "ltdrwcfjklpsimhzqyh", + "diskSizeGB": 30, + "maxDiskSizeGB": 18, + "bus": 8, + "lun": 10, + "busType": "zu", + "vhdType": "cnbeeeylrvopigdynvgpkfp", + "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln", + "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb", + "templateDiskId": "lcdwrokpyvekqccclf", + "storageQoSPolicy": { + "name": "ceiyfrflu", + "id": "o" + }, + "createDiffDisk": "true" + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key9494": "kkbmfpwhmvlobm" + }, + "location": "ayxsyduviotylbojh", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName", + "name": "ioeuwaznkaayvhpqbnrwbr", + "type": "egfzqiscydkyddksvsjujdlee", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_Update_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..e4cba90d0fec --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualMachineTemplates_Update_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "VirtualMachineTemplates_Update_MinimumSet", + "operationId": "VirtualMachineTemplates_Update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualMachineTemplateName": "-", + "properties": {} + }, + "responses": { + "200": { + "body": { + "extendedLocation": {}, + "location": "ayxsyduviotylbojh" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_CreateOrUpdate_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..50a4c76d3e46 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,90 @@ +{ + "title": "VirtualNetworks_CreateOrUpdate_MaximumSet", + "operationId": "VirtualNetworks_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualNetworkName": "_", + "resource": { + "properties": { + "inventoryItemId": "bxn", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key705": "apgplvjdyocx" + }, + "location": "fky" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "bxn", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "networkName": "eeqahvnbblsdeeqezqdinggretyeg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key705": "apgplvjdyocx" + }, + "location": "fky", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "name": "sbeiflgxwzkgt", + "type": "oinkkqcuemmcvugnhebckmxeluuulw", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "inventoryItemId": "bxn", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "networkName": "eeqahvnbblsdeeqezqdinggretyeg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key705": "apgplvjdyocx" + }, + "location": "fky", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "name": "sbeiflgxwzkgt", + "type": "oinkkqcuemmcvugnhebckmxeluuulw", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_CreateOrUpdate_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..6e4c4f88cac9 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "VirtualNetworks_CreateOrUpdate_MinimumSet", + "operationId": "VirtualNetworks_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualNetworkName": "-", + "resource": { + "extendedLocation": {}, + "location": "fky" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "extendedLocation": {}, + "location": "fky" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "extendedLocation": {}, + "location": "fky" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_Delete_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..1f093205119a --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VirtualNetworks_Delete_MaximumSet", + "operationId": "VirtualNetworks_Delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "force": "true", + "virtualNetworkName": "." + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_Delete_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..66164a63b81a --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "VirtualNetworks_Delete_MinimumSet", + "operationId": "VirtualNetworks_Delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualNetworkName": "1" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_Get_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..ca58f2432a4a --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_Get_MaximumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "VirtualNetworks_Get_MaximumSet", + "operationId": "VirtualNetworks_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualNetworkName": "2" + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "bxn", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "networkName": "eeqahvnbblsdeeqezqdinggretyeg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key705": "apgplvjdyocx" + }, + "location": "fky", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "name": "sbeiflgxwzkgt", + "type": "oinkkqcuemmcvugnhebckmxeluuulw", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_Get_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..c7ac1c76d8f2 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VirtualNetworks_Get_MinimumSet", + "operationId": "VirtualNetworks_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualNetworkName": "-" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "extendedLocation": {}, + "location": "fky" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_ListByResourceGroup_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..a8debb547a79 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "VirtualNetworks_ListByResourceGroup_MaximumSet", + "operationId": "VirtualNetworks_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "inventoryItemId": "bxn", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "networkName": "eeqahvnbblsdeeqezqdinggretyeg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key705": "apgplvjdyocx" + }, + "location": "fky", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "name": "sbeiflgxwzkgt", + "type": "oinkkqcuemmcvugnhebckmxeluuulw", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_ListByResourceGroup_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..e10c7c21f7bb --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "VirtualNetworks_ListByResourceGroup_MinimumSet", + "operationId": "VirtualNetworks_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "extendedLocation": {}, + "location": "fky" + } + ] + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_ListBySubscription_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..a86703dfd4aa --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "title": "VirtualNetworks_ListBySubscription_MaximumSet", + "operationId": "VirtualNetworks_ListBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "inventoryItemId": "bxn", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "networkName": "eeqahvnbblsdeeqezqdinggretyeg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key705": "apgplvjdyocx" + }, + "location": "fky", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "name": "sbeiflgxwzkgt", + "type": "oinkkqcuemmcvugnhebckmxeluuulw", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_ListBySubscription_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_ListBySubscription_MinimumSet_Gen.json new file mode 100644 index 000000000000..8497ea0d2d90 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_ListBySubscription_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "VirtualNetworks_ListBySubscription_MinimumSet", + "operationId": "VirtualNetworks_ListBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "extendedLocation": {}, + "location": "fky" + } + ] + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_Update_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..20769733c10e --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_Update_MaximumSet_Gen.json @@ -0,0 +1,52 @@ +{ + "title": "VirtualNetworks_Update_MaximumSet", + "operationId": "VirtualNetworks_Update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualNetworkName": "S", + "properties": { + "tags": { + "key9516": "oxduo" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "inventoryItemId": "bxn", + "uuid": "12345678-1234-1234-1234-12345678abcd", + "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "networkName": "eeqahvnbblsdeeqezqdinggretyeg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key705": "apgplvjdyocx" + }, + "location": "fky", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "name": "sbeiflgxwzkgt", + "type": "oinkkqcuemmcvugnhebckmxeluuulw", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_Update_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..da457a67e881 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VirtualNetworks_Update_MinimumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "title": "VirtualNetworks_Update_MinimumSet", + "operationId": "VirtualNetworks_Update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "virtualNetworkName": "-", + "properties": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName", + "extendedLocation": {}, + "location": "fky" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmInstanceHybridIdentityMetadatas_Get_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmInstanceHybridIdentityMetadatas_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..f846564c6be5 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmInstanceHybridIdentityMetadatas_Get_MaximumSet_Gen.json @@ -0,0 +1,30 @@ +{ + "title": "VmInstanceHybridIdentityMetadatas_Get_MaximumSet", + "operationId": "VmInstanceHybridIdentityMetadatas_Get", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "properties": { + "resourceUid": "mikbntobifeiouinvsalnu", + "publicKey": "hijhfxcdjuzidfjjztoh", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/hybridIdentityMetadata/default", + "name": "rxvpcegqc", + "type": "ixqhymswessvylnqgti", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmInstanceHybridIdentityMetadatas_Get_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmInstanceHybridIdentityMetadatas_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..a7641b7ee237 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmInstanceHybridIdentityMetadatas_Get_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "VmInstanceHybridIdentityMetadatas_Get_MinimumSet", + "operationId": "VmInstanceHybridIdentityMetadatas_Get", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/hybridIdentityMetadata/default" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MaximumSet_Gen.json new file mode 100644 index 000000000000..370524a42038 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MaximumSet_Gen.json @@ -0,0 +1,35 @@ +{ + "title": "VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MaximumSet", + "operationId": "VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "resourceUid": "mikbntobifeiouinvsalnu", + "publicKey": "hijhfxcdjuzidfjjztoh", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/hybridIdentityMetadata/default", + "name": "rxvpcegqc", + "type": "ixqhymswessvylnqgti", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MinimumSet_Gen.json new file mode 100644 index 000000000000..fc77460f89ff --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MinimumSet", + "operationId": "VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance", + "parameters": { + "api-version": "2024-06-01", + "resourceUri": "gtgclehcbsyave" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/hybridIdentityMetadata/default" + } + ] + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_CreateOrUpdate_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..e220fbd33872 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,103 @@ +{ + "title": "VmmServers_CreateOrUpdate_MaximumSet", + "operationId": "VmmServers_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "-", + "resource": { + "properties": { + "credentials": { + "username": "jbuoltypmrgqfi", + "password": "gaecsnkjr" + }, + "fqdn": "pvzcjaqrswbvptgx", + "port": 4 + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4834": "vycgfkzjcyyuotwwq" + }, + "location": "hslxkyzktvwpqbypvs" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "credentials": { + "username": "jbuoltypmrgqfi" + }, + "fqdn": "pvzcjaqrswbvptgx", + "port": 4, + "connectionStatus": "vlmrrigzmutgbzrgjtolnamfxm", + "errorMessage": "ndkzeiipz", + "uuid": "vmwbukuqbuz", + "version": "tawfjzbqrlkqzqyomxiahnfqg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4834": "vycgfkzjcyyuotwwq" + }, + "location": "hslxkyzktvwpqbypvs", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "name": "gyoxmcbnbbfajvzygtffpaufxxjzs", + "type": "nwiimbcjryiggdcbpvrqdnlrklcwbr", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "credentials": { + "username": "jbuoltypmrgqfi" + }, + "fqdn": "pvzcjaqrswbvptgx", + "port": 4, + "connectionStatus": "vlmrrigzmutgbzrgjtolnamfxm", + "errorMessage": "ndkzeiipz", + "uuid": "vmwbukuqbuz", + "version": "tawfjzbqrlkqzqyomxiahnfqg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4834": "vycgfkzjcyyuotwwq" + }, + "location": "hslxkyzktvwpqbypvs", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "name": "gyoxmcbnbbfajvzygtffpaufxxjzs", + "type": "nwiimbcjryiggdcbpvrqdnlrklcwbr", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_CreateOrUpdate_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..4b62a316f61b --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "VmmServers_CreateOrUpdate_MinimumSet", + "operationId": "VmmServers_CreateOrUpdate", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "w", + "resource": { + "extendedLocation": {}, + "location": "hslxkyzktvwpqbypvs" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "extendedLocation": {}, + "location": "hslxkyzktvwpqbypvs" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "extendedLocation": {}, + "location": "hslxkyzktvwpqbypvs" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_Delete_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..f2ade0051551 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VmmServers_Delete_MaximumSet", + "operationId": "VmmServers_Delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "force": "true", + "vmmServerName": "." + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_Delete_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..61b90ad02df8 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "VmmServers_Delete_MinimumSet", + "operationId": "VmmServers_Delete", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "8" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_Get_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..4df33afdb0ab --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_Get_MaximumSet_Gen.json @@ -0,0 +1,47 @@ +{ + "title": "VmmServers_Get_MaximumSet", + "operationId": "VmmServers_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "." + }, + "responses": { + "200": { + "body": { + "properties": { + "credentials": { + "username": "jbuoltypmrgqfi" + }, + "fqdn": "pvzcjaqrswbvptgx", + "port": 4, + "connectionStatus": "vlmrrigzmutgbzrgjtolnamfxm", + "errorMessage": "ndkzeiipz", + "uuid": "vmwbukuqbuz", + "version": "tawfjzbqrlkqzqyomxiahnfqg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4834": "vycgfkzjcyyuotwwq" + }, + "location": "hslxkyzktvwpqbypvs", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "name": "gyoxmcbnbbfajvzygtffpaufxxjzs", + "type": "nwiimbcjryiggdcbpvrqdnlrklcwbr", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_Get_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..332cfecda737 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "VmmServers_Get_MinimumSet", + "operationId": "VmmServers_Get", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "D" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "extendedLocation": {}, + "location": "hslxkyzktvwpqbypvs" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_ListByResourceGroup_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..2c16af5b71b2 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,51 @@ +{ + "title": "VmmServers_ListByResourceGroup_MaximumSet", + "operationId": "VmmServers_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "credentials": { + "username": "jbuoltypmrgqfi" + }, + "fqdn": "pvzcjaqrswbvptgx", + "port": 4, + "connectionStatus": "vlmrrigzmutgbzrgjtolnamfxm", + "errorMessage": "ndkzeiipz", + "uuid": "vmwbukuqbuz", + "version": "tawfjzbqrlkqzqyomxiahnfqg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4834": "vycgfkzjcyyuotwwq" + }, + "location": "hslxkyzktvwpqbypvs", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "name": "gyoxmcbnbbfajvzygtffpaufxxjzs", + "type": "nwiimbcjryiggdcbpvrqdnlrklcwbr", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_ListByResourceGroup_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..e6c4e2aa604f --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "VmmServers_ListByResourceGroup_MinimumSet", + "operationId": "VmmServers_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "extendedLocation": {}, + "location": "hslxkyzktvwpqbypvs" + } + ] + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_ListBySubscription_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..ab6c2ef0bf1a --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,50 @@ +{ + "title": "VmmServers_ListBySubscription_MaximumSet", + "operationId": "VmmServers_ListBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "credentials": { + "username": "jbuoltypmrgqfi" + }, + "fqdn": "pvzcjaqrswbvptgx", + "port": 4, + "connectionStatus": "vlmrrigzmutgbzrgjtolnamfxm", + "errorMessage": "ndkzeiipz", + "uuid": "vmwbukuqbuz", + "version": "tawfjzbqrlkqzqyomxiahnfqg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4834": "vycgfkzjcyyuotwwq" + }, + "location": "hslxkyzktvwpqbypvs", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "name": "gyoxmcbnbbfajvzygtffpaufxxjzs", + "type": "nwiimbcjryiggdcbpvrqdnlrklcwbr", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_ListBySubscription_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_ListBySubscription_MinimumSet_Gen.json new file mode 100644 index 000000000000..f6ca575eabd9 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_ListBySubscription_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "VmmServers_ListBySubscription_MinimumSet", + "operationId": "VmmServers_ListBySubscription", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "extendedLocation": {}, + "location": "hslxkyzktvwpqbypvs" + } + ] + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_Update_MaximumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..60dbf4d2dc3e --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_Update_MaximumSet_Gen.json @@ -0,0 +1,57 @@ +{ + "title": "VmmServers_Update_MaximumSet", + "operationId": "VmmServers_Update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "Y", + "properties": { + "tags": { + "key7187": "oktnfvklfchnquelzzdagtpwfskzc" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "credentials": { + "username": "jbuoltypmrgqfi" + }, + "fqdn": "pvzcjaqrswbvptgx", + "port": 4, + "connectionStatus": "vlmrrigzmutgbzrgjtolnamfxm", + "errorMessage": "ndkzeiipz", + "uuid": "vmwbukuqbuz", + "version": "tawfjzbqrlkqzqyomxiahnfqg", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "type": "customLocation", + "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName" + }, + "tags": { + "key4834": "vycgfkzjcyyuotwwq" + }, + "location": "hslxkyzktvwpqbypvs", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "name": "gyoxmcbnbbfajvzygtffpaufxxjzs", + "type": "nwiimbcjryiggdcbpvrqdnlrklcwbr", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-01-29T22:28:00.094Z", + "lastModifiedBy": "goxcwpyyqlxndquly", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-29T22:28:00.095Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_Update_MinimumSet_Gen.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..056ba609f838 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/examples/VmmServers_Update_MinimumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "title": "VmmServers_Update_MinimumSet", + "operationId": "VmmServers_Update", + "parameters": { + "api-version": "2024-06-01", + "subscriptionId": "79332E5A-630B-480F-A266-A941C015AB19", + "resourceGroupName": "rgscvmm", + "vmmServerName": "_", + "properties": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName", + "extendedLocation": {}, + "location": "hslxkyzktvwpqbypvs" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/scvmm.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/scvmm.json new file mode 100644 index 000000000000..a1043382dec9 --- /dev/null +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/scvmm.json @@ -0,0 +1,5356 @@ +{ + "swagger": "2.0", + "info": { + "title": "ScVmm", + "version": "2024-06-01", + "description": "The Microsoft.ScVmm Rest API spec.", + "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": "VmmServers" + }, + { + "name": "Clouds" + }, + { + "name": "VirtualNetworks" + }, + { + "name": "VirtualMachineTemplates" + }, + { + "name": "AvailabilitySets" + }, + { + "name": "InventoryItems" + }, + { + "name": "VirtualMachineInstances" + }, + { + "name": "VmInstanceHybridIdentityMetadatas" + }, + { + "name": "GuestAgents" + } + ], + "paths": { + "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances": { + "get": { + "operationId": "VirtualMachineInstances_List", + "tags": [ + "VirtualMachineInstances" + ], + "summary": "Implements List virtual machine instances.", + "description": "Lists all of the virtual machine instances within the specified parent resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualMachineInstanceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualMachineInstances_List_MaximumSet": { + "$ref": "./examples/VirtualMachineInstances_List_MaximumSet_Gen.json" + }, + "VirtualMachineInstances_List_MinimumSet": { + "$ref": "./examples/VirtualMachineInstances_List_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default": { + "get": { + "operationId": "VirtualMachineInstances_Get", + "tags": [ + "VirtualMachineInstances" + ], + "summary": "Gets a virtual machine.", + "description": "Retrieves information about a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualMachineInstance" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualMachineInstances_Get_MaximumSet": { + "$ref": "./examples/VirtualMachineInstances_Get_MaximumSet_Gen.json" + }, + "VirtualMachineInstances_Get_MinimumSet": { + "$ref": "./examples/VirtualMachineInstances_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "tags": [ + "VirtualMachineInstances" + ], + "summary": "Implements virtual machine PUT method.", + "description": "The operation to create or update a virtual machine instance. Please note some properties can be set only during virtual machine instance creation.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineInstance" + } + } + ], + "responses": { + "200": { + "description": "Resource 'VirtualMachineInstance' update operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualMachineInstance" + } + }, + "201": { + "description": "Resource 'VirtualMachineInstance' create operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualMachineInstance" + }, + "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": { + "VirtualMachineInstances_CreateOrUpdate_MaximumSet": { + "$ref": "./examples/VirtualMachineInstances_CreateOrUpdate_MaximumSet_Gen.json" + }, + "VirtualMachineInstances_CreateOrUpdate_MinimumSet": { + "$ref": "./examples/VirtualMachineInstances_CreateOrUpdate_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "VirtualMachineInstances_Update", + "tags": [ + "VirtualMachineInstances" + ], + "summary": "Updates a virtual machine.", + "description": "The operation to update a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineInstanceUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualMachineInstance" + } + }, + "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": { + "VirtualMachineInstances_Update_MaximumSet": { + "$ref": "./examples/VirtualMachineInstances_Update_MaximumSet_Gen.json" + }, + "VirtualMachineInstances_Update_MinimumSet": { + "$ref": "./examples/VirtualMachineInstances_Update_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VirtualMachineInstances_Delete", + "tags": [ + "VirtualMachineInstances" + ], + "summary": "Deletes an virtual machine.", + "description": "The operation to delete a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "$ref": "#/parameters/QueryForceDelete" + }, + { + "name": "deleteFromHost", + "in": "query", + "description": "Whether to disable the VM from azure and also delete it from Vmm.", + "required": false, + "type": "string", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "DeleteFromHost", + "modelAsString": true, + "values": [ + { + "name": "true", + "value": "true", + "description": "Enable delete from host." + }, + { + "name": "false", + "value": "false", + "description": "Disable delete from host." + } + ] + } + } + ], + "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": { + "VirtualMachineInstances_Delete_MaximumSet": { + "$ref": "./examples/VirtualMachineInstances_Delete_MaximumSet_Gen.json" + }, + "VirtualMachineInstances_Delete_MinimumSet": { + "$ref": "./examples/VirtualMachineInstances_Delete_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/createCheckpoint": { + "post": { + "operationId": "VirtualMachineInstances_CreateCheckpoint", + "tags": [ + "VirtualMachineInstances" + ], + "summary": "Implements the operation to creates a checkpoint in a virtual machine instance.", + "description": "Creates a checkpoint in virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineCreateCheckpoint" + } + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualMachineInstances_CreateCheckpoint_MaximumSet": { + "$ref": "./examples/VirtualMachineInstances_CreateCheckpoint_MaximumSet_Gen.json" + }, + "VirtualMachineInstances_CreateCheckpoint_MinimumSet": { + "$ref": "./examples/VirtualMachineInstances_CreateCheckpoint_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/deleteCheckpoint": { + "post": { + "operationId": "VirtualMachineInstances_DeleteCheckpoint", + "tags": [ + "VirtualMachineInstances" + ], + "summary": "Implements the operation to delete a checkpoint in a virtual machine instance.", + "description": "Deletes a checkpoint in virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineDeleteCheckpoint" + } + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualMachineInstances_DeleteCheckpoint_MaximumSet": { + "$ref": "./examples/VirtualMachineInstances_DeleteCheckpoint_MaximumSet_Gen.json" + }, + "VirtualMachineInstances_DeleteCheckpoint_MinimumSet": { + "$ref": "./examples/VirtualMachineInstances_DeleteCheckpoint_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents": { + "get": { + "operationId": "GuestAgents_ListByVirtualMachineInstance", + "tags": [ + "GuestAgents" + ], + "summary": "Implements GET GuestAgent in a vm.", + "description": "Returns the list of GuestAgent of the given vm.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GuestAgentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GuestAgents_ListByVirtualMachineInstance_MaximumSet": { + "$ref": "./examples/GuestAgents_ListByVirtualMachineInstance_MaximumSet_Gen.json" + }, + "GuestAgents_ListByVirtualMachineInstance_MinimumSet": { + "$ref": "./examples/GuestAgents_ListByVirtualMachineInstance_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default": { + "get": { + "operationId": "GuestAgents_Get", + "tags": [ + "GuestAgents" + ], + "summary": "Gets GuestAgent.", + "description": "Implements GuestAgent GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GuestAgent" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GuestAgents_Get_MaximumSet": { + "$ref": "./examples/GuestAgents_Get_MaximumSet_Gen.json" + }, + "GuestAgents_Get_MinimumSet": { + "$ref": "./examples/GuestAgents_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "operationId": "GuestAgents_Create", + "tags": [ + "GuestAgents" + ], + "summary": "Implements GuestAgent PUT method.", + "description": "Create Or Update GuestAgent.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/GuestAgent" + } + } + ], + "responses": { + "200": { + "description": "Resource 'GuestAgent' update operation succeeded", + "schema": { + "$ref": "#/definitions/GuestAgent" + } + }, + "201": { + "description": "Resource 'GuestAgent' create operation succeeded", + "schema": { + "$ref": "#/definitions/GuestAgent" + }, + "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": { + "GuestAgents_Create_MaximumSet": { + "$ref": "./examples/GuestAgents_Create_MaximumSet_Gen.json" + }, + "GuestAgents_Create_MinimumSet": { + "$ref": "./examples/GuestAgents_Create_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "GuestAgents_Delete", + "tags": [ + "GuestAgents" + ], + "summary": "Deletes a GuestAgent resource.", + "description": "Implements GuestAgent DELETE method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "GuestAgents_Delete_MaximumSet": { + "$ref": "./examples/GuestAgents_Delete_MaximumSet_Gen.json" + }, + "GuestAgents_Delete_MinimumSet": { + "$ref": "./examples/GuestAgents_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/hybridIdentityMetadata": { + "get": { + "operationId": "VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance", + "tags": [ + "VmInstanceHybridIdentityMetadatas" + ], + "summary": "Implements GET HybridIdentityMetadata in a vm.", + "description": "Returns the list of HybridIdentityMetadata of the given VM.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmInstanceHybridIdentityMetadataListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MaximumSet": { + "$ref": "./examples/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MaximumSet_Gen.json" + }, + "VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MinimumSet": { + "$ref": "./examples/VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/hybridIdentityMetadata/default": { + "get": { + "operationId": "VmInstanceHybridIdentityMetadatas_Get", + "tags": [ + "VmInstanceHybridIdentityMetadatas" + ], + "summary": "Gets HybridIdentityMetadata.", + "description": "Implements HybridIdentityMetadata GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmInstanceHybridIdentityMetadata" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VmInstanceHybridIdentityMetadatas_Get_MaximumSet": { + "$ref": "./examples/VmInstanceHybridIdentityMetadatas_Get_MaximumSet_Gen.json" + }, + "VmInstanceHybridIdentityMetadatas_Get_MinimumSet": { + "$ref": "./examples/VmInstanceHybridIdentityMetadatas_Get_MinimumSet_Gen.json" + } + } + } + }, + "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/restart": { + "post": { + "operationId": "VirtualMachineInstances_Restart", + "tags": [ + "VirtualMachineInstances" + ], + "summary": "Implements the operation to restart a virtual machine.", + "description": "The operation to restart a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualMachineInstances_Restart_MaximumSet": { + "$ref": "./examples/VirtualMachineInstances_Restart_MaximumSet_Gen.json" + }, + "VirtualMachineInstances_Restart_MinimumSet": { + "$ref": "./examples/VirtualMachineInstances_Restart_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/restoreCheckpoint": { + "post": { + "operationId": "VirtualMachineInstances_RestoreCheckpoint", + "tags": [ + "VirtualMachineInstances" + ], + "summary": "Implements the operation to restores to a checkpoint in a virtual machine instance.", + "description": "Restores to a checkpoint in virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineRestoreCheckpoint" + } + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualMachineInstances_RestoreCheckpoint_MaximumSet": { + "$ref": "./examples/VirtualMachineInstances_RestoreCheckpoint_MaximumSet_Gen.json" + }, + "VirtualMachineInstances_RestoreCheckpoint_MinimumSet": { + "$ref": "./examples/VirtualMachineInstances_RestoreCheckpoint_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/start": { + "post": { + "operationId": "VirtualMachineInstances_Start", + "tags": [ + "VirtualMachineInstances" + ], + "summary": "Implements the operation to start a virtual machine.", + "description": "The operation to start a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualMachineInstances_Start_MaximumSet": { + "$ref": "./examples/VirtualMachineInstances_Start_MaximumSet_Gen.json" + }, + "VirtualMachineInstances_Start_MinimumSet": { + "$ref": "./examples/VirtualMachineInstances_Start_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/stop": { + "post": { + "operationId": "VirtualMachineInstances_Stop", + "tags": [ + "VirtualMachineInstances" + ], + "summary": "Implements the operation to stop a virtual machine.", + "description": "The operation to power off (stop) a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/StopVirtualMachineOptions" + } + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualMachineInstances_Stop_MaximumSet": { + "$ref": "./examples/VirtualMachineInstances_Stop_MaximumSet_Gen.json" + }, + "VirtualMachineInstances_Stop_MinimumSet": { + "$ref": "./examples/VirtualMachineInstances_Stop_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/providers/Microsoft.ScVmm/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List_MaximumSet": { + "$ref": "./examples/Operations_List_MaximumSet_Gen.json" + }, + "Operations_List_MinimumSet": { + "$ref": "./examples/Operations_List_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ScVmm/availabilitySets": { + "get": { + "operationId": "AvailabilitySets_ListBySubscription", + "tags": [ + "AvailabilitySets" + ], + "summary": "Implements GET AvailabilitySets in a subscription.", + "description": "List of AvailabilitySets in a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvailabilitySetListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AvailabilitySets_ListBySubscription_MaximumSet": { + "$ref": "./examples/AvailabilitySets_ListBySubscription_MaximumSet_Gen.json" + }, + "AvailabilitySets_ListBySubscription_MinimumSet": { + "$ref": "./examples/AvailabilitySets_ListBySubscription_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ScVmm/clouds": { + "get": { + "operationId": "Clouds_ListBySubscription", + "tags": [ + "Clouds" + ], + "summary": "Implements GET Clouds in a subscription.", + "description": "List of Clouds in a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Clouds_ListBySubscription_MaximumSet": { + "$ref": "./examples/Clouds_ListBySubscription_MaximumSet_Gen.json" + }, + "Clouds_ListBySubscription_MinimumSet": { + "$ref": "./examples/Clouds_ListBySubscription_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ScVmm/virtualMachineTemplates": { + "get": { + "operationId": "VirtualMachineTemplates_ListBySubscription", + "tags": [ + "VirtualMachineTemplates" + ], + "summary": "Implements GET VirtualMachineTemplates in a subscription.", + "description": "List of VirtualMachineTemplates in a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualMachineTemplateListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualMachineTemplates_ListBySubscription_MaximumSet": { + "$ref": "./examples/VirtualMachineTemplates_ListBySubscription_MaximumSet_Gen.json" + }, + "VirtualMachineTemplates_ListBySubscription_MinimumSet": { + "$ref": "./examples/VirtualMachineTemplates_ListBySubscription_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ScVmm/virtualNetworks": { + "get": { + "operationId": "VirtualNetworks_ListBySubscription", + "tags": [ + "VirtualNetworks" + ], + "summary": "Implements GET VirtualNetworks in a subscription.", + "description": "List of VirtualNetworks in a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualNetworkListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualNetworks_ListBySubscription_MaximumSet": { + "$ref": "./examples/VirtualNetworks_ListBySubscription_MaximumSet_Gen.json" + }, + "VirtualNetworks_ListBySubscription_MinimumSet": { + "$ref": "./examples/VirtualNetworks_ListBySubscription_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ScVmm/vmmServers": { + "get": { + "operationId": "VmmServers_ListBySubscription", + "tags": [ + "VmmServers" + ], + "summary": "Implements GET VmmServers in a subscription.", + "description": "List of VmmServers in a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmmServerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VmmServers_ListBySubscription_MaximumSet": { + "$ref": "./examples/VmmServers_ListBySubscription_MaximumSet_Gen.json" + }, + "VmmServers_ListBySubscription_MinimumSet": { + "$ref": "./examples/VmmServers_ListBySubscription_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/availabilitySets": { + "get": { + "operationId": "AvailabilitySets_ListByResourceGroup", + "tags": [ + "AvailabilitySets" + ], + "summary": "Implements GET AvailabilitySets in a resource group.", + "description": "List of AvailabilitySets in a 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/AvailabilitySetListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AvailabilitySets_ListByResourceGroup_MaximumSet": { + "$ref": "./examples/AvailabilitySets_ListByResourceGroup_MaximumSet_Gen.json" + }, + "AvailabilitySets_ListByResourceGroup_MinimumSet": { + "$ref": "./examples/AvailabilitySets_ListByResourceGroup_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/availabilitySets/{availabilitySetResourceName}": { + "get": { + "operationId": "AvailabilitySets_Get", + "tags": [ + "AvailabilitySets" + ], + "summary": "Gets an AvailabilitySet.", + "description": "Implements AvailabilitySet GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "availabilitySetResourceName", + "in": "path", + "description": "Name of the AvailabilitySet.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AvailabilitySets_Get_MaximumSet": { + "$ref": "./examples/AvailabilitySets_Get_MaximumSet_Gen.json" + }, + "AvailabilitySets_Get_MinimumSet": { + "$ref": "./examples/AvailabilitySets_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "operationId": "AvailabilitySets_CreateOrUpdate", + "tags": [ + "AvailabilitySets" + ], + "summary": "Implements AvailabilitySets PUT method.", + "description": "Onboards the ScVmm availability set as an Azure 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": "availabilitySetResourceName", + "in": "path", + "description": "Name of the AvailabilitySet.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AvailabilitySet' update operation succeeded", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + }, + "201": { + "description": "Resource 'AvailabilitySet' create operation succeeded", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + }, + "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": { + "AvailabilitySets_CreateOrUpdate_MaximumSet": { + "$ref": "./examples/AvailabilitySets_CreateOrUpdate_MaximumSet_Gen.json" + }, + "AvailabilitySets_CreateOrUpdate_MinimumSet": { + "$ref": "./examples/AvailabilitySets_CreateOrUpdate_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "AvailabilitySets_Update", + "tags": [ + "AvailabilitySets" + ], + "summary": "Implements the AvailabilitySets PATCH method.", + "description": "Updates the AvailabilitySets 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": "availabilitySetResourceName", + "in": "path", + "description": "Name of the AvailabilitySet.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AvailabilitySetTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + }, + "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": { + "AvailabilitySets_Update_MaximumSet": { + "$ref": "./examples/AvailabilitySets_Update_MaximumSet_Gen.json" + }, + "AvailabilitySets_Update_MinimumSet": { + "$ref": "./examples/AvailabilitySets_Update_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "AvailabilitySets_Delete", + "tags": [ + "AvailabilitySets" + ], + "summary": "Implements AvailabilitySet DELETE method.", + "description": "Deregisters the ScVmm availability set from Azure.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/QueryForceDelete" + }, + { + "name": "availabilitySetResourceName", + "in": "path", + "description": "Name of the AvailabilitySet.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "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": { + "AvailabilitySets_Delete_MaximumSet": { + "$ref": "./examples/AvailabilitySets_Delete_MaximumSet_Gen.json" + }, + "AvailabilitySets_Delete_MinimumSet": { + "$ref": "./examples/AvailabilitySets_Delete_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/clouds": { + "get": { + "operationId": "Clouds_ListByResourceGroup", + "tags": [ + "Clouds" + ], + "summary": "Implements GET Clouds in a resource group.", + "description": "List of Clouds in a 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/CloudListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Clouds_ListByResourceGroup_MaximumSet": { + "$ref": "./examples/Clouds_ListByResourceGroup_MaximumSet_Gen.json" + }, + "Clouds_ListByResourceGroup_MinimumSet": { + "$ref": "./examples/Clouds_ListByResourceGroup_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/clouds/{cloudResourceName}": { + "get": { + "operationId": "Clouds_Get", + "tags": [ + "Clouds" + ], + "summary": "Gets a Cloud.", + "description": "Implements Cloud GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "cloudResourceName", + "in": "path", + "description": "Name of the Cloud.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Cloud" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Clouds_Get_MaximumSet": { + "$ref": "./examples/Clouds_Get_MaximumSet_Gen.json" + }, + "Clouds_Get_MinimumSet": { + "$ref": "./examples/Clouds_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "operationId": "Clouds_CreateOrUpdate", + "tags": [ + "Clouds" + ], + "summary": "Implements Clouds PUT method.", + "description": "Onboards the ScVmm fabric cloud as an Azure cloud 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": "cloudResourceName", + "in": "path", + "description": "Name of the Cloud.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Cloud" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Cloud' update operation succeeded", + "schema": { + "$ref": "#/definitions/Cloud" + } + }, + "201": { + "description": "Resource 'Cloud' create operation succeeded", + "schema": { + "$ref": "#/definitions/Cloud" + }, + "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": { + "Clouds_CreateOrUpdate_MaximumSet": { + "$ref": "./examples/Clouds_CreateOrUpdate_MaximumSet_Gen.json" + }, + "Clouds_CreateOrUpdate_MinimumSet": { + "$ref": "./examples/Clouds_CreateOrUpdate_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Clouds_Update", + "tags": [ + "Clouds" + ], + "summary": "Implements the Clouds PATCH method.", + "description": "Updates the Clouds 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": "cloudResourceName", + "in": "path", + "description": "Name of the Cloud.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Cloud" + } + }, + "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": { + "Clouds_Update_MaximumSet": { + "$ref": "./examples/Clouds_Update_MaximumSet_Gen.json" + }, + "Clouds_Update_MinimumSet": { + "$ref": "./examples/Clouds_Update_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Clouds_Delete", + "tags": [ + "Clouds" + ], + "summary": "Implements Cloud resource DELETE method.", + "description": "Deregisters the ScVmm fabric cloud from Azure.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/QueryForceDelete" + }, + { + "name": "cloudResourceName", + "in": "path", + "description": "Name of the Cloud.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Clouds_Delete_MaximumSet": { + "$ref": "./examples/Clouds_Delete_MaximumSet_Gen.json" + }, + "Clouds_Delete_MinimumSet": { + "$ref": "./examples/Clouds_Delete_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachineTemplates": { + "get": { + "operationId": "VirtualMachineTemplates_ListByResourceGroup", + "tags": [ + "VirtualMachineTemplates" + ], + "summary": "Implements GET VirtualMachineTemplates in a resource group.", + "description": "List of VirtualMachineTemplates in a 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/VirtualMachineTemplateListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualMachineTemplates_ListByResourceGroup_MaximumSet": { + "$ref": "./examples/VirtualMachineTemplates_ListByResourceGroup_MaximumSet_Gen.json" + }, + "VirtualMachineTemplates_ListByResourceGroup_MinimumSet": { + "$ref": "./examples/VirtualMachineTemplates_ListByResourceGroup_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachineTemplates/{virtualMachineTemplateName}": { + "get": { + "operationId": "VirtualMachineTemplates_Get", + "tags": [ + "VirtualMachineTemplates" + ], + "summary": "Gets a VirtualMachineTemplate.", + "description": "Implements VirtualMachineTemplate GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualMachineTemplateName", + "in": "path", + "description": "Name of the VirtualMachineTemplate.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualMachineTemplate" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualMachineTemplates_Get_MaximumSet": { + "$ref": "./examples/VirtualMachineTemplates_Get_MaximumSet_Gen.json" + }, + "VirtualMachineTemplates_Get_MinimumSet": { + "$ref": "./examples/VirtualMachineTemplates_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "operationId": "VirtualMachineTemplates_CreateOrUpdate", + "tags": [ + "VirtualMachineTemplates" + ], + "summary": "Implements VirtualMachineTemplates PUT method.", + "description": "Onboards the ScVmm VM Template as an Azure VM Template 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": "virtualMachineTemplateName", + "in": "path", + "description": "Name of the VirtualMachineTemplate.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineTemplate" + } + } + ], + "responses": { + "200": { + "description": "Resource 'VirtualMachineTemplate' update operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualMachineTemplate" + } + }, + "201": { + "description": "Resource 'VirtualMachineTemplate' create operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualMachineTemplate" + }, + "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": { + "VirtualMachineTemplates_CreateOrUpdate_MaximumSet": { + "$ref": "./examples/VirtualMachineTemplates_CreateOrUpdate_MaximumSet_Gen.json" + }, + "VirtualMachineTemplates_CreateOrUpdate_MinimumSet": { + "$ref": "./examples/VirtualMachineTemplates_CreateOrUpdate_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "VirtualMachineTemplates_Update", + "tags": [ + "VirtualMachineTemplates" + ], + "summary": "Implements the VirtualMachineTemplate PATCH method.", + "description": "Updates the VirtualMachineTemplate 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": "virtualMachineTemplateName", + "in": "path", + "description": "Name of the VirtualMachineTemplate.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineTemplateTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualMachineTemplate" + } + }, + "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": { + "VirtualMachineTemplates_Update_MaximumSet": { + "$ref": "./examples/VirtualMachineTemplates_Update_MaximumSet_Gen.json" + }, + "VirtualMachineTemplates_Update_MinimumSet": { + "$ref": "./examples/VirtualMachineTemplates_Update_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VirtualMachineTemplates_Delete", + "tags": [ + "VirtualMachineTemplates" + ], + "summary": "Implements VirtualMachineTemplate DELETE method.", + "description": "Deregisters the ScVmm VM Template from Azure.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/QueryForceDelete" + }, + { + "name": "virtualMachineTemplateName", + "in": "path", + "description": "Name of the VirtualMachineTemplate.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualMachineTemplates_Delete_MaximumSet": { + "$ref": "./examples/VirtualMachineTemplates_Delete_MaximumSet_Gen.json" + }, + "VirtualMachineTemplates_Delete_MinimumSet": { + "$ref": "./examples/VirtualMachineTemplates_Delete_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualNetworks": { + "get": { + "operationId": "VirtualNetworks_ListByResourceGroup", + "tags": [ + "VirtualNetworks" + ], + "summary": "Implements GET VirtualNetworks in a resource group.", + "description": "List of VirtualNetworks in a 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/VirtualNetworkListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualNetworks_ListByResourceGroup_MaximumSet": { + "$ref": "./examples/VirtualNetworks_ListByResourceGroup_MaximumSet_Gen.json" + }, + "VirtualNetworks_ListByResourceGroup_MinimumSet": { + "$ref": "./examples/VirtualNetworks_ListByResourceGroup_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualNetworks/{virtualNetworkName}": { + "get": { + "operationId": "VirtualNetworks_Get", + "tags": [ + "VirtualNetworks" + ], + "summary": "Gets a VirtualNetwork.", + "description": "Implements VirtualNetwork GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualNetworkName", + "in": "path", + "description": "Name of the VirtualNetwork.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualNetwork" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualNetworks_Get_MaximumSet": { + "$ref": "./examples/VirtualNetworks_Get_MaximumSet_Gen.json" + }, + "VirtualNetworks_Get_MinimumSet": { + "$ref": "./examples/VirtualNetworks_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "operationId": "VirtualNetworks_CreateOrUpdate", + "tags": [ + "VirtualNetworks" + ], + "summary": "Implements VirtualNetworks PUT method.", + "description": "Onboards the ScVmm virtual network as an Azure virtual network 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": "virtualNetworkName", + "in": "path", + "description": "Name of the VirtualNetwork.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetwork" + } + } + ], + "responses": { + "200": { + "description": "Resource 'VirtualNetwork' update operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualNetwork" + } + }, + "201": { + "description": "Resource 'VirtualNetwork' create operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualNetwork" + }, + "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": { + "VirtualNetworks_CreateOrUpdate_MaximumSet": { + "$ref": "./examples/VirtualNetworks_CreateOrUpdate_MaximumSet_Gen.json" + }, + "VirtualNetworks_CreateOrUpdate_MinimumSet": { + "$ref": "./examples/VirtualNetworks_CreateOrUpdate_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "VirtualNetworks_Update", + "tags": [ + "VirtualNetworks" + ], + "summary": "Implements the VirtualNetworks PATCH method.", + "description": "Updates the VirtualNetworks 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": "virtualNetworkName", + "in": "path", + "description": "Name of the VirtualNetwork.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualNetwork" + } + }, + "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": { + "VirtualNetworks_Update_MaximumSet": { + "$ref": "./examples/VirtualNetworks_Update_MaximumSet_Gen.json" + }, + "VirtualNetworks_Update_MinimumSet": { + "$ref": "./examples/VirtualNetworks_Update_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VirtualNetworks_Delete", + "tags": [ + "VirtualNetworks" + ], + "summary": "Implements VirtualNetwork DELETE method.", + "description": "Deregisters the ScVmm virtual network from Azure.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/QueryForceDelete" + }, + { + "name": "virtualNetworkName", + "in": "path", + "description": "Name of the VirtualNetwork.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualNetworks_Delete_MaximumSet": { + "$ref": "./examples/VirtualNetworks_Delete_MaximumSet_Gen.json" + }, + "VirtualNetworks_Delete_MinimumSet": { + "$ref": "./examples/VirtualNetworks_Delete_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/vmmServers": { + "get": { + "operationId": "VmmServers_ListByResourceGroup", + "tags": [ + "VmmServers" + ], + "summary": "Implements GET VmmServers in a resource group.", + "description": "List of VmmServers in a 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/VmmServerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VmmServers_ListByResourceGroup_MaximumSet": { + "$ref": "./examples/VmmServers_ListByResourceGroup_MaximumSet_Gen.json" + }, + "VmmServers_ListByResourceGroup_MinimumSet": { + "$ref": "./examples/VmmServers_ListByResourceGroup_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}": { + "get": { + "operationId": "VmmServers_Get", + "tags": [ + "VmmServers" + ], + "summary": "Gets a VMMServer.", + "description": "Implements VmmServer GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "vmmServerName", + "in": "path", + "description": "Name of the VmmServer.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmmServer" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VmmServers_Get_MaximumSet": { + "$ref": "./examples/VmmServers_Get_MaximumSet_Gen.json" + }, + "VmmServers_Get_MinimumSet": { + "$ref": "./examples/VmmServers_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "operationId": "VmmServers_CreateOrUpdate", + "tags": [ + "VmmServers" + ], + "summary": "Implements VmmServers PUT method.", + "description": "Onboards the SCVmm fabric as an Azure VmmServer 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": "vmmServerName", + "in": "path", + "description": "Name of the VmmServer.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/VmmServer" + } + } + ], + "responses": { + "200": { + "description": "Resource 'VmmServer' update operation succeeded", + "schema": { + "$ref": "#/definitions/VmmServer" + } + }, + "201": { + "description": "Resource 'VmmServer' create operation succeeded", + "schema": { + "$ref": "#/definitions/VmmServer" + }, + "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": { + "VmmServers_CreateOrUpdate_MaximumSet": { + "$ref": "./examples/VmmServers_CreateOrUpdate_MaximumSet_Gen.json" + }, + "VmmServers_CreateOrUpdate_MinimumSet": { + "$ref": "./examples/VmmServers_CreateOrUpdate_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "VmmServers_Update", + "tags": [ + "VmmServers" + ], + "summary": "Implements VmmServers PATCH method.", + "description": "Updates the VmmServers 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": "vmmServerName", + "in": "path", + "description": "Name of the VmmServer.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/VmmServerTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmmServer" + } + }, + "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": { + "VmmServers_Update_MaximumSet": { + "$ref": "./examples/VmmServers_Update_MaximumSet_Gen.json" + }, + "VmmServers_Update_MinimumSet": { + "$ref": "./examples/VmmServers_Update_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VmmServers_Delete", + "tags": [ + "VmmServers" + ], + "summary": "Implements VmmServers DELETE method.", + "description": "Removes the SCVmm fabric from Azure.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/QueryForceDelete" + }, + { + "name": "vmmServerName", + "in": "path", + "description": "Name of the VmmServer.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VmmServers_Delete_MaximumSet": { + "$ref": "./examples/VmmServers_Delete_MaximumSet_Gen.json" + }, + "VmmServers_Delete_MinimumSet": { + "$ref": "./examples/VmmServers_Delete_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}/inventoryItems": { + "get": { + "operationId": "InventoryItems_ListByVmmServer", + "tags": [ + "InventoryItems" + ], + "summary": "Implements GET for the list of Inventory Items in the VMMServer.", + "description": "Returns the list of inventoryItems in the given VmmServer.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "vmmServerName", + "in": "path", + "description": "Name of the VmmServer.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InventoryItemListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InventoryItems_ListByVmmServer_MaximumSet": { + "$ref": "./examples/InventoryItems_ListByVmmServer_MaximumSet_Gen.json" + }, + "InventoryItems_ListByVmmServer_MinimumSet": { + "$ref": "./examples/InventoryItems_ListByVmmServer_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}/inventoryItems/{inventoryItemResourceName}": { + "get": { + "operationId": "InventoryItems_Get", + "tags": [ + "InventoryItems" + ], + "summary": "Implements GET InventoryItem method.", + "description": "Shows an inventory item.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "vmmServerName", + "in": "path", + "description": "Name of the VmmServer.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" + }, + { + "name": "inventoryItemResourceName", + "in": "path", + "description": "Name of the inventoryItem.", + "required": true, + "type": "string", + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InventoryItem" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InventoryItems_Get_MaximumSet": { + "$ref": "./examples/InventoryItems_Get_MaximumSet_Gen.json" + }, + "InventoryItems_Get_MinimumSet": { + "$ref": "./examples/InventoryItems_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "operationId": "InventoryItems_Create", + "tags": [ + "InventoryItems" + ], + "summary": "Implements InventoryItem PUT method.", + "description": "Create Or Update InventoryItem.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "vmmServerName", + "in": "path", + "description": "Name of the VmmServer.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" + }, + { + "name": "inventoryItemResourceName", + "in": "path", + "description": "Name of the inventoryItem.", + "required": true, + "type": "string", + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/InventoryItem" + } + } + ], + "responses": { + "200": { + "description": "Resource 'InventoryItem' update operation succeeded", + "schema": { + "$ref": "#/definitions/InventoryItem" + } + }, + "201": { + "description": "Resource 'InventoryItem' create operation succeeded", + "schema": { + "$ref": "#/definitions/InventoryItem" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InventoryItems_Create_MaximumSet": { + "$ref": "./examples/InventoryItems_Create_MaximumSet_Gen.json" + }, + "InventoryItems_Create_MinimumSet": { + "$ref": "./examples/InventoryItems_Create_MinimumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "InventoryItems_Delete", + "tags": [ + "InventoryItems" + ], + "summary": "Implements inventoryItem DELETE method.", + "description": "Deletes an inventoryItem.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "vmmServerName", + "in": "path", + "description": "Name of the VmmServer.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 54, + "pattern": "[a-zA-Z0-9-_\\.]" + }, + { + "name": "inventoryItemResourceName", + "in": "path", + "description": "Name of the inventoryItem.", + "required": true, + "type": "string", + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "InventoryItems_Delete_MaximumSet": { + "$ref": "./examples/InventoryItems_Delete_MaximumSet_Gen.json" + }, + "InventoryItems_Delete_MinimumSet": { + "$ref": "./examples/InventoryItems_Delete_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "AllocationMethod": { + "type": "string", + "description": "Network address allocation method.", + "enum": [ + "Dynamic", + "Static" + ], + "x-ms-enum": { + "name": "AllocationMethod", + "modelAsString": true, + "values": [ + { + "name": "Dynamic", + "value": "Dynamic", + "description": "Dynamically allocated address." + }, + { + "name": "Static", + "value": "Static", + "description": "Statically allocated address." + } + ] + } + }, + "AvailabilitySet": { + "type": "object", + "description": "The AvailabilitySets resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/AvailabilitySetProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location." + } + }, + "required": [ + "extendedLocation" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "AvailabilitySetListItem": { + "type": "object", + "description": "Availability Set model", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "Gets the ARM Id of the microsoft.scvmm/availabilitySets resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ScVmm/availabilitySets" + } + ] + } + }, + "name": { + "type": "string", + "description": "Gets or sets the name of the availability set." + } + } + }, + "AvailabilitySetListResult": { + "type": "object", + "description": "The response of a AvailabilitySet list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AvailabilitySet items on this page", + "items": { + "$ref": "#/definitions/AvailabilitySet" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "AvailabilitySetProperties": { + "type": "object", + "description": "Defines the resource properties.", + "properties": { + "availabilitySetName": { + "type": "string", + "description": "Name of the availability set.", + "minLength": 1 + }, + "vmmServerId": { + "type": "string", + "format": "arm-id", + "description": "ARM Id of the vmmServer resource in which this resource resides.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ScVmm/vmmServers" + } + ] + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + } + } + }, + "AvailabilitySetTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in AvailabilitySet resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Checkpoint": { + "type": "object", + "description": "Defines the resource properties.", + "properties": { + "parentCheckpointID": { + "type": "string", + "description": "Gets ID of parent of the checkpoint.", + "x-ms-client-name": "parentCheckpointId" + }, + "checkpointID": { + "type": "string", + "description": "Gets ID of the checkpoint.", + "x-ms-client-name": "checkpointId" + }, + "name": { + "type": "string", + "description": "Gets name of the checkpoint." + }, + "description": { + "type": "string", + "description": "Gets description of the checkpoint." + } + } + }, + "Cloud": { + "type": "object", + "description": "The Clouds resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/CloudProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location." + } + }, + "required": [ + "extendedLocation" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "CloudCapacity": { + "type": "object", + "description": "Cloud Capacity model", + "properties": { + "cpuCount": { + "type": "integer", + "format": "int64", + "description": "CPUCount specifies the maximum number of CPUs that can be allocated in the cloud.", + "readOnly": true + }, + "memoryMB": { + "type": "integer", + "format": "int64", + "description": "MemoryMB specifies a memory usage limit in megabytes.", + "readOnly": true + }, + "vmCount": { + "type": "integer", + "format": "int64", + "description": "VMCount gives the max number of VMs that can be deployed in the cloud.", + "readOnly": true + } + } + }, + "CloudInventoryItem": { + "type": "object", + "description": "The Cloud inventory item.", + "allOf": [ + { + "$ref": "#/definitions/InventoryItemProperties" + } + ], + "x-ms-discriminator-value": "Cloud" + }, + "CloudListResult": { + "type": "object", + "description": "The response of a Cloud list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Cloud items on this page", + "items": { + "$ref": "#/definitions/Cloud" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "CloudProperties": { + "type": "object", + "description": "Defines the resource properties.", + "properties": { + "inventoryItemId": { + "type": "string", + "description": "Gets or sets the inventory Item ID for the resource." + }, + "uuid": { + "type": "string", + "description": "Unique ID of the cloud.", + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + }, + "vmmServerId": { + "type": "string", + "format": "arm-id", + "description": "ARM Id of the vmmServer resource in which this resource resides.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ScVmm/vmmServers" + } + ] + } + }, + "cloudName": { + "type": "string", + "description": "Name of the cloud in VmmServer.", + "readOnly": true + }, + "cloudCapacity": { + "$ref": "#/definitions/CloudCapacity", + "description": "Capacity of the cloud.", + "readOnly": true + }, + "storageQoSPolicies": { + "type": "array", + "description": "List of QoS policies available for the cloud.", + "items": { + "$ref": "#/definitions/StorageQosPolicy" + }, + "readOnly": true, + "x-ms-client-name": "storageQosPolicies" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + } + } + }, + "CloudTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in Cloud resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "CreateDiffDisk": { + "type": "string", + "description": "Create diff disk.", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "CreateDiffDisk", + "modelAsString": true, + "values": [ + { + "name": "true", + "value": "true", + "description": "Enable create diff disk." + }, + { + "name": "false", + "value": "false", + "description": "Disable create diff disk." + } + ] + } + }, + "DynamicMemoryEnabled": { + "type": "string", + "description": "Dynamic memory enabled.", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "DynamicMemoryEnabled", + "modelAsString": true, + "values": [ + { + "name": "true", + "value": "true", + "description": "Enable dynamic memory." + }, + { + "name": "false", + "value": "false", + "description": "Disable dynamic memory." + } + ] + } + }, + "ExtendedLocation": { + "type": "object", + "description": "The extended location.", + "properties": { + "type": { + "type": "string", + "description": "The extended location type." + }, + "name": { + "type": "string", + "format": "arm-id", + "description": "The extended location name.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ExtendedLocation/customLocations" + } + ] + } + } + } + }, + "GuestAgent": { + "type": "object", + "description": "Defines the GuestAgent.", + "properties": { + "properties": { + "$ref": "#/definitions/GuestAgentProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "GuestAgentListResult": { + "type": "object", + "description": "The response of a GuestAgent list operation.", + "properties": { + "value": { + "type": "array", + "description": "The GuestAgent items on this page", + "items": { + "$ref": "#/definitions/GuestAgent" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "GuestAgentProperties": { + "type": "object", + "description": "Defines the resource properties.", + "properties": { + "uuid": { + "type": "string", + "description": "Gets a unique identifier for this resource.", + "readOnly": true + }, + "credentials": { + "$ref": "#/definitions/GuestCredential", + "description": "Username / Password Credentials to provision guest agent." + }, + "httpProxyConfig": { + "$ref": "#/definitions/HttpProxyConfiguration", + "description": "HTTP Proxy configuration for the VM." + }, + "provisioningAction": { + "$ref": "#/definitions/ProvisioningAction", + "description": "Gets or sets the guest agent provisioning action." + }, + "status": { + "type": "string", + "description": "Gets the guest agent status.", + "readOnly": true + }, + "customResourceName": { + "type": "string", + "description": "Gets the name of the corresponding resource in Kubernetes.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "privateLinkScopeResourceId": { + "type": "string", + "format": "arm-id", + "description": "The resource id of the private link scope this machine is assigned to, if any.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.HybridCompute/privateLinkScopes" + } + ] + } + } + } + }, + "GuestCredential": { + "type": "object", + "description": "Username / Password Credentials to connect to guest.", + "properties": { + "username": { + "type": "string", + "description": "Gets or sets username to connect with the guest." + }, + "password": { + "type": "string", + "format": "password", + "description": "Gets or sets the password to connect with the guest.", + "x-ms-mutability": [ + "update", + "create" + ], + "x-ms-secret": true + } + }, + "required": [ + "username", + "password" + ] + }, + "HardwareProfile": { + "type": "object", + "description": "Defines the resource properties.", + "properties": { + "memoryMB": { + "type": "integer", + "format": "int32", + "description": "MemoryMB is the size of a virtual machine's memory, in MB." + }, + "cpuCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of vCPUs for the vm." + }, + "limitCpuForMigration": { + "$ref": "#/definitions/LimitCpuForMigration", + "description": "Gets or sets a value indicating whether to enable processor compatibility mode for live migration of VMs." + }, + "dynamicMemoryEnabled": { + "$ref": "#/definitions/DynamicMemoryEnabled", + "description": "Gets or sets a value indicating whether to enable dynamic memory or not." + }, + "dynamicMemoryMaxMB": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the max dynamic memory for the vm." + }, + "dynamicMemoryMinMB": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the min dynamic memory for the vm." + }, + "isHighlyAvailable": { + "$ref": "#/definitions/IsHighlyAvailable", + "description": "Gets highly available property.", + "readOnly": true + } + } + }, + "HardwareProfileUpdate": { + "type": "object", + "description": "Defines the resource update properties.", + "properties": { + "memoryMB": { + "type": "integer", + "format": "int32", + "description": "MemoryMB is the size of a virtual machine's memory, in MB." + }, + "cpuCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of vCPUs for the vm." + }, + "limitCpuForMigration": { + "$ref": "#/definitions/LimitCpuForMigration", + "description": "Gets or sets a value indicating whether to enable processor compatibility mode for live migration of VMs." + }, + "dynamicMemoryEnabled": { + "$ref": "#/definitions/DynamicMemoryEnabled", + "description": "Gets or sets a value indicating whether to enable dynamic memory or not." + }, + "dynamicMemoryMaxMB": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the max dynamic memory for the vm." + }, + "dynamicMemoryMinMB": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the min dynamic memory for the vm." + } + } + }, + "HttpProxyConfiguration": { + "type": "object", + "description": "HTTP Proxy configuration for the VM.", + "properties": { + "httpsProxy": { + "type": "string", + "description": "Gets or sets httpsProxy url." + } + } + }, + "InfrastructureProfile": { + "type": "object", + "description": "Specifies the vmmServer infrastructure specific settings for the virtual machine instance.", + "properties": { + "inventoryItemId": { + "type": "string", + "description": "Gets or sets the inventory Item ID for the resource.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "vmmServerId": { + "type": "string", + "format": "arm-id", + "description": "ARM Id of the vmmServer resource in which this resource resides.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ScVmm/vmmServers" + } + ] + } + }, + "cloudId": { + "type": "string", + "format": "arm-id", + "description": "ARM Id of the cloud resource to use for deploying the vm.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ScVmm/clouds" + } + ] + } + }, + "templateId": { + "type": "string", + "format": "arm-id", + "description": "ARM Id of the template resource to use for deploying the vm.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ScVmm/virtualMachineTemplates" + } + ] + } + }, + "vmName": { + "type": "string", + "description": "VMName is the name of VM on the SCVmm server.", + "minLength": 1, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "uuid": { + "type": "string", + "description": "Unique ID of the virtual machine.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "lastRestoredVMCheckpoint": { + "$ref": "#/definitions/Checkpoint", + "description": "Last restored checkpoint in the vm.", + "readOnly": true, + "x-ms-client-name": "lastRestoredVmCheckpoint" + }, + "checkpoints": { + "type": "array", + "description": "Checkpoints in the vm.", + "items": { + "$ref": "#/definitions/Checkpoint" + }, + "readOnly": true, + "x-ms-identifiers": [ + "checkpointID" + ] + }, + "checkpointType": { + "type": "string", + "description": "Type of checkpoint supported for the vm.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "generation": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the generation for the vm.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "biosGuid": { + "type": "string", + "description": "Gets or sets the bios guid for the vm.", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "InfrastructureProfileUpdate": { + "type": "object", + "description": "Specifies the vmmServer infrastructure specific update settings for the virtual machine instance.", + "properties": { + "checkpointType": { + "type": "string", + "description": "Type of checkpoint supported for the vm.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + } + }, + "InventoryItem": { + "type": "object", + "description": "Defines the inventory item.", + "properties": { + "properties": { + "$ref": "#/definitions/InventoryItemProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "kind": { + "type": "string", + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "InventoryItemDetails": { + "type": "object", + "description": "Defines the resource properties.", + "properties": { + "inventoryItemId": { + "type": "string", + "description": "Gets or sets the inventory Item ID for the resource." + }, + "inventoryItemName": { + "type": "string", + "description": "Gets or sets the Managed Object name in Vmm for the resource." + } + } + }, + "InventoryItemListResult": { + "type": "object", + "description": "The response of a InventoryItem list operation.", + "properties": { + "value": { + "type": "array", + "description": "The InventoryItem items on this page", + "items": { + "$ref": "#/definitions/InventoryItem" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "InventoryItemProperties": { + "type": "object", + "description": "Defines the resource properties.", + "properties": { + "inventoryType": { + "$ref": "#/definitions/InventoryType", + "description": "They inventory type." + }, + "managedResourceId": { + "type": "string", + "description": "Gets the tracked resource id corresponding to the inventory resource.", + "readOnly": true + }, + "uuid": { + "type": "string", + "description": "Gets the UUID (which is assigned by Vmm) for the inventory item.", + "readOnly": true + }, + "inventoryItemName": { + "type": "string", + "description": "Gets the Managed Object name in Vmm for the inventory item.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + } + }, + "discriminator": "inventoryType", + "required": [ + "inventoryType" + ] + }, + "InventoryType": { + "type": "string", + "description": "The inventory type", + "enum": [ + "Cloud", + "VirtualNetwork", + "VirtualMachine", + "VirtualMachineTemplate" + ], + "x-ms-enum": { + "name": "InventoryType", + "modelAsString": true, + "values": [ + { + "name": "Cloud", + "value": "Cloud", + "description": "Cloud inventory type" + }, + { + "name": "VirtualNetwork", + "value": "VirtualNetwork", + "description": "VirtualNetwork inventory type" + }, + { + "name": "VirtualMachine", + "value": "VirtualMachine", + "description": "VirtualMachine inventory type" + }, + { + "name": "VirtualMachineTemplate", + "value": "VirtualMachineTemplate", + "description": "VirtualMachineTemplate inventory type" + } + ] + } + }, + "IsCustomizable": { + "type": "string", + "description": "Customizable.", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "IsCustomizable", + "modelAsString": true, + "values": [ + { + "name": "true", + "value": "true", + "description": "Enable customizable." + }, + { + "name": "false", + "value": "false", + "description": "Disable customizable." + } + ] + } + }, + "IsHighlyAvailable": { + "type": "string", + "description": "Highly available.", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "IsHighlyAvailable", + "modelAsString": true, + "values": [ + { + "name": "true", + "value": "true", + "description": "Enable highly available." + }, + { + "name": "false", + "value": "false", + "description": "Disable highly available." + } + ] + } + }, + "LimitCpuForMigration": { + "type": "string", + "description": "Limit CPU for migration.", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "LimitCpuForMigration", + "modelAsString": true, + "values": [ + { + "name": "true", + "value": "true", + "description": "Enable limit CPU for migration." + }, + { + "name": "false", + "value": "false", + "description": "Disable limit CPU for migration." + } + ] + } + }, + "NetworkInterface": { + "type": "object", + "description": "Network Interface model", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the network interface." + }, + "displayName": { + "type": "string", + "description": "Gets the display name of the network interface as shown in the vmmServer. This is the fallback label for a NIC when the name is not set.", + "readOnly": true + }, + "ipv4Addresses": { + "type": "array", + "description": "Gets the nic ipv4 addresses.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "ipv6Addresses": { + "type": "array", + "description": "Gets the nic ipv6 addresses.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "macAddress": { + "type": "string", + "description": "Gets or sets the nic MAC address." + }, + "virtualNetworkId": { + "type": "string", + "format": "arm-id", + "description": "Gets or sets the ARM Id of the Microsoft.ScVmm/virtualNetwork resource to connect the nic.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ScVmm/virtualNetwork" + } + ] + } + }, + "networkName": { + "type": "string", + "description": "Gets the name of the virtual network in vmmServer that the nic is connected to.", + "readOnly": true + }, + "ipv4AddressType": { + "$ref": "#/definitions/AllocationMethod", + "description": "Gets or sets the ipv4 address type." + }, + "ipv6AddressType": { + "$ref": "#/definitions/AllocationMethod", + "description": "Gets or sets the ipv6 address type." + }, + "macAddressType": { + "$ref": "#/definitions/AllocationMethod", + "description": "Gets or sets the mac address type." + }, + "nicId": { + "type": "string", + "description": "Gets or sets the nic id." + } + } + }, + "NetworkInterfaceUpdate": { + "type": "object", + "description": "Network Interface Update model", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the network interface." + }, + "macAddress": { + "type": "string", + "description": "Gets or sets the nic MAC address." + }, + "virtualNetworkId": { + "type": "string", + "format": "arm-id", + "description": "Gets or sets the ARM Id of the Microsoft.ScVmm/virtualNetwork resource to connect the nic.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ScVmm/virtualNetwork" + } + ] + } + }, + "ipv4AddressType": { + "$ref": "#/definitions/AllocationMethod", + "description": "Gets or sets the ipv4 address type." + }, + "ipv6AddressType": { + "$ref": "#/definitions/AllocationMethod", + "description": "Gets or sets the ipv6 address type." + }, + "macAddressType": { + "$ref": "#/definitions/AllocationMethod", + "description": "Gets or sets the mac address type." + }, + "nicId": { + "type": "string", + "description": "Gets or sets the nic id." + } + } + }, + "NetworkProfile": { + "type": "object", + "description": "Defines the resource properties.", + "properties": { + "networkInterfaces": { + "type": "array", + "description": "Gets or sets the list of network interfaces associated with the virtual machine.", + "items": { + "$ref": "#/definitions/NetworkInterface" + }, + "x-ms-identifiers": [ + "name", + "nicId" + ] + } + } + }, + "NetworkProfileUpdate": { + "type": "object", + "description": "Defines the resource update properties.", + "properties": { + "networkInterfaces": { + "type": "array", + "description": "Gets or sets the list of network interfaces associated with the virtual machine.", + "items": { + "$ref": "#/definitions/NetworkInterfaceUpdate" + }, + "x-ms-identifiers": [ + "name", + "nicId" + ] + } + } + }, + "OsProfileForVmInstance": { + "type": "object", + "description": "Defines the resource properties.", + "properties": { + "adminPassword": { + "type": "string", + "format": "password", + "description": "Admin password of the virtual machine.", + "x-ms-mutability": [ + "update", + "create" + ], + "x-ms-secret": true + }, + "computerName": { + "type": "string", + "description": "Gets or sets computer name." + }, + "osType": { + "$ref": "#/definitions/OsType", + "description": "Gets the type of the os.", + "readOnly": true + }, + "osSku": { + "type": "string", + "description": "Gets os sku.", + "readOnly": true + }, + "osVersion": { + "type": "string", + "description": "Gets os version.", + "readOnly": true + }, + "domainName": { + "type": "string", + "description": "Gets or sets the domain name." + }, + "domainUsername": { + "type": "string", + "description": "Gets or sets the domain username." + }, + "domainPassword": { + "type": "string", + "format": "password", + "description": "Password of the domain the VM has to join.", + "x-ms-mutability": [ + "update", + "create" + ], + "x-ms-secret": true + }, + "workgroup": { + "type": "string", + "description": "Gets or sets the workgroup." + }, + "productKey": { + "type": "string", + "format": "password", + "description": "Gets or sets the product key.Input format xxxxx-xxxxx-xxxxx-xxxxx-xxxxx", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true + }, + "timezone": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the index value of the timezone." + }, + "runOnceCommands": { + "type": "string", + "description": "Get or sets the commands to be run once at the time of creation separated by semicolons." + } + } + }, + "OsType": { + "type": "string", + "description": "Virtual machine operating system type.", + "enum": [ + "Windows", + "Linux", + "Other" + ], + "x-ms-enum": { + "name": "OsType", + "modelAsString": true, + "values": [ + { + "name": "Windows", + "value": "Windows", + "description": "Windows operating system." + }, + { + "name": "Linux", + "value": "Linux", + "description": "Linux operating system." + }, + { + "name": "Other", + "value": "Other", + "description": "Other operating system." + } + ] + } + }, + "ProvisioningAction": { + "type": "string", + "description": "Guest agent provisioning action.", + "enum": [ + "install", + "uninstall", + "repair" + ], + "x-ms-enum": { + "name": "ProvisioningAction", + "modelAsString": true, + "values": [ + { + "name": "install", + "value": "install", + "description": "Install guest agent." + }, + { + "name": "uninstall", + "value": "uninstall", + "description": "Uninstall guest agent." + }, + { + "name": "repair", + "value": "repair", + "description": "Repair guest agent." + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of the resource.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Updating", + "Deleting", + "Accepted", + "Created" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "The resource is provisioning." + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource has been accepted." + }, + { + "name": "Created", + "value": "Created", + "description": "The resource was created." + } + ] + }, + "readOnly": true + }, + "StopVirtualMachineOptions": { + "type": "object", + "description": "Defines the stop action properties.", + "properties": { + "skipShutdown": { + "type": "string", + "description": "Gets or sets a value indicating whether to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Defaults to false.", + "default": "false", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "SkipShutdown", + "modelAsString": true, + "values": [ + { + "name": "true", + "value": "true", + "description": "Enable skip shutdown." + }, + { + "name": "false", + "value": "false", + "description": "Disable skip shutdown." + } + ] + } + } + } + }, + "StorageProfile": { + "type": "object", + "description": "Defines the resource properties.", + "properties": { + "disks": { + "type": "array", + "description": "Gets or sets the list of virtual disks associated with the virtual machine.", + "items": { + "$ref": "#/definitions/VirtualDisk" + }, + "x-ms-identifiers": [ + "diskId", + "name" + ] + } + } + }, + "StorageProfileUpdate": { + "type": "object", + "description": "Defines the resource update properties.", + "properties": { + "disks": { + "type": "array", + "description": "Gets or sets the list of virtual disks associated with the virtual machine.", + "items": { + "$ref": "#/definitions/VirtualDiskUpdate" + }, + "x-ms-identifiers": [ + "diskId", + "name" + ] + } + } + }, + "StorageQosPolicy": { + "type": "object", + "description": "The StorageQoSPolicy definition.", + "properties": { + "name": { + "type": "string", + "description": "The name of the policy." + }, + "id": { + "type": "string", + "description": "The ID of the QoS policy." + }, + "iopsMaximum": { + "type": "integer", + "format": "int64", + "description": "The maximum IO operations per second." + }, + "iopsMinimum": { + "type": "integer", + "format": "int64", + "description": "The minimum IO operations per second." + }, + "bandwidthLimit": { + "type": "integer", + "format": "int64", + "description": "The Bandwidth Limit for internet traffic." + }, + "policyId": { + "type": "string", + "description": "The underlying policy." + } + } + }, + "StorageQosPolicyDetails": { + "type": "object", + "description": "The StorageQoSPolicyDetails definition.", + "properties": { + "name": { + "type": "string", + "description": "The name of the policy." + }, + "id": { + "type": "string", + "description": "The ID of the QoS policy." + } + } + }, + "VirtualDisk": { + "type": "object", + "description": "Virtual disk model", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the disk." + }, + "displayName": { + "type": "string", + "description": "Gets the display name of the virtual disk as shown in the vmmServer. This is the fallback label for a disk when the name is not set.", + "readOnly": true + }, + "diskId": { + "type": "string", + "description": "Gets or sets the disk id." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the disk total size." + }, + "maxDiskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Gets the max disk size.", + "readOnly": true + }, + "bus": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the disk bus." + }, + "lun": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the disk lun." + }, + "busType": { + "type": "string", + "description": "Gets or sets the disk bus type." + }, + "vhdType": { + "type": "string", + "description": "Gets or sets the disk vhd type." + }, + "volumeType": { + "type": "string", + "description": "Gets the disk volume type.", + "readOnly": true + }, + "vhdFormatType": { + "type": "string", + "description": "Gets the disk vhd format type.", + "readOnly": true + }, + "templateDiskId": { + "type": "string", + "description": "Gets or sets the disk id in the template.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "storageQoSPolicy": { + "$ref": "#/definitions/StorageQosPolicyDetails", + "description": "The QoS policy for the disk.", + "x-ms-client-name": "storageQosPolicy" + }, + "createDiffDisk": { + "$ref": "#/definitions/CreateDiffDisk", + "description": "Gets or sets a value indicating diff disk.", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "VirtualDiskUpdate": { + "type": "object", + "description": "Virtual Disk Update model", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the disk." + }, + "diskId": { + "type": "string", + "description": "Gets or sets the disk id." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the disk total size." + }, + "bus": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the disk bus." + }, + "lun": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the disk lun." + }, + "busType": { + "type": "string", + "description": "Gets or sets the disk bus type." + }, + "vhdType": { + "type": "string", + "description": "Gets or sets the disk vhd type." + }, + "storageQoSPolicy": { + "$ref": "#/definitions/StorageQosPolicyDetails", + "description": "The QoS policy for the disk.", + "x-ms-client-name": "storageQosPolicy" + } + } + }, + "VirtualMachineCreateCheckpoint": { + "type": "object", + "description": "Defines the create checkpoint action properties.", + "properties": { + "name": { + "type": "string", + "description": "Name of the checkpoint." + }, + "description": { + "type": "string", + "description": "Description of the checkpoint." + } + } + }, + "VirtualMachineDeleteCheckpoint": { + "type": "object", + "description": "Defines the delete checkpoint action properties.", + "properties": { + "id": { + "type": "string", + "description": "ID of the checkpoint to be deleted." + } + } + }, + "VirtualMachineInstance": { + "type": "object", + "description": "Define the virtualMachineInstance.", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualMachineInstanceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "Gets or sets the extended location.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "extendedLocation" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "VirtualMachineInstanceListResult": { + "type": "object", + "description": "The response of a VirtualMachineInstance list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VirtualMachineInstance items on this page", + "items": { + "$ref": "#/definitions/VirtualMachineInstance" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "VirtualMachineInstanceProperties": { + "type": "object", + "description": "Defines the resource properties.", + "properties": { + "availabilitySets": { + "type": "array", + "description": "Availability Sets in vm.", + "items": { + "$ref": "#/definitions/AvailabilitySetListItem" + } + }, + "osProfile": { + "$ref": "#/definitions/OsProfileForVmInstance", + "description": "OS properties.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfile", + "description": "Hardware properties." + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "description": "Network properties." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "Storage properties." + }, + "infrastructureProfile": { + "$ref": "#/definitions/InfrastructureProfile", + "description": "Gets the infrastructure profile." + }, + "powerState": { + "type": "string", + "description": "Gets the power state of the virtual machine.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + } + } + }, + "VirtualMachineInstanceUpdate": { + "type": "object", + "description": "The type used for update operations of the VirtualMachineInstance.", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualMachineInstanceUpdateProperties", + "description": "The update properties of the VirtualMachineInstance.", + "x-ms-client-flatten": true + } + } + }, + "VirtualMachineInstanceUpdateProperties": { + "type": "object", + "description": "Virtual Machine Instance Properties Update model", + "properties": { + "availabilitySets": { + "type": "array", + "description": "Availability Sets in vm.", + "items": { + "$ref": "#/definitions/AvailabilitySetListItem" + } + }, + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfileUpdate", + "description": "Hardware properties." + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfileUpdate", + "description": "Network properties." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfileUpdate", + "description": "Storage properties." + }, + "infrastructureProfile": { + "$ref": "#/definitions/InfrastructureProfileUpdate", + "description": "Gets the infrastructure profile." + } + } + }, + "VirtualMachineInventoryItem": { + "type": "object", + "description": "The Virtual machine inventory item.", + "properties": { + "osType": { + "$ref": "#/definitions/OsType", + "description": "Gets the type of the os.", + "readOnly": true + }, + "osName": { + "type": "string", + "description": "Gets os name.", + "readOnly": true + }, + "osVersion": { + "type": "string", + "description": "Gets os version.", + "readOnly": true + }, + "powerState": { + "type": "string", + "description": "Gets the power state of the virtual machine.", + "readOnly": true + }, + "ipAddresses": { + "type": "array", + "description": "Gets or sets the nic ip addresses.", + "items": { + "type": "string" + } + }, + "cloud": { + "$ref": "#/definitions/InventoryItemDetails", + "description": "Cloud inventory resource details where the VM is present." + }, + "biosGuid": { + "type": "string", + "description": "Gets the bios guid.", + "readOnly": true + }, + "managedMachineResourceId": { + "type": "string", + "format": "arm-id", + "description": "Gets the tracked resource id corresponding to the inventory resource.", + "readOnly": true, + "x-ms-arm-id-details": { + "allowedResources": [] + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/InventoryItemProperties" + } + ], + "x-ms-discriminator-value": "VirtualMachine" + }, + "VirtualMachineRestoreCheckpoint": { + "type": "object", + "description": "Defines the restore checkpoint action properties.", + "properties": { + "id": { + "type": "string", + "description": "ID of the checkpoint to be restored to." + } + } + }, + "VirtualMachineTemplate": { + "type": "object", + "description": "The VirtualMachineTemplates resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualMachineTemplateProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location." + } + }, + "required": [ + "extendedLocation" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "VirtualMachineTemplateInventoryItem": { + "type": "object", + "description": "The Virtual machine template inventory item.", + "properties": { + "cpuCount": { + "type": "integer", + "format": "int32", + "description": "Gets the desired number of vCPUs for the vm.", + "readOnly": true + }, + "memoryMB": { + "type": "integer", + "format": "int32", + "description": "MemoryMB is the desired size of a virtual machine's memory, in MB.", + "readOnly": true + }, + "osType": { + "$ref": "#/definitions/OsType", + "description": "Gets the type of the os.", + "readOnly": true + }, + "osName": { + "type": "string", + "description": "Gets os name.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/InventoryItemProperties" + } + ], + "x-ms-discriminator-value": "VirtualMachineTemplate" + }, + "VirtualMachineTemplateListResult": { + "type": "object", + "description": "The response of a VirtualMachineTemplate list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VirtualMachineTemplate items on this page", + "items": { + "$ref": "#/definitions/VirtualMachineTemplate" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "VirtualMachineTemplateProperties": { + "type": "object", + "description": "Defines the resource properties.", + "properties": { + "inventoryItemId": { + "type": "string", + "description": "Gets or sets the inventory Item ID for the resource." + }, + "uuid": { + "type": "string", + "description": "Unique ID of the virtual machine template.", + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + }, + "vmmServerId": { + "type": "string", + "format": "arm-id", + "description": "ARM Id of the vmmServer resource in which this resource resides.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ScVmm/vmmServers" + } + ] + } + }, + "osType": { + "$ref": "#/definitions/OsType", + "description": "Gets the type of the os.", + "readOnly": true + }, + "osName": { + "type": "string", + "description": "Gets os name.", + "readOnly": true + }, + "computerName": { + "type": "string", + "description": "Gets computer name.", + "readOnly": true + }, + "memoryMB": { + "type": "integer", + "format": "int32", + "description": "MemoryMB is the desired size of a virtual machine's memory, in MB.", + "readOnly": true + }, + "cpuCount": { + "type": "integer", + "format": "int32", + "description": "Gets the desired number of vCPUs for the vm.", + "readOnly": true + }, + "limitCpuForMigration": { + "$ref": "#/definitions/LimitCpuForMigration", + "description": "Gets a value indicating whether to enable processor compatibility mode for live migration of VMs.", + "readOnly": true + }, + "dynamicMemoryEnabled": { + "$ref": "#/definitions/DynamicMemoryEnabled", + "description": "Gets a value indicating whether to enable dynamic memory or not.", + "readOnly": true + }, + "isCustomizable": { + "$ref": "#/definitions/IsCustomizable", + "description": "Gets a value indicating whether the vm template is customizable or not.", + "readOnly": true + }, + "dynamicMemoryMaxMB": { + "type": "integer", + "format": "int32", + "description": "Gets the max dynamic memory for the vm.", + "readOnly": true + }, + "dynamicMemoryMinMB": { + "type": "integer", + "format": "int32", + "description": "Gets the min dynamic memory for the vm.", + "readOnly": true + }, + "isHighlyAvailable": { + "$ref": "#/definitions/IsHighlyAvailable", + "description": "Gets highly available property.", + "readOnly": true + }, + "generation": { + "type": "integer", + "format": "int32", + "description": "Gets the generation for the vm.", + "readOnly": true + }, + "networkInterfaces": { + "type": "array", + "description": "Gets the network interfaces of the template.", + "items": { + "$ref": "#/definitions/NetworkInterface" + }, + "readOnly": true, + "x-ms-identifiers": [ + "name", + "nicId" + ] + }, + "disks": { + "type": "array", + "description": "Gets the disks of the template.", + "items": { + "$ref": "#/definitions/VirtualDisk" + }, + "readOnly": true, + "x-ms-identifiers": [ + "diskId", + "name" + ] + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + } + } + }, + "VirtualMachineTemplateTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in VirtualMachineTemplate resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VirtualNetwork": { + "type": "object", + "description": "The VirtualNetworks resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualNetworkProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location." + } + }, + "required": [ + "extendedLocation" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "VirtualNetworkInventoryItem": { + "type": "object", + "description": "The Virtual network inventory item.", + "allOf": [ + { + "$ref": "#/definitions/InventoryItemProperties" + } + ], + "x-ms-discriminator-value": "VirtualNetwork" + }, + "VirtualNetworkListResult": { + "type": "object", + "description": "The response of a VirtualNetwork list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VirtualNetwork items on this page", + "items": { + "$ref": "#/definitions/VirtualNetwork" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "VirtualNetworkProperties": { + "type": "object", + "description": "Defines the resource properties.", + "properties": { + "inventoryItemId": { + "type": "string", + "description": "Gets or sets the inventory Item ID for the resource." + }, + "uuid": { + "type": "string", + "description": "Unique ID of the virtual network.", + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + }, + "vmmServerId": { + "type": "string", + "format": "arm-id", + "description": "ARM Id of the vmmServer resource in which this resource resides.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ScVmm/vmmServers" + } + ] + } + }, + "networkName": { + "type": "string", + "description": "Name of the virtual network in vmmServer.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + } + } + }, + "VirtualNetworkTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in VirtualNetwork resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VmInstanceHybridIdentityMetadata": { + "type": "object", + "description": "Defines the HybridIdentityMetadata.", + "properties": { + "properties": { + "$ref": "#/definitions/VmInstanceHybridIdentityMetadataProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "VmInstanceHybridIdentityMetadataListResult": { + "type": "object", + "description": "The response of a VmInstanceHybridIdentityMetadata list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VmInstanceHybridIdentityMetadata items on this page", + "items": { + "$ref": "#/definitions/VmInstanceHybridIdentityMetadata" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "VmInstanceHybridIdentityMetadataProperties": { + "type": "object", + "description": "Describes the properties of Hybrid Identity Metadata for a Virtual Machine.", + "properties": { + "resourceUid": { + "type": "string", + "description": "The unique identifier for the resource." + }, + "publicKey": { + "type": "string", + "description": "Gets or sets the Public Key." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + } + } + }, + "VmmCredential": { + "type": "object", + "description": "Credentials to connect to VmmServer.", + "properties": { + "username": { + "type": "string", + "description": "Username to use to connect to VmmServer." + }, + "password": { + "type": "string", + "format": "password", + "description": "Password to use to connect to VmmServer.", + "x-ms-mutability": [ + "update", + "create" + ], + "x-ms-secret": true + } + } + }, + "VmmServer": { + "type": "object", + "description": "The VmmServers resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/VmmServerProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location." + } + }, + "required": [ + "extendedLocation" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "VmmServerListResult": { + "type": "object", + "description": "The response of a VmmServer list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VmmServer items on this page", + "items": { + "$ref": "#/definitions/VmmServer" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "VmmServerProperties": { + "type": "object", + "description": "Defines the resource properties.", + "properties": { + "credentials": { + "$ref": "#/definitions/VmmCredential", + "description": "Credentials to connect to VmmServer." + }, + "fqdn": { + "type": "string", + "description": "Fqdn is the hostname/ip of the vmmServer.", + "minLength": 1 + }, + "port": { + "type": "integer", + "format": "int32", + "description": "Port is the port on which the vmmServer is listening.", + "minimum": 1, + "maximum": 65535 + }, + "connectionStatus": { + "type": "string", + "description": "Gets the connection status to the vmmServer.", + "readOnly": true + }, + "errorMessage": { + "type": "string", + "description": "Gets any error message if connection to vmmServer is having any issue.", + "readOnly": true + }, + "uuid": { + "type": "string", + "description": "Unique ID of vmmServer.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "Version is the version of the vmmSever.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + } + }, + "required": [ + "fqdn" + ] + }, + "VmmServerTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in VmmServer resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "parameters": { + "Azure.ResourceManager.ResourceUriParameter": { + "name": "resourceUri", + "in": "path", + "description": "The fully qualified Azure Resource manager identifier of the resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "QueryForceDelete": { + "name": "force", + "in": "query", + "description": "Forces the resource to be deleted.", + "required": false, + "type": "string", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "ForceDelete", + "modelAsString": true, + "values": [ + { + "name": "true", + "value": "true", + "description": "Enable force delete." + }, + { + "name": "false", + "value": "false", + "description": "Disable force delete." + } + ] + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/scvmm/resource-manager/readme.md b/specification/scvmm/resource-manager/readme.md index 3955c9a41db8..badf51a0a018 100644 --- a/specification/scvmm/resource-manager/readme.md +++ b/specification/scvmm/resource-manager/readme.md @@ -27,14 +27,21 @@ These are the global settings for the scvmm. ``` yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2023-10 +tag: package-2024-06 ``` ``` yaml modelerfour: flatten-models: false ``` +### Tag: package-2024-06 +These settings apply only when `--tag=package-2024-06` is specified on the command line. + +```yaml $(tag) == 'package-2024-06' +input-file: + - Microsoft.ScVmm/stable/2024-06-01/scvmm.json +``` ### Tag: package-2023-10 These settings apply only when `--tag=package-2023-10` is specified on the command line. @@ -117,4 +124,4 @@ See configuration in [readme.typescript.md](./readme.typescript.md) ## CSharp -See configuration in [readme.csharp.md](./readme.csharp.md) +See configuration in [readme.csharp.md](./readme.csharp.md) \ No newline at end of file diff --git a/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/searchindex.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/searchindex.json index 1d30f0fbe030..d1a1455aac0d 100644 --- a/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/searchindex.json +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/searchindex.json @@ -1863,7 +1863,7 @@ }, "fields": { "type": "string", - "description": "Vector Fields of type Collection(Edm.Single) to be included in the vector searched." + "description": "The comma-separated list of field names to be included in the vector search. Each of the fields must be a valid vector type, such as Collection(Edm.Single). If multiple fields are given, the vector will be used to find the closest matches across all fields." }, "exhaustive": { "type": "boolean", diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/AuthorizationRules.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/AuthorizationRules.json new file mode 100644 index 000000000000..1f24620a8ae9 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/AuthorizationRules.json @@ -0,0 +1,1256 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2023-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules": { + "get": { + "tags": [ + "Namespaces AuthorizationRule" + ], + "operationId": "Namespaces_ListAuthorizationRules", + "x-ms-examples": { + "NameSpaceAuthorizationRuleListAll": { + "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleListAll.json" + } + }, + "description": "Gets the authorization rules for a namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639376.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace authorization rules returned successfully.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRuleListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}": { + "put": { + "tags": [ + "Namespaces AuthorizationRule" + ], + "operationId": "Namespaces_CreateOrUpdateAuthorizationRule", + "x-ms-examples": { + "NameSpaceAuthorizationRuleCreate": { + "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleCreate.json" + } + }, + "description": "Creates or updates an authorization rule for a namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639410.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + }, + "description": "The shared access authorization rule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace authorization rule created.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Namespaces AuthorizationRule" + ], + "operationId": "Namespaces_DeleteAuthorizationRule", + "x-ms-examples": { + "NameSpaceAuthorizationRuleDelete": { + "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleDelete.json" + } + }, + "description": "Deletes a namespace authorization rule.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639417.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace authorization rule successfully deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Namespaces AuthorizationRule" + ], + "operationId": "Namespaces_GetAuthorizationRule", + "x-ms-examples": { + "NameSpaceAuthorizationRuleGet": { + "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleGet.json" + } + }, + "description": "Gets an authorization rule for a namespace by rule name.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639392.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace authorization rule returned successfully.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/listKeys": { + "post": { + "tags": [ + "Namespaces AuthorizationRule" + ], + "operationId": "Namespaces_ListKeys", + "x-ms-examples": { + "NameSpaceAuthorizationRuleListKey": { + "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleListKey.json" + } + }, + "description": "Gets the primary and secondary connection strings for the namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639398.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings successfully returned.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/regenerateKeys": { + "post": { + "tags": [ + "Namespaces AuthorizationRule" + ], + "operationId": "Namespaces_RegenerateKeys", + "x-ms-examples": { + "NameSpaceAuthorizationRuleRegenerateKey": { + "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleRegenerateKey.json" + } + }, + "description": "Regenerates the primary or secondary connection strings for the namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt718977.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateAccessKeyParameters" + }, + "description": "Parameters supplied to regenerate the authorization rule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Authorization rule successfully regenerated.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules": { + "get": { + "tags": [ + "Queues AuthorizationRule" + ], + "operationId": "Queues_ListAuthorizationRules", + "x-ms-examples": { + "QueueAuthorizationRuleListAll": { + "$ref": "./examples/Queues/SBQueueAuthorizationRuleListAll.json" + } + }, + "description": "Gets all authorization rules for a queue.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt705607.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Authorization rules successfully returned.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRuleListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}": { + "put": { + "tags": [ + "Queues AuthorizationRule" + ], + "operationId": "Queues_CreateOrUpdateAuthorizationRule", + "x-ms-examples": { + "QueueAuthorizationRuleCreate": { + "$ref": "./examples/Queues/SBQueueAuthorizationRuleCreate.json" + } + }, + "description": "Creates an authorization rule for a queue.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + }, + "description": "The shared access authorization rule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Authorization rule successfully created.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Queues AuthorizationRule" + ], + "operationId": "Queues_DeleteAuthorizationRule", + "x-ms-examples": { + "QueueAuthorizationRuleDelete": { + "$ref": "./examples/Queues/SBQueueAuthorizationRuleDelete.json" + } + }, + "description": "Deletes a queue authorization rule.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt705609.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Authorization rule successfully deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Queues AuthorizationRule" + ], + "operationId": "Queues_GetAuthorizationRule", + "x-ms-examples": { + "QueueAuthorizationRuleGet": { + "$ref": "./examples/Queues/SBQueueAuthorizationRuleGet.json" + } + }, + "description": "Gets an authorization rule for a queue by rule name.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt705611.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Authorization rule successfully returned.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}/ListKeys": { + "post": { + "tags": [ + "Queues AuthorizationRule" + ], + "operationId": "Queues_ListKeys", + "x-ms-examples": { + "QueueAuthorizationRuleListKey": { + "$ref": "./examples/Queues/SBQueueAuthorizationRuleListKey.json" + } + }, + "description": "Primary and secondary connection strings to the queue.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt705608.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings successfully returned.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}/regenerateKeys": { + "post": { + "tags": [ + "Queues AuthorizationRule" + ], + "operationId": "Queues_RegenerateKeys", + "x-ms-examples": { + "QueueAuthorizationRuleRegenerateKey": { + "$ref": "./examples/Queues/SBQueueAuthorizationRuleRegenerateKey.json" + } + }, + "description": "Regenerates the primary or secondary connection strings to the queue.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt705606.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateAccessKeyParameters" + }, + "description": "Parameters supplied to regenerate the authorization rule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings successfully regenerated.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules": { + "get": { + "tags": [ + "Topics AuthorizationRule" + ], + "operationId": "Topics_ListAuthorizationRules", + "x-ms-examples": { + "TopicAuthorizationRuleListAll": { + "$ref": "./examples/Topics/SBTopicAuthorizationRuleListAll.json" + } + }, + "description": "Gets authorization rules for a topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt720681.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Authorization rules successfully returned.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRuleListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}": { + "put": { + "tags": [ + "Topics AuthorizationRule" + ], + "operationId": "Topics_CreateOrUpdateAuthorizationRule", + "x-ms-examples": { + "TopicAuthorizationRuleCreate": { + "$ref": "./examples/Topics/SBTopicAuthorizationRuleCreate.json" + } + }, + "description": "Creates an authorization rule for the specified topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt720678.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + }, + "description": "The shared access authorization rule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Topic authorization rule successfully created.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Topics AuthorizationRule" + ], + "operationId": "Topics_GetAuthorizationRule", + "x-ms-examples": { + "TopicAuthorizationRuleGet": { + "$ref": "./examples/Topics/SBTopicAuthorizationRuleGet.json" + } + }, + "description": "Returns the specified authorization rule.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt720676.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Topic authorization rule returned successfully.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Topics AuthorizationRule" + ], + "operationId": "Topics_DeleteAuthorizationRule", + "x-ms-examples": { + "TopicAuthorizationRuleDelete": { + "$ref": "./examples/Topics/SBTopicAuthorizationRuleDelete.json" + } + }, + "description": "Deletes a topic authorization rule.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt720681.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Topic authorization rule successfully deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}/ListKeys": { + "post": { + "tags": [ + "Topics AuthorizationRule" + ], + "operationId": "Topics_ListKeys", + "x-ms-examples": { + "TopicAuthorizationRuleListKey": { + "$ref": "./examples/Topics/SBTopicAuthorizationRuleListKey.json" + } + }, + "description": "Gets the primary and secondary connection strings for the topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt720677.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings successfully retrieved.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}/regenerateKeys": { + "post": { + "tags": [ + "Topics AuthorizationRule" + ], + "operationId": "Topics_RegenerateKeys", + "x-ms-examples": { + "TopicAuthorizationRuleRegenerateKey": { + "$ref": "./examples/Topics/SBTopicAuthorizationRuleRegenerateKey.json" + } + }, + "description": "Regenerates primary or secondary connection strings for the topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt720679.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateAccessKeyParameters" + }, + "description": "Parameters supplied to regenerate the authorization rule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings successfully regenerated.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules": { + "get": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_ListAuthorizationRules", + "x-ms-examples": { + "NameSpaceAuthorizationRuleListAll": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListAll.json" + } + }, + "description": "Gets the authorization rules for a namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639376.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "DisasterRecoveryConfigs authorization rules returned successfully.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRuleListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules/{authorizationRuleName}": { + "get": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_GetAuthorizationRule", + "x-ms-examples": { + "DisasterRecoveryConfigsAuthorizationRuleGet": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleGet.json" + } + }, + "description": "Gets an authorization rule for a namespace by rule name.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639392.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "DisasterRecoveryConfigs authorization rule returned successfully.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules/{authorizationRuleName}/listKeys": { + "post": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_ListKeys", + "x-ms-examples": { + "DisasterRecoveryConfigsAuthorizationRuleListKey": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListKey.json" + } + }, + "description": "Gets the primary and secondary connection strings for the namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639398.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings successfully returned.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "SBAuthorizationRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SBAuthorizationRule" + }, + "description": "Result of the List Authorization Rules operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of Authorization Rules." + } + }, + "description": "The response to the List Namespace operation." + }, + "SBAuthorizationRule": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "rights": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Manage", + "Send", + "Listen" + ], + "x-ms-enum": { + "name": "AccessRights", + "modelAsString": false + } + }, + "description": "The rights associated with the rule." + } + }, + "required": [ + "rights" + ], + "description": "AuthorizationRule properties." + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../common/v2/definitions.json#/definitions/ProxyResource" + } + ], + "description": "Description of a namespace authorization rule." + }, + "AccessKeys": { + "type": "object", + "properties": { + "primaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Primary connection string of the created namespace authorization rule." + }, + "secondaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Secondary connection string of the created namespace authorization rule." + }, + "aliasPrimaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Primary connection string of the alias if GEO DR is enabled" + }, + "aliasSecondaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Secondary connection string of the alias if GEO DR is enabled" + }, + "primaryKey": { + "readOnly": true, + "type": "string", + "description": "A base64-encoded 256-bit primary key for signing and validating the SAS token." + }, + "secondaryKey": { + "readOnly": true, + "type": "string", + "description": "A base64-encoded 256-bit primary key for signing and validating the SAS token." + }, + "keyName": { + "readOnly": true, + "type": "string", + "description": "A string that describes the authorization rule." + } + }, + "description": "Namespace/ServiceBus Connection String" + }, + "RegenerateAccessKeyParameters": { + "type": "object", + "properties": { + "keyType": { + "type": "string", + "description": "The access key to regenerate.", + "enum": [ + "PrimaryKey", + "SecondaryKey" + ], + "x-ms-enum": { + "name": "KeyType", + "modelAsString": false + } + }, + "key": { + "type": "string", + "description": "Optional, if the key value provided, is reset for KeyType value or autogenerate Key value set for keyType" + } + }, + "required": [ + "keyType" + ], + "description": "Parameters supplied to the Regenerate Authorization Rule operation, specifies which key needs to be reset." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/CheckNameAvailability.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/CheckNameAvailability.json new file mode 100644 index 000000000000..049c28de0135 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/CheckNameAvailability.json @@ -0,0 +1,185 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2023-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/CheckNameAvailability": { + "post": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_CheckNameAvailability", + "x-ms-examples": { + "NameSpaceCheckNameAvailability": { + "$ref": "./examples/NameSpaces/SBNameSpaceCheckNameAvailability.json" + } + }, + "description": "Check the give namespace name availability.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailability" + }, + "description": "Parameters to check availability of the given namespace name" + } + ], + "responses": { + "200": { + "description": "check availability returned successfully.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/CheckNameAvailability": { + "post": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_CheckNameAvailability", + "x-ms-examples": { + "AliasNameAvailability": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasCheckNameAvailability.json" + } + }, + "description": "Check the give namespace name availability.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailability" + }, + "description": "Parameters to check availability of the given namespace name" + } + ], + "responses": { + "200": { + "description": "check availability returned successfully.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "CheckNameAvailability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The Name to check the namespace name availability and The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number." + } + }, + "required": [ + "name" + ], + "description": "Description of a Check Name availability request properties." + }, + "CheckNameAvailabilityResult": { + "type": "object", + "properties": { + "message": { + "readOnly": true, + "type": "string", + "description": "The detailed info regarding the reason associated with the namespace." + }, + "nameAvailable": { + "type": "boolean", + "description": "Value indicating namespace is availability, true if the namespace is available; otherwise, false." + }, + "reason": { + "$ref": "#/definitions/UnavailableReason", + "description": "The reason for unavailability of a namespace." + } + }, + "description": "Description of a Check Name availability request properties." + }, + "UnavailableReason": { + "type": "string", + "enum": [ + "None", + "InvalidName", + "SubscriptionIsDisabled", + "NameInUse", + "NameInLockdown", + "TooManyNamespaceInCurrentSubscription" + ], + "x-ms-enum": { + "name": "UnavailableReason", + "modelAsString": false + }, + "description": "Specifies the reason for the unavailability of the service." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/DisasterRecoveryConfig.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/DisasterRecoveryConfig.json new file mode 100644 index 000000000000..4e950442f92b --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/DisasterRecoveryConfig.json @@ -0,0 +1,423 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2023-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs": { + "get": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_List", + "x-ms-examples": { + "SBAliasList": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasList.json" + } + }, + "description": "Gets all Alias(Disaster Recovery configurations)", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of Alias(Disaster Recovery configurations) for servicebus namespace", + "schema": { + "$ref": "#/definitions/ArmDisasterRecoveryListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}": { + "put": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_CreateOrUpdate", + "x-ms-examples": { + "SBAliasCreate": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasCreate.json" + } + }, + "description": "Creates or updates a new Alias(Disaster Recovery configuration)", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArmDisasterRecovery" + }, + "description": "Parameters required to create an Alias(Disaster Recovery configuration)" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Alias(Disaster Recovery configuration) successfully created", + "schema": { + "$ref": "#/definitions/ArmDisasterRecovery" + } + }, + "201": { + "description": "Alias(Disaster Recovery configuration) creation request received", + "schema": { + "$ref": "#/definitions/ArmDisasterRecovery" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_Delete", + "x-ms-examples": { + "SBAliasDelete": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasDelete.json" + } + }, + "description": "Deletes an Alias(Disaster Recovery configuration)", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete Alias(Disaster Recovery configuration) request accepted" + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_Get", + "x-ms-examples": { + "SBAliasGet": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasGet.json" + } + }, + "description": "Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the Alias(Disaster Recovery configurations)", + "schema": { + "$ref": "#/definitions/ArmDisasterRecovery" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/breakPairing": { + "post": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_BreakPairing", + "x-ms-examples": { + "SBEHAliasBreakPairing": { + "$ref": "./examples/disasterRecoveryConfigs/SBEHAliasBreakPairing.json" + } + }, + "description": "This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Break-Pairing operation is successful." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/failover": { + "post": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_FailOver", + "x-ms-examples": { + "SBAliasFailOver": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasFailOver.json" + } + }, + "description": "Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/FailoverProperties" + }, + "description": "Parameters required to create an Alias(Disaster Recovery configuration)" + } + ], + "responses": { + "200": { + "description": "Failover operation is successful." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ArmDisasterRecovery": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed'", + "enum": [ + "Accepted", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningStateDR", + "modelAsString": false + } + }, + "pendingReplicationOperationsCount": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "Number of entities pending to be replicated." + }, + "partnerNamespace": { + "type": "string", + "description": "ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing" + }, + "alternateName": { + "type": "string", + "description": "Primary/Secondary eventhub namespace name, which is part of GEO DR pairing" + }, + "role": { + "readOnly": true, + "type": "string", + "description": "role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary'", + "enum": [ + "Primary", + "PrimaryNotReplicating", + "Secondary" + ], + "x-ms-enum": { + "name": "RoleDisasterRecovery", + "modelAsString": false + } + } + }, + "description": "Properties required to the Create Or Update Alias(Disaster Recovery configurations)" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../common/v2/definitions.json#/definitions/ProxyResource" + } + ], + "description": "Single item in List or Get Alias(Disaster Recovery configuration) operation" + }, + "FailoverProperties": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "IsSafeFailover": { + "type": "boolean", + "description": "Safe failover is to indicate the service should wait for pending replication to finish before switching to the secondary." + } + }, + "description": "Safe failover is to indicate the service should wait for pending replication to finish before switching to the secondary." + } + }, + "description": "Safe failover is to indicate the service should wait for pending replication to finish before switching to the secondary." + }, + "ArmDisasterRecoveryListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ArmDisasterRecovery" + }, + "description": "List of Alias(Disaster Recovery configurations)" + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if Value contains incomplete list of Alias(Disaster Recovery configuration)" + } + }, + "description": "The result of the List Alias(Disaster Recovery configuration) operation." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/Queue.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/Queue.json new file mode 100644 index 000000000000..1942caf3659c --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/Queue.json @@ -0,0 +1,394 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2023-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues": { + "get": { + "tags": [ + "Queues" + ], + "operationId": "Queues_ListByNamespace", + "x-ms-examples": { + "QueueListByNameSpace": { + "$ref": "./examples/Queues/SBQueueListByNameSpace.json" + } + }, + "description": "Gets the queues within a namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639415.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SkipParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "Queues successfully returned.", + "schema": { + "$ref": "#/definitions/SBQueueListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}": { + "put": { + "tags": [ + "Queues" + ], + "operationId": "Queues_CreateOrUpdate", + "x-ms-examples": { + "QueueCreate": { + "$ref": "./examples/Queues/SBQueueCreate.json" + } + }, + "description": "Creates or updates a Service Bus queue. This operation is idempotent.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639395.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBQueue" + }, + "description": "Parameters supplied to create or update a queue resource." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Queue successfully created.", + "schema": { + "$ref": "#/definitions/SBQueue" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Queues" + ], + "operationId": "Queues_Delete", + "x-ms-examples": { + "QueueDelete": { + "$ref": "./examples/Queues/SBQueueDelete.json" + } + }, + "description": "Deletes a queue from the specified namespace in a resource group.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639411.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Queue successfully deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Queues" + ], + "operationId": "Queues_Get", + "x-ms-examples": { + "QueueGet": { + "$ref": "./examples/Queues/SBQueueGet.json" + } + }, + "description": "Returns a description for the specified queue.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639380.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Queue description successfully returned.", + "schema": { + "$ref": "#/definitions/SBQueue" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "SBQueueListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SBQueue" + }, + "description": "Result of the List Queues operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of queues." + } + }, + "description": "The response to the List Queues operation." + }, + "SBQueue": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SBQueueProperties", + "description": "Queue Properties" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../common/v2/definitions.json#/definitions/ProxyResource" + } + ], + "description": "Description of queue Resource." + }, + "SBQueueProperties": { + "type": "object", + "properties": { + "countDetails": { + "readOnly": true, + "$ref": "../../../common/v1/definitions.json#/definitions/MessageCountDetails", + "description": "Message Count Details." + }, + "createdAt": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The exact time the message was created." + }, + "updatedAt": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The exact time the message was updated." + }, + "accessedAt": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Last time a message was sent, or the last time there was a receive request to this queue." + }, + "sizeInBytes": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "The size of the queue, in bytes." + }, + "messageCount": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "The number of messages in the queue." + }, + "lockDuration": { + "format": "duration", + "type": "string", + "description": "ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute." + }, + "maxSizeInMegabytes": { + "format": "int32", + "type": "integer", + "description": "The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024." + }, + "maxMessageSizeInKilobytes": { + "format": "int64", + "type": "integer", + "description": "Maximum size (in KB) of the message payload that can be accepted by the queue. This property is only used in Premium today and default is 1024." + }, + "requiresDuplicateDetection": { + "type": "boolean", + "description": "A value indicating if this queue requires duplicate detection." + }, + "requiresSession": { + "type": "boolean", + "description": "A value that indicates whether the queue supports the concept of sessions." + }, + "defaultMessageTimeToLive": { + "format": "duration", + "type": "string", + "description": "ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself." + }, + "deadLetteringOnMessageExpiration": { + "type": "boolean", + "description": "A value that indicates whether this queue has dead letter support when a message expires." + }, + "duplicateDetectionHistoryTimeWindow": { + "format": "duration", + "type": "string", + "description": "ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes." + }, + "maxDeliveryCount": { + "format": "int32", + "type": "integer", + "description": "The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10." + }, + "status": { + "$ref": "../../../common/v1/definitions.json#/definitions/EntityStatus", + "description": "Enumerates the possible values for the status of a messaging entity." + }, + "enableBatchedOperations": { + "type": "boolean", + "description": "Value that indicates whether server-side batched operations are enabled." + }, + "autoDeleteOnIdle": { + "format": "duration", + "type": "string", + "description": "ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes." + }, + "enablePartitioning": { + "type": "boolean", + "description": "A value that indicates whether the queue is to be partitioned across multiple message brokers." + }, + "enableExpress": { + "type": "boolean", + "description": "A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage." + }, + "forwardTo": { + "type": "string", + "description": "Queue/Topic name to forward the messages" + }, + "forwardDeadLetteredMessagesTo": { + "type": "string", + "description": "Queue/Topic name to forward the Dead Letter message" + } + }, + "description": "The Queue Properties definition." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/Rules.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/Rules.json new file mode 100644 index 000000000000..216631491cee --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/Rules.json @@ -0,0 +1,449 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2023-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}/rules": { + "get": { + "tags": [ + "Rules" + ], + "operationId": "Rules_ListBySubscriptions", + "x-ms-examples": { + "RulesListBySubscriptions": { + "$ref": "./examples/Rules/RuleListBySubscription.json" + } + }, + "description": "List all the rules within given topic-subscription", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SkipParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved list of Rules.", + "schema": { + "$ref": "#/definitions/RuleListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}/rules/{ruleName}": { + "put": { + "tags": [ + "Rules" + ], + "operationId": "Rules_CreateOrUpdate", + "x-ms-examples": { + "RulesCreateOrUpdate": { + "$ref": "./examples/Rules/RuleCreate.json" + }, + "RulesCreateSqlFilter": { + "$ref": "./examples/Rules/RuleCreate_SqlFilter.json" + }, + "RulesCreateCorrelationFilter": { + "$ref": "./examples/Rules/RuleCreate_CorrelationFilter.json" + } + }, + "description": "Creates a new rule and updates an existing rule", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/RuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Rule" + }, + "description": "Parameters supplied to create a rule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Rule created.", + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Rules" + ], + "operationId": "Rules_Delete", + "x-ms-examples": { + "RulesDelete": { + "$ref": "./examples/Rules/RuleDelete.json" + } + }, + "description": "Deletes an existing rule.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/RuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Rule deleted." + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Subscriptions" + ], + "operationId": "Rules_Get", + "x-ms-examples": { + "RulesGet": { + "$ref": "./examples/Rules/RuleGet.json" + } + }, + "description": "Retrieves the description for the specified rule.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/RuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved rule description.", + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "Rule": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/Ruleproperties", + "description": "Properties of Rule resource" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../common/v2/definitions.json#/definitions/ProxyResource" + } + ], + "description": "Description of Rule Resource." + }, + "Ruleproperties": { + "type": "object", + "properties": { + "action": { + "$ref": "#/definitions/Action", + "description": "Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression." + }, + "filterType": { + "$ref": "#/definitions/FilterType", + "description": "Filter type that is evaluated against a BrokeredMessage." + }, + "sqlFilter": { + "$ref": "#/definitions/SqlFilter", + "description": "Properties of sqlFilter" + }, + "correlationFilter": { + "$ref": "#/definitions/CorrelationFilter", + "description": "Properties of correlationFilter" + } + }, + "description": "Description of Rule Resource." + }, + "RuleListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Rule" + }, + "description": "Result of the List Rules operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of rules" + } + }, + "description": "The response of the List rule operation." + }, + "FilterType": { + "type": "string", + "enum": [ + "SqlFilter", + "CorrelationFilter" + ], + "x-ms-enum": { + "name": "FilterType", + "modelAsString": false + }, + "description": "Rule filter types" + }, + "SqlFilter": { + "type": "object", + "properties": { + "sqlExpression": { + "type": "string", + "description": "The SQL expression. e.g. MyProperty='ABC'" + }, + "compatibilityLevel": { + "format": "int32", + "type": "integer", + "description": "This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20." + }, + "requiresPreprocessing": { + "type": "boolean", + "default": true, + "description": "Value that indicates whether the rule action requires preprocessing." + } + }, + "description": "Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline." + }, + "CorrelationFilter": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "dictionary object for custom filters" + }, + "correlationId": { + "type": "string", + "description": "Identifier of the correlation." + }, + "messageId": { + "type": "string", + "description": "Identifier of the message." + }, + "to": { + "type": "string", + "description": "Address to send to." + }, + "replyTo": { + "type": "string", + "description": "Address of the queue to reply to." + }, + "label": { + "type": "string", + "description": "Application specific label." + }, + "sessionId": { + "type": "string", + "description": "Session identifier." + }, + "replyToSessionId": { + "type": "string", + "description": "Session identifier to reply to." + }, + "contentType": { + "type": "string", + "description": "Content type of the message." + }, + "requiresPreprocessing": { + "type": "boolean", + "default": true, + "description": "Value that indicates whether the rule action requires preprocessing." + } + }, + "description": "Represents the correlation filter expression." + }, + "Action": { + "type": "object", + "properties": { + "sqlExpression": { + "type": "string", + "description": "SQL expression. e.g. MyProperty='ABC'" + }, + "compatibilityLevel": { + "format": "int32", + "type": "integer", + "description": "This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20." + }, + "requiresPreprocessing": { + "type": "boolean", + "default": true, + "description": "Value that indicates whether the rule action requires preprocessing." + } + }, + "description": "Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression." + }, + "SqlRuleAction": { + "type": "object", + "properties": { + "sqlExpression": { + "type": "string", + "description": "SQL expression. e.g. MyProperty='ABC'" + }, + "compatibilityLevel": { + "format": "int32", + "type": "integer", + "description": "This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20." + }, + "requiresPreprocessing": { + "type": "boolean", + "default": true, + "description": "Value that indicates whether the rule action requires preprocessing." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Action" + } + ], + "description": "Represents set of actions written in SQL language-based syntax that is performed against a ServiceBus.Messaging.BrokeredMessage " + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationCompleteMigration.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationCompleteMigration.json new file mode 100644 index 000000000000..469d02b7f204 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationCompleteMigration.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-41", + "resourceGroupName": "ResourceGroup", + "api-version": "2023-01-01-preview", + "configName": "$default", + "subscriptionId": "SubscriptionId" + }, + "responses": { + "200": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationCreateAndStartMigration.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationCreateAndStartMigration.json new file mode 100644 index 000000000000..4484b01f35c8 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationCreateAndStartMigration.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-41", + "resourceGroupName": "ResourceGroup", + "api-version": "2023-01-01-preview", + "subscriptionId": "SubscriptionId", + "configName": "$default", + "parameters": { + "properties": { + "targetNamespace": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-4028", + "postMigrationName": "sdk-PostMigration-5919" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-41/migrationConfigs/$default", + "name": "sdk-Namespace-41", + "type": "Microsoft.ServiceBus/Namespaces/disasterrecoveryconfigs", + "properties": { + "provisioningState": "Accepted", + "targetNamespace": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-4028", + "postMigrationName": "sdk-PostMigration-5919", + "migrationState": "Initiating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-41/migrationConfigs/$default", + "name": "sdk-Namespace-41", + "type": "Microsoft.ServiceBus/Namespaces/disasterrecoveryconfigs", + "properties": { + "provisioningState": "Accepted", + "targetNamespace": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-4028", + "postMigrationName": "sdk-PostMigration-5919", + "migrationState": "Initiating" + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationDelete.json new file mode 100644 index 000000000000..40de85f34520 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-41", + "resourceGroupName": "ResourceGroup", + "api-version": "2023-01-01-preview", + "configName": "$default", + "subscriptionId": "SubscriptionId" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationGet.json new file mode 100644 index 000000000000..15a2f68d8218 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-41", + "resourceGroupName": "ResourceGroup", + "api-version": "2023-01-01-preview", + "configName": "$default", + "subscriptionId": "SubscriptionId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-41/migrationConfigs/$default", + "name": "sdk-Namespace-41", + "type": "Microsoft.ServiceBus/Namespaces/disasterrecoveryconfigs", + "properties": { + "provisioningState": "Succeeded", + "targetNamespace": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-4028", + "postMigrationName": "sdk-PostMigration-5919", + "pendingReplicationOperationsCount": 0, + "migrationState": "Active" + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationList.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationList.json new file mode 100644 index 000000000000..f6ac93f377bd --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-9259", + "resourceGroupName": "ResourceGroup", + "api-version": "2023-01-01-preview", + "configName": "$default", + "subscriptionId": "SubscriptionId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9259/migrationConfigs/sdk-Namespace-9259", + "name": "sdk-Namespace-9259", + "type": "Microsoft.ServiceBus/Namespaces/migrationconfigurations", + "properties": { + "provisioningState": "Succeeded", + "targetNamespace": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-7454", + "postMigrationName": "sdk-PostMigration-9423", + "migrationState": "Active" + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationRevert.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationRevert.json new file mode 100644 index 000000000000..469d02b7f204 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationRevert.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-41", + "resourceGroupName": "ResourceGroup", + "api-version": "2023-01-01-preview", + "configName": "$default", + "subscriptionId": "SubscriptionId" + }, + "responses": { + "200": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionCreate.json new file mode 100644 index 000000000000..ba58b32b58d6 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionCreate.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-2924", + "resourceGroupName": "ArunMonocle", + "api-version": "2023-01-01-preview", + "subscriptionId": "subID", + "privateEndpointConnectionName": "privateEndpointConnectionName", + "parameters": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-8396/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-2847" + }, + "privateLinkServiceConnectionState": { + "status": "Rejected", + "description": "testing" + }, + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "202": { + "body": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionDelete.json new file mode 100644 index 000000000000..4a5375b9d768 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionDelete.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-3285", + "resourceGroupName": "ArunMonocle", + "privateEndpointConnectionName": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "api-version": "2023-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionGet.json new file mode 100644 index 000000000000..a913508142af --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5828", + "resourceGroupName": "SDK-ServiceBus-4794", + "privateEndpointConnectionName": "privateEndpointConnectionName", + "api-version": "2023-01-01-preview", + "subscriptionId": "subID" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateEndpointConnections/privateEndpointConnectionName", + "name": "privateEndpointConnectionName", + "type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionList.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionList.json new file mode 100644 index 000000000000..6b6cbe04150a --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5828", + "resourceGroupName": "SDK-ServiceBus-4794", + "api-version": "2023-01-01-preview", + "subscriptionId": "subID" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-7182/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5705-new/privateEndpointConnections/5dc668b3-70e4-437f-b61c-a3c1e594be7a", + "name": "5dc668b3-70e4-437f-b61c-a3c1e594be7a", + "type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-7182/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5705-new" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateLinkResourcesGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateLinkResourcesGet.json new file mode 100644 index 000000000000..f27f99fd043c --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/PrivateLinkResourcesGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-2924", + "resourceGroupName": "ArunMonocle", + "api-version": "2023-01-01-preview", + "subscriptionId": "subID" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/subID/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateLinkResources/namespace", + "name": "namespace", + "type": "Microsoft.ServiceBus/namespaces/privateLinkResources", + "properties": { + "groupId": "namespace", + "requiredMembers": [ + "namespace" + ], + "requiredZoneNames": [ + "privatelink.servicebus.windows.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleCreate.json new file mode 100644 index 000000000000..989370fb6cba --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleCreate.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6914", + "authorizationRuleName": "sdk-AuthRules-1788", + "resourceGroupName": "ArunMonocle", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-6914/AuthorizationRules/sdk-AuthRules-1788", + "name": "sdk-AuthRules-1788", + "type": "Microsoft.ServiceBus/Namespaces/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleDelete.json new file mode 100644 index 000000000000..ac0946d68008 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "namespaceName": "sdk-namespace-6914", + "authorizationRuleName": "sdk-AuthRules-1788", + "resourceGroupName": "ArunMonocle", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleGet.json new file mode 100644 index 000000000000..20cfb6eaf730 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6914", + "authorizationRuleName": "sdk-AuthRules-1788", + "resourceGroupName": "ArunMonocle", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-6914/AuthorizationRules/sdk-AuthRules-1788/", + "name": "sdk-AuthRules-1788", + "type": "Microsoft.ServiceBus/Namespaces/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleListAll.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleListAll.json new file mode 100644 index 000000000000..8baa5afc2b0d --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleListAll.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6914", + "resourceGroupName": "ArunMonocle", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "https://sbgm.windows-int.net/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-6914/AuthorizationRules?api-version=2017-04-01/RootManageSharedAccessKey", + "name": "RootManageSharedAccessKey", + "type": "Microsoft.ServiceBus/Namespaces/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Manage", + "Send" + ] + } + }, + { + "id": "https://sbgm.windows-int.net/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-6914/AuthorizationRules?api-version=2017-04-01/sdk-AuthRules-1788", + "name": "sdk-AuthRules-1788", + "type": "Microsoft.ServiceBus/Namespaces/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleListKey.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleListKey.json new file mode 100644 index 000000000000..f2ed9f91c56b --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleListKey.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "namespaceName": "sdk-namespace-6914", + "authorizationRuleName": "sdk-AuthRules-1788", + "resourceGroupName": "ArunMonocle", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "primaryConnectionString": "Endpoint=sb://sdk-namespace-6914.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-1788;SharedAccessKey=############################################", + "secondaryConnectionString": "Endpoint=sb://sdk-namespace-6914.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-1788;SharedAccessKey=############################################", + "primaryKey": "############################################", + "secondaryKey": "############################################", + "keyName": "sdk-AuthRules-1788" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleRegenerateKey.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleRegenerateKey.json new file mode 100644 index 000000000000..b4c395ee924a --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleRegenerateKey.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "namespaceName": "sdk-namespace-6914", + "authorizationRuleName": "sdk-AuthRules-1788", + "resourceGroupName": "ArunMonocle", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "keyType": "PrimaryKey" + } + }, + "responses": { + "200": { + "body": { + "primaryConnectionString": "Endpoint=sb://sdk-namespace-6914.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-1788;SharedAccessKey=#############################################", + "secondaryConnectionString": "Endpoint=sb://sdk-namespace-6914.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-1788;SharedAccessKey=#############################################", + "primaryKey": "#############################################", + "secondaryKey": "#############################################", + "keyName": "sdk-AuthRules-1788" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceCheckNameAvailability.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceCheckNameAvailability.json new file mode 100644 index 000000000000..d311c19689ed --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceCheckNameAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "name": "sdk-Namespace-2924" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "reason": "None", + "message": "" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceCreate.json new file mode 100644 index 000000000000..cce6842bb7e8 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceCreate.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace2924", + "resourceGroupName": "ArunMonocle", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "sku": { + "name": "Premium", + "tier": "Premium", + "capacity": 4 + }, + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "geoDataReplication": { + "maxReplicationLagDurationInSeconds": 300, + "locations": [ + { + "locationName": "eastus", + "roleType": "Primary" + }, + { + "locationName": "southcentralus", + "roleType": "Secondary" + } + ] + }, + "premiumMessagingPartitions": 2 + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Premium", + "tier": "Premium", + "capacity": 4 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924", + "name": "sdk-Namespace-2924", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "geoDataReplication": { + "maxReplicationLagDurationInSeconds": 300, + "locations": [ + { + "locationName": "eastus", + "roleType": "Primary" + }, + { + "locationName": "southcentralus", + "roleType": "Secondary" + } + ] + }, + "provisioningState": "Created", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-2924", + "createdAt": "2017-05-25T22:26:36.76Z", + "updatedAt": "2017-05-25T22:26:36.76Z", + "serviceBusEndpoint": "https://sdk-Namespace-2924.servicebus.windows-int.net:443/", + "minimumTlsVersion": "1.2", + "premiumMessagingPartitions": 2 + } + } + }, + "201": { + "body": { + "sku": { + "name": "Premium", + "tier": "Premium", + "capacity": 4 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924", + "name": "sdk-Namespace-2924", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Created", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-2924", + "createdAt": "2017-05-25T22:26:36.76Z", + "updatedAt": "2017-05-25T22:26:36.76Z", + "serviceBusEndpoint": "https://sdk-Namespace-2924.servicebus.windows-int.net:443/", + "disableLocalAuth": false, + "minimumTlsVersion": "1.2", + "premiumMessagingPartitions": 2 + } + } + }, + "202": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceDelete.json new file mode 100644 index 000000000000..ae716ae34586 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceDelete.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-3285", + "resourceGroupName": "ArunMonocle", + "api-version": "2023-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceGet.json new file mode 100644 index 000000000000..5b0bd9f0b97f --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceGet.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-2924", + "resourceGroupName": "ArunMonocle", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924", + "name": "sdk-Namespace-2924", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-2924", + "createdAt": "2017-05-25T22:26:36.76Z", + "updatedAt": "2017-05-25T22:26:59.35Z", + "serviceBusEndpoint": "https://sdk-Namespace-2924.servicebus.windows-int.net:443/", + "minimumTlsVersion": "1.2", + "disableLocalAuth": false, + "privateEndpointConnections": [ + { + "id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample/privateEndpointConnections/privateEndpointConnectionName", + "name": "privateEndpointConnectionName", + "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.Network/privateEndpoints/NamespaceSample" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceList.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceList.json new file mode 100644 index 000000000000..c0c2e1162e70 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceList.json @@ -0,0 +1,879 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-91f08e47-2b04-4943-b0cd-a5fb02b88f20", + "name": "NS-91f08e47-2b04-4943-b0cd-a5fb02b88f20", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-91f08e47-2b04-4943-b0cd-a5fb02b88f20", + "createdAt": "2016-08-23T02:40:17.27Z", + "updatedAt": "2017-02-11T07:15:30.78Z", + "serviceBusEndpoint": "https://NS-91f08e47-2b04-4943-b0cd-a5fb02b88f20.servicebus.windows-int.net:443/", + "minimumTlsVersion": "1.2", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-41dc63f4-0b08-4029-b3ef-535a131bfa65", + "name": "NS-41dc63f4-0b08-4029-b3ef-535a131bfa65", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-41dc63f4-0b08-4029-b3ef-535a131bfa65", + "createdAt": "2016-08-23T03:50:38.98Z", + "updatedAt": "2017-02-11T10:42:58.003Z", + "serviceBusEndpoint": "https://NS-41dc63f4-0b08-4029-b3ef-535a131bfa65.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-df52cf51-e831-4bf2-bd92-e9885f68a996", + "name": "NS-df52cf51-e831-4bf2-bd92-e9885f68a996", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-df52cf51-e831-4bf2-bd92-e9885f68a996", + "createdAt": "2016-09-16T01:17:54.997Z", + "updatedAt": "2017-02-11T06:44:39.737Z", + "serviceBusEndpoint": "https://NS-df52cf51-e831-4bf2-bd92-e9885f68a996.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Premium", + "tier": "Premium", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/RapscallionResources/providers/Microsoft.ServiceBus/namespaces/SBPremium", + "name": "SBPremium", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Created", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sbpremium", + "createdAt": "2016-10-10T22:01:00.42Z", + "updatedAt": "2016-10-10T22:01:00.42Z", + "serviceBusEndpoint": "https://SBPremium.servicebus.windows-int.net:443/", + "disableLocalAuth": false, + "premiumMessagingPartitions": 1 + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/sadfsadfsadf/providers/Microsoft.ServiceBus/namespaces/rrama-ns2", + "name": "rrama-ns2", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:rrama-ns2", + "createdAt": "2016-08-23T04:14:00.013Z", + "updatedAt": "2017-02-03T22:53:32.927Z", + "serviceBusEndpoint": "https://rrama-ns2.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-20e57600-29d0-4035-ac85-74f4c54dcda1", + "name": "NS-20e57600-29d0-4035-ac85-74f4c54dcda1", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-20e57600-29d0-4035-ac85-74f4c54dcda1", + "createdAt": "2016-08-23T03:30:49.16Z", + "updatedAt": "2017-02-11T04:17:58.483Z", + "serviceBusEndpoint": "https://NS-20e57600-29d0-4035-ac85-74f4c54dcda1.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-3e538a1a-58fb-4315-b2ce-76f5c944114c", + "name": "NS-3e538a1a-58fb-4315-b2ce-76f5c944114c", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-3e538a1a-58fb-4315-b2ce-76f5c944114c", + "createdAt": "2016-09-16T18:07:30.05Z", + "updatedAt": "2017-02-11T10:42:57.747Z", + "serviceBusEndpoint": "https://NS-3e538a1a-58fb-4315-b2ce-76f5c944114c.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Premium", + "tier": "Premium", + "capacity": 4 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/prem-ns123", + "name": "prem-ns123", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Created", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:prem-ns123", + "createdAt": "2016-09-13T00:02:39.997Z", + "updatedAt": "2016-09-13T00:02:39.997Z", + "serviceBusEndpoint": "https://prem-ns123.servicebus.windows-int.net:443/", + "disableLocalAuth": false, + "premiumMessagingPartitions": 2 + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-4e1bfdf1-0cff-4e86-ae80-cdcac4873039", + "name": "NS-4e1bfdf1-0cff-4e86-ae80-cdcac4873039", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-4e1bfdf1-0cff-4e86-ae80-cdcac4873039", + "createdAt": "2016-09-16T01:01:58.73Z", + "updatedAt": "2017-02-11T03:02:59.8Z", + "serviceBusEndpoint": "https://NS-4e1bfdf1-0cff-4e86-ae80-cdcac4873039.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-6b90b7f3-7aa0-48c9-bc30-b299dcb66c03", + "name": "NS-6b90b7f3-7aa0-48c9-bc30-b299dcb66c03", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-6b90b7f3-7aa0-48c9-bc30-b299dcb66c03", + "createdAt": "2016-08-23T03:22:45.327Z", + "updatedAt": "2017-02-11T06:08:01.207Z", + "serviceBusEndpoint": "https://NS-6b90b7f3-7aa0-48c9-bc30-b299dcb66c03.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-c05e9df3-7737-44ee-a321-15f6e0545b97", + "name": "NS-c05e9df3-7737-44ee-a321-15f6e0545b97", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-c05e9df3-7737-44ee-a321-15f6e0545b97", + "createdAt": "2016-08-05T03:29:19.75Z", + "updatedAt": "2017-02-11T08:10:35.527Z", + "serviceBusEndpoint": "https://NS-c05e9df3-7737-44ee-a321-15f6e0545b97.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-dcb4152c-231b-4c16-a683-07cc6b38fa46", + "name": "NS-dcb4152c-231b-4c16-a683-07cc6b38fa46", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-dcb4152c-231b-4c16-a683-07cc6b38fa46", + "createdAt": "2016-08-05T03:34:35.363Z", + "updatedAt": "2017-02-11T05:33:00.957Z", + "serviceBusEndpoint": "https://NS-dcb4152c-231b-4c16-a683-07cc6b38fa46.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-f501f5e6-1f24-439b-8982-9af665156d40", + "name": "NS-f501f5e6-1f24-439b-8982-9af665156d40", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-f501f5e6-1f24-439b-8982-9af665156d40", + "createdAt": "2016-09-16T01:25:55.707Z", + "updatedAt": "2017-02-11T07:42:59.687Z", + "serviceBusEndpoint": "https://NS-f501f5e6-1f24-439b-8982-9af665156d40.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-fe2ed660-2cd6-46f2-a9c3-7e11551a1f30", + "name": "NS-fe2ed660-2cd6-46f2-a9c3-7e11551a1f30", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-fe2ed660-2cd6-46f2-a9c3-7e11551a1f30", + "createdAt": "2016-08-23T02:32:08.227Z", + "updatedAt": "2017-02-11T06:32:57.77Z", + "serviceBusEndpoint": "https://NS-fe2ed660-2cd6-46f2-a9c3-7e11551a1f30.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-8a5e3b4e-4e97-4d85-9083-cd33536c9d71", + "name": "NS-8a5e3b4e-4e97-4d85-9083-cd33536c9d71", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-8a5e3b4e-4e97-4d85-9083-cd33536c9d71", + "createdAt": "2016-09-16T00:54:05.103Z", + "updatedAt": "2017-02-11T10:43:50.313Z", + "serviceBusEndpoint": "https://NS-8a5e3b4e-4e97-4d85-9083-cd33536c9d71.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-6520cc09-01ac-40a3-bc09-c5c431116e92", + "name": "NS-6520cc09-01ac-40a3-bc09-c5c431116e92", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-6520cc09-01ac-40a3-bc09-c5c431116e92", + "createdAt": "2016-09-16T01:49:59.243Z", + "updatedAt": "2017-02-11T08:15:36.95Z", + "serviceBusEndpoint": "https://NS-6520cc09-01ac-40a3-bc09-c5c431116e92.servicebus.windows-int.net:443", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-bfba6d5c-a425-42d9-85db-0f4da770e29a", + "name": "NS-bfba6d5c-a425-42d9-85db-0f4da770e29a", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-bfba6d5c-a425-42d9-85db-0f4da770e29a", + "createdAt": "2016-08-05T03:23:32.083Z", + "updatedAt": "2017-02-11T09:02:57.433Z", + "serviceBusEndpoint": "https://NS-bfba6d5c-a425-42d9-85db-0f4da770e29a.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Premium", + "tier": "Premium", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/RapscallionResources/providers/Microsoft.ServiceBus/namespaces/SBPrem", + "name": "SBPrem", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Created", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sbprem", + "createdAt": "2016-10-10T22:16:30.87Z", + "updatedAt": "2016-10-10T22:16:30.87Z", + "serviceBusEndpoint": "https://SBPrem.servicebus.windows-int.net:443/", + "disableLocalAuth": false, + "premiumMessagingPartitions": 2 + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-43b136b4-8716-40b2-97c5-0d77cac0062c", + "name": "NS-43b136b4-8716-40b2-97c5-0d77cac0062c", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-43b136b4-8716-40b2-97c5-0d77cac0062c", + "createdAt": "2016-08-23T03:14:50.577Z", + "updatedAt": "2017-02-11T09:23:01.067Z", + "serviceBusEndpoint": "https://NS-43b136b4-8716-40b2-97c5-0d77cac0062c.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-7c0443de-5f88-450c-b574-83f60a097dd1", + "name": "NS-7c0443de-5f88-450c-b574-83f60a097dd1", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-7c0443de-5f88-450c-b574-83f60a097dd1", + "createdAt": "2016-08-23T04:07:15.397Z", + "updatedAt": "2017-02-11T04:03:03.097Z", + "serviceBusEndpoint": "https://NS-7c0443de-5f88-450c-b574-83f60a097dd1.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-62dd7753-a5f9-42fd-a354-ca38a4505d69", + "name": "NS-62dd7753-a5f9-42fd-a354-ca38a4505d69", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-62dd7753-a5f9-42fd-a354-ca38a4505d69", + "createdAt": "2016-09-16T01:33:50.45Z", + "updatedAt": "2017-02-11T05:35:33.053Z", + "serviceBusEndpoint": "https://NS-62dd7753-a5f9-42fd-a354-ca38a4505d69.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-ae18a18c-97ab-4089-965d-8acbf4794091", + "name": "NS-ae18a18c-97ab-4089-965d-8acbf4794091", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-ae18a18c-97ab-4089-965d-8acbf4794091", + "createdAt": "2016-08-23T02:43:36.517Z", + "updatedAt": "2017-02-11T12:40:30.587Z", + "serviceBusEndpoint": "https://NS-ae18a18c-97ab-4089-965d-8acbf4794091.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-8e3b56c1-0ee8-4e13-ae88-5cadf6e2ce11", + "name": "NS-8e3b56c1-0ee8-4e13-ae88-5cadf6e2ce11", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-8e3b56c1-0ee8-4e13-ae88-5cadf6e2ce11", + "createdAt": "2016-09-16T00:46:03.773Z", + "updatedAt": "2017-02-11T04:43:54.56Z", + "serviceBusEndpoint": "https://NS-8e3b56c1-0ee8-4e13-ae88-5cadf6e2ce11.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-7ffca4b4-4728-4fb0-b2d0-1e7c016e3a44", + "name": "NS-7ffca4b4-4728-4fb0-b2d0-1e7c016e3a44", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-7ffca4b4-4728-4fb0-b2d0-1e7c016e3a44", + "createdAt": "2016-08-23T03:59:12.1Z", + "updatedAt": "2017-02-11T06:33:52.23Z", + "serviceBusEndpoint": "https://NS-7ffca4b4-4728-4fb0-b2d0-1e7c016e3a44.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-d9337efd-9b27-454c-b2a5-dcfea56920d9", + "name": "NS-d9337efd-9b27-454c-b2a5-dcfea56920d9", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-d9337efd-9b27-454c-b2a5-dcfea56920d9", + "createdAt": "2016-08-05T03:45:09.27Z", + "updatedAt": "2017-02-11T06:20:31.863Z", + "serviceBusEndpoint": "https://NS-d9337efd-9b27-454c-b2a5-dcfea56920d9.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-ad5ae732-abea-4e62-9de0-c90de0ddec0a", + "name": "NS-ad5ae732-abea-4e62-9de0-c90de0ddec0a", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-ad5ae732-abea-4e62-9de0-c90de0ddec0a", + "createdAt": "2016-08-23T02:34:36.447Z", + "updatedAt": "2017-02-11T06:15:31.607Z", + "serviceBusEndpoint": "https://NS-ad5ae732-abea-4e62-9de0-c90de0ddec0a.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-d447fb03-c7da-40fe-b5eb-14f36888837b", + "name": "NS-d447fb03-c7da-40fe-b5eb-14f36888837b", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-d447fb03-c7da-40fe-b5eb-14f36888837b", + "createdAt": "2016-08-05T00:53:46.697Z", + "updatedAt": "2017-02-11T11:09:41.26Z", + "serviceBusEndpoint": "https://NS-d447fb03-c7da-40fe-b5eb-14f36888837b.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/RapscallionResources/providers/Microsoft.ServiceBus/namespaces/ReproSB", + "name": "ReproSB", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:reprosb", + "createdAt": "2017-02-27T19:29:34.523Z", + "updatedAt": "2017-02-27T19:29:58.64Z", + "serviceBusEndpoint": "https://ReproSB.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-4c90097f-19a8-42e7-bb3c-4ac088994719", + "name": "NS-4c90097f-19a8-42e7-bb3c-4ac088994719", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-4c90097f-19a8-42e7-bb3c-4ac088994719", + "createdAt": "2016-09-16T17:35:32.61Z", + "updatedAt": "2017-02-11T09:13:52.27Z", + "serviceBusEndpoint": "https://NS-4c90097f-19a8-42e7-bb3c-4ac088994719.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/rrama-1-23-17", + "name": "rrama-1-23-17", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:rrama-1-23-17", + "createdAt": "2017-01-23T22:54:40.907Z", + "updatedAt": "2017-02-04T00:53:28.777Z", + "serviceBusEndpoint": "https://rrama-1-23-17.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-5191e541-8e4e-4229-9fdc-b89f6c3e7f12", + "name": "NS-5191e541-8e4e-4229-9fdc-b89f6c3e7f12", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-5191e541-8e4e-4229-9fdc-b89f6c3e7f12", + "createdAt": "2016-09-16T17:43:25.71Z", + "updatedAt": "2017-02-11T11:05:31.89Z", + "serviceBusEndpoint": "https://NS-5191e541-8e4e-4229-9fdc-b89f6c3e7f12.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-be903820-3533-46e8-90e4-72c132411848", + "name": "NS-be903820-3533-46e8-90e4-72c132411848", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-be903820-3533-46e8-90e4-72c132411848", + "createdAt": "2016-08-05T03:24:01.923Z", + "updatedAt": "2017-02-11T10:09:42.513Z", + "serviceBusEndpoint": "https://NS-be903820-3533-46e8-90e4-72c132411848.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/rrama-namespace1", + "name": "rrama-namespace1", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Created", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:rrama-namespace1", + "createdAt": "2016-08-05T00:47:22.963Z", + "updatedAt": "2016-08-05T00:47:27.297Z", + "serviceBusEndpoint": "https://rrama-namespace1.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-a3c38e9b-32a3-4c51-85d7-263150a8dda9", + "name": "NS-a3c38e9b-32a3-4c51-85d7-263150a8dda9", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-a3c38e9b-32a3-4c51-85d7-263150a8dda9", + "createdAt": "2016-09-16T00:38:02.517Z", + "updatedAt": "2017-02-11T05:03:55.96Z", + "serviceBusEndpoint": "https://NS-a3c38e9b-32a3-4c51-85d7-263150a8dda9.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-70d3fa25-6bbe-4a6b-a381-a52cf0d539e6", + "name": "NS-70d3fa25-6bbe-4a6b-a381-a52cf0d539e6", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-70d3fa25-6bbe-4a6b-a381-a52cf0d539e6", + "createdAt": "2016-08-23T03:42:40.01Z", + "updatedAt": "2017-02-11T06:33:02.363Z", + "serviceBusEndpoint": "https://NS-70d3fa25-6bbe-4a6b-a381-a52cf0d539e6.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-e6536f77-0d1b-4a6b-8f42-29cc15b2930a", + "name": "NS-e6536f77-0d1b-4a6b-8f42-29cc15b2930a", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-e6536f77-0d1b-4a6b-8f42-29cc15b2930a", + "createdAt": "2016-08-05T04:28:10.71Z", + "updatedAt": "2017-02-11T08:43:51.587Z", + "serviceBusEndpoint": "https://NS-e6536f77-0d1b-4a6b-8f42-29cc15b2930a.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924", + "name": "sdk-Namespace-2924", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-2924", + "createdAt": "2017-05-25T22:26:36.76Z", + "updatedAt": "2017-05-25T22:26:59.35Z", + "serviceBusEndpoint": "https://sdk-Namespace-2924.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/rrama-sb1", + "name": "rrama-sb1", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:rrama-sb1", + "createdAt": "2017-05-01T21:47:34.903Z", + "updatedAt": "2017-05-02T02:10:03.083Z", + "serviceBusEndpoint": "https://rrama-sb1.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/RapscallionResources/providers/Microsoft.ServiceBus/namespaces/WhackWhack", + "name": "WhackWhack", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:whackwhack", + "createdAt": "2016-10-10T23:39:01.347Z", + "updatedAt": "2017-02-04T00:56:32.687Z", + "serviceBusEndpoint": "https://WhackWhack.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-66ed32d6-611e-4bb0-8e1a-a6d0fc65427c", + "name": "NS-66ed32d6-611e-4bb0-8e1a-a6d0fc65427c", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-66ed32d6-611e-4bb0-8e1a-a6d0fc65427c", + "createdAt": "2016-09-16T17:51:27.73Z", + "updatedAt": "2017-02-11T08:19:43.383Z", + "serviceBusEndpoint": "https://NS-66ed32d6-611e-4bb0-8e1a-a6d0fc65427c.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-e0cab401-6df8-465d-8d4a-da9a9e55cf0e", + "name": "NS-e0cab401-6df8-465d-8d4a-da9a9e55cf0e", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-e0cab401-6df8-465d-8d4a-da9a9e55cf0e", + "createdAt": "2016-08-05T01:14:25.613Z", + "updatedAt": "2017-02-11T12:33:01.727Z", + "serviceBusEndpoint": "https://NS-e0cab401-6df8-465d-8d4a-da9a9e55cf0e.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/bn3-rrama-foo1", + "name": "bn3-rrama-foo1", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "East US 2", + "tags": {}, + "properties": { + "provisioningState": "Created", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:bn3-rrama-foo1", + "createdAt": "2017-04-28T23:54:26.927Z", + "updatedAt": "2017-04-28T23:54:26.927Z", + "serviceBusEndpoint": "https://bn3-rrama-foo1.servicebus.int7.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/bn3-rrama-foo3", + "name": "bn3-rrama-foo3", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "East US 2", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:bn3-rrama-foo3", + "createdAt": "2017-04-29T00:24:09.907Z", + "updatedAt": "2017-04-29T00:24:33.233Z", + "serviceBusEndpoint": "https://bn3-rrama-foo3.servicebus.int7.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/bn3-rrama-foo2", + "name": "bn3-rrama-foo2", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "East US 2", + "tags": {}, + "properties": { + "provisioningState": "Created", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:bn3-rrama-foo2", + "createdAt": "2017-04-28T23:57:40.82Z", + "updatedAt": "2017-04-28T23:57:40.82Z", + "serviceBusEndpoint": "https://bn3-rrama-foo2.servicebus.int7.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/db3-rrama-foo2", + "name": "db3-rrama-foo2", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "North Europe", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:db3-rrama-foo2", + "createdAt": "2017-04-29T00:10:43.463Z", + "updatedAt": "2017-04-29T00:11:09.133Z", + "serviceBusEndpoint": "https://db3-rrama-foo2.servicebus.int7.windows-int.net:443/", + "disableLocalAuth": false + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceListByResourceGroup.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceListByResourceGroup.json new file mode 100644 index 000000000000..b8ba14389194 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceListByResourceGroup.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "resourceGroupName": "ArunMonocle" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924", + "name": "sdk-Namespace-2924", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-2924", + "createdAt": "2017-05-25T22:26:36.76Z", + "updatedAt": "2017-05-25T22:26:59.35Z", + "serviceBusEndpoint": "https://sdk-Namespace-2924.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceUpdate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceUpdate.json new file mode 100644 index 000000000000..7e0ff4aa35ed --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNameSpaceUpdate.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-3285", + "resourceGroupName": "ArunMonocle", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "location": "South Central US", + "tags": { + "tag3": "value3", + "tag4": "value4" + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-3285", + "name": "sdk-Namespace-3285", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": { + "tag3": "value3", + "tag4": "value4" + }, + "properties": { + "provisioningState": "Updating", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-3285", + "createdAt": "2017-05-25T23:07:58.17Z", + "updatedAt": "2017-05-25T23:08:45.497Z", + "serviceBusEndpoint": "https://sdk-Namespace-3285.servicebus.windows-int.net:443/", + "minimumTlsVersion": "1.1", + "disableLocalAuth": false + } + } + }, + "201": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-3285", + "name": "sdk-Namespace-3285", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": { + "tag3": "value3", + "tag4": "value4" + }, + "properties": { + "provisioningState": "Updating", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-3285", + "createdAt": "2017-05-25T23:07:58.17Z", + "updatedAt": "2017-05-25T23:08:45.497Z", + "serviceBusEndpoint": "https://sdk-Namespace-3285.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + } + }, + "202": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNamespaceFailover.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNamespaceFailover.json new file mode 100644 index 000000000000..73df6d08ae98 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/SBNamespaceFailover.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "namespaceName": "NamespaceGeoDRFailoverSample", + "resourceGroupName": "ResurceGroupSample", + "api-version": "2023-01-01-preview", + "subscriptionId": "SampleSubscription", + "parameters": { + "properties": { + "primaryLocation": "centralus", + "force": true + } + } + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status", + "location": "https://management.azure.com/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/EHNamespaceFailover/eastus?api-version=2023-01-01-preview" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetCreate.json new file mode 100644 index 000000000000..f3ec425ada00 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetCreate.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6019", + "resourceGroupName": "ResourceGroup", + "api-version": "2023-01-01-preview", + "subscriptionId": "Subscription", + "parameters": { + "properties": { + "defaultAction": "Deny", + "virtualNetworkRules": [ + { + "subnet": { + "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2" + }, + "ignoreMissingVnetServiceEndpoint": true + }, + { + "subnet": { + "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3" + }, + "ignoreMissingVnetServiceEndpoint": false + }, + { + "subnet": { + "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6" + }, + "ignoreMissingVnetServiceEndpoint": false + } + ], + "ipRules": [ + { + "ipMask": "1.1.1.1", + "action": "Allow" + }, + { + "ipMask": "1.1.1.2", + "action": "Allow" + }, + { + "ipMask": "1.1.1.3", + "action": "Allow" + }, + { + "ipMask": "1.1.1.4", + "action": "Allow" + }, + { + "ipMask": "1.1.1.5", + "action": "Allow" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-AustraliaEast/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9659/networkruleset/default", + "name": "default", + "type": "Microsoft.ServiceBus/Namespaces/NetworkRuleSet", + "properties": { + "defaultAction": "Deny", + "publicNetworkAccess": "Enabled", + "virtualNetworkRules": [ + { + "subnet": { + "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2" + }, + "ignoreMissingVnetServiceEndpoint": true + }, + { + "subnet": { + "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3" + }, + "ignoreMissingVnetServiceEndpoint": false + }, + { + "subnet": { + "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6" + }, + "ignoreMissingVnetServiceEndpoint": false + } + ], + "ipRules": [ + { + "ipMask": "1.1.1.1", + "action": "Allow" + }, + { + "ipMask": "1.1.1.2", + "action": "Allow" + }, + { + "ipMask": "1.1.1.3", + "action": "Allow" + }, + { + "ipMask": "1.1.1.4", + "action": "Allow" + }, + { + "ipMask": "1.1.1.5", + "action": "Allow" + } + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetGet.json new file mode 100644 index 000000000000..865cbfb086c5 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetGet.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6019", + "resourceGroupName": "ResourceGroup", + "api-version": "2023-01-01-preview", + "subscriptionId": "Subscription" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionid/resourceGroups/Default-ServiceBus-AustraliaEast/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9659/networkruleset/default", + "name": "default", + "type": "Microsoft.ServiceBus/Namespaces/NetworkRuleSet", + "properties": { + "defaultAction": "Allow", + "publicNetworkAccess": "Enabled", + "virtualNetworkRules": [ + { + "subnet": { + "id": "/subscriptions/subscriptionid/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2" + }, + "ignoreMissingVnetServiceEndpoint": true + }, + { + "subnet": { + "id": "/subscriptions/subscriptionid/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3" + }, + "ignoreMissingVnetServiceEndpoint": false + }, + { + "subnet": { + "id": "/subscriptions/subscriptionid/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6" + }, + "ignoreMissingVnetServiceEndpoint": false + } + ], + "ipRules": [ + { + "ipMask": "1.1.1.1", + "action": "Allow" + }, + { + "ipMask": "1.1.1.2", + "action": "Allow" + }, + { + "ipMask": "1.1.1.3", + "action": "Allow" + }, + { + "ipMask": "1.1.1.4", + "action": "Allow" + }, + { + "ipMask": "1.1.1.5", + "action": "Allow" + } + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetList.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetList.json new file mode 100644 index 000000000000..e936d0573b2f --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetList.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6019", + "resourceGroupName": "ResourceGroup", + "api-version": "2023-01-01-preview", + "subscriptionId": "Subscription" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subscriptionid/resourceGroups/resourcegroupid/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9659/networkrulesets/default", + "name": "default", + "type": "Microsoft.ServiceBus/Namespaces/NetworkRuleSet", + "properties": { + "defaultAction": "Deny", + "virtualNetworkRules": [ + { + "subnet": { + "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2" + }, + "ignoreMissingVnetServiceEndpoint": true + }, + { + "subnet": { + "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3" + }, + "ignoreMissingVnetServiceEndpoint": false + }, + { + "subnet": { + "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6" + }, + "ignoreMissingVnetServiceEndpoint": false + } + ], + "ipRules": [ + { + "ipMask": "1.1.1.1", + "action": "Allow" + }, + { + "ipMask": "1.1.1.2", + "action": "Allow" + }, + { + "ipMask": "1.1.1.3", + "action": "Allow" + }, + { + "ipMask": "1.1.1.4", + "action": "Allow" + }, + { + "ipMask": "1.1.1.5", + "action": "Allow" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleCreate.json new file mode 100644 index 000000000000..f952e6005546 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleCreate.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-Namespace-7982", + "queueName": "sdk-Queues-2317", + "authorizationRuleName": "sdk-AuthRules-5800", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-7982/queues/sdk-Queues-2317/authorizationRules/sdk-AuthRules-5800", + "name": "sdk-AuthRules-5800", + "type": "Microsoft.ServiceBus/Namespaces/Queues/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleDelete.json new file mode 100644 index 000000000000..8457ad6562b8 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-namespace-7982", + "queueName": "sdk-Queues-2317", + "authorizationRuleName": "sdk-AuthRules-5800", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleGet.json new file mode 100644 index 000000000000..7203a07ca31c --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-Namespace-7982", + "queueName": "sdk-Queues-2317", + "authorizationRuleName": "sdk-AuthRules-5800", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-7982/queues/sdk-Queues-2317/authorizationRules/sdk-AuthRules-5800", + "name": "sdk-AuthRules-5800", + "type": "Microsoft.ServiceBus/Namespaces/Queues/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleListAll.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleListAll.json new file mode 100644 index 000000000000..f8c847ecf9bb --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleListAll.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-Namespace-7982", + "queueName": "sdk-Queues-2317", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-7982/queues/sdk-Queues-2317/authorizationRules/sdk-AuthRules-5800", + "name": "sdk-AuthRules-5800", + "type": "Microsoft.ServiceBus/Namespaces/Queues/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleListKey.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleListKey.json new file mode 100644 index 000000000000..0b3dd7221e7c --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleListKey.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-namespace-7982", + "queueName": "sdk-Queues-2317", + "authorizationRuleName": "sdk-AuthRules-5800", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "primaryConnectionString": "Endpoint=sb://sdk-namespace-7982.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-5800;SharedAccessKey=############################################;EntityPath=sdk-Queues-2317", + "secondaryConnectionString": "Endpoint=sb://sdk-namespace-7982.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-5800;SharedAccessKey=############################################;EntityPath=sdk-Queues-2317", + "primaryKey": "############################################", + "secondaryKey": "############################################", + "keyName": "sdk-AuthRules-5800" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleRegenerateKey.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleRegenerateKey.json new file mode 100644 index 000000000000..9a2ebf9e0077 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueAuthorizationRuleRegenerateKey.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-namespace-7982", + "queueName": "sdk-Queues-2317", + "authorizationRuleName": "sdk-AuthRules-5800", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "keyType": "PrimaryKey" + } + }, + "responses": { + "200": { + "body": { + "primaryConnectionString": "Endpoint=sb://sdk-namespace-7982.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-5800;SharedAccessKey=############################################;EntityPath=sdk-Queues-2317", + "secondaryConnectionString": "Endpoint=sb://sdk-namespace-7982.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-5800;SharedAccessKey=############################################;EntityPath=sdk-Queues-2317", + "primaryKey": "############################################", + "secondaryKey": "############################################", + "keyName": "sdk-AuthRules-5800" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueCreate.json new file mode 100644 index 000000000000..dcb6c8874376 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueCreate.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-3174", + "resourceGroupName": "ArunMonocle", + "queueName": "sdk-Queues-5647", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "properties": { + "enablePartitioning": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-3174/queues/sdk-Queues-5647", + "name": "sdk-Queues-5647", + "type": "Microsoft.ServiceBus/Namespaces/Queues", + "properties": { + "lockDuration": "PT1M", + "maxSizeInMegabytes": 163840, + "maxMessageSizeInKilobytes": 10240, + "requiresDuplicateDetection": false, + "requiresSession": false, + "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S", + "duplicateDetectionHistoryTimeWindow": "PT10M", + "maxDeliveryCount": 10, + "sizeInBytes": 0, + "messageCount": 0, + "status": "Active", + "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S", + "enablePartitioning": true, + "enableExpress": false, + "createdAt": "2017-05-26T18:07:33.68Z", + "updatedAt": "2017-05-26T18:07:34.227Z", + "accessedAt": "2017-05-26T18:07:34.227Z" + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueDelete.json new file mode 100644 index 000000000000..2f8755f6245d --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-183", + "resourceGroupName": "ArunMonocle", + "queueName": "sdk-Queues-8708", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueGet.json new file mode 100644 index 000000000000..69218faab5d6 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-3174", + "resourceGroupName": "ArunMonocle", + "queueName": "sdk-Queues-5647", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-3174/queues/sdk-Queues-5647", + "name": "sdk-Queues-5647", + "type": "Microsoft.ServiceBus/Namespaces/Queues", + "properties": { + "lockDuration": "PT1M", + "maxSizeInMegabytes": 163840, + "maxMessageSizeInKilobytes": 10240, + "requiresDuplicateDetection": false, + "requiresSession": false, + "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S", + "duplicateDetectionHistoryTimeWindow": "PT10M", + "maxDeliveryCount": 10, + "sizeInBytes": 0, + "messageCount": 0, + "status": "Active", + "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S", + "enablePartitioning": true, + "enableExpress": false, + "createdAt": "2017-05-26T18:07:32.4592931Z", + "updatedAt": "2017-05-26T18:07:34.6243761Z", + "accessedAt": "0001-01-01T00:00:00Z" + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueListByNameSpace.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueListByNameSpace.json new file mode 100644 index 000000000000..7e2a5864d103 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Queues/SBQueueListByNameSpace.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-3174", + "resourceGroupName": "ArunMonocle", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-3174/queues/sdk-queues-5647", + "name": "sdk-queues-5647", + "type": "Microsoft.ServiceBus/Namespaces/Queues", + "properties": { + "lockDuration": "PT1M", + "maxSizeInMegabytes": 163840, + "maxMessageSizeInKilobytes": 10240, + "requiresDuplicateDetection": false, + "requiresSession": false, + "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S", + "duplicateDetectionHistoryTimeWindow": "PT10M", + "maxDeliveryCount": 10, + "sizeInBytes": 0, + "messageCount": 0, + "status": "Active", + "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S", + "enablePartitioning": true, + "enableExpress": false, + "createdAt": "2017-05-26T18:07:32.4592931Z", + "updatedAt": "2017-05-26T18:07:34.6243761Z", + "accessedAt": "0001-01-01T00:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleCreate.json new file mode 100644 index 000000000000..dac6f83f27f2 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleCreate.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1319", + "resourceGroupName": "resourceGroupName", + "topicName": "sdk-Topics-2081", + "subscriptionName": "sdk-Subscriptions-8691", + "ruleName": "sdk-Rules-6571", + "api-version": "2023-01-01-preview", + "subscriptionId": "subscriptionId", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1319/topics/sdk-Topics-2081/subscriptions/sdk-Subscriptions-8691/rules/sdk-Rules-6571", + "name": "sdk-Rules-6571", + "type": "Microsoft.ServiceBus/Namespaces/Topics/Subscriptions/Rules", + "properties": { + "action": {}, + "filterType": "SqlFilter", + "sqlFilter": { + "sqlExpression": "1=1", + "compatibilityLevel": 20 + } + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleCreate_CorrelationFilter.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleCreate_CorrelationFilter.json new file mode 100644 index 000000000000..b8a7dcbc8070 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleCreate_CorrelationFilter.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1319", + "resourceGroupName": "resourceGroupName", + "topicName": "sdk-Topics-2081", + "subscriptionName": "sdk-Subscriptions-8691", + "ruleName": "sdk-Rules-6571", + "api-version": "2023-01-01-preview", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "filterType": "CorrelationFilter", + "correlationFilter": { + "properties": { + "topicHint": "Crop" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1319/topics/sdk-Topics-2081/subscriptions/sdk-Subscriptions-8691/rules/sdk-Rules-6571", + "name": "sdk-Rules-6571", + "type": "Microsoft.ServiceBus/Namespaces/Topics/Subscriptions/Rules", + "properties": { + "action": {}, + "filterType": "CorrelationFilter", + "correlationFilter": { + "properties": { + "queueHint": "Crop" + } + } + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleCreate_SqlFilter.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleCreate_SqlFilter.json new file mode 100644 index 000000000000..6bda3a315aa5 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleCreate_SqlFilter.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1319", + "resourceGroupName": "resourceGroupName", + "topicName": "sdk-Topics-2081", + "subscriptionName": "sdk-Subscriptions-8691", + "ruleName": "sdk-Rules-6571", + "api-version": "2023-01-01-preview", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "filterType": "SqlFilter", + "sqlFilter": { + "sqlExpression": "myproperty=test" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1319/topics/sdk-Topics-2081/subscriptions/sdk-Subscriptions-8691/rules/sdk-Rules-6571", + "name": "sdk-Rules-6571", + "type": "Microsoft.ServiceBus/Namespaces/Topics/Subscriptions/Rules", + "properties": { + "action": {}, + "filterType": "SqlFilter", + "sqlFilter": { + "sqlExpression": "myproperty=test", + "compatibilityLevel": 20 + } + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleDelete.json new file mode 100644 index 000000000000..695bba753df8 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleDelete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1319", + "resourceGroupName": "ArunMonocle", + "topicName": "sdk-Topics-2081", + "subscriptionName": "sdk-Subscriptions-8691", + "ruleName": "sdk-Rules-6571", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleGet.json new file mode 100644 index 000000000000..647fc586ed19 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1319", + "resourceGroupName": "ArunMonocle", + "topicName": "sdk-Topics-2081", + "subscriptionName": "sdk-Subscriptions-8691", + "ruleName": "sdk-Rules-6571", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1319/topics/sdk-Topics-2081/subscriptions/sdk-Subscriptions-8691/rules/sdk-Rules-6571", + "name": "sdk-Rules-6571", + "type": "Microsoft.ServiceBus/Namespaces/Topics/Subscriptions/Rules", + "properties": { + "action": {}, + "filterType": "SqlFilter", + "sqlFilter": { + "sqlExpression": "1=1", + "compatibilityLevel": 20 + } + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleListBySubscription.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleListBySubscription.json new file mode 100644 index 000000000000..8159cab4975f --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Rules/RuleListBySubscription.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1319", + "resourceGroupName": "ArunMonocle", + "topicName": "sdk-Topics-2081", + "subscriptionName": "sdk-Subscriptions-8691", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1319/topics/sdk-Topics-2081/subscriptions/sdk-Subscriptions-8691/rules/sdk-Rules-6571", + "name": "sdk-Rules-6571", + "type": "Microsoft.ServiceBus/Namespaces/Topics/Subscriptions/Rules", + "properties": { + "action": {}, + "filterType": "SqlFilter", + "sqlFilter": { + "sqlExpression": "1=1", + "compatibilityLevel": 20 + } + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/SBOperations_List.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/SBOperations_List.json new file mode 100644 index 000000000000..37bda682e4a5 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/SBOperations_List.json @@ -0,0 +1,301 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ServiceBus/checkNameAvailability/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Non Resource Operation", + "operation": "Get namespace availability." + } + }, + { + "name": "Microsoft.ServiceBus/register/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "ServiceBus Resource Provider", + "operation": "Registers the ServiceBus Resource Provider" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Namespace", + "operation": "Create Or Update Namespace " + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Namespace", + "operation": "Get Namespace Resource" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/Delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Namespace", + "operation": "Delete Namespace" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/authorizationRules/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "AuthorizationRules", + "operation": "Create or Update Namespace Authorization Rules" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/authorizationRules/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "AuthorizationRules", + "operation": "Get Namespace Authorization Rules" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/authorizationRules/delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "AuthorizationRules", + "operation": "Delete Namespace Authorization Rule" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/authorizationRules/listkeys/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "AuthorizationRules", + "operation": "Get Namespace Listkeys" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/authorizationRules/regenerateKeys/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "AuthorizationRules", + "operation": "Resource Regeneratekeys" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue", + "operation": "Create or Update Queue" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue", + "operation": "Get Queue" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/Delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue", + "operation": "Delete Queue" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/authorizationRules/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue AuthorizationRules", + "operation": "Create or Update Queue Authorization Rule" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/authorizationRules/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue AuthorizationRules", + "operation": " Get Queue Authorization Rules" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/authorizationRules/delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue AuthorizationRules", + "operation": "Delete Queue Authorization Rules" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/authorizationRules/listkeys/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue AuthorizationRules", + "operation": "List Queue keys" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/authorizationRules/regenerateKeys/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue AuthorizationRules", + "operation": "Resource Regeneratekeys" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic", + "operation": "Create or Update Topic" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic", + "operation": "Get Topic" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/Delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic", + "operation": "Delete Topic" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/authorizationRules/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic AuthorizationRules", + "operation": "Create or Update Topic Authorization Rule" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/authorizationRules/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic AuthorizationRules", + "operation": " Get Topic Authorization Rules" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/authorizationRules/delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic AuthorizationRules", + "operation": "Delete Topic Authorization Rules" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/authorizationRules/listkeys/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic AuthorizationRules", + "operation": "List Topic keys" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/authorizationRules/regenerateKeys/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic AuthorizationRules", + "operation": "Resource Regeneratekeys" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/subscriptions/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "TopicSubscription", + "operation": "Create or Update TopicSubscription" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/subscriptions/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "TopicSubscription", + "operation": "Get TopicSubscription" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/subscriptions/Delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "TopicSubscription", + "operation": "Delete TopicSubscription" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/subscriptions/rules/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Rule", + "operation": "Create or Update Rule" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/subscriptions/rules/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Rule", + "operation": "Get Rule" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/subscriptions/rules/Delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Rule", + "operation": "Delete Rule" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/metricDefinitions/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Namespace metrics", + "operation": "Get Namespace metrics" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/diagnosticSettings/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Namespace diagnostic settings", + "operation": "Get Namespace diagnostic settings" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/diagnosticSettings/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Namespace diagnostic settings", + "operation": "Create or Update Namespace diagnostic settings" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/logDefinitions/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Namespace logs", + "operation": "Get Namespace logs" + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Subscriptions/SBSubscriptionCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Subscriptions/SBSubscriptionCreate.json new file mode 100644 index 000000000000..8705a38eb053 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Subscriptions/SBSubscriptionCreate.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1349", + "resourceGroupName": "ResourceGroup", + "topicName": "sdk-Topics-8740", + "subscriptionName": "sdk-Subscriptions-2178", + "api-version": "2023-01-01-preview", + "subscriptionId": "Subscriptionid", + "parameters": { + "properties": { + "enableBatchedOperations": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/Subscriptionid/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1349/topics/sdk-Topics-8740/subscriptions/sdk-Subscriptions-2178", + "name": "sdk-Subscriptions-2178", + "type": "Microsoft.ServiceBus/Namespaces/Topics/Subscriptions", + "properties": { + "lockDuration": "PT1M", + "requiresSession": false, + "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S", + "deadLetteringOnMessageExpiration": true, + "deadLetteringOnFilterEvaluationExceptions": true, + "messageCount": 0, + "maxDeliveryCount": 10, + "status": "Active", + "enableBatchedOperations": true, + "createdAt": "2021-01-04T18:02:20.5992764Z", + "updatedAt": "2021-01-04T18:02:20.5992764Z", + "accessedAt": "2021-01-04T18:02:20.5992764Z", + "countDetails": { + "activeMessageCount": 0, + "deadLetterMessageCount": 0, + "scheduledMessageCount": 0, + "transferMessageCount": 0, + "transferDeadLetterMessageCount": 0 + }, + "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S", + "forwardTo": "sdk-Topics-3065", + "forwardDeadLetteredMessagesTo": "sdk-Topics-3065" + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Subscriptions/SBSubscriptionDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Subscriptions/SBSubscriptionDelete.json new file mode 100644 index 000000000000..df2b7986bf7f --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Subscriptions/SBSubscriptionDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5882", + "resourceGroupName": "ResourceGroup", + "topicName": "sdk-Topics-1804", + "subscriptionName": "sdk-Subscriptions-3670", + "api-version": "2023-01-01-preview", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Subscriptions/SBSubscriptionGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Subscriptions/SBSubscriptionGet.json new file mode 100644 index 000000000000..9f5e4d07607b --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Subscriptions/SBSubscriptionGet.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1349", + "resourceGroupName": "ResourceGroup", + "topicName": "sdk-Topics-8740", + "subscriptionName": "sdk-Subscriptions-2178", + "api-version": "2023-01-01-preview", + "subscriptionId": "Subscriptionid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/Subscriptionid/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1349/topics/sdk-Topics-8740/subscriptions/sdk-Subscriptions-2178", + "name": "sdk-Subscriptions-2178", + "type": "Microsoft.ServiceBus/Namespaces/Topics/Subscriptions", + "properties": { + "lockDuration": "PT1M", + "requiresSession": false, + "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S", + "deadLetteringOnMessageExpiration": true, + "deadLetteringOnFilterEvaluationExceptions": true, + "messageCount": 0, + "maxDeliveryCount": 10, + "status": "Active", + "enableBatchedOperations": true, + "createdAt": "2021-01-04T18:02:20.5992764Z", + "updatedAt": "2021-01-04T18:02:20.5992764Z", + "accessedAt": "2021-01-04T18:02:20.5992764Z", + "countDetails": { + "activeMessageCount": 0, + "deadLetterMessageCount": 0, + "scheduledMessageCount": 0, + "transferMessageCount": 0, + "transferDeadLetterMessageCount": 0 + }, + "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S", + "forwardTo": "sdk-Topics-3065", + "forwardDeadLetteredMessagesTo": "sdk-Topics-3065" + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Subscriptions/SBSubscriptionListByTopic.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Subscriptions/SBSubscriptionListByTopic.json new file mode 100644 index 000000000000..47e6d1044f63 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Subscriptions/SBSubscriptionListByTopic.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1349", + "resourceGroupName": "ResourceGroup", + "topicName": "sdk-Topics-8740", + "api-version": "2023-01-01-preview", + "subscriptionId": "5{Subscriptionid}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/Subscriptionid/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1349/topics/sdk-Topics-8740/subscriptions/sdk-Subscriptions-2178", + "name": "sdk-Subscriptions-2178", + "type": "Microsoft.ServiceBus/Namespaces/Topics/Subscriptions", + "properties": { + "lockDuration": "PT1M", + "requiresSession": false, + "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S", + "deadLetteringOnMessageExpiration": true, + "deadLetteringOnFilterEvaluationExceptions": true, + "messageCount": 0, + "maxDeliveryCount": 10, + "status": "Active", + "enableBatchedOperations": true, + "createdAt": "2021-01-04T18:02:20.5992764Z", + "updatedAt": "2021-01-04T18:02:20.5992764Z", + "accessedAt": "2021-01-04T18:02:20.5992764Z", + "countDetails": { + "activeMessageCount": 0, + "deadLetterMessageCount": 0, + "scheduledMessageCount": 0, + "transferMessageCount": 0, + "transferDeadLetterMessageCount": 0 + }, + "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S", + "forwardTo": "sdk-Topics-3065", + "forwardDeadLetteredMessagesTo": "sdk-Topics-3065" + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleCreate.json new file mode 100644 index 000000000000..bd94db218a3e --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleCreate.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-Namespace-6261", + "topicName": "sdk-Topics-1984", + "authorizationRuleName": "sdk-AuthRules-4310", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-6261/topics/sdk-Topics-1984/authorizationRules/sdk-AuthRules-4310", + "name": "sdk-AuthRules-4310", + "type": "Microsoft.ServiceBus/Namespaces/Topics/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleDelete.json new file mode 100644 index 000000000000..fe16d17693c2 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-Namespace-6261", + "topicName": "sdk-Topics-1984", + "authorizationRuleName": "sdk-AuthRules-4310", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleGet.json new file mode 100644 index 000000000000..ab1e0a9496de --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-Namespace-6261", + "topicName": "sdk-Topics-1984", + "authorizationRuleName": "sdk-AuthRules-4310", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-6261/topics/sdk-Topics-1984/authorizationRules/sdk-AuthRules-4310", + "name": "sdk-AuthRules-4310", + "type": "Microsoft.ServiceBus/Namespaces/Topics/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleListAll.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleListAll.json new file mode 100644 index 000000000000..4ca636808728 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleListAll.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-Namespace-6261", + "topicName": "sdk-Topics-1984", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-6261/topics/sdk-Topics-1984/authorizationRules/sdk-AuthRules-4310", + "name": "sdk-AuthRules-4310", + "type": "Microsoft.ServiceBus/Namespaces/Topics/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleListKey.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleListKey.json new file mode 100644 index 000000000000..8e48293353f9 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleListKey.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "resourceGroupName": "Default-ServiceBus-WestUS", + "namespaceName": "sdk-Namespace8408", + "topicName": "sdk-Topics2075", + "authorizationRuleName": "sdk-Authrules5067", + "api-version": "2023-01-01-preview", + "subscriptionId": "e2f361f0-3b27-4503-a9cc-21cfba380093" + }, + "responses": { + "200": { + "body": { + "primaryConnectionString": "Endpoint=sb://sdk-namespace-6261.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-4310;SharedAccessKey=#############################################;EntityPath=sdk-Topics-1984", + "secondaryConnectionString": "Endpoint=sb://sdk-namespace-6261.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-4310;SharedAccessKey=#############################################;EntityPath=sdk-Topics-1984", + "primaryKey": "#############################################", + "secondaryKey": "#############################################", + "keyName": "sdk-AuthRules-4310" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleRegenerateKey.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleRegenerateKey.json new file mode 100644 index 000000000000..a626a337faf0 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicAuthorizationRuleRegenerateKey.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "resourceGroupName": "Default-ServiceBus-WestUS", + "namespaceName": "sdk-Namespace8408", + "topicName": "sdk-Topics2075", + "authorizationRuleName": "sdk-Authrules5067", + "api-version": "2023-01-01-preview", + "subscriptionId": "e2f361f0-3b27-4503-a9cc-21cfba380093", + "parameters": { + "keyType": "PrimaryKey" + } + }, + "responses": { + "200": { + "body": { + "primaryConnectionString": "Endpoint=sb://sdk-namespace-6261.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-4310;SharedAccessKey=#############################################;EntityPath=sdk-Topics-1984", + "secondaryConnectionString": "Endpoint=sb://sdk-namespace-6261.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-4310;SharedAccessKey=#############################################;EntityPath=sdk-Topics-1984", + "primaryKey": "#############################################", + "secondaryKey": "#############################################", + "keyName": "sdk-AuthRules-4310" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicCreate.json new file mode 100644 index 000000000000..1ab3da720aa6 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicCreate.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1617", + "resourceGroupName": "ArunMonocle", + "topicName": "sdk-Topics-5488", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "properties": { + "enableExpress": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1617/topics/sdk-Topics-5488", + "name": "sdk-Topics-5488", + "type": "Microsoft.ServiceBus/Namespaces/Topics", + "properties": { + "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S", + "maxSizeInMegabytes": 10240, + "maxMessageSizeInKilobytes": 10240, + "requiresDuplicateDetection": false, + "duplicateDetectionHistoryTimeWindow": "PT10M", + "enableBatchedOperations": true, + "sizeInBytes": 0, + "status": "Active", + "supportOrdering": true, + "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S", + "enablePartitioning": false, + "enableExpress": true, + "createdAt": "2017-05-26T20:50:34.1Z", + "updatedAt": "2017-05-26T20:50:34.32Z", + "accessedAt": "2017-05-26T20:50:34.32Z", + "subscriptionCount": 0 + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicDelete.json new file mode 100644 index 000000000000..266712e2b6ad --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1617", + "resourceGroupName": "ArunMonocle", + "topicName": "sdk-Topics-5488", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicGet.json new file mode 100644 index 000000000000..ad13ddda813a --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1617", + "resourceGroupName": "ArunMonocle", + "topicName": "sdk-Topics-5488", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1617/topics/sdk-Topics-5488", + "name": "sdk-Topics-5488", + "type": "Microsoft.ServiceBus/Namespaces/Topics", + "properties": { + "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S", + "maxSizeInMegabytes": 10240, + "maxMessageSizeInKilobytes": 10240, + "requiresDuplicateDetection": false, + "duplicateDetectionHistoryTimeWindow": "PT10M", + "enableBatchedOperations": true, + "sizeInBytes": 0, + "status": "Active", + "supportOrdering": true, + "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S", + "enablePartitioning": false, + "enableExpress": true, + "createdAt": "2017-05-26T20:50:31.4442694Z", + "updatedAt": "2017-05-26T20:52:32.2092264Z", + "accessedAt": "0001-01-01T00:00:00Z", + "subscriptionCount": 0 + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicListByNameSpace.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicListByNameSpace.json new file mode 100644 index 000000000000..3f165c00952a --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/Topics/SBTopicListByNameSpace.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1617", + "resourceGroupName": "Default-ServiceBus-WestUS", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1617/topics/sdk-topics-5488", + "name": "sdk-topics-5488", + "type": "Microsoft.ServiceBus/Namespaces/Topics", + "properties": { + "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S", + "maxSizeInMegabytes": 10240, + "maxMessageSizeInKilobytes": 10240, + "requiresDuplicateDetection": false, + "duplicateDetectionHistoryTimeWindow": "PT10M", + "enableBatchedOperations": true, + "sizeInBytes": 0, + "status": "Active", + "supportOrdering": true, + "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S", + "enablePartitioning": false, + "enableExpress": true, + "createdAt": "2017-05-26T20:50:31.4442694Z", + "updatedAt": "2017-05-26T20:52:32.2092264Z", + "accessedAt": "0001-01-01T00:00:00Z", + "subscriptionCount": 0 + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleGet.json new file mode 100644 index 000000000000..440097d1f3a2 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-9080", + "authorizationRuleName": "sdk-Authrules-4879", + "resourceGroupName": "exampleResourceGroup", + "alias": "sdk-DisasterRecovery-4879", + "api-version": "2023-01-01-preview", + "subscriptionId": "exampleSubscriptionId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/exampleSubscriptionId/resourceGroups/exampleResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9080/disasterRecoveryConfigs/sdk-DisasterRecovery-4047/AuthorizationRules/sdk-Authrules-4879", + "name": "sdk-Authrules-4879", + "type": "Microsoft.ServiceBus/Namespaces/DisasterRecoveryConfig/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListAll.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListAll.json new file mode 100644 index 000000000000..df6cbaf224c5 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListAll.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-9080", + "resourceGroupName": "exampleResourceGroup", + "alias": "sdk-DisasterRecovery-4047", + "api-version": "2023-01-01-preview", + "subscriptionId": "exampleSubscriptionId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/exampleSubscriptionId/resourceGroups/exampleResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9080/disasterRecoveryConfigs/sdk-DisasterRecovery-4047/AuthorizationRules/RootManageSharedAccessKey", + "name": "RootManageSharedAccessKey", + "type": "Microsoft.ServiceBus/Namespaces/DisasterRecoveryConfig/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Manage", + "Send" + ] + } + }, + { + "id": "/subscriptions/exampleSubscriptionId/resourceGroups/exampleResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9080/disasterRecoveryConfigs/sdk-DisasterRecovery-4047/AuthorizationRules/sdk-Authrules-1067", + "name": "sdk-Authrules-1067", + "type": "Microsoft.ServiceBus/Namespaces/DisasterRecoveryConfig/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + }, + { + "id": "/subscriptions/exampleSubscriptionId/resourceGroups/exampleResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9080/disasterRecoveryConfigs/sdk-DisasterRecovery-4047/AuthorizationRules/sdk-Authrules-1684", + "name": "sdk-Authrules-1684", + "type": "Microsoft.ServiceBus/Namespaces/DisasterRecoveryConfig/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + }, + { + "id": "/subscriptions/exampleSubscriptionId/resourceGroups/exampleResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9080/disasterRecoveryConfigs/sdk-DisasterRecovery-4047/AuthorizationRules/sdk-Authrules-4879", + "name": "sdk-Authrules-4879", + "type": "Microsoft.ServiceBus/Namespaces/DisasterRecoveryConfig/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListKey.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListKey.json new file mode 100644 index 000000000000..dadb8c6de753 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListKey.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-2702", + "authorizationRuleName": "sdk-Authrules-1746", + "resourceGroupName": "exampleResourceGroup", + "alias": "sdk-DisasterRecovery-4047", + "api-version": "2023-01-01-preview", + "subscriptionId": "exampleSubscriptionId" + }, + "responses": { + "200": { + "body": { + "aliasPrimaryConnectionString": "Endpoint=sb://sdk-disasterrecovery-4047.servicebus.windows-int.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=############################################", + "aliasSecondaryConnectionString": "Endpoint=sb://sdk-disasterrecovery-4047.servicebus.windows-int.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=############################################", + "primaryKey": "############################################", + "secondaryKey": "############################################", + "keyName": "sdk-Authrules-1746" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasCheckNameAvailability.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasCheckNameAvailability.json new file mode 100644 index 000000000000..b862269eba10 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasCheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2023-01-01-preview", + "subscriptionId": "exampleSubscriptionId", + "namespaceName": "sdk-Namespace-9080", + "resourceGroupName": "exampleResourceGroup", + "parameters": { + "name": "sdk-DisasterRecovery-9474" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "reason": "None", + "message": "" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasCreate.json new file mode 100644 index 000000000000..efbfc9887970 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasCreate.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-8860", + "resourceGroupName": "ardsouzatestRG", + "alias": "sdk-Namespace-8860", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "properties": { + "partnerNamespace": "sdk-Namespace-37", + "alternateName": "alternameforAlias-Namespace-8860" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ardsouzatestRG/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-8860/disasterRecoveryConfig/sdk-Namespace-8860", + "name": "sdk-Namespace-8860", + "type": "Microsoft.ServiceBus/Namespaces/DisasterRecoveryConfig", + "properties": { + "provisioningState": "Accepted", + "partnerNamespace": "sdk-Namespace-37", + "alternateName": "alternameforAlias-Namespace-8860", + "role": "Primary" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ardsouzatestRG/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-8860/disasterRecoveryConfig/sdk-Namespace-8860", + "name": "sdk-Namespace-8860", + "type": "Microsoft.ServiceBus/Namespaces/DisasterRecoveryConfig", + "properties": { + "provisioningState": "Accepted", + "partnerNamespace": "sdk-Namespace-37", + "alternateName": "alternameforAlias-Namespace-8860", + "role": "Primary" + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasDelete.json new file mode 100644 index 000000000000..9c58279a47bc --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-8860", + "resourceGroupName": "SouthCentralUS", + "alias": "sdk-DisasterRecovery-3814", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasFailOver.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasFailOver.json new file mode 100644 index 000000000000..69aeb09882e7 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasFailOver.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-8860", + "resourceGroupName": "ardsouzatestRG", + "alias": "sdk-DisasterRecovery-3814", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasGet.json new file mode 100644 index 000000000000..5cd07d6d7d47 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-8860", + "resourceGroupName": "ardsouzatestRG", + "alias": "sdk-DisasterRecovery-3814", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ardsouzatestRG/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-37/disasterRecoveryConfig/sdk-DisasterRecovery-3814", + "name": "sdk-DisasterRecovery-3814", + "type": "Microsoft.ServiceBus/Namespaces/DisasterRecoveryConfig", + "properties": { + "provisioningState": "Accepted", + "partnerNamespace": "sdk-Namespace-8860", + "role": "Secondary", + "pendingReplicationOperationsCount": 0 + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasList.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasList.json new file mode 100644 index 000000000000..1465505de99f --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBAliasList.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-8860", + "resourceGroupName": "ardsouzatestRG", + "alias": "sdk-DisasterRecovery-3814", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ardsouzatestRG/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-8860/disasterRecoveryConfig/sdk-DisasterRecovery-3814", + "name": "sdk-DisasterRecovery-3814", + "type": "Microsoft.ServiceBus/Namespaces/DisasterRecoveryConfig", + "properties": { + "provisioningState": "Accepted", + "partnerNamespace": "sdk-Namespace-37", + "role": "Primary" + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBEHAliasBreakPairing.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBEHAliasBreakPairing.json new file mode 100644 index 000000000000..69aeb09882e7 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/examples/disasterRecoveryConfigs/SBEHAliasBreakPairing.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-8860", + "resourceGroupName": "ardsouzatestRG", + "alias": "sdk-DisasterRecovery-3814", + "api-version": "2023-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/migrationconfigs.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/migrationconfigs.json new file mode 100644 index 000000000000..f0221b752179 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/migrationconfigs.json @@ -0,0 +1,385 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2023-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations": { + "get": { + "tags": [ + "MigrationConfigs" + ], + "operationId": "MigrationConfigs_List", + "x-ms-examples": { + "MigrationConfigurationsList": { + "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationList.json" + } + }, + "description": "Gets all migrationConfigurations", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of migrationConfigurations for servicebus namespace", + "schema": { + "$ref": "#/definitions/MigrationConfigListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}": { + "put": { + "tags": [ + "MigrationConfigs" + ], + "operationId": "MigrationConfigs_CreateAndStartMigration", + "x-ms-examples": { + "MigrationConfigurationsStartMigration": { + "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationCreateAndStartMigration.json" + } + }, + "description": "Creates Migration configuration and starts migration of entities from Standard to Premium namespace", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ConfigNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MigrationConfigProperties" + }, + "description": "Parameters required to create Migration Configuration" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Migration Config successfully created", + "schema": { + "$ref": "#/definitions/MigrationConfigProperties" + } + }, + "201": { + "description": "Migration Config creation request received", + "schema": { + "$ref": "#/definitions/MigrationConfigProperties" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "MigrationConfigs" + ], + "operationId": "MigrationConfigs_Delete", + "x-ms-examples": { + "MigrationConfigurationsDelete": { + "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationDelete.json" + } + }, + "description": "Deletes a MigrationConfiguration", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ConfigNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete Migration Config request accepted" + }, + "204": { + "description": "Not Found" + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "MigrationConfigs" + ], + "operationId": "MigrationConfigs_Get", + "x-ms-examples": { + "MigrationConfigurationsGet": { + "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationGet.json" + } + }, + "description": "Retrieves Migration Config", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ConfigNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved Migration Config)", + "schema": { + "$ref": "#/definitions/MigrationConfigProperties" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}/upgrade": { + "post": { + "tags": [ + "MigrationConfigs" + ], + "operationId": "MigrationConfigs_CompleteMigration", + "x-ms-examples": { + "MigrationConfigurationsCompleteMigration": { + "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationCompleteMigration.json" + } + }, + "description": "This operation Completes Migration of entities by pointing the connection strings to Premium namespace and any entities created after the operation will be under Premium Namespace. CompleteMigration operation will fail when entity migration is in-progress.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ConfigNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "upgrade operation of Migration Config is successful." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}/revert": { + "post": { + "tags": [ + "MigrationConfigs" + ], + "operationId": "MigrationConfigs_Revert", + "x-ms-examples": { + "MigrationConfigurationsRevert": { + "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationRevert.json" + } + }, + "description": "This operation reverts Migration", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ConfigNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "MigrationConfig Revert operation is successful." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "MigrationConfigProperties": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of Migration Configuration " + }, + "pendingReplicationOperationsCount": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "Number of entities pending to be replicated." + }, + "targetNamespace": { + "type": "string", + "description": "Existing premium Namespace ARM Id name which has no entities, will be used for migration" + }, + "postMigrationName": { + "type": "string", + "description": "Name to access Standard Namespace after migration" + }, + "migrationState": { + "readOnly": true, + "type": "string", + "description": "State in which Standard to Premium Migration is, possible values : Unknown, Reverting, Completing, Initiating, Syncing, Active" + } + }, + "required": [ + "targetNamespace", + "postMigrationName" + ], + "description": "Properties required to the Create Migration Configuration" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../common/v2/definitions.json#/definitions/ProxyResource" + } + ], + "description": "Single item in List or Get Migration Config operation" + }, + "MigrationConfigListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MigrationConfigProperties" + }, + "description": "List of Migration Configs" + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if Value contains incomplete list of migrationConfigurations" + } + }, + "description": "The result of the List migrationConfigurations operation." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/namespace-preview.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/namespace-preview.json new file mode 100644 index 000000000000..8d6cb1b623ea --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/namespace-preview.json @@ -0,0 +1,1301 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client for managing Namespace", + "version": "2023-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/namespaces": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_List", + "x-ms-examples": { + "NameSpaceList": { + "$ref": "./examples/NameSpaces/SBNameSpaceList.json" + } + }, + "description": "Gets all the available namespaces within the subscription, irrespective of the resource groups.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespaces successfully returned.", + "schema": { + "$ref": "#/definitions/SBNamespaceListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_ListByResourceGroup", + "x-ms-examples": { + "NameSpaceListByResourceGroup": { + "$ref": "./examples/NameSpaces/SBNameSpaceListByResourceGroup.json" + } + }, + "description": "Gets the available namespaces within a resource group.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespaces successfully returned.", + "schema": { + "$ref": "#/definitions/SBNamespaceListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}": { + "put": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_CreateOrUpdate", + "x-ms-examples": { + "NameSpaceCreate": { + "$ref": "./examples/NameSpaces/SBNameSpaceCreate.json" + } + }, + "description": "Creates or updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639408.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "namespaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBNamespace" + }, + "description": "Parameters supplied to create a namespace resource." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace created successfully.", + "schema": { + "$ref": "#/definitions/SBNamespace" + } + }, + "201": { + "description": "Namespace create request accepted.", + "schema": { + "$ref": "#/definitions/SBNamespace" + } + }, + "202": { + "description": "Namespace create or update request accepted." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Delete", + "x-ms-examples": { + "NameSpaceDelete": { + "$ref": "./examples/NameSpaces/SBNameSpaceDelete.json" + } + }, + "description": "Deletes an existing namespace. This operation also removes all associated resources under the namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639389.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace successfully deleted." + }, + "202": { + "description": "Namespace delete request accepted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Get", + "x-ms-examples": { + "NameSpaceGet": { + "$ref": "./examples/NameSpaces/SBNameSpaceGet.json" + } + }, + "description": "Gets a description for the specified namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace successfully returned.", + "schema": { + "$ref": "#/definitions/SBNamespace" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Update", + "x-ms-examples": { + "NameSpaceUpdate": { + "$ref": "./examples/NameSpaces/SBNameSpaceUpdate.json" + } + }, + "description": "Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBNamespaceUpdateParameters" + }, + "description": "Parameters supplied to update a namespace resource." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace updated successfully.", + "schema": { + "$ref": "#/definitions/SBNamespace" + } + }, + "201": { + "description": "Namespace update request accepted.", + "schema": { + "$ref": "#/definitions/SBNamespace" + } + }, + "202": { + "description": "Namespace update request accepted." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/privateEndpointConnections": { + "get": { + "tags": [ + "Namespaces PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "x-ms-examples": { + "NameSpaceCreate": { + "$ref": "./examples/NameSpaces/PrivateEndPointConnectionList.json" + } + }, + "description": "Gets the available PrivateEndpointConnections within a namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "PrivateEndpointConnections successfully returned.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/failover": { + "post": { + "tags": [ + "Namespaces Geo DR Failover" + ], + "operationId": "Namespaces_Failover", + "x-ms-examples": { + "NameSpaceCreate": { + "$ref": "./examples/NameSpaces/SBNamespaceFailover.json" + } + }, + "description": "GeoDR Failover", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FailOver" + }, + "description": "Parameters for updating a namespace resource." + } + ], + "responses": { + "202": { + "description": "Accepted. The failover policy change operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "put": { + "tags": [ + "Namespaces PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "x-ms-examples": { + "NameSpacePrivateEndPointConnectionCreate": { + "$ref": "./examples/NameSpaces/PrivateEndPointConnectionCreate.json" + } + }, + "description": "Creates or updates PrivateEndpointConnections of service namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639408.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "Parameters supplied to update Status of PrivateEndPoint Connection to namespace resource." + } + ], + "responses": { + "200": { + "description": "Status of PrivateEndPoint Connection Created successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "Request to update Status of PrivateEndPoint Connection accepted.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "202": { + "description": "Request to update Status of PrivateEndPoint Connection accepted.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Namespaces PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "x-ms-examples": { + "NameSpacePrivateEndPointConnectionDelete": { + "$ref": "./examples/NameSpaces/PrivateEndPointConnectionDelete.json" + } + }, + "description": "Deletes an existing Private Endpoint Connection.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639389.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/PrivateEndpointConnectionNameParameter" + } + ], + "responses": { + "200": { + "description": "Private Endpoint Connection successfully deleted." + }, + "202": { + "description": "Private Endpoint Connection delete request accepted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Namespaces PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "x-ms-examples": { + "NameSpacePrivateEndPointConnectionGet": { + "$ref": "./examples/NameSpaces/PrivateEndPointConnectionGet.json" + } + }, + "description": "Gets a description for the specified Private Endpoint Connection.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Description of Private Endpoint Connection returned successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/privateLinkResources": { + "get": { + "tags": [ + "Namespaces PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_Get", + "x-ms-examples": { + "NameSpacePrivateLinkResourcesGet": { + "$ref": "./examples/NameSpaces/PrivateLinkResourcesGet.json" + } + }, + "description": "Gets lists of resources that supports Privatelinks.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Private Link resource List", + "schema": { + "$ref": "#/definitions/PrivateLinkResourcesListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ResourceNamespacePatch": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "The Resource definition." + }, + "SBNamespaceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SBNamespace" + }, + "description": "Result of the List Namespace operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of Namespaces." + } + }, + "description": "The response of the List Namespace operation." + }, + "SBNamespace": { + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/SBSku", + "description": "Properties of SKU" + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "Properties of BYOK Identity description" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SBNamespaceProperties", + "description": "Properties of the namespace." + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/TrackedResource" + } + ], + "description": "Description of a namespace resource." + }, + "SBNamespaceUpdateParameters": { + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/SBSku", + "description": "Properties of SKU" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SBNamespaceUpdateProperties", + "description": "Properties of the namespace." + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "Properties of BYOK Identity description" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceNamespacePatch" + } + ], + "description": "Description of a namespace resource." + }, + "SBNamespaceProperties": { + "type": "object", + "properties": { + "minimumTlsVersion": { + "type": "string", + "description": "The minimum TLS version for the cluster to support, e.g. '1.2'", + "enum": [ + "1.0", + "1.1", + "1.2" + ], + "x-ms-enum": { + "name": "TlsVersion", + "modelAsString": true + } + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the namespace." + }, + "status": { + "readOnly": true, + "type": "string", + "description": "Status of the namespace." + }, + "createdAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The time the namespace was created" + }, + "updatedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The time the namespace was updated." + }, + "serviceBusEndpoint": { + "readOnly": true, + "type": "string", + "description": "Endpoint you can use to perform Service Bus operations." + }, + "metricId": { + "readOnly": true, + "type": "string", + "description": "Identifier for Azure Insights metrics" + }, + "zoneRedundant": { + "type": "boolean", + "description": "Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "Properties of BYOK Encryption description" + }, + "privateEndpointConnections": { + "description": "List of private endpoint connections.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "disableLocalAuth": { + "type": "boolean", + "description": "This property disables SAS authentication for the Service Bus namespace." + }, + "alternateName": { + "type": "string", + "description": "Alternate name for namespace" + }, + "publicNetworkAccess": { + "description": "This determines if traffic is allowed over public network. By default it is enabled.", + "enum": [ + "Enabled", + "Disabled", + "SecuredByPerimeter" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + }, + "default": "Enabled" + }, + "premiumMessagingPartitions": { + "format": "int32", + "type": "integer", + "description": "The number of partitions of a Service Bus namespace. This property is only applicable to Premium SKU namespaces. The default value is 1 and possible values are 1, 2 and 4" + }, + "geoDataReplication": { + "$ref": "#/definitions/GeoDataReplicationProperties", + "description": "Geo Data Replication settings for the namespace" + } + }, + "description": "Properties of the namespace." + }, + "SBNamespaceUpdateProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the namespace." + }, + "status": { + "readOnly": true, + "type": "string", + "description": "Status of the namespace." + }, + "createdAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The time the namespace was created" + }, + "updatedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The time the namespace was updated." + }, + "serviceBusEndpoint": { + "readOnly": true, + "type": "string", + "description": "Endpoint you can use to perform Service Bus operations." + }, + "metricId": { + "readOnly": true, + "type": "string", + "description": "Identifier for Azure Insights metrics" + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "Properties of BYOK Encryption description" + }, + "privateEndpointConnections": { + "description": "List of private endpoint connections.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "disableLocalAuth": { + "type": "boolean", + "description": "This property disables SAS authentication for the Service Bus namespace." + }, + "alternateName": { + "type": "string", + "description": "Alternate name for namespace" + } + }, + "description": "Properties of the namespace." + }, + "SBSku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of this SKU.", + "enum": [ + "Basic", + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": false + } + }, + "tier": { + "type": "string", + "description": "The billing tier of this particular SKU.", + "enum": [ + "Basic", + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": false + } + }, + "capacity": { + "format": "int32", + "type": "integer", + "description": "Messaging units for your service bus premium namespace. Valid capacities are {1, 2, 4, 8, 16} multiples of your properties.premiumMessagingPartitions setting. For example, If properties.premiumMessagingPartitions is 1 then possible capacity values are 1, 2, 4, 8, and 16. If properties.premiumMessagingPartitions is 4 then possible capacity values are 4, 8, 16, 32 and 64" + } + }, + "required": [ + "name" + ], + "description": "SKU of the namespace." + }, + "GeoDataReplicationProperties": { + "type": "object", + "properties": { + "maxReplicationLagDurationInSeconds": { + "format": "int32", + "type": "integer", + "description": "The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day." + }, + "locations": { + "type": "array", + "items": { + "$ref": "#/definitions/NamespaceReplicaLocation" + }, + "x-ms-identifiers": [], + "description": "A list of regions where replicas of the namespace are maintained." + } + }, + "description": "GeoDR Replication properties" + }, + "NamespaceReplicaLocation": { + "type": "object", + "properties": { + "locationName": { + "type": "string", + "description": "Azure regions where a replica of the namespace is maintained" + }, + "roleType": { + "type": "string", + "description": "GeoDR Role Types", + "enum": [ + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "GeoDRRoleType", + "modelAsString": true + } + }, + "clusterArmId": { + "type": "string", + "description": "Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster" + } + }, + "description": "Namespace replication properties" + }, + "FailOver": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/FailOverProperties" + } + } + }, + "FailOverProperties": { + "type": "object", + "properties": { + "primaryLocation": { + "type": "string", + "description": "Query parameter for the new primary location after failover." + }, + "force": { + "type": "boolean", + "description": "If Force is false then graceful failover is attempted after ensuring no data loss. If Force flag is set to true, Forced failover is attempted with possible data loss." + } + } + }, + "Identity": { + "type": "object", + "x-ms-client-flatten": true, + "properties": { + "principalId": { + "type": "string", + "description": "ObjectId from the KeyVault", + "readOnly": true + }, + "tenantId": { + "type": "string", + "description": "TenantId from the KeyVault", + "readOnly": true + }, + "type": { + "description": "Type of managed service identity.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedServiceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + }, + "description": "Properties for User Assigned Identities" + } + }, + "description": "Properties to configure User Assigned Identities for Bring your Own Keys" + }, + "UserAssignedIdentity": { + "description": "Recognized Dictionary value.", + "type": "object", + "properties": { + "principalId": { + "description": "Principal Id of user assigned identity", + "type": "string", + "x-ms-client-name": "PrincipalId", + "readOnly": true + }, + "clientId": { + "description": "Client Id of user assigned identity", + "type": "string", + "x-ms-client-name": "ClientId", + "readOnly": true + } + } + }, + "Encryption": { + "type": "object", + "x-ms-client-flatten": true, + "properties": { + "keyVaultProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/KeyVaultProperties" + }, + "x-ms-client-name": "KeyVaultProperties", + "description": "Properties of KeyVault" + }, + "keySource": { + "type": "string", + "description": "Enumerates the possible value of keySource for Encryption", + "default": "Microsoft.KeyVault", + "enum": [ + "Microsoft.KeyVault" + ], + "x-ms-enum": { + "name": "keySource", + "modelAsString": false + } + }, + "requireInfrastructureEncryption": { + "type": "boolean", + "description": "Enable Infrastructure Encryption (Double Encryption)" + } + }, + "description": "Properties to configure Encryption" + }, + "KeyVaultProperties": { + "type": "object", + "properties": { + "keyName": { + "type": "string", + "description": "Name of the Key from KeyVault" + }, + "keyVaultUri": { + "type": "string", + "description": "Uri of KeyVault" + }, + "keyVersion": { + "type": "string", + "description": "Version of KeyVault" + }, + "identity": { + "$ref": "#/definitions/userAssignedIdentityProperties" + } + }, + "description": "Properties to configure keyVault Properties" + }, + "PrivateEndpointConnection": { + "type": "object", + "description": "Properties of the PrivateEndpointConnection.", + "allOf": [ + { + "$ref": "../../../common/v2/definitions.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Properties of the PrivateEndpointConnection.", + "x-ms-client-flatten": true + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + } + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "description": "Properties of the private endpoint connection resource.", + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The Private Endpoint resource for this Connection." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/ConnectionState", + "description": "Details about the state of the connection." + }, + "provisioningState": { + "description": "Provisioning state of the Private Endpoint Connection.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Canceled", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "EndPointProvisioningState", + "modelAsString": true + } + } + } + }, + "PrivateEndpoint": { + "type": "object", + "description": "PrivateEndpoint information.", + "properties": { + "id": { + "description": "The ARM identifier for Private Endpoint.", + "type": "string" + } + } + }, + "ConnectionState": { + "type": "object", + "description": "ConnectionState information.", + "properties": { + "status": { + "description": "Status of the connection.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateLinkConnectionStatus", + "modelAsString": true + } + }, + "description": { + "description": "Description of the connection state.", + "type": "string" + } + } + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "Result of the list of all private endpoint connections operation.", + "properties": { + "value": { + "description": "A collection of private endpoint connection resources.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "description": "A link for the next page of private endpoint connection resources.", + "type": "string" + } + } + }, + "PrivateLinkResource": { + "type": "object", + "description": "Information of the private link resource.", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Properties of the private link resource.", + "x-ms-client-flatten": true + }, + "id": { + "description": "Fully qualified identifier of the resource.", + "type": "string" + }, + "name": { + "description": "Name of the resource", + "type": "string" + }, + "type": { + "description": "Type of the resource", + "type": "string" + } + } + }, + "PrivateLinkResourceProperties": { + "type": "object", + "description": "Properties of PrivateLinkResource", + "properties": { + "groupId": { + "type": "string" + }, + "requiredMembers": { + "type": "array", + "description": "Required Members", + "items": { + "type": "string" + } + }, + "requiredZoneNames": { + "type": "array", + "description": "Required Zone Names", + "items": { + "type": "string" + } + } + } + }, + "PrivateLinkResourcesListResult": { + "type": "object", + "description": "Result of the List private link resources operation.", + "properties": { + "value": { + "description": "A collection of private link resources", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "description": "A link for the next page of private link resources.", + "type": "string" + } + } + }, + "userAssignedIdentityProperties": { + "type": "object", + "x-ms-client-flatten": true, + "properties": { + "userAssignedIdentity": { + "type": "string", + "description": "ARM ID of user Identity selected for encryption" + } + } + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/networksets.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/networksets.json new file mode 100644 index 000000000000..efb6af8cf558 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/networksets.json @@ -0,0 +1,310 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2023-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/networkRuleSets/default": { + "put": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceNetworkRuleSetCreate": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetCreate.json" + } + }, + "operationId": "Namespaces_CreateOrUpdateNetworkRuleSet", + "description": "Create or update NetworkRuleSet for a Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkRuleSet" + }, + "description": "The Namespace IpFilterRule." + } + ], + "responses": { + "200": { + "description": "Namespace NetworkRuleSet successfully returned.", + "schema": { + "$ref": "#/definitions/NetworkRuleSet" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceNetworkRuleSetGet": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetGet.json" + } + }, + "operationId": "Namespaces_GetNetworkRuleSet", + "description": "Gets NetworkRuleSet for a Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace NetworkRuleSet successfully returned.", + "schema": { + "$ref": "#/definitions/NetworkRuleSet" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/networkRuleSets": { + "get": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceNetworkRuleSetList": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetList.json" + } + }, + "operationId": "Namespaces_ListNetworkRuleSets", + "description": "Gets list of NetworkRuleSet for a Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of NetworkRuleSets for Namespace successfully returned.", + "schema": { + "$ref": "#/definitions/NetworkRuleSetListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "NWRuleSetIpRules": { + "type": "object", + "x-ms-client-flatten": true, + "properties": { + "ipMask": { + "type": "string", + "description": "IP Mask" + }, + "action": { + "type": "string", + "description": "The IP Filter Action", + "enum": [ + "Allow" + ], + "x-ms-enum": { + "name": "NetworkRuleIPAction", + "modelAsString": true + }, + "default": "Allow" + } + }, + "description": "Description of NetWorkRuleSet - IpRules resource." + }, + "Subnet": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID of Virtual Network Subnet" + } + }, + "required": [ + "id" + ], + "description": "Properties supplied for Subnet" + }, + "NWRuleSetVirtualNetworkRules": { + "type": "object", + "x-ms-client-flatten": true, + "properties": { + "subnet": { + "$ref": "#/definitions/Subnet", + "description": "Subnet properties" + }, + "ignoreMissingVnetServiceEndpoint": { + "type": "boolean", + "description": "Value that indicates whether to ignore missing VNet Service Endpoint" + } + }, + "description": "Description of VirtualNetworkRules - NetworkRules resource." + }, + "NetworkRuleSet": { + "type": "object", + "properties": { + "properties": { + "description": "NetworkRuleSet properties", + "x-ms-client-flatten": true, + "properties": { + "trustedServiceAccessEnabled": { + "type": "boolean", + "description": "Value that indicates whether Trusted Service Access is Enabled or not." + }, + "defaultAction": { + "type": "string", + "description": "Default Action for Network Rule Set", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "DefaultAction", + "modelAsString": true + } + }, + "virtualNetworkRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NWRuleSetVirtualNetworkRules" + }, + "description": "List VirtualNetwork Rules" + }, + "ipRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NWRuleSetIpRules" + }, + "description": "List of IpRules" + }, + "publicNetworkAccess": { + "description": "This determines if traffic is allowed over public network. By default it is enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccessFlag", + "modelAsString": true + }, + "default": "Enabled" + } + } + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../common/v2/definitions.json#/definitions/ProxyResource" + } + ], + "description": "Description of NetworkRuleSet resource." + }, + "NetworkRuleSetListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkRuleSet" + }, + "description": "Result of the List NetworkRuleSet operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of NetworkRuleSet." + } + }, + "description": "The response of the List NetworkRuleSet operation." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/operations.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/operations.json new file mode 100644 index 000000000000..e42df4f46bf4 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/operations.json @@ -0,0 +1,150 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2023-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.ServiceBus/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/SBOperations_List.json" + } + }, + "description": "Lists all of the available ServiceBus REST API operations.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "OperationListResult": { + "type": "object", + "description": "Result of the request to list ServiceBus operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "description": "List of ServiceBus operations supported by the Microsoft.ServiceBus resource provider.", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "A Service Bus REST API operation", + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Operation name: {provider}/{resource}/{operation}" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "Display of the operation" + }, + "origin": { + "description": "Origin of the operation", + "type": "string" + }, + "properties": { + "description": "Properties of the operation", + "type": "object", + "x-ms-client-flatten": true + } + } + }, + "OperationDisplay": { + "description": "Operation display payload", + "type": "object", + "properties": { + "provider": { + "description": "Resource provider of the operation", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "Resource of the operation", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "Localized friendly name for the operation", + "type": "string", + "readOnly": true + }, + "description": { + "description": "Localized friendly description for the operation", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/subscriptions.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/subscriptions.json new file mode 100644 index 000000000000..ee2b3fb8df67 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/subscriptions.json @@ -0,0 +1,407 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2023-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions": { + "get": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_ListByTopic", + "x-ms-examples": { + "SubscriptionListByTopic": { + "$ref": "./examples/Subscriptions/SBSubscriptionListByTopic.json" + } + }, + "description": "List all the subscriptions under a specified topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639400.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SkipParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved list of subscriptions.", + "schema": { + "$ref": "#/definitions/SBSubscriptionListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}": { + "put": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_CreateOrUpdate", + "x-ms-examples": { + "SubscriptionCreate": { + "$ref": "./examples/Subscriptions/SBSubscriptionCreate.json" + } + }, + "description": "Creates a topic subscription.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639385.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBSubscription" + }, + "description": "Parameters supplied to create a subscription resource." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Subscription create request accepted.", + "schema": { + "$ref": "#/definitions/SBSubscription" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_Delete", + "x-ms-examples": { + "SubscriptionDelete": { + "$ref": "./examples/Subscriptions/SBSubscriptionDelete.json" + } + }, + "description": "Deletes a subscription from the specified topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639381.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Subscription successfully deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_Get", + "x-ms-examples": { + "SubscriptionGet": { + "$ref": "./examples/Subscriptions/SBSubscriptionGet.json" + } + }, + "description": "Returns a subscription description for the specified topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639402.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved subscription description.", + "schema": { + "$ref": "#/definitions/SBSubscription" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "SBSubscriptionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SBSubscription" + }, + "description": "Result of the List Subscriptions operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of subscriptions." + } + }, + "description": "The response to the List Subscriptions operation." + }, + "SBSubscription": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SBSubscriptionProperties", + "description": "Properties of subscriptions resource." + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../common/v2/definitions.json#/definitions/ProxyResource" + } + ], + "description": "Description of subscription resource." + }, + "SBSubscriptionProperties": { + "type": "object", + "properties": { + "messageCount": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "Number of messages." + }, + "createdAt": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Exact time the message was created." + }, + "accessedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "Last time there was a receive request to this subscription." + }, + "updatedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the message was updated." + }, + "countDetails": { + "readOnly": true, + "$ref": "../../../common/v1/definitions.json#/definitions/MessageCountDetails", + "description": "Message count details" + }, + "lockDuration": { + "format": "duration", + "type": "string", + "description": "ISO 8061 lock duration timespan for the subscription. The default value is 1 minute." + }, + "requiresSession": { + "type": "boolean", + "description": "Value indicating if a subscription supports the concept of sessions." + }, + "defaultMessageTimeToLive": { + "format": "duration", + "type": "string", + "description": "ISO 8061 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself." + }, + "deadLetteringOnFilterEvaluationExceptions": { + "type": "boolean", + "description": "Value that indicates whether a subscription has dead letter support on filter evaluation exceptions." + }, + "deadLetteringOnMessageExpiration": { + "type": "boolean", + "description": "Value that indicates whether a subscription has dead letter support when a message expires." + }, + "duplicateDetectionHistoryTimeWindow": { + "format": "duration", + "type": "string", + "description": "ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes." + }, + "maxDeliveryCount": { + "format": "int32", + "type": "integer", + "description": "Number of maximum deliveries." + }, + "status": { + "$ref": "../../../common/v1/definitions.json#/definitions/EntityStatus", + "description": "Enumerates the possible values for the status of a messaging entity." + }, + "enableBatchedOperations": { + "type": "boolean", + "description": "Value that indicates whether server-side batched operations are enabled." + }, + "autoDeleteOnIdle": { + "format": "duration", + "type": "string", + "description": "ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes." + }, + "forwardTo": { + "type": "string", + "description": "Queue/Topic name to forward the messages" + }, + "forwardDeadLetteredMessagesTo": { + "type": "string", + "description": "Queue/Topic name to forward the Dead Letter message" + }, + "isClientAffine": { + "type": "boolean", + "description": "Value that indicates whether the subscription has an affinity to the client id." + }, + "clientAffineProperties": { + "$ref": "#/definitions/SBClientAffineProperties", + "description": "Properties specific to client affine subscriptions." + } + }, + "description": "Description of Subscription Resource." + }, + "SBClientAffineProperties": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "Indicates the Client ID of the application that created the client-affine subscription." + }, + "isDurable": { + "type": "boolean", + "description": "For client-affine subscriptions, this value indicates whether the subscription is durable or not." + }, + "isShared": { + "type": "boolean", + "description": "For client-affine subscriptions, this value indicates whether the subscription is shared or not." + } + }, + "description": "Properties specific to client affine subscriptions." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/topics.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/topics.json new file mode 100644 index 000000000000..b677bb87e9dd --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2023-01-01-preview/topics.json @@ -0,0 +1,372 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2023-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics": { + "get": { + "tags": [ + "Topics" + ], + "operationId": "Topics_ListByNamespace", + "x-ms-examples": { + "TopicGet": { + "$ref": "./examples/Topics/SBTopicListByNameSpace.json" + } + }, + "description": "Gets all the topics in a namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639388.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SkipParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved list of topics.", + "schema": { + "$ref": "#/definitions/SBTopicListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}": { + "put": { + "tags": [ + "Topics" + ], + "operationId": "Topics_CreateOrUpdate", + "x-ms-examples": { + "TopicCreate": { + "$ref": "./examples/Topics/SBTopicCreate.json" + } + }, + "description": "Creates a topic in the specified namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639409.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBTopic" + }, + "description": "Parameters supplied to create a topic resource." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Topic successfully created.", + "schema": { + "$ref": "#/definitions/SBTopic" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Topics" + ], + "operationId": "Topics_Delete", + "x-ms-examples": { + "TopicDelete": { + "$ref": "./examples/Topics/SBTopicDelete.json" + } + }, + "description": "Deletes a topic from the specified namespace and resource group.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639404.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Topic successfully deleted." + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Topics" + ], + "operationId": "Topics_Get", + "x-ms-examples": { + "TopicGet": { + "$ref": "./examples/Topics/SBTopicGet.json" + } + }, + "description": "Returns a description for the specified topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639399.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Topic description successfully retrieved.", + "schema": { + "$ref": "#/definitions/SBTopic" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "SBTopicListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SBTopic" + }, + "description": "Result of the List Topics operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of topics." + } + }, + "description": "The response to the List Topics operation." + }, + "SBTopic": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SBTopicProperties", + "description": "Properties of topic resource." + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../common/v2/definitions.json#/definitions/ProxyResource" + } + ], + "description": "Description of topic resource." + }, + "SBTopicProperties": { + "type": "object", + "properties": { + "sizeInBytes": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "Size of the topic, in bytes." + }, + "createdAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "Exact time the message was created." + }, + "updatedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the message was updated." + }, + "accessedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "Last time the message was sent, or a request was received, for this topic." + }, + "subscriptionCount": { + "readOnly": true, + "format": "int32", + "type": "integer", + "description": "Number of subscriptions." + }, + "countDetails": { + "readOnly": true, + "$ref": "../../../common/v1/definitions.json#/definitions/MessageCountDetails", + "description": "Message count details" + }, + "defaultMessageTimeToLive": { + "format": "duration", + "type": "string", + "description": "ISO 8601 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself." + }, + "maxSizeInMegabytes": { + "format": "int32", + "type": "integer", + "description": "Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024." + }, + "maxMessageSizeInKilobytes": { + "format": "int64", + "type": "integer", + "description": "Maximum size (in KB) of the message payload that can be accepted by the topic. This property is only used in Premium today and default is 1024." + }, + "requiresDuplicateDetection": { + "type": "boolean", + "description": "Value indicating if this topic requires duplicate detection." + }, + "duplicateDetectionHistoryTimeWindow": { + "format": "duration", + "type": "string", + "description": "ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes." + }, + "enableBatchedOperations": { + "type": "boolean", + "description": "Value that indicates whether server-side batched operations are enabled." + }, + "status": { + "$ref": "../../../common/v1/definitions.json#/definitions/EntityStatus", + "description": "Enumerates the possible values for the status of a messaging entity." + }, + "supportOrdering": { + "type": "boolean", + "description": "Value that indicates whether the topic supports ordering." + }, + "autoDeleteOnIdle": { + "format": "duration", + "type": "string", + "description": "ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes." + }, + "enablePartitioning": { + "type": "boolean", + "description": "Value that indicates whether the topic to be partitioned across multiple message brokers is enabled." + }, + "enableExpress": { + "type": "boolean", + "description": "Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage." + } + }, + "description": "The Topic Properties definition." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/readme.md b/specification/servicebus/resource-manager/readme.md index 643e3e803f24..923698d74f39 100644 --- a/specification/servicebus/resource-manager/readme.md +++ b/specification/servicebus/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the ServiceBus API. ``` yaml openapi-type: arm -tag: package-2022-10-preview +tag: package-2023-01-preview ``` ### Tag: package-2021-01-preview @@ -173,6 +173,25 @@ input-file: - Microsoft.ServiceBus/stable/2017-04-01/topics.json ``` +### Tag: package-2023-01-preview + +These settings apply only when `--tag=package-2023-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2023-01-preview' +input-file: +- Microsoft.ServiceBus/preview/2023-01-01-preview/namespace-preview.json +- Microsoft.ServiceBus/preview/2023-01-01-preview/operations.json +- Microsoft.ServiceBus/preview/2023-01-01-preview/DisasterRecoveryConfig.json +- Microsoft.ServiceBus/preview/2023-01-01-preview/migrationconfigs.json +- Microsoft.ServiceBus/preview/2023-01-01-preview/networksets.json +- Microsoft.ServiceBus/preview/2023-01-01-preview/AuthorizationRules.json +- Microsoft.ServiceBus/preview/2023-01-01-preview/Queue.json +- Microsoft.ServiceBus/preview/2023-01-01-preview/topics.json +- Microsoft.ServiceBus/preview/2023-01-01-preview/Rules.json +- Microsoft.ServiceBus/preview/2023-01-01-preview/subscriptions.json +- Microsoft.ServiceBus/preview/2023-01-01-preview/CheckNameAvailability.json +``` + Important notes: On the advice of @fearthecowboy, the `EncodingCaptureDescription` enum previously contained two values [`Avro`,`AvroDeflate`] ; the service has been changed (on 2018-01-17) and will not ever return the `AvroDeflate` value, however, we have left the value in the enum (in servicebus.json) so that existing clients won't suffer a binary breaking change @@ -238,5 +257,23 @@ See configuration in [readme.go.md](./readme.go.md) See configuration in [readme.java.md](./readme.java.md) +## Suppression + +``` yaml +directive: + - suppress: ResourceNameRestriction + from: namespace-preview.json + reason: Addition of Pattern restriction will cause a breaking change as there is no restriction in previous api versions. + + - suppress: ResourceNameRestriction + from: AuthorizationRules.json + reason: Addition of Pattern restriction will cause a breaking change as there is no restriction in previous api versions. + - suppress: RequestSchemaForTrackedResourcesMustHaveTags + from: AuthorizationRules.json + reason: Authorization rules are not tracked resources. + - suppress: PutResponseCodes + from: AuthorizationRules.json + reason: Breaking change in order to change the API response code. +``` diff --git a/specification/servicelinker/resource-manager/readme.md b/specification/servicelinker/resource-manager/readme.md index f4fdf934132f..96b6eb39a705 100644 --- a/specification/servicelinker/resource-manager/readme.md +++ b/specification/servicelinker/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-python-track2 + - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go-track2 - repo: azure-sdk-for-js diff --git a/specification/servicenetworking/ServiceNetworking.Management/main.tsp b/specification/servicenetworking/ServiceNetworking.Management/main.tsp index f42b4988387f..3d71ddb0a17a 100644 --- a/specification/servicenetworking/ServiceNetworking.Management/main.tsp +++ b/specification/servicenetworking/ServiceNetworking.Management/main.tsp @@ -229,9 +229,15 @@ interface AssociationsInterface { Association, LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; - update is ArmResourcePatchSync; + update is ArmCustomPatchSync< + Association, + Azure.ResourceManager.Foundations.ResourceUpdateModel< + Association, + AssociationProperties + > + >; delete is ArmResourceDeleteWithoutOkAsync; - listByResourceGroup is ArmResourceListByParent; + listByTrafficController is ArmResourceListByParent; } @armResourceOperations @@ -243,9 +249,15 @@ interface FrontendsInterface { Frontend, LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; - update is ArmResourcePatchSync; + update is ArmCustomPatchSync< + Frontend, + Azure.ResourceManager.Foundations.ResourceUpdateModel< + Frontend, + FrontendProperties + > + >; delete is ArmResourceDeleteWithoutOkAsync; - listByResourceGroup is ArmResourceListByParent; + listByTrafficController is ArmResourceListByParent; } @added(Versions.v2024_05_01_preview) @@ -258,9 +270,15 @@ interface SecurityPoliciesInterface { SecurityPolicy, LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; - update is ArmResourcePatchSync; + update is ArmCustomPatchSync< + SecurityPolicy, + Azure.ResourceManager.Foundations.ResourceUpdateModel< + SecurityPolicy, + SecurityPolicyProperties + > + >; delete is ArmResourceDeleteWithoutOkAsync; - listByResourceGroup is ArmResourceListByParent; + listByTrafficController is ArmResourceListByParent; } @armResourceOperations @@ -272,9 +290,12 @@ interface TrafficControllerInterface { TrafficController, LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; - update is ArmResourcePatchSync< + update is ArmCustomPatchSync< TrafficController, - TrafficControllerProperties + Azure.ResourceManager.Foundations.ResourceUpdateModel< + TrafficController, + TrafficControllerProperties + > >; delete is ArmResourceDeleteWithoutOkAsync; listByResourceGroup is ArmResourceListByParent; diff --git a/specification/servicenetworking/ServiceNetworking.Management/tspconfig.yaml b/specification/servicenetworking/ServiceNetworking.Management/tspconfig.yaml index 337cbb1d2c42..50c5a96a661d 100644 --- a/specification/servicenetworking/ServiceNetworking.Management/tspconfig.yaml +++ b/specification/servicenetworking/ServiceNetworking.Management/tspconfig.yaml @@ -8,6 +8,9 @@ linter: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true emitter-output-dir: "{project-root}/.." examples-directory: "{project-root}/examples" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/TrafficController.json" diff --git a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/preview/2024-05-01-preview/TrafficController.json b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/preview/2024-05-01-preview/TrafficController.json index d406c4d8ddef..f1dcee182766 100644 --- a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/preview/2024-05-01-preview/TrafficController.json +++ b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/preview/2024-05-01-preview/TrafficController.json @@ -1462,6 +1462,7 @@ }, "properties": { "$ref": "#/definitions/AssociationUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } @@ -1724,6 +1725,7 @@ }, "properties": { "$ref": "#/definitions/SecurityPolicyUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } @@ -1836,6 +1838,7 @@ }, "properties": { "$ref": "#/definitions/TrafficControllerUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } diff --git a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/stable/2023-11-01/TrafficController.json b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/stable/2023-11-01/TrafficController.json index 69b74f74c5c0..edfef3536269 100644 --- a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/stable/2023-11-01/TrafficController.json +++ b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/stable/2023-11-01/TrafficController.json @@ -1145,6 +1145,7 @@ }, "properties": { "$ref": "#/definitions/AssociationUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } diff --git a/specification/sphere/Sphere.Management/tspconfig.yaml b/specification/sphere/Sphere.Management/tspconfig.yaml index 51124381df85..70b4572b43f3 100644 --- a/specification/sphere/Sphere.Management/tspconfig.yaml +++ b/specification/sphere/Sphere.Management/tspconfig.yaml @@ -5,6 +5,9 @@ options: omit-unreachable-types: true emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/azuresphere.json" examples-directory: "{project-root}/examples" "@azure-tools/cadl-python": diff --git a/specification/splitio/SplitIO.Experimentation.Management/main.tsp b/specification/splitio/SplitIO.Experimentation.Management/main.tsp index c65478dc7e8a..73987ca2793c 100644 --- a/specification/splitio/SplitIO.Experimentation.Management/main.tsp +++ b/specification/splitio/SplitIO.Experimentation.Management/main.tsp @@ -125,9 +125,12 @@ namespace SplitIO.Experimentation { ExperimentationWorkspace, LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; - update is ArmResourcePatchAsync< + update is ArmCustomPatchAsync< ExperimentationWorkspace, - ExperimentationWorkspaceProperties + Azure.ResourceManager.Foundations.ResourceUpdateModel< + ExperimentationWorkspace, + ExperimentationWorkspaceProperties + > >; delete is ArmResourceDeleteWithoutOkAsync; listByResourceGroup is ArmResourceListByParent; diff --git a/specification/splitio/SplitIO.Experimentation.Management/tspconfig.yaml b/specification/splitio/SplitIO.Experimentation.Management/tspconfig.yaml index 018b4f7213da..b2b9bd7e7d27 100644 --- a/specification/splitio/SplitIO.Experimentation.Management/tspconfig.yaml +++ b/specification/splitio/SplitIO.Experimentation.Management/tspconfig.yaml @@ -5,6 +5,9 @@ options: "@azure-tools/typespec-autorest": emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/splitio.json" examples-directory: "{project-root}/examples" linter: diff --git a/specification/splitio/resource-manager/SplitIO.Experimentation/preview/2024-03-01-preview/splitio.json b/specification/splitio/resource-manager/SplitIO.Experimentation/preview/2024-03-01-preview/splitio.json index fdc038996b8b..7804179d3570 100644 --- a/specification/splitio/resource-manager/SplitIO.Experimentation/preview/2024-03-01-preview/splitio.json +++ b/specification/splitio/resource-manager/SplitIO.Experimentation/preview/2024-03-01-preview/splitio.json @@ -705,6 +705,7 @@ }, "properties": { "$ref": "#/definitions/ExperimentationWorkspaceUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } diff --git a/specification/standbypool/StandbyPool.Management/standbyContainerGroupPool.tsp b/specification/standbypool/StandbyPool.Management/standbyContainerGroupPool.tsp index 1ba16b8eb60d..c816fe4e0188 100644 --- a/specification/standbypool/StandbyPool.Management/standbyContainerGroupPool.tsp +++ b/specification/standbypool/StandbyPool.Management/standbyContainerGroupPool.tsp @@ -113,9 +113,12 @@ interface StandbyContainerGroupPools { LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; delete is ArmResourceDeleteWithoutOkAsync; - update is ArmResourcePatchSync< + update is ArmCustomPatchSync< StandbyContainerGroupPoolResource, - StandbyContainerGroupPoolResourceProperties + Azure.ResourceManager.Foundations.ResourceUpdateModel< + StandbyContainerGroupPoolResource, + StandbyContainerGroupPoolResourceProperties + > >; listByResourceGroup is ArmResourceListByParent; listBySubscription is ArmListBySubscription; diff --git a/specification/standbypool/StandbyPool.Management/standbyVM.tsp b/specification/standbypool/StandbyPool.Management/standbyVM.tsp index 9b7a3ac21900..e36d61163002 100644 --- a/specification/standbypool/StandbyPool.Management/standbyVM.tsp +++ b/specification/standbypool/StandbyPool.Management/standbyVM.tsp @@ -45,5 +45,5 @@ model StandbyVirtualMachineResourceProperties { @armResourceOperations interface StandbyVirtualMachines { get is ArmResourceRead; - listByStandbyPool is ArmResourceListByParent; + listByStandbyVirtualMachinePoolResource is ArmResourceListByParent; } diff --git a/specification/standbypool/StandbyPool.Management/standbyVMPool.tsp b/specification/standbypool/StandbyPool.Management/standbyVMPool.tsp index 01a6d30ecd75..ed5813d4395a 100644 --- a/specification/standbypool/StandbyPool.Management/standbyVMPool.tsp +++ b/specification/standbypool/StandbyPool.Management/standbyVMPool.tsp @@ -84,9 +84,12 @@ interface StandbyVirtualMachinePools { LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; delete is ArmResourceDeleteWithoutOkAsync; - update is ArmResourcePatchSync< + update is ArmCustomPatchSync< StandbyVirtualMachinePoolResource, - StandbyVirtualMachinePoolResourceProperties + Azure.ResourceManager.Foundations.ResourceUpdateModel< + StandbyVirtualMachinePoolResource, + StandbyVirtualMachinePoolResourceProperties + > >; listByResourceGroup is ArmResourceListByParent; listBySubscription is ArmListBySubscription; diff --git a/specification/standbypool/StandbyPool.Management/tspconfig.yaml b/specification/standbypool/StandbyPool.Management/tspconfig.yaml index e2d06b12e0a4..6333f53e2b04 100644 --- a/specification/standbypool/StandbyPool.Management/tspconfig.yaml +++ b/specification/standbypool/StandbyPool.Management/tspconfig.yaml @@ -10,6 +10,9 @@ options: "@azure-tools/typespec-autorest": use-read-only-status-schema: true azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true emitter-output-dir: "{project-root}/.." examples-directory: "{project-root}/examples" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/standbypool.json" diff --git a/specification/standbypool/resource-manager/Microsoft.StandbyPool/preview/2023-12-01-preview/standbypool.json b/specification/standbypool/resource-manager/Microsoft.StandbyPool/preview/2023-12-01-preview/standbypool.json index 868c8cfac56d..3af5c525dd59 100644 --- a/specification/standbypool/resource-manager/Microsoft.StandbyPool/preview/2023-12-01-preview/standbypool.json +++ b/specification/standbypool/resource-manager/Microsoft.StandbyPool/preview/2023-12-01-preview/standbypool.json @@ -1072,6 +1072,7 @@ }, "properties": { "$ref": "#/definitions/StandbyContainerGroupPoolResourceUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } @@ -1206,6 +1207,7 @@ }, "properties": { "$ref": "#/definitions/StandbyVirtualMachinePoolResourceUpdateProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } } diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/blob.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/blob.json index 24e925f9f380..d3a092eb9390 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/blob.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/blob.json @@ -544,7 +544,7 @@ "in": "header", "required": false, "type": "string", - "description": "The entity state (ETag) version of the immutability policy to update. A value of \"*\" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied." + "description": "The entity state (ETag) version of the immutability policy to update must be returned to the server for all update operations. The ETag value must include the leading and trailing double quotes as returned by the service." } ], "responses": { @@ -597,7 +597,7 @@ "in": "header", "required": false, "type": "string", - "description": "The entity state (ETag) version of the immutability policy to update. A value of \"*\" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied." + "description": "The entity state (ETag) version of the immutability policy to update must be returned to the server for all update operations. The ETag value must include the leading and trailing double quotes as returned by the service." } ], "responses": { @@ -650,7 +650,7 @@ "in": "header", "required": true, "type": "string", - "description": "The entity state (ETag) version of the immutability policy to update. A value of \"*\" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied." + "description": "The entity state (ETag) version of the immutability policy to update must be returned to the server for all update operations. The ETag value must include the leading and trailing double quotes as returned by the service." } ], "responses": { @@ -702,7 +702,7 @@ "in": "header", "required": true, "type": "string", - "description": "The entity state (ETag) version of the immutability policy to update. A value of \"*\" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied." + "description": "The entity state (ETag) version of the immutability policy to update must be returned to the server for all update operations. The ETag value must include the leading and trailing double quotes as returned by the service." } ], "responses": { @@ -762,7 +762,7 @@ "in": "header", "required": true, "type": "string", - "description": "The entity state (ETag) version of the immutability policy to update. A value of \"*\" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied." + "description": "The entity state (ETag) version of the immutability policy to update must be returned to the server for all update operations. The ETag value must include the leading and trailing double quotes as returned by the service." } ], "responses": { 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 523cf94b76a2..c4c1f709cc13 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 @@ -95,13 +95,32 @@ "typeProperties": { "description": "Azure Table Storage linked service properties.", "x-ms-client-flatten": true, - "$ref": "#/definitions/AzureStorageLinkedServiceTypeProperties" + "$ref": "#/definitions/AzureTableStorageLinkedServiceTypeProperties" } }, "required": [ "typeProperties" ] }, + "AzureTableStorageLinkedServiceTypeProperties": { + "description": "Azure Table Storage linked service properties.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureStorageLinkedServiceTypeProperties" + } + ], + "properties": { + "serviceEndpoint": { + "type": "object", + "description": "Table service endpoint of the Azure Table Storage resource. It is mutually exclusive with connectionString, sasUri property." + }, + "credential": { + "$ref": "../artifacts.json#/definitions/CredentialReference", + "description": "The credential reference containing authentication information." + } + } + }, "AzureStorageLinkedServiceTypeProperties": { "description": "Azure Storage linked service properties.", "type": "object", @@ -916,7 +935,11 @@ }, "authenticationType": { "type": "object", - "description": "The authentication type to connect to Dynamics server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string)." + "description": "The authentication type to connect to Dynamics server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario, 'Active Directory' for Dynamics on-premises with IFD. Type: string (or Expression with resultType string)." + }, + "domain": { + "type": "object", + "description": "The Active Directory domain that will verify user credentials. Type: string (or Expression with resultType string)." }, "username": { "type": "object", @@ -970,7 +993,8 @@ "enum": [ "Office365", "Ifd", - "AADServicePrincipal" + "AADServicePrincipal", + "Active Directory" ], "x-ms-enum": { "name": "DynamicsAuthenticationType", @@ -1023,7 +1047,11 @@ }, "authenticationType": { "type": "object", - "description": "The authentication type to connect to Dynamics CRM server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string)." + "description": "The authentication type to connect to Dynamics CRM server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario, 'Active Directory' for Dynamics on-premises with IFD. Type: string (or Expression with resultType string)." + }, + "domain": { + "type": "object", + "description": "The Active Directory domain that will verify user credentials. Type: string (or Expression with resultType string)." }, "username": { "type": "object", @@ -1117,7 +1145,11 @@ }, "authenticationType": { "type": "object", - "description": "The authentication type to connect to Common Data Service for Apps server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario. 'AADServicePrincipal' for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string)." + "description": "The authentication type to connect to Common Data Service for Apps server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario. 'AADServicePrincipal' for Server-To-Server authentication in online scenario, 'Active Directory' for Dynamics on-premises with IFD. Type: string (or Expression with resultType string)." + }, + "domain": { + "type": "object", + "description": "The Active Directory domain that will verify user credentials. Type: string (or Expression with resultType string)." }, "username": { "type": "object", @@ -1318,6 +1350,15 @@ "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)." + }, + "serviceEndpoint": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "File service endpoint of the Azure File Storage resource. It is mutually exclusive with connectionString, sasUri property." + }, + "credential": { + "$ref": "../artifacts.json#/definitions/CredentialReference", + "description": "The credential reference containing authentication information." } }, "required": [ @@ -6165,6 +6206,22 @@ "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", "type": "object" }, + "server": { + "type": "object", + "description": "Server name for connection. Type: string." + }, + "port": { + "type": "object", + "description": "The port for the connection. Type: integer." + }, + "uid": { + "type": "object", + "description": "Username for authentication. Type: string." + }, + "database": { + "type": "object", + "description": "Database name for connection. Type: string." + }, "pwd": { "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." diff --git a/specification/translation/Azure.AI.DocumentTranslation/client.tsp b/specification/translation/Azure.AI.DocumentTranslation/client.tsp index 0eb76c501974..121ca660a59a 100644 --- a/specification/translation/Azure.AI.DocumentTranslation/client.tsp +++ b/specification/translation/Azure.AI.DocumentTranslation/client.tsp @@ -77,3 +77,13 @@ interface SingleDocumentTranslationClient { @@access(DocumentTranslation.DocumentsStatus, Access.internal, "python"); @@access(DocumentTranslation.SupportedFileFormats, Access.internal, "python"); @@access(DocumentTranslation.FileFormat, Access.internal, "python"); + +@@clientName(DocumentTranslation.DocumentTranslateBody.body, + "documentTranslateContent", + "csharp,java" +); + +@@clientName(DocumentTranslation.StartTranslationBody.body, + "startTranslationDetails", + "csharp,java" +); diff --git a/specification/translation/Azure.AI.DocumentTranslation/models.tsp b/specification/translation/Azure.AI.DocumentTranslation/models.tsp index 98f36a54789c..892e598176b8 100644 --- a/specification/translation/Azure.AI.DocumentTranslation/models.tsp +++ b/specification/translation/Azure.AI.DocumentTranslation/models.tsp @@ -10,41 +10,6 @@ using TypeSpec.Versioning; namespace DocumentTranslation; @doc("Document Translate Request Content") model DocumentTranslateContent { - @doc(""" - Specifies source language of the input document. - If this parameter isn't specified, automatic language detection is applied to determine the source language. - For example if the source document is written in English, then use sourceLanguage=en - """) - @query("sourceLanguage") - sourceLanguage?: string; - - @doc(""" - Specifies the language of the output document. - The target language must be one of the supported languages included in the translation scope. - For example if you want to translate the document in German language, then use targetLanguage=de - """) - @query("targetLanguage") - targetLanguage: string; - - @doc(""" - A string specifying the category (domain) of the translation. This parameter is used to get translations - from a customized system built with Custom Translator. Add the Category ID from your Custom Translator - project details to this parameter to use your deployed customized system. Default value is: general. - """) - @query("category") - category?: string = "general"; - - @doc(""" - Specifies that the service is allowed to fall back to a general system when a custom system doesn't exist. - Possible values are: true (default) or false. - """) - @query("allowFallback") - allowFallback?: boolean; - - @doc("Content Type as multipart/form-data") - @header - contentType: "multipart/form-data"; - @doc("Document to be translated in the form") document: bytes; @@ -470,3 +435,52 @@ model FileFormat { @doc("Supported Type for this format") type?: string; } + +@doc("Document Translate Request Body") +model DocumentTranslateBody { + @doc(""" + Specifies source language of the input document. + If this parameter isn't specified, automatic language detection is applied to determine the source language. + For example if the source document is written in English, then use sourceLanguage=en + """) + @query("sourceLanguage") + sourceLanguage?: string; + + @doc(""" + Specifies the language of the output document. + The target language must be one of the supported languages included in the translation scope. + For example if you want to translate the document in German language, then use targetLanguage=de + """) + @query("targetLanguage") + targetLanguage: string; + + @doc(""" + A string specifying the category (domain) of the translation. This parameter is used to get translations + from a customized system built with Custom Translator. Add the Category ID from your Custom Translator + project details to this parameter to use your deployed customized system. Default value is: general. + """) + @query("category") + category?: string = "general"; + + @doc(""" + Specifies that the service is allowed to fall back to a general system when a custom system doesn't exist. + Possible values are: true (default) or false. + """) + @query("allowFallback") + allowFallback?: boolean; + + @doc("Content Type as multipart/form-data") + @header + contentType: "multipart/form-data"; + + @doc("Document Translate Request Content") + @body + body: DocumentTranslateContent; +} + +@doc("Start Translation Request Body") +model StartTranslationBody { + @doc("Translation job submission batch request") + @body + body: StartTranslationDetails; +} diff --git a/specification/translation/Azure.AI.DocumentTranslation/routes.tsp b/specification/translation/Azure.AI.DocumentTranslation/routes.tsp index 63a640672fd5..4b556b6496dc 100644 --- a/specification/translation/Azure.AI.DocumentTranslation/routes.tsp +++ b/specification/translation/Azure.AI.DocumentTranslation/routes.tsp @@ -21,7 +21,7 @@ interface DocumentTranslationOperations { @route("document:translate") @post documentTranslate is RpcOperation< - DocumentTranslateContent, + DocumentTranslateBody, DocumentTranslateResult, ServiceTraits >; @@ -54,7 +54,7 @@ interface DocumentTranslationOperations { @route("/document/batches") @post startTranslation is Azure.Core.Foundations.Operation< - StartTranslationDetails, + StartTranslationBody, { @doc("Request has been accepted successfully.") @statusCode diff --git a/specification/translation/data-plane/Azure.AI.DocumentTranslation/stable/2024-05-01/openapi.json b/specification/translation/data-plane/Azure.AI.DocumentTranslation/stable/2024-05-01/openapi.json index 999176fb42ad..a24e8fa059f0 100644 --- a/specification/translation/data-plane/Azure.AI.DocumentTranslation/stable/2024-05-01/openapi.json +++ b/specification/translation/data-plane/Azure.AI.DocumentTranslation/stable/2024-05-01/openapi.json @@ -189,12 +189,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/StartTranslationDetails" - } + "$ref": "#/parameters/StartTranslationBody" } ], "responses": { @@ -577,25 +572,37 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/DocumentTranslateContent.sourceLanguage" + "$ref": "#/parameters/DocumentTranslateBody.sourceLanguage" }, { - "$ref": "#/parameters/DocumentTranslateContent.targetLanguage" + "$ref": "#/parameters/DocumentTranslateBody.targetLanguage" }, { - "$ref": "#/parameters/DocumentTranslateContent.category" + "$ref": "#/parameters/DocumentTranslateBody.category" }, { - "$ref": "#/parameters/DocumentTranslateContent.allowFallback" + "$ref": "#/parameters/DocumentTranslateBody.allowFallback" }, { "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" }, { - "$ref": "#/parameters/DocumentTranslateContent.document" + "name": "document", + "in": "formData", + "description": "Document to be translated in the form", + "required": true, + "type": "file" }, { - "$ref": "#/parameters/DocumentTranslateContent.glossary" + "name": "glossary", + "in": "formData", + "description": "Glossary-translation memory will be used during translation in the form. ", + "required": false, + "type": "array", + "items": { + "type": "string", + "format": "binary" + } } ], "responses": { @@ -1412,7 +1419,7 @@ "x-ms-parameter-location": "method", "x-ms-client-name": "apiVersion" }, - "DocumentTranslateContent.allowFallback": { + "DocumentTranslateBody.allowFallback": { "name": "allowFallback", "in": "query", "description": "Specifies that the service is allowed to fall back to a general system when a custom system doesn't exist. \nPossible values are: true (default) or false.", @@ -1420,7 +1427,7 @@ "type": "boolean", "x-ms-parameter-location": "method" }, - "DocumentTranslateContent.category": { + "DocumentTranslateBody.category": { "name": "category", "in": "query", "description": "A string specifying the category (domain) of the translation. This parameter is used to get translations \nfrom a customized system built with Custom Translator. Add the Category ID from your Custom Translator \nproject details to this parameter to use your deployed customized system. Default value is: general.", @@ -1429,27 +1436,7 @@ "default": "general", "x-ms-parameter-location": "method" }, - "DocumentTranslateContent.document": { - "name": "document", - "in": "formData", - "description": "Document to be translated in the form", - "required": true, - "type": "file", - "x-ms-parameter-location": "method" - }, - "DocumentTranslateContent.glossary": { - "name": "glossary", - "in": "formData", - "description": "Glossary-translation memory will be used during translation in the form. ", - "required": false, - "type": "array", - "items": { - "type": "string", - "format": "binary" - }, - "x-ms-parameter-location": "method" - }, - "DocumentTranslateContent.sourceLanguage": { + "DocumentTranslateBody.sourceLanguage": { "name": "sourceLanguage", "in": "query", "description": "Specifies source language of the input document.\nIf this parameter isn't specified, automatic language detection is applied to determine the source language.\nFor example if the source document is written in English, then use sourceLanguage=en", @@ -1457,13 +1444,23 @@ "type": "string", "x-ms-parameter-location": "method" }, - "DocumentTranslateContent.targetLanguage": { + "DocumentTranslateBody.targetLanguage": { "name": "targetLanguage", "in": "query", "description": "Specifies the language of the output document.\nThe target language must be one of the supported languages included in the translation scope.\nFor example if you want to translate the document in German language, then use targetLanguage=de ", "required": true, "type": "string", "x-ms-parameter-location": "method" + }, + "StartTranslationBody": { + "name": "body", + "in": "body", + "description": "Translation job submission batch request", + "required": true, + "schema": { + "$ref": "#/definitions/StartTranslationDetails" + }, + "x-ms-parameter-location": "method" } } } diff --git a/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_CreateOrUpdate.json b/specification/verifiedid/Microsoft.VerifiedId.Management/examples/2024-01-26-preview/Authorities_CreateOrUpdate.json similarity index 100% rename from specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_CreateOrUpdate.json rename to specification/verifiedid/Microsoft.VerifiedId.Management/examples/2024-01-26-preview/Authorities_CreateOrUpdate.json diff --git a/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Delete.json b/specification/verifiedid/Microsoft.VerifiedId.Management/examples/2024-01-26-preview/Authorities_Delete.json similarity index 100% rename from specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Delete.json rename to specification/verifiedid/Microsoft.VerifiedId.Management/examples/2024-01-26-preview/Authorities_Delete.json diff --git a/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Get.json b/specification/verifiedid/Microsoft.VerifiedId.Management/examples/2024-01-26-preview/Authorities_Get.json similarity index 100% rename from specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Get.json rename to specification/verifiedid/Microsoft.VerifiedId.Management/examples/2024-01-26-preview/Authorities_Get.json diff --git a/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_ListByResourceGroup.json b/specification/verifiedid/Microsoft.VerifiedId.Management/examples/2024-01-26-preview/Authorities_ListByResourceGroup.json similarity index 100% rename from specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_ListByResourceGroup.json rename to specification/verifiedid/Microsoft.VerifiedId.Management/examples/2024-01-26-preview/Authorities_ListByResourceGroup.json diff --git a/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_ListBySubscription.json b/specification/verifiedid/Microsoft.VerifiedId.Management/examples/2024-01-26-preview/Authorities_ListBySubscription.json similarity index 100% rename from specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_ListBySubscription.json rename to specification/verifiedid/Microsoft.VerifiedId.Management/examples/2024-01-26-preview/Authorities_ListBySubscription.json diff --git a/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Update.json b/specification/verifiedid/Microsoft.VerifiedId.Management/examples/2024-01-26-preview/Authorities_Update.json similarity index 100% rename from specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Update.json rename to specification/verifiedid/Microsoft.VerifiedId.Management/examples/2024-01-26-preview/Authorities_Update.json diff --git a/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Operations_List.json b/specification/verifiedid/Microsoft.VerifiedId.Management/examples/2024-01-26-preview/Operations_List.json similarity index 100% rename from specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Operations_List.json rename to specification/verifiedid/Microsoft.VerifiedId.Management/examples/2024-01-26-preview/Operations_List.json diff --git a/specification/verifiedid/Microsoft.VerifiedId.Management/main.tsp b/specification/verifiedid/Microsoft.VerifiedId.Management/main.tsp new file mode 100644 index 000000000000..95d515689465 --- /dev/null +++ b/specification/verifiedid/Microsoft.VerifiedId.Management/main.tsp @@ -0,0 +1,90 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.ResourceManager; + +@armProviderNamespace("Microsoft.VerifiedId") +@service({ + title: "VerifiedIdMgmtClient", +}) +@versioned(Microsoft.VerifiedId.Versions) +@doc("VerifiedId Resource Provider management API.") +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.VerifiedId; + +/** + * Supported versions for Microsoft.VerifiedId. + */ +enum Versions { + /** + * The 2024-01-26-preview version of the Microsoft.VerifiedId resource provider. + */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + v2024_01_26_preview: "2024-01-26-preview", +} + +interface Operations extends Azure.ResourceManager.Operations {} + +@doc("A VerifiedId authority resource") +model Authority is TrackedResource { + @doc("The ID of the authority") + @pattern("^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$") + @key("authorityName") + @segment("authorities") + @path + name: string; +} + +@doc("The status of the current operation.") +@Azure.Core.lroStatus +union ProvisioningState { + string, + ResourceProvisioningState, + + @doc("Initial provisioning in progress") + Provisioning: "Provisioning", + + @doc("Update in progress") + Updating: "Updating", + + @doc("Deletion in progress") + Deleting: "Deleting", + + @doc("Change accepted for processing") + Accepted: "Accepted", +} + +@doc("Details of the VerifiedId Authority.") +model AuthorityProperties { + @visibility("read") + @doc("The status of the last operation.") + provisioningState?: ProvisioningState; +} + +@armResourceOperations(Authority) +interface Authorities { + get is ArmResourceRead; + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrReplaceAsync< + Authority, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; + update is ArmCustomPatchSync< + Authority, + Azure.ResourceManager.Foundations.ResourceUpdateModel< + Authority, + AuthorityProperties + > + >; + delete is ArmResourceDeleteSync; + listByResourceGroup is ArmResourceListByParent; + listBySubscription is ArmListBySubscription; +} diff --git a/specification/verifiedid/Microsoft.VerifiedId.Management/tspconfig.yaml b/specification/verifiedid/Microsoft.VerifiedId.Management/tspconfig.yaml new file mode 100644 index 000000000000..5c512006623e --- /dev/null +++ b/specification/verifiedid/Microsoft.VerifiedId.Management/tspconfig.yaml @@ -0,0 +1,15 @@ +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true + emitter-output-dir: "{project-root}/.." + examples-directory: "examples" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/verifiedid.json" + use-read-only-status-schema: true diff --git a/specification/verifiedid/Microsoft.VerifiedId/main.tsp b/specification/verifiedid/Microsoft.VerifiedId/main.tsp deleted file mode 100644 index e33db6e1b6f7..000000000000 --- a/specification/verifiedid/Microsoft.VerifiedId/main.tsp +++ /dev/null @@ -1,84 +0,0 @@ -import "@typespec/http"; -import "@typespec/rest"; -import "@typespec/versioning"; -import "@azure-tools/typespec-azure-core"; -import "@azure-tools/typespec-azure-resource-manager"; - -using TypeSpec.Http; -using TypeSpec.Rest; -using TypeSpec.Versioning; -using Azure.Core; -using Azure.ResourceManager; - -@armProviderNamespace("Microsoft.VerifiedId") -@service({ - title: "VerifiedIdMgmtClient", -}) -@versioned(Microsoft.VerifiedId.Versions) -@doc("VerifiedId Resource Provider management API.") -@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) -namespace Microsoft.VerifiedId; - -/** - * Supported versions for Microsoft.VerifiedId. - */ -enum Versions { - /** - * The 2024-01-26-preview version of the Microsoft.VerifiedId resource provider. - */ - @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) - v2024_01_26_preview: "2024-01-26-preview", -} - -interface Operations extends Azure.ResourceManager.Operations {} - -@doc("A VerifiedId authority resource") -model Authority is TrackedResource { - @doc("The ID of the authority") - @pattern("^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$") - @key("authorityName") - @segment("authorities") - @path - name: string; -} - -@doc("The status of the current operation.") -@Azure.Core.lroStatus -union ProvisioningState { - string, - ResourceProvisioningState, - - @doc("Initial provisioning in progress") - Provisioning: "Provisioning", - - @doc("Update in progress") - Updating: "Updating", - - @doc("Deletion in progress") - Deleting: "Deleting", - - @doc("Change accepted for processing") - Accepted: "Accepted", -} - -@doc("Details of the VerifiedId Authority.") -model AuthorityProperties { - @visibility("read") - @doc("The status of the last operation.") - provisioningState?: ProvisioningState; -} - -@armResourceOperations(Authority) -interface Authorities { - get is ArmResourceRead; - #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" - @Azure.Core.useFinalStateVia("azure-async-operation") - createOrUpdate is ArmResourceCreateOrReplaceAsync< - Authority, - LroHeaders = Azure.Core.Foundations.RetryAfterHeader - >; - update is ArmResourcePatchSync; - delete is ArmResourceDeleteSync; - listByResourceGroup is ArmResourceListByParent; - listBySubscription is ArmListBySubscription; -} diff --git a/specification/verifiedid/Microsoft.VerifiedId/tspconfig.yaml b/specification/verifiedid/Microsoft.VerifiedId/tspconfig.yaml deleted file mode 100644 index d165ce086157..000000000000 --- a/specification/verifiedid/Microsoft.VerifiedId/tspconfig.yaml +++ /dev/null @@ -1,12 +0,0 @@ -linter: - extends: - - "@azure-tools/typespec-azure-rulesets/resource-manager" -emit: - - "@azure-tools/typespec-autorest" -options: - "@azure-tools/typespec-autorest": - azure-resource-provider-folder: "resource-manager" - emitter-output-dir: "{project-root}/.." - examples-directory: "examples" - output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/verifiedid.json" - use-read-only-status-schema: true diff --git a/specification/verifiedid/resource-manager/readme.md b/specification/verifiedid/resource-manager/readme.md index 1070721e810e..a317a4224d3c 100644 --- a/specification/verifiedid/resource-manager/readme.md +++ b/specification/verifiedid/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-python-track2 + - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_CreateOrUpdate_ArcReg.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_CreateOrUpdate_ArcReg.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_CreateOrUpdate_ArcReg.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_CreateOrUpdate_ArcReg.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_CreateOrUpdate_HCX.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_CreateOrUpdate_HCX.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_CreateOrUpdate_HCX.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_CreateOrUpdate_HCX.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_CreateOrUpdate_SRM.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_CreateOrUpdate_SRM.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_CreateOrUpdate_SRM.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_CreateOrUpdate_SRM.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_CreateOrUpdate_VR.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_CreateOrUpdate_VR.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_CreateOrUpdate_VR.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_CreateOrUpdate_VR.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_Delete.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_Delete.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_Delete.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_Delete.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_Get_ArcReg.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_Get_ArcReg.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_Get_ArcReg.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_Get_ArcReg.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_Get_HCX.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_Get_HCX.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_Get_HCX.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_Get_HCX.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_Get_SRM.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_Get_SRM.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_Get_SRM.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_Get_SRM.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_Get_VR.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_Get_VR.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_Get_VR.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_Get_VR.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Addons_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Addons_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Authorizations_CreateOrUpdate.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Authorizations_CreateOrUpdate.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Authorizations_CreateOrUpdate.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Authorizations_CreateOrUpdate.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Authorizations_Delete.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Authorizations_Delete.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Authorizations_Delete.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Authorizations_Delete.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Authorizations_Get.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Authorizations_Get.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Authorizations_Get.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Authorizations_Get.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Authorizations_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Authorizations_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Authorizations_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Authorizations_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/CloudLinks_CreateOrUpdate.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/CloudLinks_CreateOrUpdate.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/CloudLinks_CreateOrUpdate.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/CloudLinks_CreateOrUpdate.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/CloudLinks_Delete.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/CloudLinks_Delete.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/CloudLinks_Delete.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/CloudLinks_Delete.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/CloudLinks_Get.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/CloudLinks_Get.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/CloudLinks_Get.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/CloudLinks_Get.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/CloudLinks_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/CloudLinks_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/CloudLinks_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/CloudLinks_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Clusters_CreateOrUpdate.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Clusters_CreateOrUpdate.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Clusters_CreateOrUpdate.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Clusters_CreateOrUpdate.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Clusters_Delete.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Clusters_Delete.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Clusters_Delete.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Clusters_Delete.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Clusters_Get.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Clusters_Get.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Clusters_Get.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Clusters_Get.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Clusters_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Clusters_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Clusters_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Clusters_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Clusters_ListZones.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Clusters_ListZones.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Clusters_ListZones.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Clusters_ListZones.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Clusters_ListZones_Stretched.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Clusters_ListZones_Stretched.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Clusters_ListZones_Stretched.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Clusters_ListZones_Stretched.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Clusters_Update.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Clusters_Update.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Clusters_Update.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Clusters_Update.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Datastores_CreateOrUpdate.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Datastores_CreateOrUpdate.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Datastores_CreateOrUpdate.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Datastores_CreateOrUpdate.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Datastores_Delete.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Datastores_Delete.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Datastores_Delete.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Datastores_Delete.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Datastores_Get.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Datastores_Get.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Datastores_Get.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Datastores_Get.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Datastores_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Datastores_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Datastores_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Datastores_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/GlobalReachConnections_CreateOrUpdate.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/GlobalReachConnections_CreateOrUpdate.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/GlobalReachConnections_CreateOrUpdate.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/GlobalReachConnections_CreateOrUpdate.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/GlobalReachConnections_Delete.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/GlobalReachConnections_Delete.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/GlobalReachConnections_Delete.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/GlobalReachConnections_Delete.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/GlobalReachConnections_Get.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/GlobalReachConnections_Get.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/GlobalReachConnections_Get.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/GlobalReachConnections_Get.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/GlobalReachConnections_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/GlobalReachConnections_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/GlobalReachConnections_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/GlobalReachConnections_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/HcxEnterpriseSites_CreateOrUpdate.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/HcxEnterpriseSites_CreateOrUpdate.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/HcxEnterpriseSites_CreateOrUpdate.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/HcxEnterpriseSites_CreateOrUpdate.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/HcxEnterpriseSites_Delete.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/HcxEnterpriseSites_Delete.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/HcxEnterpriseSites_Delete.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/HcxEnterpriseSites_Delete.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/HcxEnterpriseSites_Get.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/HcxEnterpriseSites_Get.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/HcxEnterpriseSites_Get.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/HcxEnterpriseSites_Get.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/HcxEnterpriseSites_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/HcxEnterpriseSites_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/HcxEnterpriseSites_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/HcxEnterpriseSites_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/IscsiPaths_CreateOrUpdate.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/IscsiPaths_CreateOrUpdate.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/IscsiPaths_CreateOrUpdate.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/IscsiPaths_CreateOrUpdate.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/IscsiPaths_Delete.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/IscsiPaths_Delete.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/IscsiPaths_Delete.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/IscsiPaths_Delete.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/IscsiPaths_Get.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/IscsiPaths_Get.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/IscsiPaths_Get.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/IscsiPaths_Get.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/IscsiPaths_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/IscsiPaths_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/IscsiPaths_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/IscsiPaths_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Locations_CheckQuotaAvailability.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Locations_CheckQuotaAvailability.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Locations_CheckQuotaAvailability.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Locations_CheckQuotaAvailability.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Locations_CheckTrialAvailability.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Locations_CheckTrialAvailability.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Locations_CheckTrialAvailability.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Locations_CheckTrialAvailability.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Locations_CheckTrialAvailabilityWithSku.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Locations_CheckTrialAvailabilityWithSku.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Locations_CheckTrialAvailabilityWithSku.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Locations_CheckTrialAvailabilityWithSku.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/Operations_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Operations_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/Operations_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/Operations_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PlacementPolicies_CreateOrUpdate.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PlacementPolicies_CreateOrUpdate.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PlacementPolicies_CreateOrUpdate.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PlacementPolicies_CreateOrUpdate.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PlacementPolicies_Delete.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PlacementPolicies_Delete.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PlacementPolicies_Delete.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PlacementPolicies_Delete.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PlacementPolicies_Get.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PlacementPolicies_Get.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PlacementPolicies_Get.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PlacementPolicies_Get.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PlacementPolicies_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PlacementPolicies_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PlacementPolicies_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PlacementPolicies_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PlacementPolicies_Update.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PlacementPolicies_Update.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PlacementPolicies_Update.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PlacementPolicies_Update.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_CreateOrUpdate.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_CreateOrUpdate.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_CreateOrUpdate.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_CreateOrUpdate.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_CreateOrUpdate_Stretched.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_CreateOrUpdate_Stretched.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_CreateOrUpdate_Stretched.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_CreateOrUpdate_Stretched.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_Delete.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_Delete.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_Delete.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_Delete.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_Get.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_Get.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_Get.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_Get.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_Get_Stretched.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_Get_Stretched.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_Get_Stretched.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_Get_Stretched.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_ListAdminCredentials.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_ListAdminCredentials.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_ListAdminCredentials.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_ListAdminCredentials.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_ListInSubscription.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_ListInSubscription.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_ListInSubscription.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_ListInSubscription.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_ListInSubscription_Stretched.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_ListInSubscription_Stretched.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_ListInSubscription_Stretched.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_ListInSubscription_Stretched.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_List_Stretched.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_List_Stretched.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_List_Stretched.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_List_Stretched.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_RotateNsxtPassword.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_RotateNsxtPassword.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_RotateNsxtPassword.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_RotateNsxtPassword.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_RotateVcenterPassword.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_RotateVcenterPassword.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_RotateVcenterPassword.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_RotateVcenterPassword.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_Update.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_Update.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_Update.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_Update.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_Update_Stretched.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_Update_Stretched.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/PrivateClouds_Update_Stretched.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/PrivateClouds_Update_Stretched.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptCmdlets_Get.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptCmdlets_Get.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptCmdlets_Get.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptCmdlets_Get.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptCmdlets_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptCmdlets_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptCmdlets_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptCmdlets_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptExecutions_CreateOrUpdate.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptExecutions_CreateOrUpdate.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptExecutions_CreateOrUpdate.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptExecutions_CreateOrUpdate.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptExecutions_Delete.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptExecutions_Delete.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptExecutions_Delete.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptExecutions_Delete.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptExecutions_Get.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptExecutions_Get.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptExecutions_Get.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptExecutions_Get.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptExecutions_GetExecutionLogs.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptExecutions_GetExecutionLogs.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptExecutions_GetExecutionLogs.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptExecutions_GetExecutionLogs.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptExecutions_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptExecutions_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptExecutions_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptExecutions_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptPackages_Get.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptPackages_Get.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptPackages_Get.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptPackages_Get.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptPackages_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptPackages_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/ScriptPackages_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/ScriptPackages_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/VirtualMachines_Get.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/VirtualMachines_Get.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/VirtualMachines_Get.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/VirtualMachines_Get.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/VirtualMachines_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/VirtualMachines_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/VirtualMachines_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/VirtualMachines_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/VirtualMachines_RestrictMovement.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/VirtualMachines_RestrictMovement.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/VirtualMachines_RestrictMovement.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/VirtualMachines_RestrictMovement.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_CreateDhcp.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_CreateDhcp.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_CreateDhcp.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_CreateDhcp.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_CreateDnsService.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_CreateDnsService.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_CreateDnsService.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_CreateDnsService.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_CreateDnsZone.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_CreateDnsZone.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_CreateDnsZone.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_CreateDnsZone.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_CreatePortMirroring.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_CreatePortMirroring.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_CreatePortMirroring.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_CreatePortMirroring.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_CreatePublicIP.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_CreatePublicIP.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_CreatePublicIP.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_CreatePublicIP.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_CreateSegments.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_CreateSegments.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_CreateSegments.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_CreateSegments.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_CreateVMGroup.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_CreateVMGroup.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_CreateVMGroup.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_CreateVMGroup.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_DeleteDhcp.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_DeleteDhcp.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_DeleteDhcp.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_DeleteDhcp.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_DeleteDnsService.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_DeleteDnsService.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_DeleteDnsService.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_DeleteDnsService.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_DeleteDnsZone.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_DeleteDnsZone.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_DeleteDnsZone.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_DeleteDnsZone.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_DeletePortMirroring.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_DeletePortMirroring.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_DeletePortMirroring.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_DeletePortMirroring.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_DeletePublicIP.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_DeletePublicIP.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_DeletePublicIP.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_DeletePublicIP.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_DeleteSegment.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_DeleteSegment.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_DeleteSegment.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_DeleteSegment.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_DeleteVMGroup.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_DeleteVMGroup.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_DeleteVMGroup.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_DeleteVMGroup.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_Get.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_Get.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_Get.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_Get.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetDhcp.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetDhcp.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetDhcp.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetDhcp.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetDnsService.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetDnsService.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetDnsService.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetDnsService.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetDnsZone.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetDnsZone.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetDnsZone.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetDnsZone.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetGateway.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetGateway.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetGateway.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetGateway.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetPortMirroring.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetPortMirroring.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetPortMirroring.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetPortMirroring.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetPublicIP.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetPublicIP.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetPublicIP.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetPublicIP.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetSegment.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetSegment.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetSegment.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetSegment.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetVMGroup.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetVMGroup.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetVMGroup.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetVMGroup.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetVirtualMachine.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetVirtualMachine.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_GetVirtualMachine.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_GetVirtualMachine.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_List.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_List.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_List.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_List.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListDhcp.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListDhcp.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListDhcp.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListDhcp.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListDnsServices.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListDnsServices.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListDnsServices.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListDnsServices.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListDnsZones.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListDnsZones.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListDnsZones.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListDnsZones.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListGateways.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListGateways.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListGateways.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListGateways.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListPortMirroring.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListPortMirroring.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListPortMirroring.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListPortMirroring.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListPublicIPs.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListPublicIPs.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListPublicIPs.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListPublicIPs.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListSegments.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListSegments.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListSegments.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListSegments.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListVMGroups.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListVMGroups.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListVMGroups.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListVMGroups.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListVirtualMachines.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListVirtualMachines.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_ListVirtualMachines.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_ListVirtualMachines.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_UpdateDhcp.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_UpdateDhcp.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_UpdateDhcp.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_UpdateDhcp.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_UpdateDnsService.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_UpdateDnsService.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_UpdateDnsService.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_UpdateDnsService.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_UpdateDnsZone.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_UpdateDnsZone.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_UpdateDnsZone.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_UpdateDnsZone.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_UpdatePortMirroring.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_UpdatePortMirroring.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_UpdatePortMirroring.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_UpdatePortMirroring.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_UpdateSegments.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_UpdateSegments.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_UpdateSegments.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_UpdateSegments.json diff --git a/specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_UpdateVMGroup.json b/specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_UpdateVMGroup.json similarity index 100% rename from specification/vmware/Microsoft.AVS/examples/2023-09-01/WorkloadNetworks_UpdateVMGroup.json rename to specification/vmware/Microsoft.AVS.Management/examples/2023-09-01/WorkloadNetworks_UpdateVMGroup.json diff --git a/specification/vmware/Microsoft.AVS/main.tsp b/specification/vmware/Microsoft.AVS.Management/main.tsp similarity index 100% rename from specification/vmware/Microsoft.AVS/main.tsp rename to specification/vmware/Microsoft.AVS.Management/main.tsp diff --git a/specification/vmware/Microsoft.AVS/models.tsp b/specification/vmware/Microsoft.AVS.Management/models.tsp similarity index 100% rename from specification/vmware/Microsoft.AVS/models.tsp rename to specification/vmware/Microsoft.AVS.Management/models.tsp diff --git a/specification/vmware/Microsoft.AVS.Management/routes.tsp b/specification/vmware/Microsoft.AVS.Management/routes.tsp new file mode 100644 index 000000000000..8775e4143c88 --- /dev/null +++ b/specification/vmware/Microsoft.AVS.Management/routes.tsp @@ -0,0 +1,1192 @@ +import "@azure-tools/typespec-azure-core"; +import "@typespec/rest"; +import "@azure-tools/typespec-client-generator-core"; +import "./models.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; +using Azure.ClientGenerator.Core; +using OpenAPI; + +namespace Microsoft.AVS; + +interface Operations extends Azure.ResourceManager.Operations {} + +@armResourceOperations +interface Locations { + @doc("Return trial status for subscription by region") + @armResourceAction(Location) + checkTrialAvailability( + ...ResourceInstanceParameters, + + @doc("Optionally, check for a specific SKU") + @bodyRoot + sku?: Sku, + ): ArmResponse | ErrorResponse; + + @doc("Return quota for subscription by region") + @armResourceAction(Location) + @post + checkQuotaAvailability( + ...ResourceInstanceParameters, + ): ArmResponse | ErrorResponse; +} + +alias PrivateCloudList = ResourceList; +@armResourceOperations +interface PrivateClouds { + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("PrivateClouds_List") + list is ArmResourceListByParent< + PrivateCloud, + Response = ArmResponse + >; + + listInSubscription is ArmListBySubscription< + PrivateCloud, + Response = ArmResponse + >; + + get is ArmResourceRead; + + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + PrivateCloud, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; + + // This could be modeled with ArmCustomPatchAsync if a 202 response with no body is used instead of a 201. + // update is ArmCustomPatchAsync; + @doc("Update a PrivateCloud") + @extension("x-ms-long-running-operation", true) + @extension( + "x-ms-long-running-operation-options", + { + `final-state-via`: "location", + } + ) + @armResourceUpdate(PrivateCloud) + @patch + update( + ...ResourceInstanceParameters, + + @bodyRoot + @doc("The private cloud properties to be updated.") + privateCloudUpdate: PrivateCloudUpdate, + ): ArmResponse | { + // @doc("Resource update request created.") + ...CreatedResponse; + + ...Azure.Core.Foundations.RetryAfterHeader; + ...LocationHeader; + + @bodyRoot + @doc("The updated private cloud.") + placementPolicy: PrivateCloud; + } | ErrorResponse; + + #suppress "deprecated" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" + delete is ArmResourceDeleteAsync; + + #suppress "@azure-tools/typespec-azure-resource-manager/arm-post-operation-response-codes" "Existing API" + @doc("Rotate the vCenter password") + rotateVcenterPassword is ArmResourceActionNoContentAsyncNoRequestBody; + + #suppress "@azure-tools/typespec-azure-resource-manager/arm-post-operation-response-codes" "Existing API" + @doc("Rotate the NSX-T Manager password") + rotateNsxtPassword is ArmResourceActionNoContentAsyncNoRequestBody; + + @doc("List the admin credentials for the private cloud") + listAdminCredentials is ArmResourceActionSyncNoRequestBody< + PrivateCloud, + AdminCredentials + >; +} + +@@encodedName(PrivateClouds.createOrUpdate::parameters.resource, + "application/json", + "privateCloud" +); +@@OpenAPI.extension(PrivateClouds.createOrUpdate::parameters.resource, + "x-ms-client-name", + "privateCloud" +); +@@clientName(PrivateClouds.createOrUpdate::parameters.resource, "privateCloud"); + +@armResourceOperations +interface Clusters { + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("Clusters_List") + list is ArmResourceListByParent< + Cluster, + Response = ArmResponse> + >; + + get is ArmResourceRead; + + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + Cluster, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; + + // This could be modeled with ArmCustomPatchAsync if a 202 response with no body is used instead of a 201. + // update is ArmCustomPatchAsync; + @doc("Update a Cluster") + @extension("x-ms-long-running-operation", true) + @extension( + "x-ms-long-running-operation-options", + { + `final-state-via`: "location", + } + ) + @armResourceUpdate(Cluster) + @patch + update( + ...ResourceInstanceParameters, + + @bodyRoot + @doc("The cluster properties to be updated.") + clusterUpdate: ClusterUpdate, + ): ArmResponse | { + // @doc("Resource update request created.") + ...CreatedResponse; + + ...Azure.Core.Foundations.RetryAfterHeader; + ...LocationHeader; + + @bodyRoot + @doc("The updated cluster.") + cluster: Cluster; + } | ErrorResponse; + + #suppress "deprecated" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" + delete is ArmResourceDeleteAsync; + + @doc("List hosts by zone in a cluster") + listZones is ArmResourceActionSyncNoRequestBody; +} + +@@encodedName(Clusters.createOrUpdate::parameters.resource, + "application/json", + "cluster" +); +@@OpenAPI.extension(Clusters.createOrUpdate::parameters.resource, + "x-ms-client-name", + "cluster" +); +@@clientName(Clusters.createOrUpdate::parameters.resource, "cluster"); + +@armResourceOperations +interface Datastores { + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("Datastores_List") + list is ArmResourceListByParent< + Datastore, + Response = ArmResponse> + >; + + get is ArmResourceRead; + + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + Datastore, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; + + #suppress "deprecated" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" + delete is ArmResourceDeleteAsync; +} + +@@encodedName(Datastores.createOrUpdate::parameters.resource, + "application/json", + "datastore" +); +@@clientName(Datastores.createOrUpdate::parameters.resource, "datastore"); +@@OpenAPI.extension(Datastores.createOrUpdate::parameters.resource, + "x-ms-client-name", + "datastore" +); + +@armResourceOperations +interface HcxEnterpriseSites { + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("HcxEnterpriseSites_List") + list is ArmResourceListByParent< + HcxEnterpriseSite, + Response = ArmResponse> + >; + + get is ArmResourceRead; + + createOrUpdate is ArmResourceCreateOrReplaceSync; + + delete is ArmResourceDeleteSync; +} + +@@encodedName(HcxEnterpriseSites.createOrUpdate::parameters.resource, + "application/json", + "hcxEnterpriseSite" +); +@@clientName(HcxEnterpriseSites.createOrUpdate::parameters.resource, + "hcxEnterpriseSite" +); +@@OpenAPI.extension(HcxEnterpriseSites.createOrUpdate::parameters.resource, + "x-ms-client-name", + "hcxEnterpriseSite" +); + +@armResourceOperations +interface Authorizations { + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("Authorizations_List") + list is ArmResourceListByParent< + ExpressRouteAuthorization, + Response = ArmResponse> + >; + + get is ArmResourceRead; + + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST REMOVE AT NEXT API VERSION UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + ExpressRouteAuthorization, + BaseParameters, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; + + #suppress "deprecated" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" + delete is ArmResourceDeleteAsync; +} + +@@encodedName(Authorizations.createOrUpdate::parameters.resource, + "application/json", + "authorization" +); +@@clientName(Authorizations.createOrUpdate::parameters.resource, + "authorization" +); +@@OpenAPI.extension(Authorizations.createOrUpdate::parameters.resource, + "x-ms-client-name", + "authorization" +); + +@armResourceOperations +interface GlobalReachConnections { + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("GlobalReachConnections_List") + list is ArmResourceListByParent< + GlobalReachConnection, + Response = ArmResponse> + >; + + get is ArmResourceRead; + + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + GlobalReachConnection, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; + + #suppress "deprecated" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" + delete is ArmResourceDeleteAsync; +} + +@@encodedName(GlobalReachConnections.createOrUpdate::parameters.resource, + "application/json", + "globalReachConnection" +); +@@clientName(GlobalReachConnections.createOrUpdate::parameters.resource, + "globalReachConnection" +); +@@OpenAPI.extension(GlobalReachConnections.createOrUpdate::parameters.resource, + "x-ms-client-name", + "globalReachConnection" +); + +@armResourceOperations +interface WorkloadNetworks { + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_Get") + get is ArmResourceRead; + + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_List") + list is ArmResourceListByParent< + WorkloadNetwork, + Response = ArmResponse> + >; +} + +@armResourceOperations +interface WorkloadNetworkSegments { + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_ListSegments") + list is ArmResourceListByParent< + WorkloadNetworkSegment, + Response = ArmResponse> + >; + + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_GetSegment") + get is ArmResourceRead; + + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @operationId("WorkloadNetworks_CreateSegments") + @Azure.Core.useFinalStateVia("azure-async-operation") + create is ArmResourceCreateOrUpdateAsync< + WorkloadNetworkSegment, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; + + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_UpdateSegments") + @parameterVisibility + update is ArmCustomPatchAsync; + + #suppress "deprecated" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_DeleteSegment") + deleteSegment is ArmResourceDeleteAsync; +} + +@@encodedName(WorkloadNetworkSegments.create::parameters.resource, + "application/json", + "workloadNetworkSegment" +); +@@clientName(WorkloadNetworkSegments.create::parameters.resource, + "workloadNetworkSegment" +); +@@OpenAPI.extension(WorkloadNetworkSegments.create::parameters.resource, + "x-ms-client-name", + "workloadNetworkSegment" +); + +@@encodedName(WorkloadNetworkSegments.update::parameters.properties, + "application/json", + "workloadNetworkSegment" +); +@@clientName(WorkloadNetworkSegments.update::parameters.properties, + "application/json", + "workloadNetworkSegment" +); +@@OpenAPI.extension(WorkloadNetworkSegments.update::parameters.properties, + "x-ms-client-name", + "workloadNetworkSegment" +); + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" +// @armResourceOperations +interface WorkloadNetworkDhcpConfigurations { + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_ListDhcp") + list is ArmResourceListByParent< + WorkloadNetworkDhcp, + Response = ArmResponse> + >; + + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "DhcpIdParameter should be last, but it is breaking to correct it." + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_GetDhcp") + // get is ArmResourceRead; + @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}") + @doc("Get a {name}", WorkloadNetworkDhcp) + @get + get( + ...BaseParameters, + ...DhcpIdParameter, + ...PrivateCloudNameParameter, + ): ArmResponse | ErrorResponse; + + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @operationId("WorkloadNetworks_CreateDhcp") + @Azure.Core.useFinalStateVia("azure-async-operation") + create is ArmResourceCreateOrUpdateAsync< + WorkloadNetworkDhcp, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; + + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_UpdateDhcp") + @parameterVisibility + update is ArmCustomPatchAsync; + + #suppress "deprecated" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_DeleteDhcp") + delete is ArmResourceDeleteAsync; +} + +@@encodedName(WorkloadNetworkDhcpConfigurations.create::parameters.resource, + "application/json", + "workloadNetworkDhcp" +); +@@clientName(WorkloadNetworkDhcpConfigurations.create::parameters.resource, + "workloadNetworkDhcp" +); +@@OpenAPI.extension(WorkloadNetworkDhcpConfigurations.create::parameters.resource, + "x-ms-client-name", + "workloadNetworkDhcp" +); + +@@encodedName(WorkloadNetworkDhcpConfigurations.update::parameters.properties, + "application/json", + "workloadNetworkDhcp" +); +@@clientName(WorkloadNetworkDhcpConfigurations.update::parameters.properties, + "workloadNetworkDhcp" +); +@@OpenAPI.extension(WorkloadNetworkDhcpConfigurations.update::parameters.properties, + "x-ms-client-name", + "workloadNetworkDhcp" +); + +@@encodedName(WorkloadNetworkDhcpConfigurations.update::parameters.properties, + "application/json", + "workloadNetworkDhcp" +); +@@clientName(WorkloadNetworkDhcpConfigurations.update::parameters.properties, + "workloadNetworkDhcp" +); +@@OpenAPI.extension(WorkloadNetworkDhcpConfigurations.update::parameters.properties, + "x-ms-client-name", + "workloadNetworkDhcp" +); + +@armResourceOperations +interface WorkloadNetworkGateways { + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_ListGateways") + list is ArmResourceListByParent< + WorkloadNetworkGateway, + Response = ArmResponse> + >; + + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_GetGateway") + get is ArmResourceRead; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" +#suppress "@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation" +// @armResourceOperations +@doc("Workload Network Port Mirroring Profiles") +interface WorkloadNetworkPortMirroringProfiles { + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_ListPortMirroring") + list is ArmResourceListByParent< + WorkloadNetworkPortMirroring, + Response = ArmResponse> + >; + + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_GetPortMirroring") + get is ArmResourceRead; + + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @operationId("WorkloadNetworks_CreatePortMirroring") + @Azure.Core.useFinalStateVia("azure-async-operation") + create is ArmResourceCreateOrUpdateAsync< + WorkloadNetworkPortMirroring, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; + + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_UpdatePortMirroring") + @parameterVisibility + update is ArmCustomPatchAsync< + WorkloadNetworkPortMirroring, + WorkloadNetworkPortMirroring + >; + + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "PortMirroringProfileParameter should be last, but it is breaking to correct it." + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_DeletePortMirroring") + // delete is ArmResourceDeleteAsync; + @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}") + @doc("Delete a {name}", WorkloadNetworkPortMirroring) + @delete + @extension("x-ms-long-running-operation", true) + @extension( + "x-ms-long-running-operation-options", + { + `final-state-via`: "location", + } + ) + delete( + ...BaseParameters, + ...PortMirroringProfileParameter, + ...PrivateCloudNameParameter, + ): + | ArmDeletedResponse + | ArmDeleteAcceptedLroResponse + | ArmDeletedNoContentResponse + | ErrorResponse; +} + +@@encodedName(WorkloadNetworkPortMirroringProfiles.create::parameters.resource, + "application/json", + "workloadNetworkPortMirroring" +); +@@clientName(WorkloadNetworkPortMirroringProfiles.create::parameters.resource, + "workloadNetworkPortMirroring" +); +@@OpenAPI.extension(WorkloadNetworkPortMirroringProfiles.create::parameters.resource, + "x-ms-client-name", + "workloadNetworkPortMirroring" +); + +@@encodedName(WorkloadNetworkPortMirroringProfiles.update::parameters.properties, + "application/json", + "workloadNetworkPortMirroring" +); +@@clientName(WorkloadNetworkPortMirroringProfiles.update::parameters.properties, + "workloadNetworkPortMirroring" +); +@@OpenAPI.extension(WorkloadNetworkPortMirroringProfiles.update::parameters.properties, + "x-ms-client-name", + "workloadNetworkPortMirroring" +); + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" +#suppress "@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation" +// @armResourceOperations +@doc("Workload Network VM Groups") +interface WorkloadNetworkVmGroups { + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_ListVMGroups") + list is ArmResourceListByParent< + WorkloadNetworkVMGroup, + Response = ArmResponse> + >; + + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_GetVMGroup") + get is ArmResourceRead; + + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @operationId("WorkloadNetworks_CreateVMGroup") + @Azure.Core.useFinalStateVia("azure-async-operation") + create is ArmResourceCreateOrUpdateAsync< + WorkloadNetworkVMGroup, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; + + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_UpdateVMGroup") + @parameterVisibility + update is ArmCustomPatchAsync; + + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "VmGroupIdParameter should be last, but it is breaking to correct it." + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_DeleteVMGroup") + // delete is ArmResourceDeleteAsync; + @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}") + @doc("Delete a {name}", WorkloadNetworkVMGroup) + @delete + @extension("x-ms-long-running-operation", true) + @extension( + "x-ms-long-running-operation-options", + { + `final-state-via`: "location", + } + ) + delete( + ...BaseParameters, + ...VmGroupIdParameter, + ...PrivateCloudNameParameter, + ): + | ArmDeletedResponse + | ArmDeleteAcceptedLroResponse + | ArmDeletedNoContentResponse + | ErrorResponse; +} + +@@encodedName(WorkloadNetworkVmGroups.create::parameters.resource, + "application/json", + "workloadNetworkVMGroup" +); +@@clientName(WorkloadNetworkVmGroups.create::parameters.resource, + "application/json", + "workloadNetworkVMGroup" +); +@@OpenAPI.extension(WorkloadNetworkVmGroups.create::parameters.resource, + "x-ms-client-name", + "workloadNetworkVMGroup" +); + +@@encodedName(WorkloadNetworkVmGroups.update::parameters.properties, + "application/json", + "workloadNetworkVMGroup" +); +@@clientName(WorkloadNetworkVmGroups.update::parameters.properties, + "workloadNetworkVMGroup" +); +@@OpenAPI.extension(WorkloadNetworkVmGroups.update::parameters.properties, + "x-ms-client-name", + "workloadNetworkVMGroup" +); + +@armResourceOperations +interface WorkloadNetworkVirtualMachines { + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_ListVirtualMachines") + list is ArmResourceListByParent< + WorkloadNetworkVirtualMachine, + Response = ArmResponse> + >; + + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_GetVirtualMachine") + get is ArmResourceRead; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" +#suppress "@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation" +// @armResourceOperations +@doc("Workload Network Dns Services") +interface WorkloadNetworkDnsServices { + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_ListDnsServices") + list is ArmResourceListByParent< + WorkloadNetworkDnsService, + Response = ArmResponse> + >; + + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_GetDnsService") + get is ArmResourceRead; + + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @operationId("WorkloadNetworks_CreateDnsService") + @Azure.Core.useFinalStateVia("azure-async-operation") + create is ArmResourceCreateOrUpdateAsync< + WorkloadNetworkDnsService, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; + + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_UpdateDnsService") + @parameterVisibility + update is ArmCustomPatchAsync< + WorkloadNetworkDnsService, + WorkloadNetworkDnsService + >; + + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "DnsServiceIdParameter should be last, but it is breaking to correct it." + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_DeleteDnsService") + // delete is ArmResourceDeleteAsync; + @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}") + @doc("Delete a {name}", WorkloadNetworkDnsService) + @delete + @extension("x-ms-long-running-operation", true) + @extension( + "x-ms-long-running-operation-options", + { + `final-state-via`: "location", + } + ) + delete( + ...BaseParameters, + ...DnsServiceIdParameter, + ...PrivateCloudNameParameter, + ): + | ArmDeletedResponse + | ArmDeleteAcceptedLroResponse + | ArmDeletedNoContentResponse + | ErrorResponse; +} + +@@encodedName(WorkloadNetworkDnsServices.create::parameters.resource, + "application/json", + "workloadNetworkDnsService" +); +@@clientName(WorkloadNetworkDnsServices.create::parameters.resource, + "workloadNetworkDnsService" +); +@@OpenAPI.extension(WorkloadNetworkDnsServices.create::parameters.resource, + "x-ms-client-name", + "workloadNetworkDnsService" +); + +@@encodedName(WorkloadNetworkDnsServices.update::parameters.properties, + "application/json", + "workloadNetworkDnsService" +); +@@clientName(WorkloadNetworkDnsServices.update::parameters.properties, + "workloadNetworkDnsService" +); +@@OpenAPI.extension(WorkloadNetworkDnsServices.update::parameters.properties, + "x-ms-client-name", + "workloadNetworkDnsService" +); + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" +#suppress "@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation" +// @armResourceOperations +@doc("Workload Network DNS Zones") +interface WorkloadNetworkDnsZones { + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_ListDnsZones") + list is ArmResourceListByParent< + WorkloadNetworkDnsZone, + Response = ArmResponse> + >; + + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_GetDnsZone") + get is ArmResourceRead; + + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @operationId("WorkloadNetworks_CreateDnsZone") + @Azure.Core.useFinalStateVia("azure-async-operation") + create is ArmResourceCreateOrUpdateAsync< + WorkloadNetworkDnsZone, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; + + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_UpdateDnsZone") + @parameterVisibility + update is ArmCustomPatchAsync; + + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "DnsZoneIdParameter should be last, but it is breaking to correct it." + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_DeleteDnsZone") + // delete is ArmResourceDeleteAsync; + @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId}") + @doc("Delete a {name}", WorkloadNetworkDnsZone) + @delete + @extension("x-ms-long-running-operation", true) + @extension( + "x-ms-long-running-operation-options", + { + `final-state-via`: "location", + } + ) + delete( + ...BaseParameters, + ...DnsZoneIdParameter, + ...PrivateCloudNameParameter, + ): + | ArmDeletedResponse + | ArmDeleteAcceptedLroResponse + | ArmDeletedNoContentResponse + | ErrorResponse; +} + +@@encodedName(WorkloadNetworkDnsZones.create::parameters.resource, + "application/json", + "workloadNetworkDnsZone" +); +@@clientName(WorkloadNetworkDnsZones.create::parameters.resource, + "workloadNetworkDnsZone" +); +@@OpenAPI.extension(WorkloadNetworkDnsZones.create::parameters.resource, + "x-ms-client-name", + "workloadNetworkDnsZone" +); + +@@encodedName(WorkloadNetworkDnsZones.update::parameters.properties, + "application/json", + "workloadNetworkDnsZone" +); +@@clientName(WorkloadNetworkDnsZones.update::parameters.properties, + "workloadNetworkDnsZone" +); +@@OpenAPI.extension(WorkloadNetworkDnsZones.update::parameters.properties, + "x-ms-client-name", + "workloadNetworkDnsZone" +); + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" +#suppress "@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation" +// @armResourceOperations +interface WorkloadNetworkPublicIps { + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_ListPublicIPs") + list is ArmResourceListByParent< + WorkloadNetworkPublicIP, + Response = ArmResponse> + >; + + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_GetPublicIP") + get is ArmResourceRead; + + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @operationId("WorkloadNetworks_CreatePublicIP") + @Azure.Core.useFinalStateVia("azure-async-operation") + create is ArmResourceCreateOrUpdateAsync< + WorkloadNetworkPublicIP, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; + + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "PublicIPIdParameter should be last, but it is breaking to correct it." + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("WorkloadNetworks_DeletePublicIP") + // delete is ArmResourceDeleteAsync; + @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/publicIPs/{publicIPId}") + @doc("Delete a {name}", WorkloadNetworkPublicIP) + @delete + @extension("x-ms-long-running-operation", true) + @extension( + "x-ms-long-running-operation-options", + { + `final-state-via`: "location", + } + ) + delete( + ...BaseParameters, + ...PublicIPIdParameter, + ...PrivateCloudNameParameter, + ): + | ArmDeletedResponse + | ArmDeleteAcceptedLroResponse + | ArmDeletedNoContentResponse + | ErrorResponse; +} + +@@encodedName(WorkloadNetworkPublicIps.create::parameters.resource, + "application/json", + "workloadNetworkPublicIP" +); +@@clientName(WorkloadNetworkPublicIps.create::parameters.resource, + "workloadNetworkPublicIP" +); +@@OpenAPI.extension(WorkloadNetworkPublicIps.create::parameters.resource, + "x-ms-client-name", + "workloadNetworkPublicIP" +); + +@armResourceOperations +interface CloudLinks { + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("CloudLinks_List") + list is ArmResourceListByParent< + CloudLink, + Response = ArmResponse> + >; + + get is ArmResourceRead; + + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + CloudLink, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; + + #suppress "deprecated" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" + delete is ArmResourceDeleteAsync; +} + +@@encodedName(CloudLinks.createOrUpdate::parameters.resource, + "application/json", + "cloudLink" +); +@@clientName(CloudLinks.createOrUpdate::parameters.resource, "cloudLink"); +@@OpenAPI.extension(CloudLinks.createOrUpdate::parameters.resource, + "x-ms-client-name", + "cloudLink" +); + +@armResourceOperations +interface Addons { + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("Addons_List") + list is ArmResourceListByParent< + Addon, + Response = ArmResponse> + >; + + get is ArmResourceRead; + + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + Addon, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; + + #suppress "deprecated" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" + delete is ArmResourceDeleteAsync; +} + +@@encodedName(Addons.createOrUpdate::parameters.resource, + "application/json", + "addon" +); +@@clientName(Addons.createOrUpdate::parameters.resource, "addon"); +@@OpenAPI.extension(Addons.createOrUpdate::parameters.resource, + "x-ms-client-name", + "addon" +); + +@armResourceOperations +interface VirtualMachines { + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("VirtualMachines_List") + list is ArmResourceListByParent< + VirtualMachine, + Response = ArmResponse> + >; + + get is ArmResourceRead; + + // restrictMovement should be a ArmResourceActionNoContentAsync, but does not respond with a 204. + @doc("Enable or disable DRS-driven VM movement restriction") + @armResourceAction(Location) + @post + @extension("x-ms-long-running-operation", true) + restrictMovement( + ...ResourceInstanceParameters, + + @bodyRoot + @doc("The body type of the operation request.") + restrictMovement: VirtualMachineRestrictMovement, + ): ArmAcceptedLroResponse | ErrorResponse; +} + +@armResourceOperations +interface PlacementPolicies { + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("PlacementPolicies_List") + list is ArmResourceListByParent< + PlacementPolicy, + Response = ArmResponse> + >; + + get is ArmResourceRead; + + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + PlacementPolicy, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; + + // 202 response has a body, but it should not to match ArmCustomPatchAsync. + // update is ArmCustomPatchAsync; + #suppress "@azure-tools/typespec-azure-resource-manager/no-response-body" + @doc("Update a PlacementPolicy") + @extension("x-ms-long-running-operation", true) + @extension( + "x-ms-long-running-operation-options", + { + `final-state-via`: "location", + } + ) + @armResourceUpdate(PlacementPolicy) + @patch + update( + ...ResourceInstanceParameters, + + @bodyRoot + @doc("The placement policy properties to be updated.") + placementPolicyUpdate: PlacementPolicyUpdate, + ): ArmResponse | { + ...AcceptedResponse; + ...Azure.Core.Foundations.RetryAfterHeader; + ...LocationHeader; + + @bodyRoot + @doc("The updatd placement policy.") + placementPolicy: PlacementPolicy; + } | ErrorResponse; + + #suppress "deprecated" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" + delete is ArmResourceDeleteAsync; +} + +@@encodedName(PlacementPolicies.createOrUpdate::parameters.resource, + "application/json", + "placementPolicy" +); +@@clientName(PlacementPolicies.createOrUpdate::parameters.resource, + "placementPolicy" +); +@@OpenAPI.extension(PlacementPolicies.createOrUpdate::parameters.resource, + "x-ms-client-name", + "placementPolicy" +); + +@armResourceOperations +interface ScriptPackages { + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("ScriptPackages_List") + list is ArmResourceListByParent< + ScriptPackage, + Response = ArmResponse> + >; + + get is ArmResourceRead; +} + +@armResourceOperations +interface ScriptCmdlets { + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("ScriptCmdlets_List") + list is ArmResourceListByParent< + ScriptCmdlet, + Response = ArmResponse> + >; + + get is ArmResourceRead; +} + +@armResourceOperations +interface ScriptExecutions { + #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." + @operationId("ScriptExecutions_List") + list is ArmResourceListByParent< + ScriptExecution, + Response = ArmResponse> + >; + + get is ArmResourceRead; + + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + ScriptExecution, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; + + #suppress "deprecated" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" + delete is ArmResourceDeleteAsync; + + @doc("Return the logs for a script execution resource") + @autoRoute + @armResourceAction(ScriptExecution) + @post + getExecutionLogs( + ...ResourceInstanceParameters, + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" + @bodyRoot + @doc("Name of the desired output stream to return. If not provided, will return all. An empty array will return nothing.") + scriptOutputStreamType?: ScriptOutputStreamType[], + ): ArmResponse | ErrorResponse; +} + +@@encodedName(ScriptExecutions.createOrUpdate::parameters.resource, + "application/json", + "scriptExecution" +); +@@clientName(ScriptExecutions.createOrUpdate::parameters.resource, + "scriptExecution" +); +@@OpenAPI.extension(ScriptExecutions.createOrUpdate::parameters.resource, + "x-ms-client-name", + "scriptExecution" +); + +@doc("The location envelope.") +model LocationHeader { + @doc("The Location header contains the URL where the status of the long running operation can be checked.") + @header("Location") + location?: string; +} + +@armResourceOperations +interface IscsiPaths { + listByPrivateCloud is ArmResourceListByParent; + + get is ArmResourceRead; + + #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" + @Azure.Core.useFinalStateVia("azure-async-operation") + createOrUpdate is ArmResourceCreateOrUpdateAsync< + IscsiPath, + LroHeaders = Azure.Core.Foundations.RetryAfterHeader + >; + + #suppress "deprecated" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" + delete is ArmResourceDeleteAsync; +} + +// use { @bodyRoot _: void } with the next version of typespec-azure +// https://github.com/Azure/typespec-azure/issues/3759 + +// Just like ArmResourceActionSync, but with no request body. +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" +#suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update" +@autoRoute +@armResourceAction(TResource) +@post +op ArmResourceActionSyncNoRequestBody< + TResource extends Azure.ResourceManager.Foundations.Resource, + TResponse extends TypeSpec.Reflection.Model, + TBaseParameters = BaseParameters +>( + ...ResourceInstanceParameters, +): ArmResponse | ErrorResponse; + +// Just like ArmResourceActionAsync, but with no request body. +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" +#suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update" +op ArmResourceActionNoContentAsyncNoRequestBody< + TResource extends Azure.ResourceManager.Foundations.Resource, + TBaseParameters extends TypeSpec.Reflection.Model = BaseParameters +> is ArmResourceActionAsyncBaseNoRequestBody< + TResource, + ArmAcceptedLroResponse | ArmNoContentResponse<"Action completed successfully.">, + TBaseParameters +>; + +// Just like ArmResourceActionAsyncBase, but with no request body. +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" +#suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update" +@autoRoute +@extension("x-ms-long-running-operation", true) +@extension( + "x-ms-long-running-operation-options", + { + `final-state-via`: "location", + } +) +@armResourceAction(TResource) +@post +op ArmResourceActionAsyncBaseNoRequestBody< + TResource extends Azure.ResourceManager.Foundations.Resource, + TResponse, + TBaseParameters extends TypeSpec.Reflection.Model +>( + ...ResourceInstanceParameters, +): TResponse | ErrorResponse; diff --git a/specification/vmware/Microsoft.AVS.Management/tspconfig.yaml b/specification/vmware/Microsoft.AVS.Management/tspconfig.yaml new file mode 100644 index 000000000000..8ec13f966d18 --- /dev/null +++ b/specification/vmware/Microsoft.AVS.Management/tspconfig.yaml @@ -0,0 +1,20 @@ +parameters: + "service-dir": + default: "sdk/vmware" + "service-directory-name": + default: "vmware" +emit: ["@azure-tools/typespec-autorest"] +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true + emitter-output-dir: "{project-root}/.." + examples-directory: "{project-root}/examples" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/vmware.json" + omit-unreachable-types: true + use-read-only-status-schema: true diff --git a/specification/vmware/Microsoft.AVS/routes.tsp b/specification/vmware/Microsoft.AVS/routes.tsp deleted file mode 100644 index cbd9cce37e96..000000000000 --- a/specification/vmware/Microsoft.AVS/routes.tsp +++ /dev/null @@ -1,1192 +0,0 @@ -import "@azure-tools/typespec-azure-core"; -import "@typespec/rest"; -import "@azure-tools/typespec-client-generator-core"; -import "./models.tsp"; - -using TypeSpec.Rest; -using TypeSpec.Http; -using Azure.ResourceManager; -using Azure.ResourceManager.Foundations; -using Azure.ClientGenerator.Core; -using OpenAPI; - -namespace Microsoft.AVS; - -interface Operations extends Azure.ResourceManager.Operations {} - -@armResourceOperations -interface Locations { - @doc("Return trial status for subscription by region") - @armResourceAction(Location) - checkTrialAvailability( - ...ResourceInstanceParameters, - - @doc("Optionally, check for a specific SKU") - @bodyRoot - sku?: Sku, - ): ArmResponse | ErrorResponse; - - @doc("Return quota for subscription by region") - @armResourceAction(Location) - @post - checkQuotaAvailability( - ...ResourceInstanceParameters, - ): ArmResponse | ErrorResponse; -} - -alias PrivateCloudList = ResourceList; -@armResourceOperations -interface PrivateClouds { - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("PrivateClouds_List") - list is ArmResourceListByParent< - PrivateCloud, - Response = ArmResponse - >; - - listInSubscription is ArmListBySubscription< - PrivateCloud, - Response = ArmResponse - >; - - get is ArmResourceRead; - - #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" - @Azure.Core.useFinalStateVia("azure-async-operation") - createOrUpdate is ArmResourceCreateOrUpdateAsync< - PrivateCloud, - LroHeaders = Azure.Core.Foundations.RetryAfterHeader - >; - - // This could be modeled with ArmCustomPatchAsync if a 202 response with no body is used instead of a 201. - // update is ArmCustomPatchAsync; - @doc("Update a PrivateCloud") - @extension("x-ms-long-running-operation", true) - @extension( - "x-ms-long-running-operation-options", - { - `final-state-via`: "location", - } - ) - @armResourceUpdate(PrivateCloud) - @patch - update( - ...ResourceInstanceParameters, - - @bodyRoot - @doc("The private cloud properties to be updated.") - privateCloudUpdate: PrivateCloudUpdate, - ): ArmResponse | { - // @doc("Resource update request created.") - ...CreatedResponse; - - ...Azure.Core.Foundations.RetryAfterHeader; - ...LocationHeader; - - @bodyRoot - @doc("The updated private cloud.") - placementPolicy: PrivateCloud; - } | ErrorResponse; - - #suppress "deprecated" - #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" - delete is ArmResourceDeleteAsync; - - #suppress "@azure-tools/typespec-azure-resource-manager/arm-post-operation-response-codes" "Existing API" - @doc("Rotate the vCenter password") - rotateVcenterPassword is ArmResourceActionNoContentAsyncNoRequestBody; - - #suppress "@azure-tools/typespec-azure-resource-manager/arm-post-operation-response-codes" "Existing API" - @doc("Rotate the NSX-T Manager password") - rotateNsxtPassword is ArmResourceActionNoContentAsyncNoRequestBody; - - @doc("List the admin credentials for the private cloud") - listAdminCredentials is ArmResourceActionSyncNoRequestBody< - PrivateCloud, - AdminCredentials - >; -} - -@@encodedName(PrivateClouds.createOrUpdate::parameters.resource, - "application/json", - "privateCloud" -); -@@OpenAPI.extension(PrivateClouds.createOrUpdate::parameters.resource, - "x-ms-client-name", - "privateCloud" -); -@@clientName(PrivateClouds.createOrUpdate::parameters.resource, "privateCloud"); - -@armResourceOperations -interface Clusters { - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("Clusters_List") - list is ArmResourceListByParent< - Cluster, - Response = ArmResponse> - >; - - get is ArmResourceRead; - - #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" - @Azure.Core.useFinalStateVia("azure-async-operation") - createOrUpdate is ArmResourceCreateOrUpdateAsync< - Cluster, - LroHeaders = Azure.Core.Foundations.RetryAfterHeader - >; - - // This could be modeled with ArmCustomPatchAsync if a 202 response with no body is used instead of a 201. - // update is ArmCustomPatchAsync; - @doc("Update a Cluster") - @extension("x-ms-long-running-operation", true) - @extension( - "x-ms-long-running-operation-options", - { - `final-state-via`: "location", - } - ) - @armResourceUpdate(Cluster) - @patch - update( - ...ResourceInstanceParameters, - - @bodyRoot - @doc("The cluster properties to be updated.") - clusterUpdate: ClusterUpdate, - ): ArmResponse | { - // @doc("Resource update request created.") - ...CreatedResponse; - - ...Azure.Core.Foundations.RetryAfterHeader; - ...LocationHeader; - - @bodyRoot - @doc("The updated cluster.") - cluster: Cluster; - } | ErrorResponse; - - #suppress "deprecated" - #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" - delete is ArmResourceDeleteAsync; - - @doc("List hosts by zone in a cluster") - listZones is ArmResourceActionSyncNoRequestBody; -} - -@@encodedName(Clusters.createOrUpdate::parameters.resource, - "application/json", - "cluster" -); -@@OpenAPI.extension(Clusters.createOrUpdate::parameters.resource, - "x-ms-client-name", - "cluster" -); -@@clientName(Clusters.createOrUpdate::parameters.resource, "cluster"); - -@armResourceOperations -interface Datastores { - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("Datastores_List") - list is ArmResourceListByParent< - Datastore, - Response = ArmResponse> - >; - - get is ArmResourceRead; - - #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" - @Azure.Core.useFinalStateVia("azure-async-operation") - createOrUpdate is ArmResourceCreateOrUpdateAsync< - Datastore, - LroHeaders = Azure.Core.Foundations.RetryAfterHeader - >; - - #suppress "deprecated" - #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" - delete is ArmResourceDeleteAsync; -} - -@@encodedName(Datastores.createOrUpdate::parameters.resource, - "application/json", - "datastore" -); -@@clientName(Datastores.createOrUpdate::parameters.resource, "datastore"); -@@OpenAPI.extension(Datastores.createOrUpdate::parameters.resource, - "x-ms-client-name", - "datastore" -); - -@armResourceOperations -interface HcxEnterpriseSites { - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("HcxEnterpriseSites_List") - list is ArmResourceListByParent< - HcxEnterpriseSite, - Response = ArmResponse> - >; - - get is ArmResourceRead; - - createOrUpdate is ArmResourceCreateOrReplaceSync; - - delete is ArmResourceDeleteSync; -} - -@@encodedName(HcxEnterpriseSites.createOrUpdate::parameters.resource, - "application/json", - "hcxEnterpriseSite" -); -@@clientName(HcxEnterpriseSites.createOrUpdate::parameters.resource, - "hcxEnterpriseSite" -); -@@OpenAPI.extension(HcxEnterpriseSites.createOrUpdate::parameters.resource, - "x-ms-client-name", - "hcxEnterpriseSite" -); - -@armResourceOperations -interface Authorizations { - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("Authorizations_List") - list is ArmResourceListByParent< - ExpressRouteAuthorization, - Response = ArmResponse> - >; - - get is ArmResourceRead; - - #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST REMOVE AT NEXT API VERSION UPDATE" - @Azure.Core.useFinalStateVia("azure-async-operation") - createOrUpdate is ArmResourceCreateOrUpdateAsync< - ExpressRouteAuthorization, - BaseParameters, - LroHeaders = Azure.Core.Foundations.RetryAfterHeader - >; - - #suppress "deprecated" - #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" - delete is ArmResourceDeleteAsync; -} - -@@encodedName(Authorizations.createOrUpdate::parameters.resource, - "application/json", - "authorization" -); -@@clientName(Authorizations.createOrUpdate::parameters.resource, - "authorization" -); -@@OpenAPI.extension(Authorizations.createOrUpdate::parameters.resource, - "x-ms-client-name", - "authorization" -); - -@armResourceOperations -interface GlobalReachConnections { - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("GlobalReachConnections_List") - list is ArmResourceListByParent< - GlobalReachConnection, - Response = ArmResponse> - >; - - get is ArmResourceRead; - - #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" - @Azure.Core.useFinalStateVia("azure-async-operation") - createOrUpdate is ArmResourceCreateOrUpdateAsync< - GlobalReachConnection, - LroHeaders = Azure.Core.Foundations.RetryAfterHeader - >; - - #suppress "deprecated" - #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" - delete is ArmResourceDeleteAsync; -} - -@@encodedName(GlobalReachConnections.createOrUpdate::parameters.resource, - "application/json", - "globalReachConnection" -); -@@clientName(GlobalReachConnections.createOrUpdate::parameters.resource, - "globalReachConnection" -); -@@OpenAPI.extension(GlobalReachConnections.createOrUpdate::parameters.resource, - "x-ms-client-name", - "globalReachConnection" -); - -@armResourceOperations -interface WorkloadNetworks { - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_Get") - get is ArmResourceRead; - - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_List") - list is ArmResourceListByParent< - WorkloadNetwork, - Response = ArmResponse> - >; -} - -@armResourceOperations -interface WorkloadNetworkSegments { - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_ListSegments") - list is ArmResourceListByParent< - WorkloadNetworkSegment, - Response = ArmResponse> - >; - - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_GetSegment") - get is ArmResourceRead; - - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" - @operationId("WorkloadNetworks_CreateSegments") - @Azure.Core.useFinalStateVia("azure-async-operation") - create is ArmResourceCreateOrUpdateAsync< - WorkloadNetworkSegment, - LroHeaders = Azure.Core.Foundations.RetryAfterHeader - >; - - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_UpdateSegments") - @parameterVisibility - update is ArmCustomPatchAsync; - - #suppress "deprecated" - #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_DeleteSegment") - deleteSegment is ArmResourceDeleteAsync; -} - -@@encodedName(WorkloadNetworkSegments.create::parameters.resource, - "application/json", - "workloadNetworkSegment" -); -@@clientName(WorkloadNetworkSegments.create::parameters.resource, - "workloadNetworkSegment" -); -@@OpenAPI.extension(WorkloadNetworkSegments.create::parameters.resource, - "x-ms-client-name", - "workloadNetworkSegment" -); - -@@encodedName(WorkloadNetworkSegments.update::parameters.properties, - "application/json", - "workloadNetworkSegment" -); -@@clientName(WorkloadNetworkSegments.update::parameters.properties, - "application/json", - "workloadNetworkSegment" -); -@@OpenAPI.extension(WorkloadNetworkSegments.update::parameters.properties, - "x-ms-client-name", - "workloadNetworkSegment" -); - -#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" -// @armResourceOperations -interface WorkloadNetworkDhcpConfigurations { - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_ListDhcp") - list is ArmResourceListByParent< - WorkloadNetworkDhcp, - Response = ArmResponse> - >; - - #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "DhcpIdParameter should be last, but it is breaking to correct it." - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_GetDhcp") - // get is ArmResourceRead; - @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}") - @doc("Get a {name}", WorkloadNetworkDhcp) - @get - get( - ...BaseParameters, - ...DhcpIdParameter, - ...PrivateCloudNameParameter, - ): ArmResponse | ErrorResponse; - - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" - @operationId("WorkloadNetworks_CreateDhcp") - @Azure.Core.useFinalStateVia("azure-async-operation") - create is ArmResourceCreateOrUpdateAsync< - WorkloadNetworkDhcp, - LroHeaders = Azure.Core.Foundations.RetryAfterHeader - >; - - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_UpdateDhcp") - @parameterVisibility - update is ArmCustomPatchAsync; - - #suppress "deprecated" - #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_DeleteDhcp") - delete is ArmResourceDeleteAsync; -} - -@@encodedName(WorkloadNetworkDhcpConfigurations.create::parameters.resource, - "application/json", - "workloadNetworkDhcp" -); -@@clientName(WorkloadNetworkDhcpConfigurations.create::parameters.resource, - "workloadNetworkDhcp" -); -@@OpenAPI.extension(WorkloadNetworkDhcpConfigurations.create::parameters.resource, - "x-ms-client-name", - "workloadNetworkDhcp" -); - -@@encodedName(WorkloadNetworkDhcpConfigurations.update::parameters.properties, - "application/json", - "workloadNetworkDhcp" -); -@@clientName(WorkloadNetworkDhcpConfigurations.update::parameters.properties, - "workloadNetworkDhcp" -); -@@OpenAPI.extension(WorkloadNetworkDhcpConfigurations.update::parameters.properties, - "x-ms-client-name", - "workloadNetworkDhcp" -); - -@@encodedName(WorkloadNetworkDhcpConfigurations.update::parameters.properties, - "application/json", - "workloadNetworkDhcp" -); -@@clientName(WorkloadNetworkDhcpConfigurations.update::parameters.properties, - "workloadNetworkDhcp" -); -@@OpenAPI.extension(WorkloadNetworkDhcpConfigurations.update::parameters.properties, - "x-ms-client-name", - "workloadNetworkDhcp" -); - -@armResourceOperations -interface WorkloadNetworkGateways { - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_ListGateways") - list is ArmResourceListByParent< - WorkloadNetworkGateway, - Response = ArmResponse> - >; - - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_GetGateway") - get is ArmResourceRead; -} - -#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" -#suppress "@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation" -// @armResourceOperations -@doc("Workload Network Port Mirroring Profiles") -interface WorkloadNetworkPortMirroringProfiles { - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_ListPortMirroring") - list is ArmResourceListByParent< - WorkloadNetworkPortMirroring, - Response = ArmResponse> - >; - - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_GetPortMirroring") - get is ArmResourceRead; - - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" - @operationId("WorkloadNetworks_CreatePortMirroring") - @Azure.Core.useFinalStateVia("azure-async-operation") - create is ArmResourceCreateOrUpdateAsync< - WorkloadNetworkPortMirroring, - LroHeaders = Azure.Core.Foundations.RetryAfterHeader - >; - - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_UpdatePortMirroring") - @parameterVisibility - update is ArmCustomPatchAsync< - WorkloadNetworkPortMirroring, - WorkloadNetworkPortMirroring - >; - - #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "PortMirroringProfileParameter should be last, but it is breaking to correct it." - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_DeletePortMirroring") - // delete is ArmResourceDeleteAsync; - @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}") - @doc("Delete a {name}", WorkloadNetworkPortMirroring) - @delete - @extension("x-ms-long-running-operation", true) - @extension( - "x-ms-long-running-operation-options", - { - `final-state-via`: "location", - } - ) - delete( - ...BaseParameters, - ...PortMirroringProfileParameter, - ...PrivateCloudNameParameter, - ): - | ArmDeletedResponse - | ArmDeleteAcceptedLroResponse - | ArmDeletedNoContentResponse - | ErrorResponse; -} - -@@encodedName(WorkloadNetworkPortMirroringProfiles.create::parameters.resource, - "application/json", - "workloadNetworkPortMirroring" -); -@@clientName(WorkloadNetworkPortMirroringProfiles.create::parameters.resource, - "workloadNetworkPortMirroring" -); -@@OpenAPI.extension(WorkloadNetworkPortMirroringProfiles.create::parameters.resource, - "x-ms-client-name", - "workloadNetworkPortMirroring" -); - -@@encodedName(WorkloadNetworkPortMirroringProfiles.update::parameters.properties, - "application/json", - "workloadNetworkPortMirroring" -); -@@clientName(WorkloadNetworkPortMirroringProfiles.update::parameters.properties, - "workloadNetworkPortMirroring" -); -@@OpenAPI.extension(WorkloadNetworkPortMirroringProfiles.update::parameters.properties, - "x-ms-client-name", - "workloadNetworkPortMirroring" -); - -#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" -#suppress "@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation" -// @armResourceOperations -@doc("Workload Network VM Groups") -interface WorkloadNetworkVmGroups { - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_ListVMGroups") - list is ArmResourceListByParent< - WorkloadNetworkVMGroup, - Response = ArmResponse> - >; - - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_GetVMGroup") - get is ArmResourceRead; - - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" - @operationId("WorkloadNetworks_CreateVMGroup") - @Azure.Core.useFinalStateVia("azure-async-operation") - create is ArmResourceCreateOrUpdateAsync< - WorkloadNetworkVMGroup, - LroHeaders = Azure.Core.Foundations.RetryAfterHeader - >; - - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_UpdateVMGroup") - @parameterVisibility - update is ArmCustomPatchAsync; - - #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "VmGroupIdParameter should be last, but it is breaking to correct it." - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_DeleteVMGroup") - // delete is ArmResourceDeleteAsync; - @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}") - @doc("Delete a {name}", WorkloadNetworkVMGroup) - @delete - @extension("x-ms-long-running-operation", true) - @extension( - "x-ms-long-running-operation-options", - { - `final-state-via`: "location", - } - ) - delete( - ...BaseParameters, - ...VmGroupIdParameter, - ...PrivateCloudNameParameter, - ): - | ArmDeletedResponse - | ArmDeleteAcceptedLroResponse - | ArmDeletedNoContentResponse - | ErrorResponse; -} - -@@encodedName(WorkloadNetworkVmGroups.create::parameters.resource, - "application/json", - "workloadNetworkVMGroup" -); -@@clientName(WorkloadNetworkVmGroups.create::parameters.resource, - "application/json", - "workloadNetworkVMGroup" -); -@@OpenAPI.extension(WorkloadNetworkVmGroups.create::parameters.resource, - "x-ms-client-name", - "workloadNetworkVMGroup" -); - -@@encodedName(WorkloadNetworkVmGroups.update::parameters.properties, - "application/json", - "workloadNetworkVMGroup" -); -@@clientName(WorkloadNetworkVmGroups.update::parameters.properties, - "workloadNetworkVMGroup" -); -@@OpenAPI.extension(WorkloadNetworkVmGroups.update::parameters.properties, - "x-ms-client-name", - "workloadNetworkVMGroup" -); - -@armResourceOperations -interface WorkloadNetworkVirtualMachines { - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_ListVirtualMachines") - list is ArmResourceListByParent< - WorkloadNetworkVirtualMachine, - Response = ArmResponse> - >; - - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_GetVirtualMachine") - get is ArmResourceRead; -} - -#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" -#suppress "@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation" -// @armResourceOperations -@doc("Workload Network Dns Services") -interface WorkloadNetworkDnsServices { - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_ListDnsServices") - list is ArmResourceListByParent< - WorkloadNetworkDnsService, - Response = ArmResponse> - >; - - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_GetDnsService") - get is ArmResourceRead; - - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" - @operationId("WorkloadNetworks_CreateDnsService") - @Azure.Core.useFinalStateVia("azure-async-operation") - create is ArmResourceCreateOrUpdateAsync< - WorkloadNetworkDnsService, - LroHeaders = Azure.Core.Foundations.RetryAfterHeader - >; - - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_UpdateDnsService") - @parameterVisibility - update is ArmCustomPatchAsync< - WorkloadNetworkDnsService, - WorkloadNetworkDnsService - >; - - #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "DnsServiceIdParameter should be last, but it is breaking to correct it." - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_DeleteDnsService") - // delete is ArmResourceDeleteAsync; - @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}") - @doc("Delete a {name}", WorkloadNetworkDnsService) - @delete - @extension("x-ms-long-running-operation", true) - @extension( - "x-ms-long-running-operation-options", - { - `final-state-via`: "location", - } - ) - delete( - ...BaseParameters, - ...DnsServiceIdParameter, - ...PrivateCloudNameParameter, - ): - | ArmDeletedResponse - | ArmDeleteAcceptedLroResponse - | ArmDeletedNoContentResponse - | ErrorResponse; -} - -@@encodedName(WorkloadNetworkDnsServices.create::parameters.resource, - "application/json", - "workloadNetworkDnsService" -); -@@clientName(WorkloadNetworkDnsServices.create::parameters.resource, - "workloadNetworkDnsService" -); -@@OpenAPI.extension(WorkloadNetworkDnsServices.create::parameters.resource, - "x-ms-client-name", - "workloadNetworkDnsService" -); - -@@encodedName(WorkloadNetworkDnsServices.update::parameters.properties, - "application/json", - "workloadNetworkDnsService" -); -@@clientName(WorkloadNetworkDnsServices.update::parameters.properties, - "workloadNetworkDnsService" -); -@@OpenAPI.extension(WorkloadNetworkDnsServices.update::parameters.properties, - "x-ms-client-name", - "workloadNetworkDnsService" -); - -#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" -#suppress "@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation" -// @armResourceOperations -@doc("Workload Network DNS Zones") -interface WorkloadNetworkDnsZones { - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_ListDnsZones") - list is ArmResourceListByParent< - WorkloadNetworkDnsZone, - Response = ArmResponse> - >; - - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_GetDnsZone") - get is ArmResourceRead; - - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" - @operationId("WorkloadNetworks_CreateDnsZone") - @Azure.Core.useFinalStateVia("azure-async-operation") - create is ArmResourceCreateOrUpdateAsync< - WorkloadNetworkDnsZone, - LroHeaders = Azure.Core.Foundations.RetryAfterHeader - >; - - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_UpdateDnsZone") - @parameterVisibility - update is ArmCustomPatchAsync; - - #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "DnsZoneIdParameter should be last, but it is breaking to correct it." - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_DeleteDnsZone") - // delete is ArmResourceDeleteAsync; - @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId}") - @doc("Delete a {name}", WorkloadNetworkDnsZone) - @delete - @extension("x-ms-long-running-operation", true) - @extension( - "x-ms-long-running-operation-options", - { - `final-state-via`: "location", - } - ) - delete( - ...BaseParameters, - ...DnsZoneIdParameter, - ...PrivateCloudNameParameter, - ): - | ArmDeletedResponse - | ArmDeleteAcceptedLroResponse - | ArmDeletedNoContentResponse - | ErrorResponse; -} - -@@encodedName(WorkloadNetworkDnsZones.create::parameters.resource, - "application/json", - "workloadNetworkDnsZone" -); -@@clientName(WorkloadNetworkDnsZones.create::parameters.resource, - "workloadNetworkDnsZone" -); -@@OpenAPI.extension(WorkloadNetworkDnsZones.create::parameters.resource, - "x-ms-client-name", - "workloadNetworkDnsZone" -); - -@@encodedName(WorkloadNetworkDnsZones.update::parameters.properties, - "application/json", - "workloadNetworkDnsZone" -); -@@clientName(WorkloadNetworkDnsZones.update::parameters.properties, - "workloadNetworkDnsZone" -); -@@OpenAPI.extension(WorkloadNetworkDnsZones.update::parameters.properties, - "x-ms-client-name", - "workloadNetworkDnsZone" -); - -#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" -#suppress "@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation" -// @armResourceOperations -interface WorkloadNetworkPublicIps { - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_ListPublicIPs") - list is ArmResourceListByParent< - WorkloadNetworkPublicIP, - Response = ArmResponse> - >; - - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_GetPublicIP") - get is ArmResourceRead; - - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" - @operationId("WorkloadNetworks_CreatePublicIP") - @Azure.Core.useFinalStateVia("azure-async-operation") - create is ArmResourceCreateOrUpdateAsync< - WorkloadNetworkPublicIP, - LroHeaders = Azure.Core.Foundations.RetryAfterHeader - >; - - #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "PublicIPIdParameter should be last, but it is breaking to correct it." - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("WorkloadNetworks_DeletePublicIP") - // delete is ArmResourceDeleteAsync; - @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/publicIPs/{publicIPId}") - @doc("Delete a {name}", WorkloadNetworkPublicIP) - @delete - @extension("x-ms-long-running-operation", true) - @extension( - "x-ms-long-running-operation-options", - { - `final-state-via`: "location", - } - ) - delete( - ...BaseParameters, - ...PublicIPIdParameter, - ...PrivateCloudNameParameter, - ): - | ArmDeletedResponse - | ArmDeleteAcceptedLroResponse - | ArmDeletedNoContentResponse - | ErrorResponse; -} - -@@encodedName(WorkloadNetworkPublicIps.create::parameters.resource, - "application/json", - "workloadNetworkPublicIP" -); -@@clientName(WorkloadNetworkPublicIps.create::parameters.resource, - "workloadNetworkPublicIP" -); -@@OpenAPI.extension(WorkloadNetworkPublicIps.create::parameters.resource, - "x-ms-client-name", - "workloadNetworkPublicIP" -); - -@armResourceOperations -interface CloudLinks { - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("CloudLinks_List") - list is ArmResourceListByParent< - CloudLink, - Response = ArmResponse> - >; - - get is ArmResourceRead; - - #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" - @Azure.Core.useFinalStateVia("azure-async-operation") - createOrUpdate is ArmResourceCreateOrUpdateAsync< - CloudLink, - LroHeaders = Azure.Core.Foundations.RetryAfterHeader - >; - - #suppress "deprecated" - #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" - delete is ArmResourceDeleteAsync; -} - -@@encodedName(CloudLinks.createOrUpdate::parameters.resource, - "application/json", - "cloudLink" -); -@@clientName(CloudLinks.createOrUpdate::parameters.resource, "cloudLink"); -@@OpenAPI.extension(CloudLinks.createOrUpdate::parameters.resource, - "x-ms-client-name", - "cloudLink" -); - -@armResourceOperations -interface Addons { - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("Addons_List") - list is ArmResourceListByParent< - Addon, - Response = ArmResponse> - >; - - get is ArmResourceRead; - - #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" - @Azure.Core.useFinalStateVia("azure-async-operation") - createOrUpdate is ArmResourceCreateOrUpdateAsync< - Addon, - LroHeaders = Azure.Core.Foundations.RetryAfterHeader - >; - - #suppress "deprecated" - #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" - delete is ArmResourceDeleteAsync; -} - -@@encodedName(Addons.createOrUpdate::parameters.resource, - "application/json", - "addon" -); -@@clientName(Addons.createOrUpdate::parameters.resource, "addon"); -@@OpenAPI.extension(Addons.createOrUpdate::parameters.resource, - "x-ms-client-name", - "addon" -); - -@armResourceOperations -interface VirtualMachines { - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("VirtualMachines_List") - list is ArmResourceListByParent< - VirtualMachine, - Response = ArmResponse> - >; - - get is ArmResourceRead; - - // restrictMovement should be a ArmResourceActionNoContentAsync, but does not respond with a 204. - @doc("Enable or disable DRS-driven VM movement restriction") - @armResourceAction(Location) - @post - @extension("x-ms-long-running-operation", true) - restrictMovement( - ...ResourceInstanceParameters, - - @bodyRoot - @doc("The body type of the operation request.") - restrictMovement: VirtualMachineRestrictMovement, - ): ArmAcceptedLroResponse | ErrorResponse; -} - -@armResourceOperations -interface PlacementPolicies { - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("PlacementPolicies_List") - list is ArmResourceListByParent< - PlacementPolicy, - Response = ArmResponse> - >; - - get is ArmResourceRead; - - #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" - @Azure.Core.useFinalStateVia("azure-async-operation") - createOrUpdate is ArmResourceCreateOrUpdateAsync< - PlacementPolicy, - LroHeaders = Azure.Core.Foundations.RetryAfterHeader - >; - - // 202 response has a body, but it should not to match ArmCustomPatchAsync. - // update is ArmCustomPatchAsync; - #suppress "@azure-tools/typespec-azure-resource-manager/no-response-body" - @doc("Update a PlacementPolicy") - @extension("x-ms-long-running-operation", true) - @extension( - "x-ms-long-running-operation-options", - { - `final-state-via`: "location", - } - ) - @armResourceUpdate(PlacementPolicy) - @patch - update( - ...ResourceInstanceParameters, - - @bodyRoot - @doc("The placement policy properties to be updated.") - placementPolicyUpdate: PlacementPolicyUpdate, - ): ArmResponse | { - ...AcceptedResponse; - ...Azure.Core.Foundations.RetryAfterHeader; - ...LocationHeader; - - @bodyRoot - @doc("The updatd placement policy.") - placementPolicy: PlacementPolicy; - } | ErrorResponse; - - #suppress "deprecated" - #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" - delete is ArmResourceDeleteAsync; -} - -@@encodedName(PlacementPolicies.createOrUpdate::parameters.resource, - "application/json", - "placementPolicy" -); -@@clientName(PlacementPolicies.createOrUpdate::parameters.resource, - "placementPolicy" -); -@@OpenAPI.extension(PlacementPolicies.createOrUpdate::parameters.resource, - "x-ms-client-name", - "placementPolicy" -); - -@armResourceOperations -interface ScriptPackages { - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("ScriptPackages_List") - list is ArmResourceListByParent< - ScriptPackage, - Response = ArmResponse> - >; - - get is ArmResourceRead; -} - -@armResourceOperations -interface ScriptCmdlets { - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("ScriptCmdlets_List") - list is ArmResourceListByParent< - ScriptCmdlet, - Response = ArmResponse> - >; - - get is ArmResourceRead; -} - -@armResourceOperations -interface ScriptExecutions { - #suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." - @operationId("ScriptExecutions_List") - list is ArmResourceListByParent< - ScriptExecution, - Response = ArmResponse> - >; - - get is ArmResourceRead; - - #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" - @Azure.Core.useFinalStateVia("azure-async-operation") - createOrUpdate is ArmResourceCreateOrUpdateAsync< - ScriptExecution, - LroHeaders = Azure.Core.Foundations.RetryAfterHeader - >; - - #suppress "deprecated" - #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" - delete is ArmResourceDeleteAsync; - - @doc("Return the logs for a script execution resource") - @autoRoute - @armResourceAction(ScriptExecution) - @post - getExecutionLogs( - ...ResourceInstanceParameters, - - #suppress "@azure-tools/typespec-azure-core/request-body-problem" - @bodyRoot - @doc("Name of the desired output stream to return. If not provided, will return all. An empty array will return nothing.") - scriptOutputStreamType?: ScriptOutputStreamType[], - ): ArmResponse | ErrorResponse; -} - -@@encodedName(ScriptExecutions.createOrUpdate::parameters.resource, - "application/json", - "scriptExecution" -); -@@clientName(ScriptExecutions.createOrUpdate::parameters.resource, - "scriptExecution" -); -@@OpenAPI.extension(ScriptExecutions.createOrUpdate::parameters.resource, - "x-ms-client-name", - "scriptExecution" -); - -@doc("The location envelope.") -model LocationHeader { - @doc("The Location header contains the URL where the status of the long running operation can be checked.") - @header("Location") - location?: string; -} - -@armResourceOperations -interface IscsiPaths { - list is ArmResourceListByParent; - - get is ArmResourceRead; - - #suppress "@azure-tools/typespec-azure-core/invalid-final-state" "MUST CHANGE ON NEXT UPDATE" - @Azure.Core.useFinalStateVia("azure-async-operation") - createOrUpdate is ArmResourceCreateOrUpdateAsync< - IscsiPath, - LroHeaders = Azure.Core.Foundations.RetryAfterHeader - >; - - #suppress "deprecated" - #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" - delete is ArmResourceDeleteAsync; -} - -// use { @bodyRoot _: void } with the next version of typespec-azure -// https://github.com/Azure/typespec-azure/issues/3759 - -// Just like ArmResourceActionSync, but with no request body. -#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" -#suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update" -@autoRoute -@armResourceAction(TResource) -@post -op ArmResourceActionSyncNoRequestBody< - TResource extends Azure.ResourceManager.Foundations.Resource, - TResponse extends TypeSpec.Reflection.Model, - TBaseParameters = BaseParameters ->( - ...ResourceInstanceParameters, -): ArmResponse | ErrorResponse; - -// Just like ArmResourceActionAsync, but with no request body. -#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" -#suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update" -op ArmResourceActionNoContentAsyncNoRequestBody< - TResource extends Azure.ResourceManager.Foundations.Resource, - TBaseParameters extends TypeSpec.Reflection.Model = BaseParameters -> is ArmResourceActionAsyncBaseNoRequestBody< - TResource, - ArmAcceptedLroResponse | ArmNoContentResponse<"Action completed successfully.">, - TBaseParameters ->; - -// Just like ArmResourceActionAsyncBase, but with no request body. -#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" -#suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update" -@autoRoute -@extension("x-ms-long-running-operation", true) -@extension( - "x-ms-long-running-operation-options", - { - `final-state-via`: "location", - } -) -@armResourceAction(TResource) -@post -op ArmResourceActionAsyncBaseNoRequestBody< - TResource extends Azure.ResourceManager.Foundations.Resource, - TResponse, - TBaseParameters extends TypeSpec.Reflection.Model ->( - ...ResourceInstanceParameters, -): TResponse | ErrorResponse; diff --git a/specification/vmware/Microsoft.AVS/tspconfig.yaml b/specification/vmware/Microsoft.AVS/tspconfig.yaml deleted file mode 100644 index 310703263db8..000000000000 --- a/specification/vmware/Microsoft.AVS/tspconfig.yaml +++ /dev/null @@ -1,17 +0,0 @@ -parameters: - "service-dir": - default: "sdk/vmware" - "service-directory-name": - default: "vmware" -emit: ["@azure-tools/typespec-autorest"] -linter: - extends: - - "@azure-tools/typespec-azure-rulesets/resource-manager" -options: - "@azure-tools/typespec-autorest": - azure-resource-provider-folder: "resource-manager" - emitter-output-dir: "{project-root}/.." - examples-directory: "{project-root}/examples" - output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/vmware.json" - omit-unreachable-types: true - use-read-only-status-schema: true diff --git a/specification/workloads/Workloads.Operations.Management/tspconfig.yaml b/specification/workloads/Workloads.Operations.Management/tspconfig.yaml index dc13f45348b5..7bfd4bf58b80 100644 --- a/specification/workloads/Workloads.Operations.Management/tspconfig.yaml +++ b/specification/workloads/Workloads.Operations.Management/tspconfig.yaml @@ -5,6 +5,9 @@ options: use-read-only-status-schema: true emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/operations/{version-status}/{version}/operations.json" examples-directory: "{project-root}/examples" linter: diff --git a/specification/workloads/Workloads.SAPDiscoverySite.Management/SAPInstance.tsp b/specification/workloads/Workloads.SAPDiscoverySite.Management/SAPInstance.tsp index 4fc5f70be91c..5b884636749a 100644 --- a/specification/workloads/Workloads.SAPDiscoverySite.Management/SAPInstance.tsp +++ b/specification/workloads/Workloads.SAPDiscoverySite.Management/SAPInstance.tsp @@ -56,5 +56,5 @@ interface SAPInstances { * Lists the SAP Instance resources for the given SAP Migration discovery site resource. */ #suppress "@azure-tools/typespec-azure-core/casing-style" "SAP is a product." - list is ArmResourceListByParent; + ListBySapDiscoverySite is ArmResourceListByParent; } diff --git a/specification/workloads/Workloads.SAPDiscoverySite.Management/ServerInstance.tsp b/specification/workloads/Workloads.SAPDiscoverySite.Management/ServerInstance.tsp index b6d6be8903e9..3a35ece80995 100644 --- a/specification/workloads/Workloads.SAPDiscoverySite.Management/ServerInstance.tsp +++ b/specification/workloads/Workloads.SAPDiscoverySite.Management/ServerInstance.tsp @@ -53,5 +53,5 @@ interface ServerInstances { * Lists the Server Instance resources for the given SAP Instance resource. */ #suppress "@azure-tools/typespec-azure-core/casing-style" "Supporting existing name." - list is ArmResourceListByParent; + ListBySapInstance is ArmResourceListByParent; } diff --git a/specification/workloads/Workloads.SAPDiscoverySite.Management/tspconfig.yaml b/specification/workloads/Workloads.SAPDiscoverySite.Management/tspconfig.yaml index df02fc7b5ac0..b3363d9805d0 100644 --- a/specification/workloads/Workloads.SAPDiscoverySite.Management/tspconfig.yaml +++ b/specification/workloads/Workloads.SAPDiscoverySite.Management/tspconfig.yaml @@ -5,6 +5,9 @@ options: use-read-only-status-schema: true emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/SAPDiscoverySites/{version-status}/{version}/SAPDiscoverySites.json" examples-directory: "{project-root}/examples" linter: diff --git a/specification/workloads/Workloads.SAPMonitor.Management/ProviderInstance.tsp b/specification/workloads/Workloads.SAPMonitor.Management/ProviderInstance.tsp index a5a36bfb2c24..32a0311f4e62 100644 --- a/specification/workloads/Workloads.SAPMonitor.Management/ProviderInstance.tsp +++ b/specification/workloads/Workloads.SAPMonitor.Management/ProviderInstance.tsp @@ -44,7 +44,7 @@ interface ProviderInstances { /** * Gets a list of provider instances in the specified SAP monitor. The operations returns various properties of each provider instances. */ - list is ArmResourceListByParent; + listByMonitor is ArmResourceListByParent; } @@doc(ProviderInstances.create::parameters.resource, diff --git a/specification/workloads/Workloads.SAPMonitor.Management/SapLandscapeMonitor.tsp b/specification/workloads/Workloads.SAPMonitor.Management/SapLandscapeMonitor.tsp index 77b5ed33066c..b0b964619191 100644 --- a/specification/workloads/Workloads.SAPMonitor.Management/SapLandscapeMonitor.tsp +++ b/specification/workloads/Workloads.SAPMonitor.Management/SapLandscapeMonitor.tsp @@ -58,7 +58,7 @@ interface SapLandscapeMonitor { /** * Gets configuration values for Single Pane Of Glass for SAP monitor for the specified subscription, resource group, and resource name. */ - list is ArmResourceListByParent; + listByMonitor is ArmResourceListByParent; } @@doc(SapLandscapeMonitor.create::parameters.resource, diff --git a/specification/workloads/Workloads.SAPMonitor.Management/tspconfig.yaml b/specification/workloads/Workloads.SAPMonitor.Management/tspconfig.yaml index 6039a2f8a0a0..477dfed0d31b 100644 --- a/specification/workloads/Workloads.SAPMonitor.Management/tspconfig.yaml +++ b/specification/workloads/Workloads.SAPMonitor.Management/tspconfig.yaml @@ -6,6 +6,9 @@ options: omit-unreachable-types: true emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" + emit-common-types-schema: "never" + # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag + arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/monitors/{version-status}/{version}/monitors.json" examples-directory: "{project-root}/examples" linter: diff --git a/specificationRepositoryConfiguration.json b/specificationRepositoryConfiguration.json index 460ced229230..823fa140a108 100644 --- a/specificationRepositoryConfiguration.json +++ b/specificationRepositoryConfiguration.json @@ -33,10 +33,6 @@ "integrationRepository": "azure-sdk/azure-sdk-for-python", "mainRepository": "Azure/azure-sdk-for-python" }, - "azure-sdk-for-python-track2": { - "integrationRepository": "azure-sdk/azure-sdk-for-python", - "mainRepository": "Azure/azure-sdk-for-python" - }, "azure-resource-manager-schemas": { "integrationRepository": "azure-sdk/azure-resource-manager-schemas", "mainRepository": "Azure/azure-resource-manager-schemas" @@ -76,10 +72,6 @@ "integrationRepository": "azure-sdk/azure-sdk-for-python-pr", "mainRepository": "Azure/azure-sdk-for-python-pr" }, - "azure-sdk-for-python-track2": { - "integrationRepository": "azure-sdk/azure-sdk-for-python-pr", - "mainRepository": "Azure/azure-sdk-for-python-pr" - }, "azure-powershell": { "integrationRepository": "Azure/azure-powershell-pr", "mainRepository": "Azure/azure-powershell-pr"